1036074718

Committed 13 Oct 2023 02:44PM UTC coverage: 78.132% (-2.8%) from 80.913%

Build # 1036074718

Build Type

Pull #939

gitlab-ci

Committed by

MuchoLucho

Commit Message

Fix: Make comment more readable for users that may end up troubleshooting
to this point

Changelog: None
Ticket: None

Signed-off-by: Luis Ramirez Vargas <luis.ramirez@northern.tech>

Pull Request Pull Request #939: Fix: Make comment more readable for users

Run Details

3 of 3 new or added lines in 1 file covered. (100.0%)

483 existing lines in 6 files now uncovered.

3998 of 5117 relevant lines covered (78.13%)

56.11 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

62.26

/server.go

// Copyright 2023 Northern.tech AS
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.

package main

import (
        "context"
        "encoding/base64"
        "net/http"
        "net/url"
        "strings"
        "time"

        "github.com/ant0ine/go-json-rest/rest"
        "github.com/pkg/errors"

        "github.com/mendersoftware/go-lib-micro/config"
        "github.com/mendersoftware/go-lib-micro/log"

        api "github.com/mendersoftware/deployments/api/http"
        "github.com/mendersoftware/deployments/app"
        "github.com/mendersoftware/deployments/client/reporting"
        dconfig "github.com/mendersoftware/deployments/config"
        "github.com/mendersoftware/deployments/storage"
        "github.com/mendersoftware/deployments/storage/azblob"
        "github.com/mendersoftware/deployments/storage/manager"
        "github.com/mendersoftware/deployments/storage/s3"
        mstore "github.com/mendersoftware/deployments/store/mongo"
)

func SetupS3(ctx context.Context, defaultOptions *s3.Options) (storage.ObjectStorage, error) {
        c := config.Config

        bucket := c.GetString(dconfig.SettingStorageBucket)

        // Copy / merge defaultOptions
        options := s3.NewOptions(defaultOptions).
                SetBucketName(bucket).
                SetForcePathStyle(c.GetBool(dconfig.SettingAwsS3ForcePathStyle)).
                SetUseAccelerate(c.GetBool(dconfig.SettingAwsS3UseAccelerate))

        // The following parameters falls back on AWS_* environment if not set
        if c.IsSet(dconfig.SettingAwsS3Region) {
                options.SetRegion(c.GetString(dconfig.SettingAwsS3Region))
        }
        if c.IsSet(dconfig.SettingsAwsAuth) ||
                (c.IsSet(dconfig.SettingAwsAuthKeyId) &&
                        c.IsSet(dconfig.SettingAwsAuthSecret)) {
                options.SetStaticCredentials(
                        c.GetString(dconfig.SettingAwsAuthKeyId),
                        c.GetString(dconfig.SettingAwsAuthSecret),
                        c.GetString(dconfig.SettingAwsAuthToken),
                )
        }
        if c.IsSet(dconfig.SettingAwsURI) {
                options.SetURI(c.GetString(dconfig.SettingAwsURI))
        }
        if c.IsSet(dconfig.SettingAwsExternalURI) {
                options.SetExternalURI(c.GetString(dconfig.SettingAwsExternalURI))
        }
        if c.IsSet(dconfig.SettingStorageProxyURI) {
                rawURL := c.GetString(dconfig.SettingStorageProxyURI)
                proxyURL, err := url.Parse(rawURL)
                if err != nil {
                        return nil, errors.WithMessage(err, "invalid setting `storage.proxy_uri`")
                }
                options.SetProxyURI(proxyURL)
        }
        if c.IsSet(dconfig.SettingAwsUnsignedHeaders) {
                options.SetUnsignedHeaders(c.GetStringSlice(dconfig.SettingAwsUnsignedHeaders))
        }

        storage, err := s3.New(ctx, options)
        return storage, err
}

