Added tests

Author: paqstd-dev

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Set up Go 1.19
+        uses: actions/setup-go@v6
+        with:
+          go-version: '1.19'
+
+      - name: Tidy modules
+        run: go mod tidy
+
+      - name: Run tests with coverage (100% enforced)
+        run: make test
+
+      - name: Upload coverage artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage
+          path: coverage.out
+
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage.out
+          flags: unittests
+          fail_ci_if_error: true
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -5,3 +5,6 @@
 fake-cli
 
 dist/
+
+coverage.out
+.DS_Store

Makefile

@@ -21,3 +21,11 @@ run:
 
 # Define the default command as the build command
 default: build
+
+test:
+	TESTING=1 go test ./tests -covermode=atomic -coverpkg=./app,./cache,./config,./handler -coverprofile=coverage.out
+	@echo "\nCoverage by function/package:" && go tool cover -func=coverage.out | sed 's/^/  /'
+	@echo "\nUncovered code blocks (file:line1.col-line2.col [statements]):"
+	@awk 'NR>1 && $$3==0 {print "  " $$1 " [" $$2 "]"}' coverage.out | sort
+	@echo "Enforcing 100% coverage"
+	@go tool cover -func=coverage.out | awk '/total:/ { if ($$3 != "100.0%") { print; exit 1 } }'

app/app.go

@@ -0,0 +1,30 @@
+package app
+
+import (
+	"log"
+	"net/http"
+	"strconv"
+
+	"github.com/brianvoe/gofakeit/v6"
+	"github.com/paqstd-team/fake-cli/config"
+	"github.com/paqstd-team/fake-cli/handler"
+)
+
+// Run constructs the HTTP server using the provided config path and port.
+// It seeds the random generator to make responses deterministic across runs.
+func Run(configPath string, port int) (*http.Server, error) {
+	gofakeit.Seed(0)
+
+	cfg, err := config.LoadConfigFromFile(configPath)
+	if err != nil {
+		return nil, err
+	}
+
+	srv := &http.Server{
+		Addr:    ":" + strconv.Itoa(port),
+		Handler: handler.MakeHandler(cfg),
+	}
+
+	log.Printf("Starting server on %v", srv.Addr)
+	return srv, nil
+}

docker-compose.example.yml

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
   # ...other services
   fake-cli:

go.mod

@@ -1,7 +1,7 @@
 module github.com/paqstd-team/fake-cli
 
-go 1.19
+go 1.21
 
-require github.com/brianvoe/gofakeit/v6 v6.20.1
+require github.com/brianvoe/gofakeit/v6 v6.28.0
 
-require github.com/gorilla/mux v1.8.0 // indirect
+require github.com/gorilla/mux v1.8.1

go.sum

@@ -1,4 +1,4 @@
-github.com/brianvoe/gofakeit/v6 v6.20.1 h1:8ihJ60OvPnPJ2W6wZR7M+TTeaZ9bml0z6oy4gvyJ/ek=
-github.com/brianvoe/gofakeit/v6 v6.20.1/go.mod h1:Ow6qC71xtwm79anlwKRlWZW6zVq9D2XHE4QSSMP/rU8=
-github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
-github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
+github.com/brianvoe/gofakeit/v6 v6.28.0 h1:Xib46XXuQfmlLS2EXRuJpqcw8St6qSZz75OUo0tgAW4=
+github.com/brianvoe/gofakeit/v6 v6.28.0/go.mod h1:Xj58BMSnFqcn/fAQeSK+/PLtC5kSb7FJIq4JyGa8vEs=
+github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
+github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=

handler/handler.go

@@ -10,6 +10,10 @@ import (
 	"github.com/paqstd-team/fake-cli/config"
 )
 
+// JSONMarshal is used to marshal response data. It is a variable to allow tests
+// to inject failures and exercise error-handling branches.
+var JSONMarshal = json.Marshal
+
 func MakeHandler(config config.Config) http.Handler {
 	mux := mux.NewRouter()
 	cache := cache.NewCache(config.Cache)
@@ -41,7 +45,7 @@ func makeHandlerFunc(fields any, responseType string, cache *cache.Cache) http.H
 			data = generateData(fields)
 		}
 
-		jsonData, err := json.Marshal(data)
+		jsonData, err := JSONMarshal(data)
 		if err != nil {
 			http.Error(w, fmt.Sprintf("Error generating JSON: %v", err), http.StatusInternalServerError)
 			return

main.go

@@ -3,19 +3,18 @@ package main
 import (
 	"flag"
 	"log"
-	"net/http"
 	"os"
 	"strconv"
 
-	"github.com/brianvoe/gofakeit/v6"
-	"github.com/paqstd-team/fake-cli/config"
-	"github.com/paqstd-team/fake-cli/handler"
+	"github.com/paqstd-team/fake-cli/app"
 )
 
 func main() {
-	// Seed the random number generator for reproducibility
-	gofakeit.Seed(0)
+	Main()
+}
 
+// Main is the exported entrypoint to allow external tests to exercise startup logic.
+func Main() {
 	// Define command-line flags
 	port := flag.Int("p", 8080, "port number")
 	configPath := flag.String("c", "config.json", "path to config file")
@@ -37,19 +36,18 @@ func main() {
 		*configPath = envConfig
 	}
 
-	config, err := config.LoadConfigFromFile(*configPath)
+	server, err := app.Run(*configPath, *port)
 	if err != nil {
-		log.Fatalf("Error loading config: %v", err)
+		log.Fatalf("Error starting server: %v", err)
 	}
 
-	server := &http.Server{
-		Addr:    ":" + strconv.Itoa(*port),
-		Handler: handler.MakeHandler(config),
+	// Allow tests to execute main without blocking
+	if os.Getenv("TESTING") == "1" {
+		return
 	}
 
-	log.Printf("Starting server on %v", server.Addr)
-	err = server.ListenAndServe()
-	if err != nil {
+	// Block in production run
+	if err := server.ListenAndServe(); err != nil {
 		log.Fatalf("Error starting server: %v", err)
 	}
 }

tests/test_app_test.go

@@ -0,0 +1,35 @@
+package tests
+
+import (
+	"context"
+	"net/http"
+	"os"
+	"path/filepath"
+	"testing"
+	"time"
+
+	"github.com/paqstd-team/fake-cli/app"
+)
+
+func TestApp_RunLifecycle(t *testing.T) {
+	cfgPath := filepath.Join(t.TempDir(), "config.json")
+	if err := os.WriteFile(cfgPath, []byte(`{"endpoints":[{"url":"/ping","fields":{"id":"uuid"},"response":"single"}],"cache":1}`), 0o600); err != nil {
+		t.Fatalf("write cfg: %v", err)
+	}
+	srv, err := app.Run(cfgPath, 0)
+	if err != nil {
+		t.Fatalf("Run: %v", err)
+	}
+	go func() { _ = srv.ListenAndServe() }()
+	time.Sleep(30 * time.Millisecond)
+	_ = srv.Close()
+	_ = srv.Shutdown(context.Background())
+	_ = http.ErrServerClosed
+}
+
+func TestApp_RunMissingConfig(t *testing.T) {
+	_, err := app.Run(filepath.Join(t.TempDir(), "missing.json"), 0)
+	if err == nil {
+		t.Fatalf("expected error for missing config file")
+	}
+}