Merge pull request #1 from thisisdevelopment/feature/generics

Feature/generics

Author: thisisdev-patrick

.circleci/config.yml

@@ -1,52 +1,93 @@
-version: 2.1 # use CircleCI 2.0
+version: 2.1 # use CircleCI 2.1
 orbs:
-  codecov: codecov/codecov@1.0.5
+  codecov: codecov/codecov@4.0.1
 jobs: # basic units of work in a run
   build: # runs not using Workflows must have a `build` job as entry point
     docker: # run the steps with Docker
-      # CircleCI Go images available at: https://hub.docker.com/r/circleci/golang/
-      - image: circleci/golang:1.13 #
+      # Updated Go image with Go 1.21+ support for generics
+      - image: cimg/go:1.21
         environment:
           GO111MODULE: "on"
       # CircleCI PostgreSQL images available at: https://hub.docker.com/r/circleci/postgres/
-    # directory where steps are run. Path must conform to the Go Workspace requirements
-    working_directory: /go/src/github.com/thisisdevelopment/flashflood
+    # directory where steps are run - updated for v2 module
+    working_directory: ~/project
 
     environment: # environment variables for the build itself
       TEST_RESULTS: /tmp/test-results # path to where test results will be saved
 
     steps: # steps that comprise the `build` job
-      - checkout # check out source code to working directory
+      - run:
+          name: Checkout code via HTTPS
+          command: |
+            git clone https://github.com/thisisdevelopment/flashflood.git .
+            git checkout $CIRCLE_SHA1
       - run: mkdir -p $TEST_RESULTS # create the test results directory
 
       - restore_cache: # restores saved cache if no changes are detected since last run
       # Read about caching dependencies: https://circleci.com/docs/2.0/caching/
           keys:
-            - v1-pkg-cache
+            - v2-pkg-cache-{{ checksum "go.sum" }}
+            - v2-pkg-cache-
+
+      # Install go-junit-report for test reporting
+      - run: go install github.com/jstemmer/go-junit-report/v2@latest
 
-      # Normally, this step would be in a custom primary image;
-      # we've added it here for the sake of explanation.
-      - run: go get github.com/thisisdevelopment/flashflood
-      - run: go get github.com/jstemmer/go-junit-report
+      # Download dependencies
+      - run:
+          name: Download dependencies
+          command: go mod download
+
+      # Verify dependencies and format
+      - run:
+          name: Verify and format code
+          command: |
+            go mod verify
+            go fmt ./...
 
+      # Run tests with our test runner
       - run:
           name: Run unit tests
           command: |
-            trap "go-junit-report <${TEST_RESULTS}/go-test.out > ${TEST_RESULTS}/go-test-report.xml" EXIT
-            make test | tee ${TEST_RESULTS}/go-test.out
+            # Use our test-runner.sh if available, otherwise use go test directly
+            if [ -f "./test-runner.sh" ]; then
+              chmod +x ./test-runner.sh
+              ./test-runner.sh -v -c
+            else
+              go test -v -race ./... | tee ${TEST_RESULTS}/go-test.out
+            fi
+
+      # Generate JUnit report if go test output exists
+      - run:
+          name: Generate JUnit report
+          command: |
+            if [ -f "${TEST_RESULTS}/go-test.out" ]; then
+              cat ${TEST_RESULTS}/go-test.out | go-junit-report > ${TEST_RESULTS}/go-test-report.xml
+            fi
+          when: always
 
+      # Run coverage separately to ensure we get the file
       - run:
           name: Run code coverage
           command: |
-            go test -race -coverprofile=coverage.txt -covermode=atomic
-            mv coverage.txt /tmp/test-results/
+            go test -race -coverprofile=coverage.txt -covermode=atomic ./...
+            if [ -f "coverage.txt" ]; then
+              cp coverage.txt ${TEST_RESULTS}/coverage.txt
+            fi
 
-      - run: make # pull and build dependencies for the project
+      # Build the project to verify everything compiles
+      - run:
+          name: Build project
+          command: |
+            if [ -f "Makefile" ]; then
+              make build-native
+            else
+              go build ./...
+            fi
 
       - save_cache: # Store cache in the /go/pkg directory
-          key: v1-pkg-cache
+          key: v2-pkg-cache-{{ checksum "go.sum" }}
           paths:
-            - "/go/pkg"
+            - "/home/circleci/go/pkg"
 
       - store_artifacts: # Upload test summary for display in Artifacts: https://circleci.com/docs/2.0/artifacts/
           path: /tmp/test-results

.gitignore

@@ -10,6 +10,8 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+coverage.html
+coverage.txt
 
 # Dependency directories (remove the comment below to include it)
 # vendor/

Makefile

@@ -1,20 +1,46 @@
 GOFILES = $(shell find . -name '*.go' -not -path './vendor/*')
 GOPACKAGES = $(shell go list ./...  | grep -v /vendor/)
 
-default: build
+default: test
 
 workdir:
 	mkdir -p workdir
 
-build: workdir/flashflood
+# For library projects, build means compile-check all packages
+build: $(GOFILES)
+	go build ./...
 
+# Native build also just checks compilation for libraries
 build-native: $(GOFILES)
-	go build -o workdir/native-flashflood .
-
-workdir/flashflood: $(GOFILES)
-	GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o workdir/flashflood .
+	go build ./...
 
+# Run tests
 test: test-all
 
 test-all:
-	@go test -v $(GOPACKAGES)
+	@go test -v $(GOPACKAGES)
+
+# Run tests with coverage
+test-coverage:
+	@go test -race -coverprofile=coverage.out -covermode=atomic $(GOPACKAGES)
+
+# Format code
+fmt:
+	@go fmt $(GOPACKAGES)
+
+# Lint code
+lint:
+	@if command -v golangci-lint >/dev/null 2>&1; then \
+		golangci-lint run; \
+	else \
+		echo "golangci-lint not installed, skipping linting"; \
+	fi
+
+# Run all quality checks
+check: fmt lint test-coverage
+
+# Clean build artifacts
+clean:
+	rm -rf workdir coverage.out coverage.html coverage.txt
+
+.PHONY: default build build-native test test-all test-coverage fmt lint check clean