func SetupBlobStorage(
        ctx context.Context,
        defaultOptions *azblob.Options,
) (storage.ObjectStorage, error) {
        c := config.Config

        // Copy / merge options
        options := azblob.NewOptions(defaultOptions)

        if c.IsSet(dconfig.SettingAzureConnectionString) {
                options.SetConnectionString(c.GetString(dconfig.SettingAzureConnectionString))
        } else if c.IsSet(dconfig.SettingAzureSharedKeyAccount) &&
                c.IsSet(dconfig.SettingAzureSharedKeyAccountKey) {
                creds := azblob.SharedKeyCredentials{
                        AccountName: c.GetString(dconfig.SettingAzureSharedKeyAccount),
                        AccountKey:  c.GetString(dconfig.SettingAzureSharedKeyAccountKey),
                }
                if c.IsSet(dconfig.SettingAzureSharedKeyURI) {
                        uri := c.GetString(dconfig.SettingAzureSharedKeyURI)
                        creds.URI = &uri
                }
                options.SetSharedKey(creds)
        }
        if c.IsSet(dconfig.SettingStorageProxyURI) {
                rawURL := c.GetString(dconfig.SettingStorageProxyURI)
                proxyURL, err := url.Parse(rawURL)
                if err != nil {
                        return nil, errors.WithMessage(err, `invalid setting "storage.proxy_uri"`)
                }
                if !strings.HasPrefix(strings.ToLower(proxyURL.Scheme), "https") {
                        log.FromContext(ctx).
                                Warnf(`setting "storage.proxy_uri" (%s) is not using https`, rawURL)
                }
                options.SetProxyURI(proxyURL)
        }
        return azblob.New(ctx, c.GetString(dconfig.SettingStorageBucket), options)
}

func SetupObjectStorage(ctx context.Context) (objManager storage.ObjectStorage, err error) {
        c := config.Config

        // Calculate s3 multipart buffer size: the minimum buffer size that
        // covers the maximum image size aligned to multiple of 5MiB.
        maxImageSize := c.GetInt64(dconfig.SettingStorageMaxImageSize)
        bufferSize := (((maxImageSize - 1) /
                (s3.MultipartMaxParts * s3.MultipartMinSize)) + 1) *
                s3.MultipartMinSize
        var (
                s3Options = s3.NewOptions().
                                SetContentType(app.ArtifactContentType).
                                SetBufferSize(int(bufferSize))
                azOptions = azblob.NewOptions().
                                SetContentType(app.ArtifactContentType)
        )
        var defaultStorage storage.ObjectStorage
        switch defType := c.GetString(dconfig.SettingDefaultStorage); defType {
        case dconfig.StorageTypeAWS:
                defaultStorage, err = SetupS3(ctx, s3Options)
        case dconfig.StorageTypeAzure:
                defaultStorage, err = SetupBlobStorage(ctx, azOptions)
        default:
                err = errors.Errorf(
                        `storage type must be one of %q or %q, received value %q`,
                        dconfig.StorageTypeAWS, dconfig.StorageTypeAzure, defType,
                )
        }
        if err != nil {
                return nil, err
        }
        return manager.New(ctx, defaultStorage, s3Options, azOptions)
}

