Introduced gofmt and golangci-lint to GitHub Actions, with a corresponding code cleanup

Author: starichkov

.github/workflows/build.yml

@@ -33,6 +33,20 @@ jobs:
       - name: Build
         run: go build -v ./...
 
+      - name: Check formatting (gofmt)
+        run: |
+          fmtres=$(gofmt -l .)
+          if [ -n "$fmtres" ]; then
+          echo "These files are not gofmt'ed:"
+          echo "$fmtres"
+          exit 1
+          fi
+
+      - name: Run golangci-lint
+        uses: golangci/golangci-lint-action@v8
+        with:
+          version: v2.6
+
       - name: Run unit tests
         run: go test -v -short ./...
 

README.md

@@ -1,12 +1,11 @@
+# Notes API: Golang with NoSQL Databases
+
 [![Author](https://img.shields.io/badge/Author-Vadim%20Starichkov-blue?style=for-the-badge)](https://github.com/starichkov)
 ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/starichkov/golang-simple-notes?style=for-the-badge)
 [![GitHub License](https://img.shields.io/github/license/starichkov/golang-simple-notes?style=for-the-badge)](https://github.com/starichkov/golang-simple-notes/blob/main/LICENSE.md)
 [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/starichkov/golang-simple-notes/build.yml?style=for-the-badge)](https://github.com/starichkov/golang-simple-notes/actions/workflows/build.yml)
 [![Codecov](https://img.shields.io/codecov/c/github/starichkov/golang-simple-notes?style=for-the-badge)](https://codecov.io/gh/starichkov/golang-simple-notes)
 
-Notes API: Golang with NoSQL Databases
-=
-
 A simple microservice for notes management with REST and gRPC APIs, with support for multiple storage backends.
 
 *This project is generated using JetBrains Junie and several other AI coding agents to evaluate agent capabilities.*

app_test.go

@@ -53,8 +53,14 @@ func TestApp_InitializeWithCouchDB(t *testing.T) {
 
 	defer func() {
 		// Clean up: delete the notes database
-		req, _ := http.NewRequest(http.MethodDelete, couchURL+"/notes", nil)
-		http.DefaultClient.Do(req)
+		req, err := http.NewRequest(http.MethodDelete, couchURL+"/notes", nil)
+		if err != nil {
+			return
+		}
+		resp, err := http.DefaultClient.Do(req)
+		if err == nil && resp != nil {
+			_ = resp.Body.Close()
+		}
 	}()
 
 	// Create app with CouchDB config
@@ -81,7 +87,7 @@ func TestApp_InitializeWithCouchDB(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Failed to create CouchDB database: %v", err)
 	}
-	defer resp.Body.Close()
+	defer func() { _ = resp.Body.Close() }()
 	if resp.StatusCode != http.StatusCreated && resp.StatusCode != http.StatusPreconditionFailed {
 		t.Fatalf("Failed to create CouchDB database: %s", resp.Status)
 	}
@@ -108,7 +114,9 @@ func TestApp_InitializeWithCouchDB(t *testing.T) {
 	}
 
 	// Clean up
-	defer app.storage.Close(ctx)
+	if err := app.storage.Close(ctx); err != nil {
+		t.Logf("storage close error: %v", err)
+	}
 }
 
 func TestApp_InitializeWithMongoDB(t *testing.T) {
@@ -171,7 +179,9 @@ func TestApp_InitializeWithMongoDB(t *testing.T) {
 	}
 
 	// Clean up
-	defer app.storage.Close(ctx)
+	if err := app.storage.Close(ctx); err != nil {
+		t.Logf("storage close error: %v", err)
+	}
 }
 
 func TestApp_CreateSampleNotes(t *testing.T) {
@@ -574,7 +584,9 @@ func TestApp_StartServers(t *testing.T) {
 	// Clean up
 	shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 	defer cancel()
-	app.restServer.Shutdown(shutdownCtx)
+	if err := app.restServer.Shutdown(shutdownCtx); err != nil {
+		t.Logf("rest shutdown error: %v", err)
+	}
 	// gRPC server cleanup is handled by the context timeout
 }
 

config_test.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"os"
 	"testing"
 )
 
@@ -35,12 +34,12 @@ func TestNewConfig(t *testing.T) {
 	}
 
 	// Test environment variable override
-	os.Setenv("STORAGE_TYPE", "couchdb")
-	os.Setenv("COUCHDB_URL", "http://test:5984")
-	os.Setenv("COUCHDB_DB", "testdb")
-	os.Setenv("MONGODB_URI", "mongodb://test:27017")
-	os.Setenv("MONGODB_DB", "testdb")
-	os.Setenv("MONGODB_COLLECTION", "testcoll")
+	t.Setenv("STORAGE_TYPE", "couchdb")
+	t.Setenv("COUCHDB_URL", "http://test:5984")
+	t.Setenv("COUCHDB_DB", "testdb")
+	t.Setenv("MONGODB_URI", "mongodb://test:27017")
+	t.Setenv("MONGODB_DB", "testdb")
+	t.Setenv("MONGODB_COLLECTION", "testcoll")
 
 	config = NewConfig()
 	if config.StorageType != "couchdb" {
@@ -62,13 +61,6 @@ func TestNewConfig(t *testing.T) {
 		t.Errorf("Expected MongoDBCollection to be 'testcoll', got %s", config.MongoDBCollection)
 	}
 
-	// Clean up environment variables
-	os.Unsetenv("STORAGE_TYPE")
-	os.Unsetenv("COUCHDB_URL")
-	os.Unsetenv("COUCHDB_DB")
-	os.Unsetenv("MONGODB_URI")
-	os.Unsetenv("MONGODB_DB")
-	os.Unsetenv("MONGODB_COLLECTION")
 }
 
 func TestGetEnv(t *testing.T) {
@@ -79,12 +71,9 @@ func TestGetEnv(t *testing.T) {
 	}
 
 	// Test environment variable override
-	os.Setenv("TEST_VAR", "test_value")
+	t.Setenv("TEST_VAR", "test_value")
 	value = getEnv("TEST_VAR", "default")
 	if value != "test_value" {
 		t.Errorf("Expected 'test_value', got %s", value)
 	}
-
-	// Clean up
-	os.Unsetenv("TEST_VAR")
 }

grpc/server_test.go

@@ -147,7 +147,12 @@ func TestStartError(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Failed to create listener for test: %v", err)
 	}
-	defer listener.Close()
+	defer func(listener net.Listener) {
+		err := listener.Close()
+		if err != nil {
+			t.Errorf("Failed to close listener: %v", err)
+		}
+	}(listener)
 
 	// Now try to start a server on the same port, which should fail
 	server := NewServer(mockStorage, 8082)
@@ -201,7 +206,10 @@ func TestGetNote(t *testing.T) {
 
 	// Create a note
 	originalNote := model.NewNote("Test Title", "Test Content")
-	mockStorage.Create(ctx, originalNote)
+	err := mockStorage.Create(ctx, originalNote)
+	if err != nil {
+		return
+	}
 
 	// Test getting an existing note
 	note, err := server.GetNote(ctx, originalNote.ID)
@@ -237,8 +245,14 @@ func TestGetAllNotes(t *testing.T) {
 	// Create some notes
 	note1 := model.NewNote("Title 1", "Content 1")
 	note2 := model.NewNote("Title 2", "Content 2")
-	mockStorage.Create(ctx, note1)
-	mockStorage.Create(ctx, note2)
+	err1 := mockStorage.Create(ctx, note1)
+	if err1 != nil {
+		return
+	}
+	err2 := mockStorage.Create(ctx, note2)
+	if err2 != nil {
+		return
+	}
 
 	// Get all notes
 	notes, err := server.GetAllNotes(ctx)
@@ -274,7 +288,10 @@ func TestUpdateNote(t *testing.T) {
 
 	// Create a note
 	originalNote := model.NewNote("Original Title", "Original Content")
-	mockStorage.Create(ctx, originalNote)
+	err := mockStorage.Create(ctx, originalNote)
+	if err != nil {
+		return
+	}
 
 	// Update the note
 	updatedNote, err := server.UpdateNote(ctx, originalNote.ID, "Updated Title", "Updated Content")
@@ -313,7 +330,10 @@ func TestDeleteNote(t *testing.T) {
 
 	// Create a note
 	note := model.NewNote("Test Title", "Test Content")
-	mockStorage.Create(ctx, note)
+	errc := mockStorage.Create(ctx, note)
+	if errc != nil {
+		return
+	}
 
 	// Delete the note
 	err := server.DeleteNote(ctx, note.ID)

main_test.go

@@ -52,7 +52,10 @@ func acquireLock() (*os.File, error) {
 		f, err := os.OpenFile(lockFile, os.O_CREATE|os.O_EXCL|os.O_WRONLY, 0644)
 		if err == nil {
 			// Write our PID to the lock file
-			fmt.Fprintf(f, "%d", os.Getpid())
+			_, errF := fmt.Fprintf(f, "%d", os.Getpid())
+			if errF != nil {
+				return nil, errF
+			}
 			return f, nil
 		}
 		// Lock file exists, wait and retry
@@ -64,8 +67,14 @@ func acquireLock() (*os.File, error) {
 // releaseLock releases the file-based lock
 func releaseLock(f *os.File) {
 	if f != nil {
-		f.Close()
-		os.Remove(getLockFilePath())
+		errC := f.Close()
+		if errC != nil {
+			return
+		}
+		errR := os.Remove(getLockFilePath())
+		if errR != nil {
+			return
+		}
 	}
 }
 
@@ -186,14 +195,17 @@ func TestMain(m *testing.M) {
 		}
 
 		// Clean up state file
-		os.Remove(getStateFilePath())
+		errR := os.Remove(getStateFilePath())
+		if errR != nil {
+			return
+		}
 	}
 
 	os.Exit(code)
 }
 
 func startSharedMongoDBContainer(ctx context.Context) error {
-	container, err := mongodb.RunContainer(ctx, testcontainers.WithImage("mongo:7.0.25-jammy"))
+	container, err := mongodb.Run(ctx, "mongo:7.0.25-jammy")
 	if err != nil {
 		return fmt.Errorf("failed to start MongoDB container: %w", err)
 	}
@@ -335,41 +347,3 @@ type MyLogConsumer struct{}
 func (c *MyLogConsumer) Accept(log testcontainers.Log) {
 	fmt.Printf("Log: %s\n", string(log.Content))
 }
-
-// startCouchDBContainer starts a CouchDB container and returns the container and connection URL
-func startCouchDBContainer(ctx context.Context) (testcontainers.Container, string, error) {
-	consumer := &MyLogConsumer{}
-	req := testcontainers.ContainerRequest{
-		Image:        "couchdb:3.4.3",
-		ExposedPorts: []string{"5984/tcp"},
-		WaitingFor:   wait.ForListeningPort("5984/tcp"),
-		Env: map[string]string{
-			"COUCHDB_USER":     "admin",
-			"COUCHDB_PASSWORD": "password",
-		},
-		LogConsumerCfg: &testcontainers.LogConsumerConfig{
-			Consumers: []testcontainers.LogConsumer{
-				consumer,
-			},
-		},
-	}
-	container, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
-		ContainerRequest: req,
-		Started:          true,
-	})
-	if err != nil {
-		return nil, "", err
-	}
-	host, err := container.Host(ctx)
-	if err != nil {
-		container.Terminate(ctx)
-		return nil, "", err
-	}
-	port, err := container.MappedPort(ctx, "5984")
-	if err != nil {
-		container.Terminate(ctx)
-		return nil, "", err
-	}
-	url := fmt.Sprintf("http://admin:password@%s:%s", host, port.Port())
-	return container, url, nil
-}

rest/handlers.go

@@ -72,7 +72,9 @@ func (h *Handler) RegisterRoutes(r chi.Router) {
 // This endpoint can be used by load balancers or monitoring tools to check if the service is healthy.
 func (h *Handler) handleHealth(w http.ResponseWriter, r *http.Request) {
 	w.WriteHeader(http.StatusOK) // Set the status code to 200 OK
-	w.Write([]byte("OK"))        // Write a simple "OK" response
+	if _, err := w.Write([]byte("OK")); err != nil {
+		_ = err // cannot change status code; ignore write error
+	}
 }
 
 // getAllNotes handles GET /api/notes.

rest/handlers_test.go

@@ -227,8 +227,14 @@ func TestGetAllNotes(t *testing.T) {
 		// Add some notes to the storage
 		note1 := model.NewNote("Title 1", "Content 1")
 		note2 := model.NewNote("Title 2", "Content 2")
-		mockStorage.Create(context.Background(), note1)
-		mockStorage.Create(context.Background(), note2)
+		err1 := mockStorage.Create(context.Background(), note1)
+		if err1 != nil {
+			return
+		}
+		err2 := mockStorage.Create(context.Background(), note2)
+		if err2 != nil {
+			return
+		}
 
 		req := setupTestRequest("GET", "/api/notes", "")
 		w := httptest.NewRecorder()
@@ -279,7 +285,10 @@ func TestGetNote(t *testing.T) {
 
 		// Add a note to the storage with a valid ID
 		note := &model.Note{ID: "testid123", Title: "Test Title", Content: "Test Content"}
-		mockStorage.Create(context.Background(), note)
+		errC := mockStorage.Create(context.Background(), note)
+		if errC != nil {
+			return
+		}
 
 		req := setupTestRequest("GET", "/api/notes/"+note.ID, "")
 		chiCtx := chi.NewRouteContext()
@@ -358,7 +367,10 @@ func TestUpdateNote(t *testing.T) {
 
 		// Add a note to the storage with a valid ID
 		note := &model.Note{ID: "testid123", Title: "Original Title", Content: "Original Content"}
-		mockStorage.Create(context.Background(), note)
+		errC := mockStorage.Create(context.Background(), note)
+		if errC != nil {
+			return
+		}
 
 		reqBody := `{"title":"Updated Title","content":"Updated Content"}`
 		req := setupTestRequest("PUT", "/api/notes/"+note.ID, reqBody)
@@ -467,7 +479,10 @@ func TestDeleteNote(t *testing.T) {
 
 		// Add a note to the storage with a valid ID
 		note := &model.Note{ID: "testid123", Title: "Test Title", Content: "Test Content"}
-		mockStorage.Create(context.Background(), note)
+		errC := mockStorage.Create(context.Background(), note)
+		if errC != nil {
+			return
+		}
 
 		req := setupTestRequest("DELETE", "/api/notes/"+note.ID, "")
 		chiCtx := chi.NewRouteContext()