Integrate EL monitoring stack

.github/workflows/e2e_tests.yml

@@ -29,6 +29,11 @@ jobs:
 
       - name: Install deps
         run: make install-deps
-
-      - name: Run e2e tests
+
+      - name: Run e2e tests Windows
+        if: runner.os == 'Windows'
+        run: make e2e-test-windows
+
+      - name: Run e2e tests other
+        if: runner.os != 'Windows'
         run: make e2e-test

.github/workflows/unit_tests.yml

@@ -36,7 +36,7 @@ jobs:
 
       - name: Run tests other
         if: matrix.os != 'ubuntu-latest'
-        run: make generate && go test ./...
+        run: make generate && make test-no-e2e
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - New command `lido-status` to display data of Lido Node Operator.
+- Monitoring setup for Lido CSM Node.
 
 ### Fixed
 -  Teku and Lighthouse import keys container error on Windows.

Makefile

@@ -37,9 +37,16 @@ test: generate ## run tests
 e2e-test: generate ## Run e2e tests
 	@go test -timeout 20m -count=1 ./e2e/...
 
+e2e-test-windows: generate ## Run e2e tests on Windows
+	@go test -timeout 20m -count=1 -skip TestE2E_MonitoringStack ./e2e/...
+
+test-no-e2e: generate ## run tests excluding e2e
+	@mkdir -p coverage
+	@go test -coverprofile=coverage/coverage.out -covermode=count ./... -skip TestE2E
+
 codecov-test: generate ## unit tests with coverage using the courtney tool
 	@mkdir -p coverage
-	@courtney/courtney -v -o coverage/coverage.out ./...
+	@courtney/courtney -v -o coverage/coverage.out -t="-skip=TestE2E" ./...
 	@go tool cover -html=coverage/coverage.out -o coverage/coverage.html
 
 install-gofumpt: ## install gofumpt

cli/actions/actions.go

@@ -18,7 +18,6 @@ package actions
 import (
 	"github.com/NethermindEth/sedge/internal/pkg/commands"
 	"github.com/NethermindEth/sedge/internal/pkg/generate"
-	"github.com/NethermindEth/sedge/internal/pkg/services"
 	"github.com/docker/docker/client"
 )
 
@@ -37,22 +36,22 @@ type SedgeActions interface {
 }
 
 type sedgeActions struct {
-	dockerClient   client.APIClient
-	serviceManager services.ServiceManager
-	commandRunner  commands.CommandRunner
+	dockerClient         client.APIClient
+	dockerServiceManager DockerServiceManager
+	commandRunner        commands.CommandRunner
 }
 
 type SedgeActionsOptions struct {
-	DockerClient   client.APIClient
-	ServiceManager services.ServiceManager
-	CommandRunner  commands.CommandRunner
+	DockerClient         client.APIClient
+	DockerServiceManager DockerServiceManager
+	CommandRunner        commands.CommandRunner
 }
 
 func NewSedgeActions(options SedgeActionsOptions) SedgeActions {
 	return &sedgeActions{
-		dockerClient:   options.DockerClient,
-		serviceManager: options.ServiceManager,
-		commandRunner:  options.CommandRunner,
+		dockerClient:         options.DockerClient,
+		dockerServiceManager: options.DockerServiceManager,
+		commandRunner:        options.CommandRunner,
 	}
 }
 

cli/actions/docker.go

@@ -0,0 +1,14 @@
+package actions
+
+import "github.com/docker/docker/api/types/container"
+
+// DockerServiceManager is an interface for managing Docker containers.
+type DockerServiceManager interface {
+	Image(service string) (string, error)
+	Stop(service string) error
+	Start(service string) error
+	IsRunning(service string) (bool, error)
+	Wait(service string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error)
+	ContainerID(service string) (string, error)
+	ContainerLogs(ctID, service string) (string, error)
+}

cli/actions/generation_test.go

