1616550521

Committed 08 Jan 2025 03:57PM UTC coverage: 76.618%. First build

Build # 1616550521

Build Type

push

gitlab-ci

Committed by

web-flow

Commit Message

Merge pull request #274 from bahaa-ghazal/QA-782

fix: implement signal handler for `server` commands

Run Details

4279 of 6204 branches covered (68.97%)

Branch coverage included in aggregate %.

73 of 109 new or added lines in 8 files covered. (66.97%)

45311 of 58520 relevant lines covered (77.43%)

21.83 hits per line

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

75.76

/backend/services/deviceconnect/server/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 server

import (
        "context"
        "net/http"
        "os"
        "os/signal"
        "time"

        "golang.org/x/sys/unix"

        "github.com/mendersoftware/mender-server/pkg/config"
        "github.com/mendersoftware/mender-server/pkg/log"

        api "github.com/mendersoftware/mender-server/services/deviceconnect/api/http"
        "github.com/mendersoftware/mender-server/services/deviceconnect/app"
        "github.com/mendersoftware/mender-server/services/deviceconnect/client/nats"
        "github.com/mendersoftware/mender-server/services/deviceconnect/client/workflows"
        dconfig "github.com/mendersoftware/mender-server/services/deviceconnect/config"
        "github.com/mendersoftware/mender-server/services/deviceconnect/store"
)