func RunServer(ctx context.Context) error {
        c := config.Config
        dbClient, err := mstore.NewMongoClient(ctx, c)
        if err != nil {
                return err
        }
        defer func() {
                _ = dbClient.Disconnect(context.Background())
        }()

        ds := mstore.NewDataStoreMongoWithClient(dbClient)

        // Storage Layer
        objStore, err := SetupObjectStorage(ctx)
        if err != nil {
                return errors.WithMessage(err, "main: failed to setup storage client")
        }

        app := app.NewDeployments(ds, objStore, 0, false)
        if addr := c.GetString(dconfig.SettingReportingAddr); addr != "" {
                c := reporting.NewClient(addr)
                app = app.WithReporting(c)
        }

        // Setup API Router configuration
        base64Repl := strings.NewReplacer("-", "+", "_", "/", "=", "")
        expireSec := c.GetDuration(dconfig.SettingPresignExpireSeconds)
        apiConf := api.NewConfig().
                SetPresignExpire(time.Second * expireSec).
                SetPresignHostname(c.GetString(dconfig.SettingPresignHost)).
                SetPresignScheme(c.GetString(dconfig.SettingPresignScheme)).
                SetMaxImageSize(c.GetInt64(dconfig.SettingStorageMaxImageSize)).
                SetEnableDirectUpload(c.GetBool(dconfig.SettingStorageEnableDirectUpload)).
                SetEnableDirectUploadSkipVerify(c.GetBool(dconfig.SettingStorageDirectUploadSkipVerify))
        if key, err := base64.RawStdEncoding.DecodeString(
                base64Repl.Replace(
                        c.GetString(dconfig.SettingPresignSecret),
                ),
        ); err == nil {
                apiConf.SetPresignSecret(key)
        }
        router, err := api.NewRouter(ctx, app, ds, apiConf)
        if err != nil {
                return err
        }

        api := rest.NewApi()
        SetupMiddleware(c, api)
        api.SetApp(router)

        listen := c.GetString(dconfig.SettingListen)

        if c.IsSet(dconfig.SettingHttps) {

                cert := c.GetString(dconfig.SettingHttpsCertificate)
                key := c.GetString(dconfig.SettingHttpsKey)

                return http.ListenAndServeTLS(listen, cert, key, api.MakeHandler())
        }

        return http.ListenAndServe(listen, api.MakeHandler())
}