@@ -47,10 +47,10 @@ import (
 func newAction(t *testing.T, ctrl *gomock.Controller) actions.SedgeActions {
 	t.Helper()
 	dockerClient := sedge_mocks.NewMockAPIClient(ctrl)
-	serviceManager := services.NewServiceManager(dockerClient)
+	dockerServiceManager := services.NewDockerServiceManager(dockerClient)
 	return actions.NewSedgeActions(actions.SedgeActionsOptions{
-		DockerClient:   dockerClient,
-		ServiceManager: serviceManager,
+		DockerClient:         dockerClient,
+		DockerServiceManager: dockerServiceManager,
 	})
 }
 

cli/actions/getContainers_test.go

@@ -168,9 +168,9 @@ func getMockActions(
 
 	return actions.NewSedgeActions(
 		actions.SedgeActionsOptions{
-			DockerClient:   dockerClient,
-			ServiceManager: nil,
-			CommandRunner:  nil,
+			DockerClient:         dockerClient,
+			DockerServiceManager: nil,
+			CommandRunner:        nil,
 		},
 	)
 }

cli/actions/importKeys.go

@@ -28,7 +28,6 @@ import (
 	"github.com/NethermindEth/sedge/internal/images/validator-import/teku"
 	"github.com/NethermindEth/sedge/internal/pkg/commands"
 	"github.com/NethermindEth/sedge/internal/pkg/services"
-	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/mount"
 	"github.com/docker/docker/api/types/network"
@@ -70,18 +69,18 @@ func (s *sedgeActions) ImportValidatorKeys(options ImportValidatorKeysOptions) e
 	}
 	validatorCtName := services.ContainerNameWithTag(services.DefaultSedgeValidatorClient, options.ContainerTag)
 	// Check validator container exists
-	_, err := s.serviceManager.ContainerId(validatorCtName)
+	_, err := s.dockerServiceManager.ContainerID(validatorCtName)
 	if err != nil {
 		return err
 	}
-	previouslyRunning, err := s.serviceManager.IsRunning(validatorCtName)
+	previouslyRunning, err := s.dockerServiceManager.IsRunning(validatorCtName)
 	if err != nil {
 		return err
 	}
 	// Stop validator
 	if previouslyRunning {
 		log.Info("Stopping validator client")
-		if err := s.serviceManager.Stop(validatorCtName); err != nil {
+		if err := s.dockerServiceManager.Stop(validatorCtName); err != nil {
 			return err
 		}
 	}
@@ -106,13 +105,13 @@ func (s *sedgeActions) ImportValidatorKeys(options ImportValidatorKeysOptions) e
 	var ctID string
 	switch options.ValidatorClient {
 	case "prysm":
-		prysmCtID, err := setupPrysmValidatorImportContainer(s.dockerClient, s.serviceManager, options)
+		prysmCtID, err := setupPrysmValidatorImportContainer(s.dockerClient, s.dockerServiceManager, options)
 		if err != nil {
 			return err
 		}
 		ctID = prysmCtID
 	case "lodestar":
-		lodestarCtID, err := setupLodestarValidatorImport(s.dockerClient, s.serviceManager, options)
+		lodestarCtID, err := setupLodestarValidatorImport(s.dockerClient, s.dockerServiceManager, options)
 		if err != nil {
 			return err
 		}
@@ -133,11 +132,11 @@ func (s *sedgeActions) ImportValidatorKeys(options ImportValidatorKeysOptions) e
 		return fmt.Errorf("%w: %s", ErrUnsupportedValidatorClient, options.ValidatorClient)
 	}
 	log.Info("Importing validator keys")
-	runErr := runAndWaitImportKeys(s.dockerClient, s.serviceManager, ctID)
+	runErr := runAndWaitImportKeys(s.dockerClient, s.dockerServiceManager, ctID)
 	// Run validator again
 	if (previouslyRunning && !options.StopValidator) || options.StartValidator {
 		log.Info("The validator container is being restarted")
-		if err := s.serviceManager.Start(validatorCtName); err != nil {
+		if err := s.dockerServiceManager.Start(validatorCtName); err != nil {
 			return err
 		}
 	}
@@ -151,12 +150,12 @@ func isDefaultKeysPath(generationPath, from string) bool {
 	return from == filepath.Join(generationPath, "keystore")
 }
 
-func setupPrysmValidatorImportContainer(dockerClient client.APIClient, serviceManager services.ServiceManager, options ImportValidatorKeysOptions) (string, error) {
+func setupPrysmValidatorImportContainer(dockerClient client.APIClient, dockerServiceManager DockerServiceManager, options ImportValidatorKeysOptions) (string, error) {
 	var (
 		validatorCtName       = services.ContainerNameWithTag(services.DefaultSedgeValidatorClient, options.ContainerTag)
 		validatorImportCtName = services.ContainerNameWithTag(services.ServiceCtValidatorImport, options.ContainerTag)
 	)
-	validatorImage, err := serviceManager.Image(validatorCtName)
+	validatorImage, err := dockerServiceManager.Image(validatorCtName)
 	if err != nil {
 		return "", err
 	}
@@ -209,12 +208,12 @@ func setupPrysmValidatorImportContainer(dockerClient client.APIClient, serviceMa
 	return ct.ID, nil
 }
 
-func setupLodestarValidatorImport(dockerClient client.APIClient, serviceManager services.ServiceManager, options ImportValidatorKeysOptions) (string, error) {
+func setupLodestarValidatorImport(dockerClient client.APIClient, dockerServiceManager DockerServiceManager, options ImportValidatorKeysOptions) (string, error) {
 	var (
 		validatorCtName       = services.ContainerNameWithTag(services.DefaultSedgeValidatorClient, options.ContainerTag)
 		validatorImportCtName = services.ContainerNameWithTag(services.ServiceCtValidatorImport, options.ContainerTag)
 	)
-	validatorImage, err := serviceManager.Image(validatorCtName)
+	validatorImage, err := dockerServiceManager.Image(validatorCtName)
 	if err != nil {
 		return "", err
 	}
@@ -402,19 +401,19 @@ func setupTekuValidatorImport(dockerClient client.APIClient, commandRunner comma
 	return ct.ID, nil
 }
 
-func runAndWaitImportKeys(dockerClient client.APIClient, serviceManager services.ServiceManager, ctID string) error {
+func runAndWaitImportKeys(dockerClient client.APIClient, dockerServiceManager DockerServiceManager, ctID string) error {
 	log.Debugf("import keys container id: %s", ctID)
-	ctExit, errChan := serviceManager.Wait(ctID, container.WaitConditionNextExit)
+	ctExit, errChan := dockerServiceManager.Wait(ctID, container.WaitConditionNextExit)
 	log.Info("The keys import container is starting")
-	if err := dockerClient.ContainerStart(context.Background(), ctID, types.ContainerStartOptions{}); err != nil {
+	if err := dockerClient.ContainerStart(context.Background(), ctID, container.StartOptions{}); err != nil {
 		return err
 	}
 	osSignals := make(chan os.Signal, 1)
 	signal.Notify(osSignals, os.Interrupt)
 	for {
 		select {
 		case exitResult := <-ctExit:
-			logs, err := serviceManager.ContainerLogs(ctID, "Import keys")
+			logs, err := dockerServiceManager.ContainerLogs(ctID, "Import keys")
 			if err != nil {
 				return err
 			}

cli/actions/importKeys_test.go

@@ -79,12 +79,12 @@ func TestImportKeys_ValidatorRunning(t *testing.T) {
 				defer ctrl.Finish()
 
 				dockerClient := importKeysGoldenPath(t, ctrl, false)
-				serviceManager := services.NewServiceManager(dockerClient)
+				dockerServiceManager := services.NewDockerServiceManager(dockerClient)
 				cmdRunner := test.SimpleCMDRunner{}
 				s := actions.NewSedgeActions(actions.SedgeActionsOptions{
-					DockerClient:   dockerClient,
-					ServiceManager: serviceManager,
-					CommandRunner:  &cmdRunner,
+					DockerClient:         dockerClient,
+					DockerServiceManager: dockerServiceManager,
+					CommandRunner:        &cmdRunner,
 				})
 
 				from, err := setupKeystoreDir(t)
@@ -114,12 +114,12 @@ func TestImportKeysCustom_ValidatorRunning(t *testing.T) {
 			defer ctrl.Finish()
 
 			dockerClient := importKeysGoldenPath(t, ctrl, true)
-			serviceManager := services.NewServiceManager(dockerClient)
+			dockerServiceManager := services.NewDockerServiceManager(dockerClient)
 			cmdRunner := test.SimpleCMDRunner{}
 			s := actions.NewSedgeActions(actions.SedgeActionsOptions{
-				DockerClient:   dockerClient,
-				ServiceManager: serviceManager,
-				CommandRunner:  &cmdRunner,
+				DockerClient:         dockerClient,
+				DockerServiceManager: dockerServiceManager,
+				CommandRunner:        &cmdRunner,
 			})
 
 			from, err := setupKeystoreDir(t)
@@ -198,12 +198,12 @@ func TestImportKeys_CustomOptions(t *testing.T) {
 			defer ctrl.Finish()
 
 			dockerClient := importKeysGoldenPath(t, ctrl, tt.customImage)
-			serviceManager := services.NewServiceManager(dockerClient)
+			dockerServiceManager := services.NewDockerServiceManager(dockerClient)
 			cmdRunner := test.SimpleCMDRunner{}
 			s := actions.NewSedgeActions(actions.SedgeActionsOptions{
-				DockerClient:   dockerClient,
-				ServiceManager: serviceManager,
-				CommandRunner:  &cmdRunner,
+				DockerClient:         dockerClient,
+				DockerServiceManager: dockerServiceManager,
+				CommandRunner:        &cmdRunner,
 			})
 
 			from, err := setupKeystoreDir(t)
@@ -256,12 +256,12 @@ func TestImportKeys_UnexpectedExitCode(t *testing.T) {
 	defer ctrl.Finish()
 
 	dockerClient := importKeysExitError(t, ctrl)
-	serviceManager := services.NewServiceManager(dockerClient)
+	dockerServiceManager := services.NewDockerServiceManager(dockerClient)
 	cmdRunner := test.SimpleCMDRunner{}
 	s := actions.NewSedgeActions(actions.SedgeActionsOptions{
-		DockerClient:   dockerClient,
-		ServiceManager: serviceManager,
-		CommandRunner:  &cmdRunner,
+		DockerClient:         dockerClient,
+		DockerServiceManager: dockerServiceManager,
+		CommandRunner:        &cmdRunner,
 	})
 
 	from, err := setupKeystoreDir(t)
@@ -327,7 +327,7 @@ func importKeysGoldenPath(t *testing.T, ctrl *gomock.Controller, withCustomImage
 
 	// Mock ContainerList
 	dockerClient.EXPECT().
-		ContainerList(gomock.Any(), types.ContainerListOptions{
+		ContainerList(gomock.Any(), container.ListOptions{
 			All:     true,
 			Filters: filters.NewArgs(filters.Arg("name", services.DefaultSedgeValidatorClient)),
 		}).
@@ -387,7 +387,7 @@ func importKeysGoldenPath(t *testing.T, ctrl *gomock.Controller, withCustomImage
 		Times(1)
 	// Mock ContainerRemove
 	dockerClient.EXPECT().
-		ContainerRemove(gomock.Any(), validatorImportCtId, types.ContainerRemoveOptions{}).
+		ContainerRemove(gomock.Any(), validatorImportCtId, container.RemoveOptions{}).
 		Return(nil).
 		Times(1)
 
@@ -403,7 +403,7 @@ func importKeysExitError(t *testing.T, ctrl *gomock.Controller) client.APIClient
 
 	// Mock ContainerList
 	dockerClient.EXPECT().
-		ContainerList(gomock.Any(), types.ContainerListOptions{
+		ContainerList(gomock.Any(), container.ListOptions{
 			All:     true,
 			Filters: filters.NewArgs(filters.Arg("name", services.DefaultSedgeValidatorClient)),
 		}).
@@ -459,7 +459,7 @@ func importKeysExitError(t *testing.T, ctrl *gomock.Controller) client.APIClient
 		Times(1)
 	// Mock ContainerRemove
 	dockerClient.EXPECT().
-		ContainerRemove(gomock.Any(), validatorImportCtId, types.ContainerRemoveOptions{}).
+		ContainerRemove(gomock.Any(), validatorImportCtId, container.RemoveOptions{}).
 		Return(nil).
 		Times(1)