feat: verify checksum (SHA256) (#16)

Author: srg-bnd

.env.example

@@ -0,0 +1,13 @@
+# APP CONFIG
+ADDRESS=
+LOG_LEVEL=
+STORE_INTERVAL=
+FILE_STORAGE_PATH=
+RESTORE=
+DATABASE_DSN=
+
+# GOOSE CONFIG
+GOOSE_DRIVER=
+GOOSE_DBSTRING=
+GOOSE_MIGRATION_DIR=
+GOOSE_TABLE=

.gitignore

@@ -18,6 +18,9 @@ cmd/agent/agent
 cmd/server/main
 cmd/server/server
 
+# Envs
+.env
+
 # Dependency directories (remove the comment below to include it)
 vendor/
 

Makefile

@@ -0,0 +1,25 @@
+BINARY_SERVER = server
+BINARY_AGENT = agent
+
+default: build
+
+build: build_server build_agent
+
+build_server:
+	go build -o ${BINARY_SERVER} cmd/server/main.go
+
+build_agent:
+	go build -o ${BINARY_AGENT} cmd/agent/main.go
+
+test_server:
+	go test ./... -timeout 60m --tags=server -v
+
+test_agent:
+	go test ./... -timeout 60m --tags=agent -v
+
+clean:
+	go clean
+	rm -f $(BINARY_SERVER) $(BINARY_AGENT)
+
+lint:
+	go fmt ./...

README.md

@@ -2,7 +2,64 @@
 
 Metrics collection and alerting service
 
-## For students
+[![go report card](https://goreportcard.com/badge/github.com/srg-bnd/observator?style=flat-square)](https://goreportcard.com/report/github.com/srg-bnd/observator)
+[![test status](https://github.com/srg-bnd/observator/workflows/mertricstest/badge.svg?branch=main "test status")](https://github.com/srg-bnd/observator/actions)
+
+## Getting Started
+
+Dependencies:
+
+* Go `1.23`
+* PostgreSQL
+* Linux or macOS platform
+
+### Startup
+
+#### Server
+
+To build a server, run in the terminal:
+
+```bash
+cd cmd/server && go run . # in the root directory of the project
+```
+
+To startup the server, run in the terminal:
+
+```bash
+./cmd/server/server # in the root directory of the project
+```
+
+##### Envs & flags
+
+* `ADDRESS` | `-a` – address and port to run server. Default `:8080`
+* `LOG_LEVEL` | `-l` – log level. Default `info`
+* `STORE_INTERVAL` | `-i` – store interval in seconds (zero for sync). Default `300`
+* `FILE_STORAGE_PATH` | `-f` – file storage path. Default `./temp.storage.db`
+* `RESTORE` | `-r` – load data from storage. Default `true`
+* `DATABASE_DSN` | `-d` – DB connection address
+
+#### Agent
+
+To build a agent, run in the terminal:
+
+```bash
+cd cmd/agent && go run . # in the root directory of the project
+```
+
+To startup the agent, run in the terminal:
+
+```bash
+./cmd/server/agent # in the root directory of the project
+```
+
+##### Envs & flags
+
+* `POLL_INTERVAL` | `-p` – frequency (seconds) of metric polling. Default `2`
+* `REPORT_INTERVAL` | `-r` – frequency (seconds) of sending values to the server. Default `10`
+* `ADDRESS` | `-a` – address and port to run agent. Default `localhost:8080`
+* `KEY` | `-k` – encryption key
+
+## Development
 
 ### Updating the template
 

cmd/agent/README.md

@@ -4,26 +4,28 @@ package main
 import (
 	"log"
 
+	config "github.com/srg-bnd/observator/config/agent"
 	"github.com/srg-bnd/observator/internal/agent"
+	"github.com/srg-bnd/observator/internal/shared/services"
 	"github.com/srg-bnd/observator/internal/storage"
 )
 
-// Application
-type App struct {
-	agent *agent.Agent
+func init() {
+	config.Flags.ParseFlags()
 }
 
-// Returns a new application
-func NewApp() *App {
-	return &App{
-		agent: agent.NewAgent(storage.NewMemStorage(), appConfigs.serverAddr),
+func main() {
+	// Init DI container
+	container := &config.Container{
+		Storage:    storage.NewMemStorage(),
+		ServerAddr: config.Flags.ServerAddr,
 	}
-}
 
-func main() {
-	parseFlags()
+	if config.Flags.SecretKey != "" {
+		container.ChecksumService = services.NewChecksum(config.Flags.SecretKey)
+	}
 
-	if err := NewApp().agent.Start(appConfigs.pollInterval, appConfigs.reportInterval); err != nil {
+	if err := agent.NewAgent(container).Start(config.Flags.PollInterval, config.Flags.ReportInterval); err != nil {
 		log.Fatal(err)
 	}
 }