1	// Copyright 2023 Northern.tech AS
2	//
3	// Licensed under the Apache License, Version 2.0 (the "License");
4	// you may not use this file except in compliance with the License.
5	// You may obtain a copy of the License at
6	//
7	// http://www.apache.org/licenses/LICENSE-2.0
8	//
9	// Unless required by applicable law or agreed to in writing, software
10	// distributed under the License is distributed on an "AS IS" BASIS,
11	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	// See the License for the specific language governing permissions and
13	// limitations under the License.
14
15	package main
16
17	import (
18	"context"
19	"encoding/base64"
20	"net/http"
21	"net/url"
22	"strings"
23	"time"
24
25	"github.com/ant0ine/go-json-rest/rest"
26	"github.com/pkg/errors"
27
28	"github.com/mendersoftware/go-lib-micro/config"
29	"github.com/mendersoftware/go-lib-micro/log"
30
31	api "github.com/mendersoftware/deployments/api/http"
32	"github.com/mendersoftware/deployments/app"
33	"github.com/mendersoftware/deployments/client/reporting"
34	dconfig "github.com/mendersoftware/deployments/config"
35	"github.com/mendersoftware/deployments/storage"
36	"github.com/mendersoftware/deployments/storage/azblob"
37	"github.com/mendersoftware/deployments/storage/manager"
38	"github.com/mendersoftware/deployments/storage/s3"
39	mstore "github.com/mendersoftware/deployments/store/mongo"
40	)
41
42	func SetupS3(ctx context.Context, defaultOptions *s3.Options) (storage.ObjectStorage, error) {	1✔
43	c := config.Config	1✔
44		1✔
45	bucket := c.GetString(dconfig.SettingStorageBucket)	1✔
46		1✔
47	// Copy / merge defaultOptions	1✔
48	options := s3.NewOptions(defaultOptions).	1✔
49	SetBucketName(bucket).	1✔
50	SetForcePathStyle(c.GetBool(dconfig.SettingAwsS3ForcePathStyle)).	1✔
51	SetUseAccelerate(c.GetBool(dconfig.SettingAwsS3UseAccelerate))	1✔
52		1✔
53	// The following parameters falls back on AWS_* environment if not set	1✔
54	if c.IsSet(dconfig.SettingAwsS3Region) {	2✔
55	options.SetRegion(c.GetString(dconfig.SettingAwsS3Region))	1✔
56	}	1✔
57	if c.IsSet(dconfig.SettingsAwsAuth) \|\|	1✔
58	(c.IsSet(dconfig.SettingAwsAuthKeyId) &&	1✔
59	c.IsSet(dconfig.SettingAwsAuthSecret)) {	2✔
60	options.SetStaticCredentials(	1✔
61	c.GetString(dconfig.SettingAwsAuthKeyId),	1✔
62	c.GetString(dconfig.SettingAwsAuthSecret),	1✔
63	c.GetString(dconfig.SettingAwsAuthToken),	1✔
64	)	1✔
65	}	1✔
66	if c.IsSet(dconfig.SettingAwsURI) {	2✔
67	options.SetURI(c.GetString(dconfig.SettingAwsURI))	1✔
68	}	1✔
69	if c.IsSet(dconfig.SettingAwsExternalURI) {	2✔
70	options.SetExternalURI(c.GetString(dconfig.SettingAwsExternalURI))	1✔
71	}	1✔
72	if c.IsSet(dconfig.SettingStorageProxyURI) {	1✔
73	rawURL := c.GetString(dconfig.SettingStorageProxyURI)	×
74	proxyURL, err := url.Parse(rawURL)	×
75	if err != nil {	×
76	return nil, errors.WithMessage(err, "invalid setting `storage.proxy_uri`")	×
77	}	×
78	options.SetProxyURI(proxyURL)	×
79	}
80	if c.IsSet(dconfig.SettingAwsUnsignedHeaders) {	2✔
81	options.SetUnsignedHeaders(c.GetStringSlice(dconfig.SettingAwsUnsignedHeaders))	1✔
82	}	1✔
83
84	storage, err := s3.New(ctx, options)	1✔
85	return storage, err	1✔
86	}
87
88	func SetupBlobStorage(
89	ctx context.Context,
90	defaultOptions *azblob.Options,
91	) (storage.ObjectStorage, error) {	×
92	c := config.Config	×
93		×
94	// Copy / merge options	×
95	options := azblob.NewOptions(defaultOptions)	×
96		×
97	if c.IsSet(dconfig.SettingAzureConnectionString) {	×
98	options.SetConnectionString(c.GetString(dconfig.SettingAzureConnectionString))	×
99	} else if c.IsSet(dconfig.SettingAzureSharedKeyAccount) &&	×
100	c.IsSet(dconfig.SettingAzureSharedKeyAccountKey) {	×
101	creds := azblob.SharedKeyCredentials{	×
102	AccountName: c.GetString(dconfig.SettingAzureSharedKeyAccount),	×
103	AccountKey: c.GetString(dconfig.SettingAzureSharedKeyAccountKey),	×
104	}	×
105	if c.IsSet(dconfig.SettingAzureSharedKeyURI) {	×
106	uri := c.GetString(dconfig.SettingAzureSharedKeyURI)	×
107	creds.URI = &uri	×
108	}	×
109	options.SetSharedKey(creds)	×
110	}
111	if c.IsSet(dconfig.SettingStorageProxyURI) {	×
112	rawURL := c.GetString(dconfig.SettingStorageProxyURI)	×
113	proxyURL, err := url.Parse(rawURL)	×
114	if err != nil {	×
115	return nil, errors.WithMessage(err, `invalid setting "storage.proxy_uri"`)	×
116	}	×
117	if !strings.HasPrefix(strings.ToLower(proxyURL.Scheme), "https") {	×
118	log.FromContext(ctx).	×
119	Warnf(`setting "storage.proxy_uri" (%s) is not using https`, rawURL)	×
120	}	×
121	options.SetProxyURI(proxyURL)	×
122	}
123	return azblob.New(ctx, c.GetString(dconfig.SettingStorageBucket), options)	×
124	}
125
126	func SetupObjectStorage(ctx context.Context) (objManager storage.ObjectStorage, err error) {	1✔
127	c := config.Config	1✔
128		1✔
129	// Calculate s3 multipart buffer size: the minimum buffer size that	1✔
130	// covers the maximum image size aligned to multiple of 5MiB.	1✔
131	maxImageSize := c.GetInt64(dconfig.SettingStorageMaxImageSize)	1✔
132	bufferSize := (((maxImageSize - 1) /	1✔
133	(s3.MultipartMaxParts * s3.MultipartMinSize)) + 1) *	1✔
134	s3.MultipartMinSize	1✔
135	var (	1✔
136	s3Options = s3.NewOptions().	1✔
137	SetContentType(app.ArtifactContentType).	1✔
138	SetBufferSize(int(bufferSize))	1✔
139	azOptions = azblob.NewOptions().	1✔
140	SetContentType(app.ArtifactContentType)	1✔
141	)	1✔
142	var defaultStorage storage.ObjectStorage	1✔
143	switch defType := c.GetString(dconfig.SettingDefaultStorage); defType {	1✔
144	case dconfig.StorageTypeAWS:	1✔
145	defaultStorage, err = SetupS3(ctx, s3Options)	1✔
146	case dconfig.StorageTypeAzure:	×
147	defaultStorage, err = SetupBlobStorage(ctx, azOptions)	×
148	default:	×
149	err = errors.Errorf(	×
150	`storage type must be one of %q or %q, received value %q`,	×
151	dconfig.StorageTypeAWS, dconfig.StorageTypeAzure, defType,	×
152	)	×
153	}
154	if err != nil {	1✔
155	return nil, err	×
156	}	×
157	return manager.New(ctx, defaultStorage, s3Options, azOptions)	1✔
158	}
159
160	func RunServer(ctx context.Context) error {	1✔
161	c := config.Config	1✔
162	dbClient, err := mstore.NewMongoClient(ctx, c)	1✔
163	if err != nil {	1✔
164	return err	×
165	}	×
166	defer func() {	1✔
167	_ = dbClient.Disconnect(context.Background())	×
168	}()	×
169
170	ds := mstore.NewDataStoreMongoWithClient(dbClient)	1✔
171		1✔
172	// Storage Layer	1✔
173	objStore, err := SetupObjectStorage(ctx)	1✔
174	if err != nil {	1✔
175	return errors.WithMessage(err, "main: failed to setup storage client")	×
176	}	×
177
178	app := app.NewDeployments(ds, objStore, 0, false)	1✔
179	if addr := c.GetString(dconfig.SettingReportingAddr); addr != "" {	2✔
180	c := reporting.NewClient(addr)	1✔
181	app = app.WithReporting(c)	1✔
182	}	1✔
183
184	// Setup API Router configuration
185	base64Repl := strings.NewReplacer("-", "+", "_", "/", "=", "")	1✔
186	expireSec := c.GetDuration(dconfig.SettingPresignExpireSeconds)	1✔
187	apiConf := api.NewConfig().	1✔
188	SetPresignExpire(time.Second * expireSec).	1✔
189	SetPresignHostname(c.GetString(dconfig.SettingPresignHost)).	1✔
190	SetPresignScheme(c.GetString(dconfig.SettingPresignScheme)).	1✔
191	SetMaxImageSize(c.GetInt64(dconfig.SettingStorageMaxImageSize)).	1✔
192	SetEnableDirectUpload(c.GetBool(dconfig.SettingStorageEnableDirectUpload)).	1✔
193	SetEnableDirectUploadSkipVerify(c.GetBool(dconfig.SettingStorageDirectUploadSkipVerify))	1✔
194	if key, err := base64.RawStdEncoding.DecodeString(	1✔
195	base64Repl.Replace(	1✔
196	c.GetString(dconfig.SettingPresignSecret),	1✔
197	),	1✔
198	); err == nil {	2✔
199	apiConf.SetPresignSecret(key)	1✔
200	}	1✔
201	router, err := api.NewRouter(ctx, app, ds, apiConf)	1✔
202	if err != nil {	1✔
UNCOV 203	return err	×
204	}	×
205
206	api := rest.NewApi()	1✔
207	SetupMiddleware(c, api)	1✔
208	api.SetApp(router)	1✔
209		1✔
210	listen := c.GetString(dconfig.SettingListen)	1✔
211		1✔
212	if c.IsSet(dconfig.SettingHttps) {	1✔
UNCOV 213		×
214	cert := c.GetString(dconfig.SettingHttpsCertificate)	×
215	key := c.GetString(dconfig.SettingHttpsKey)	×
216		×
217	return http.ListenAndServeTLS(listen, cert, key, api.MakeHandler())	×
218	}	×
219
220	return http.ListenAndServe(listen, api.MakeHandler())	1✔
221	}

mendersoftware / deployments / 1036074718

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous