chore: restructuring and simplification (#158)

* Updated ignores

* Added mocks

* Added/updated actions

* Changed proto path

* Updated utils

* Updated data transfer

* Updatted logging

* Added encryption

Added encryptor

* Updated docs a bit

* Improved docker build - now using ldflags

* Removed

* Rework WIP

* fix: use ocpp manager v1.3, fix compile time issues, resolve mock generation

* fix: compilation issues

* fix: remove logrus entirely

* chore: naming convention enforcement + log fix

* chore: fmt

* chore: remove duplicate workflows

* fix: build issue

* chore: minor code style improvements

Author: xBlaz3kx

.dockerignore

@@ -8,7 +8,12 @@
 
 *.md
 .idea
+.run
 .github/
 build/
 docs/
 deployments/
+
+ui/node_modules
+ui/build
+ui/.next

.github/workflows/buf.yaml

@@ -1,4 +1,4 @@
-name: buf.yaml
+name: "Buf"
 on:
   pull_request:
     branches:

.github/workflows/test.yaml

@@ -1,4 +1,4 @@
-name: "Test and lint"
+name: "Test"
 
 on:
   push:

.gitignore

@@ -13,4 +13,5 @@ configs
 rpi_ws281x
 ui/.next
 ui/build
+*.env
 libnfc-*

.golangci.yaml

@@ -23,13 +23,16 @@ linters:
   exclusions:
     generated: lax
     paths:
-      - ./gen
-      - ./pkg/reader
+      - ./gen/*
+      - ./pkg/hardware/reader
 formatters:
   settings:
     goimports:
       local-prefixes:
         - github.com/ChargePi/ChargePi-go
   enable:
     - gofmt
-    - goimports
+    - goimports
+  exclusions:
+    paths:
+      - gen/*

build/Dockerfile

@@ -90,7 +90,7 @@ COPY --from=base /ChargePi/src/ChargePi /usr/bin/ChargePi
 COPY --from=build-ui /ui/build/* /usr/bin/ui/build/*
 
 EXPOSE 8080
-HEALTHCHECK --interval=5s --timeout=3s CMD curl --fail http://localhost:8081/healthz || exit 1
+HEALTHCHECK --interval=5s --timeout=3s CMD curl --fail http://localhost:8080/healthz || exit 1
 
 ENTRYPOINT ["ChargePi"]
 CMD ["-c", "/etc/ChargePi/configs/config.yaml", "run"]

cmd/charge_point.go

@@ -0,0 +1,65 @@
+package cmd
+
+import (
+	"context"
+
+	"go.uber.org/zap"
+
+	"github.com/lorenzodonini/ocpp-go/ocpp1.6/core"
+	"github.com/lorenzodonini/ocpp-go/ocpp1.6/localauth"
+	"github.com/lorenzodonini/ocpp-go/ocpp1.6/remotetrigger"
+	"github.com/lorenzodonini/ocpp-go/ocpp1.6/reservation"
+	"github.com/pkg/errors"
+
+	"github.com/ChargePi/ChargePi-go/internal/auth"
+	"github.com/ChargePi/ChargePi-go/internal/chargepoint"
+	v16 "github.com/ChargePi/ChargePi-go/internal/chargepoint/v16"
+	"github.com/ChargePi/ChargePi-go/internal/diagnostics"
+	"github.com/ChargePi/ChargePi-go/internal/evse/manager"
+	settings "github.com/ChargePi/ChargePi-go/internal/pkg/configuration/manager"
+	"github.com/ChargePi/ChargePi-go/internal/sessions"
+	"github.com/ChargePi/ChargePi-go/pkg/hardware/indicator"
+	"github.com/ChargePi/ChargePi-go/pkg/ocpp"
+)
+
+var supportedOcppV16Profiles = []string{
+	core.ProfileName,
+	reservation.ProfileName,
+	remotetrigger.ProfileName,
+	localauth.ProfileName,
+}
+
+// NewChargePoint Creates a OCPP-enabled charge point based on the protocol version
+func NewChargePoint(
+	ctx context.Context,
+	protocolVersion ocpp.ProtocolVersion,
+	logger *zap.Logger,
+	manager manager.Manager,
+	tagManager auth.Service,
+	settingsManager settings.Manager,
+	sessionManager sessions.Service,
+	diagnosticsManager diagnostics.Service,
+	hardware chargepoint.Hardware,
+) (chargepoint.ChargePoint, error) {
+
+	// Create a status indicator (if enabled)
+	statusIndicator := indicator.NewIndicator(len(manager.GetEVSEs()), hardware.Indicator)
+
+	// Attach additional components based on the configuration
+	opts := []chargepoint.Options{
+		chargepoint.WithDisplayFromSettings(hardware.Display),
+		chargepoint.WithReaderFromSettings(ctx, hardware.TagReader),
+		chargepoint.WithLogger(logger),
+		chargepoint.WithIndicator(statusIndicator),
+	}
+
+	switch protocolVersion {
+	case ocpp.OCPP16:
+		// Setup OCPP configuration from the database
+		return v16.NewChargePoint(logger, manager, settingsManager, tagManager, sessionManager, diagnosticsManager, opts...)
+	case ocpp.OCPP201:
+		return nil, errors.New("Version 2.0.1 is not supported yet.")
+	default:
+		return nil, errors.New("Invalid protocol version")
+	}
+}

cmd/export.go

@@ -3,31 +3,59 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/ChargePi/ChargePi-go/internal/pkg/models/settings"
-	cfg "github.com/ChargePi/ChargePi-go/internal/pkg/settings"
+	"go.uber.org/zap"
+
+	"github.com/ChargePi/ocpp-manager/ocpp_v16"
 	"github.com/spf13/cobra"
+
+	"github.com/ChargePi/ChargePi-go/internal/auth"
+	"github.com/ChargePi/ChargePi-go/internal/chargepoint"
+	"github.com/ChargePi/ChargePi-go/internal/pkg/badger"
+	cfg "github.com/ChargePi/ChargePi-go/internal/pkg/configuration"
+	exporter2 "github.com/ChargePi/ChargePi-go/internal/pkg/configuration/exporter"
+	"github.com/ChargePi/ChargePi-go/internal/pkg/configuration/manager"
 )
 
 var (
 	exportEvseFolderPath            *string
 	exportOcppConfigurationFilePath *string
 	exportAuthFilePath              *string
 	exportSettingsFilePath          *string
+	databasePath                    *string
 )
 
 // exportCommand represents the export command
 func exportCommand() *cobra.Command {
 	exportCmd := &cobra.Command{
-		Use:   "export",
-		Short: "Export settings from ChargePi.",
-		Long:  ``,
+		Use:     "export",
+		Short:   "Export settings from ChargePi.",
+		Long:    ``,
+		Version: chargepoint.FirmwareVersion,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			exporter := cfg.GetExporter()
+			db, err := badger.NewBadgerDb(*databasePath)
+			if err != nil {
+				return fmt.Errorf("could not create database: %v", err)
+			}
+
+			logger := zap.L()
+			tagManager := auth.NewManager(logger, db, db)
+
+			configurationManager, err := ocpp_v16.NewV16ConfigurationManager(ocpp_v16.NewEmptyConfiguration())
+			if err != nil {
+				return fmt.Errorf("could not create OCPP configuration manager: %v", err)
+			}
+
+			settingsManager, err := manager.NewManager(logger, db, db, configurationManager)
+			if err != nil {
+				return fmt.Errorf("could not create settings manager: %v", err)
+			}
+
+			exporter := exporter2.NewExporter(logger, tagManager, settingsManager, db)
 
-			evseFlag := cmd.Flags().Lookup(settings.EvseFlag).Changed
-			ocppFlag := cmd.Flags().Lookup(settings.OcppConfigPathFlag).Changed
-			authFlag := cmd.Flags().Lookup(settings.AuthFileFlag).Changed
-			settingsFlag := cmd.Flags().Lookup(settings.SettingsFlag).Changed
+			evseFlag := cmd.Flags().Lookup(cfg.EvseFlag).Changed
+			ocppFlag := cmd.Flags().Lookup(cfg.OcppConfigPathFlag).Changed
+			authFlag := cmd.Flags().Lookup(cfg.AuthFileFlag).Changed
+			settingsFlag := cmd.Flags().Lookup(cfg.SettingsFlag).Changed
 
 			// If the flag was set, export the EVSE configurations
 			if evseFlag {
@@ -65,10 +93,11 @@ func exportCommand() *cobra.Command {
 		},
 	}
 
-	exportEvseFolderPath = exportCmd.Flags().String(settings.EvseFlag, "./configs/evses", "evse folder path")
-	exportOcppConfigurationFilePath = exportCmd.Flags().String(settings.OcppConfigPathFlag, "./configs/ocpp.yaml", "OCPP config file path")
-	exportAuthFilePath = exportCmd.Flags().String(settings.AuthFileFlag, "./configs/authorization.yaml", "authorization file path")
-	exportSettingsFilePath = exportCmd.Flags().String(settings.SettingsFlag, "./configs/settings.yaml", "settings file path")
+	exportEvseFolderPath = exportCmd.Flags().String(cfg.EvseFlag, "./configs/evses", "evse folder path")
+	exportOcppConfigurationFilePath = exportCmd.Flags().String(cfg.OcppConfigPathFlag, "./configs/ocpp.yaml", "OCPP config file path")
+	exportAuthFilePath = exportCmd.Flags().String(cfg.AuthFileFlag, "./configs/authorization.yaml", "authorization file path")
+	exportSettingsFilePath = exportCmd.Flags().String(cfg.SettingsFlag, "./configs/settings.yaml", "settings file path")
+	databasePath = exportCmd.Flags().String("database", cfg.DatabasePath, "database path")
 
 	return exportCmd
 }

cmd/import.go

@@ -3,10 +3,16 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/ChargePi/ChargePi-go/internal/pkg/models/settings"
-	cfg "github.com/ChargePi/ChargePi-go/internal/pkg/settings"
-	"github.com/ChargePi/ChargePi-go/pkg/models/ocpp"
+	"github.com/ChargePi/ocpp-manager/ocpp_v16"
 	"github.com/spf13/cobra"
+	"go.uber.org/zap"
+
+	"github.com/ChargePi/ChargePi-go/internal/chargepoint"
+	"github.com/ChargePi/ChargePi-go/internal/pkg/badger"
+	cfg "github.com/ChargePi/ChargePi-go/internal/pkg/configuration"
+	importer2 "github.com/ChargePi/ChargePi-go/internal/pkg/configuration/importer"
+	"github.com/ChargePi/ChargePi-go/internal/pkg/configuration/manager"
+	"github.com/ChargePi/ChargePi-go/pkg/ocpp"
 )
 
 var (
@@ -20,16 +26,34 @@ var (
 // importCmd represents the import command
 func importCommand() *cobra.Command {
 	importCmd := &cobra.Command{
-		Use:   "import",
-		Short: "Import configurations to ChargePi.",
-		Long:  ``,
+		Use:     "import",
+		Short:   "Import configurations to ChargePi.",
+		Long:    ``,
+		Version: chargepoint.FirmwareVersion,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			importer := cfg.GetImporter()
+			db, err := badger.NewBadgerDb(*databasePath)
+			if err != nil {
+				return fmt.Errorf("could not create database: %v", err)
+			}
+
+			logger := zap.L()
+
+			configurationManager, err := ocpp_v16.NewV16ConfigurationManager(ocpp_v16.NewEmptyConfiguration())
+			if err != nil {
+				return fmt.Errorf("could not create OCPP configuration manager: %v", err)
+			}
+
+			settingsManager, err := manager.NewManager(logger, db, db, configurationManager)
+			if err != nil {
+				return fmt.Errorf("could not create settings manager: %v", err)
+			}
+
+			importer := importer2.NewImporter(logger, settingsManager, db, db)
 
-			evseFlag := cmd.Flags().Lookup(settings.EvseFlag).Changed
-			ocppFlag := cmd.Flags().Lookup(settings.OcppConfigPathFlag).Changed
-			authFlag := cmd.Flags().Lookup(settings.AuthFileFlag).Changed
-			settingsFlag := cmd.Flags().Lookup(settings.SettingsFlag).Changed
+			evseFlag := cmd.Flags().Lookup(cfg.EvseFlag).Changed
+			ocppFlag := cmd.Flags().Lookup(cfg.OcppConfigPathFlag).Changed
+			authFlag := cmd.Flags().Lookup(cfg.AuthFileFlag).Changed
+			settingsFlag := cmd.Flags().Lookup(cfg.SettingsFlag).Changed
 
 			if evseFlag {
 				// If a directory is specified, (try to) import all the files in that directory.
@@ -66,11 +90,11 @@ func importCommand() *cobra.Command {
 		},
 	}
 
-	evseFolderPath = importCmd.Flags().String(settings.EvseFlag, "", "evse folder path")
-	ocppConfigurationFilePath = importCmd.Flags().String(settings.OcppConfigPathFlag, "", "OCPP config file path")
-	ocppVersionFlag = importCmd.Flags().StringP(settings.OcppVersion, "v", "1.6", "OCPP config file path")
-	authFilePath = importCmd.Flags().String(settings.AuthFileFlag, "", "authorization file path")
-	importSettingsFilePath = importCmd.Flags().String(settings.SettingsFlag, "", "settings file path")
+	evseFolderPath = importCmd.Flags().String(cfg.EvseFlag, "", "evse folder path")
+	ocppConfigurationFilePath = importCmd.Flags().String(cfg.OcppConfigPathFlag, "", "OCPP config file path")
+	ocppVersionFlag = importCmd.Flags().StringP(cfg.OcppVersion, "v", "1.6", "OCPP config file path")
+	authFilePath = importCmd.Flags().String(cfg.AuthFileFlag, "", "authorization file path")
+	importSettingsFilePath = importCmd.Flags().String(cfg.SettingsFlag, "", "settings file path")
 
 	return importCmd
 }

cmd/root.go

@@ -1,11 +1,17 @@
 package cmd
 
 import (
-	"github.com/ChargePi/ChargePi-go/internal/pkg/models/settings"
-	"github.com/ChargePi/ChargePi-go/pkg/observability/logging"
+	"context"
+	"os"
+	"os/signal"
+	"syscall"
+
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"go.uber.org/zap"
+
+	"github.com/ChargePi/ChargePi-go/internal/pkg/configuration"
+	"github.com/ChargePi/ChargePi-go/pkg/observability"
 )
 
 var rootCmd = &cobra.Command{
@@ -17,21 +23,23 @@ var rootCmd = &cobra.Command{
 
 func init() {
 	cobra.OnInitialize(func() {
-		logger := logging.SetupZap(settings.Logging{}, viper.GetBool(settings.Debug))
-		zap.ReplaceGlobals(logger)
+		observability.SetupLogger(viper.GetBool(configuration.Debug))
 	})
 
 	rootCmd.AddCommand(runCommand())
 	rootCmd.AddCommand(versionCommand())
 	rootCmd.AddCommand(exportCommand())
 	rootCmd.AddCommand(importCommand())
 
-	rootCmd.PersistentFlags().BoolP(settings.DebugFlag, "d", false, "debug mode")
-	_ = viper.BindPFlag(settings.Debug, rootCmd.PersistentFlags().Lookup(settings.DebugFlag))
+	rootCmd.PersistentFlags().BoolP(configuration.DebugFlag, "d", false, "debug mode")
+	_ = viper.BindPFlag(configuration.Debug, rootCmd.PersistentFlags().Lookup(configuration.DebugFlag))
 }
 
 func Execute() {
-	err := rootCmd.Execute()
+	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGKILL, syscall.SIGTERM)
+	defer cancel()
+
+	err := rootCmd.ExecuteContext(ctx)
 	if err != nil {
 		zap.L().Fatal("Unable to run", zap.Error(err))
 	}