// InitAndRun initializes the server and runs it
func InitAndRun(conf config.Reader, dataStore store.DataStore) error {
        ctx := context.Background()

        log.Setup(conf.GetBool(dconfig.SettingDebugLog))
        l := log.FromContext(ctx)

        allowedOrigin := conf.GetStringSlice(dconfig.SettingWSAllowedOrigins)
        if allowedOrigin != nil {
                api.SetAcceptedOrigins(allowedOrigin)
        }

        natsClient, err := nats.NewClientWithDefaults(
                config.Config.GetString(dconfig.SettingNatsURI),
        )
        if err != nil {
                return err
        }
        wflows := workflows.NewClient(
                config.Config.GetString(dconfig.SettingWorkflowsURL),
        )
        deviceConnectApp := app.New(
                dataStore, wflows, app.Config{
                        HaveAuditLogs: conf.GetBool(dconfig.SettingEnableAuditLogs),
                },
        )

        gracefulShutdownTimeout := conf.GetDuration(dconfig.SettingGracefulShutdownTimeout)
        router, err := api.NewRouter(deviceConnectApp, natsClient, &api.RouterConfig{
                GracefulShutdownTimeout: gracefulShutdownTimeout,
        })
        if err != nil {
                l.Fatal(err)
        }

        var listen = conf.GetString(dconfig.SettingListen)
        srv := &http.Server{
                Addr:    listen,
                Handler: router,
        }

        go func() {
                if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
                        l.Fatalf("listen: %s\n", err)
                }
        }()

        quit := make(chan os.Signal, 1)
        signal.Notify(quit, unix.SIGINT, unix.SIGTERM, unix.SIGUSR1)
        recvSignal := <-quit

        l.Info("server shutdown")

        if recvSignal == unix.SIGUSR1 {
                l.Info("received SIGUSR1, graceful shutdown")
                srv.RegisterOnShutdown(func() {
                        deviceConnectApp.Shutdown(gracefulShutdownTimeout)
                })
        }

        ctxWithTimeout, cancel := context.WithTimeout(ctx, 5*time.Second)
        defer cancel()
        if err := srv.Shutdown(ctxWithTimeout); err != nil {
                l.Errorf("error when shutting down the server: %s", err.Error())
                return err
        }
        l.Info("server exited")

        if recvSignal == unix.SIGUSR1 {
                deviceConnectApp.ShutdownDone()
                l.Info("graceful shutdown completed")
        }

        return nil
}

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 server
16
17	import (
18	"context"
19	"net/http"
20	"os"
21	"os/signal"
22	"time"
23
24	"golang.org/x/sys/unix"
25
26	"github.com/mendersoftware/mender-server/pkg/config"
27	"github.com/mendersoftware/mender-server/pkg/log"
28
29	api "github.com/mendersoftware/mender-server/services/deviceconnect/api/http"
30	"github.com/mendersoftware/mender-server/services/deviceconnect/app"
31	"github.com/mendersoftware/mender-server/services/deviceconnect/client/nats"
32	"github.com/mendersoftware/mender-server/services/deviceconnect/client/workflows"
33	dconfig "github.com/mendersoftware/mender-server/services/deviceconnect/config"
34	"github.com/mendersoftware/mender-server/services/deviceconnect/store"
35	)
36
37	// InitAndRun initializes the server and runs it
38	func InitAndRun(conf config.Reader, dataStore store.DataStore) error {	2✔
39	ctx := context.Background()	2✔
40		2✔
41	log.Setup(conf.GetBool(dconfig.SettingDebugLog))	2✔
42	l := log.FromContext(ctx)	2✔
43		2✔
44	allowedOrigin := conf.GetStringSlice(dconfig.SettingWSAllowedOrigins)	2✔
45	if allowedOrigin != nil {	4✔
46	api.SetAcceptedOrigins(allowedOrigin)	2✔
47	}	2✔
48
49	natsClient, err := nats.NewClientWithDefaults(	2✔
50	config.Config.GetString(dconfig.SettingNatsURI),	2✔
51	)	2✔
52	if err != nil {	2✔
53	return err	×
54	}	×
55	wflows := workflows.NewClient(	2✔
56	config.Config.GetString(dconfig.SettingWorkflowsURL),	2✔
57	)	2✔
58	deviceConnectApp := app.New(	2✔
59	dataStore, wflows, app.Config{	2✔
60	HaveAuditLogs: conf.GetBool(dconfig.SettingEnableAuditLogs),	2✔
61	},	2✔
62	)	2✔
63		2✔
64	gracefulShutdownTimeout := conf.GetDuration(dconfig.SettingGracefulShutdownTimeout)	2✔
65	router, err := api.NewRouter(deviceConnectApp, natsClient, &api.RouterConfig{	2✔
66	GracefulShutdownTimeout: gracefulShutdownTimeout,	2✔
67	})	2✔
68	if err != nil {	2✔
69	l.Fatal(err)	×
70	}	×
71
72	var listen = conf.GetString(dconfig.SettingListen)	2✔
73	srv := &http.Server{	2✔
74	Addr: listen,	2✔
75	Handler: router,	2✔
76	}	2✔
77		2✔
78	go func() {	4✔
79	if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {	2✔
80	l.Fatalf("listen: %s\n", err)	×
81	}	×
82	}()
83
84	quit := make(chan os.Signal, 1)	2✔
85	signal.Notify(quit, unix.SIGINT, unix.SIGTERM, unix.SIGUSR1)	2✔
86	recvSignal := <-quit	2✔
87		2✔
88	l.Info("server shutdown")	2✔
89		2✔
90	if recvSignal == unix.SIGUSR1 {	2✔
91	l.Info("received SIGUSR1, graceful shutdown")	×
92	srv.RegisterOnShutdown(func() {	×
93	deviceConnectApp.Shutdown(gracefulShutdownTimeout)	×
94	})	×
95	}
96
97	ctxWithTimeout, cancel := context.WithTimeout(ctx, 5*time.Second)	2✔
98	defer cancel()	2✔
99	if err := srv.Shutdown(ctxWithTimeout); err != nil {	2✔
NEW 100	l.Errorf("error when shutting down the server: %s", err.Error())	×
NEW 101	return err	×
102	}	×
103	l.Info("server exited")	2✔
104		2✔
105	if recvSignal == unix.SIGUSR1 {	2✔
106	deviceConnectApp.ShutdownDone()	×
107	l.Info("graceful shutdown completed")	×
108	}	×
109
110	return nil	2✔
111	}

mendersoftware / mender-server / 1616550521

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