chore: update CI/CD configuration and documentation

Trozz · Trozz · commit a819af5317f7 · 2025-07-01T21:15:53.000+01:00
- Update CI workflow configuration
- Update golangci-lint configuration
- Add codecov.yml for code coverage settings
- Update Makefile with new targets
- Update README with additional documentation
- Update CHANGELOG
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,7 +13,7 @@ on:
       - develop
 
 env:
-  GO_VERSION: "1.21"
+  GO_VERSION: "1.24"
   GOLANGCI_LINT_VERSION: "v1.54"
 
 jobs:
@@ -51,7 +51,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version: ["1.21"]
+        go-version: ["1.24"]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -65,18 +65,31 @@ jobs:
       - name: Download dependencies
         run: go mod download
 
+      - name: Install gotestsum
+        run: go install gotest.tools/gotestsum@latest
+
       - name: Run tests
-        run: go test -v -cover -coverprofile=coverage.out ./internal/...
+        run: |
+          gotestsum --junitfile junit.xml --format testname -- -v -cover -coverprofile=coverage.out ./internal/...
+
+      - name: Upload test results
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: test-results
+          path: junit.xml
 
       - name: Upload coverage reports
         uses: codecov/codecov-action@v5
         if: matrix.go-version == env.GO_VERSION
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           slug: Trozz/terraform-provider-pocketid
-          file: ./coverage.out
+          files: ./coverage.out,./junit.xml
           flags: unittests
           name: codecov-umbrella
+          fail_ci_if_error: true
+          verbose: true
 
   build:
     name: Build
diff --git a/.golangci.yml b/.golangci.yml
@@ -1,45 +1,43 @@
-# .golangci.yml
-# Minimal configuration to avoid compatibility issues
-
+version: "2"
 run:
-  timeout: 5m
-  tests: true
   build-tags:
     - acc
-
+  tests: true
 linters:
-  disable-all: true
+  default: none
   enable:
-    # Enable only stable, essential linters
     - errcheck
-    - gosimple
     - govet
     - ineffassign
+    - misspell
     - staticcheck
-    - typecheck
     - unused
-    - gofmt
-    - goimports
-    - misspell
-
-linters-settings:
-  gofmt:
-    simplify: true
-  goimports:
-    local-prefixes: github.com/Trozz/terraform-provider-pocketid
-
+  exclusions:
+    generated: lax
+    rules:
+      - linters:
+          - errcheck
+        path: _test\.go
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
 issues:
-  exclude-use-default: false
-  max-same-issues: 0
   max-issues-per-linter: 0
-
-  # Exclude some linters from running on tests files.
-  exclude-rules:
-    - path: _test\.go
-      linters:
-        - errcheck
-
-output:
-  format: colored-line-number
-  print-issued-lines: true
-  print-linter-name: true
+  max-same-issues: 0
+formatters:
+  enable:
+    - gofmt
+    - goimports
+  settings:
+    gofmt:
+      simplify: true
+    goimports:
+      local-prefixes:
+        - github.com/Trozz/terraform-provider-pocketid
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,6 +20,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Tests for request timeout and context cancellation scenarios
 - Tests for JSON unmarshaling errors and network failures
 - Coverage report documentation (COVERAGE_REPORT.md)
+- Test analytics support with Codecov integration
+  - JUnit XML test result reporting for failed test analysis
+  - Enhanced CI workflow with gotestsum for better test output
+  - Codecov configuration for test analytics and coverage tracking
+  - New make targets: `test-junit` and `test-ci` for JUnit output
 
 ### Improved
 - Enhanced error handling throughout the client package
diff --git a/Makefile b/Makefile
@@ -51,14 +51,32 @@ install: build ## Build and install the provider locally
 .PHONY: test
 test: ## Run unit tests
 	@echo "$(GREEN)Running unit tests...$(NC)"
-	$(GOTEST) -v -cover -coverprofile=coverage.out ./internal/...
+	@if command -v gotestsum >/dev/null 2>&1; then \
+		echo "$(CYAN)Using gotestsum for enhanced test output...$(NC)"; \
+		gotestsum --junitfile junit.xml --format testname -- -v -cover -coverprofile=coverage.out ./internal/...; \
+	else \
+		$(GOTEST) -v -cover -coverprofile=coverage.out ./internal/...; \
+	fi
 	@echo "$(GREEN)Unit tests complete!$(NC)"
 
 .PHONY: test-coverage
 test-coverage: test ## Run tests and show coverage report
 	@echo "$(GREEN)Generating coverage report...$(NC)"
 	@go tool cover -html=coverage.out -o coverage.html
 	@echo "$(GREEN)Coverage report generated: coverage.html$(NC)"
+	@if [ -f junit.xml ]; then \
+		echo "$(GREEN)JUnit test report generated: junit.xml$(NC)"; \
+	fi
+
+.PHONY: test-junit
+test-junit: ## Run tests with JUnit XML output
+	@echo "$(GREEN)Running tests with JUnit output...$(NC)"
+	@if ! command -v gotestsum >/dev/null 2>&1; then \
+		echo "$(YELLOW)Installing gotestsum...$(NC)"; \
+		go install gotest.tools/gotestsum@latest; \
+	fi
+	@gotestsum --junitfile junit.xml --format testname -- -v -cover -coverprofile=coverage.out ./internal/...
+	@echo "$(GREEN)Tests complete! JUnit report: junit.xml$(NC)"
 
 .PHONY: test-acc
 test-acc: ## Run acceptance tests (requires POCKETID_BASE_URL and POCKETID_API_TOKEN)
@@ -134,7 +152,7 @@ docs-preview: ## Preview documentation in browser
 clean: ## Clean build artifacts
 	@echo "$(GREEN)Cleaning build artifacts...$(NC)"
 	@rm -f $(BINARY_NAME)
-	@rm -f coverage.out coverage.html
+	@rm -f coverage.out coverage.html junit.xml
 	@rm -rf dist/
 	@echo "$(GREEN)Clean complete!$(NC)"
 
@@ -201,6 +219,18 @@ test-integration: ## Run integration tests against live Pocket-ID instance
 	@cd test && terraform init && terraform apply -auto-approve
 	@echo "$(GREEN)Integration tests complete!$(NC)"
 
+.PHONY: test-ci
+test-ci: ## Run tests in CI format with JUnit output
+	@echo "$(GREEN)Running tests in CI format...$(NC)"
+	@if ! command -v gotestsum >/dev/null 2>&1; then \
+		echo "$(YELLOW)Installing gotestsum...$(NC)"; \
+		go install gotest.tools/gotestsum@latest; \
+	fi
+	@gotestsum --junitfile junit.xml --format standard-verbose -- -v -race -cover -coverprofile=coverage.out ./internal/...
+	@echo "$(GREEN)CI tests complete!$(NC)"
+	@echo "  Coverage report: coverage.out"
+	@echo "  JUnit report: junit.xml"
+
 .PHONY: test-cleanup
 test-cleanup: ## Clean up integration test resources
 	@echo "$(GREEN)Cleaning up test resources...$(NC)"
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![Terraform Registry](https://img.shields.io/badge/Terraform%20Registry-v0.1.0-blue)](https://registry.terraform.io/providers/trozz/pocketid/latest)
 [![CI](https://github.com/Trozz/terraform-provider-pocketid/actions/workflows/ci.yml/badge.svg)](https://github.com/Trozz/terraform-provider-pocketid/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/Trozz/terraform-provider-pocketid/branch/main/graph/badge.svg)](https://codecov.io/gh/Trozz/terraform-provider-pocketid)
 [![Go Report Card](https://goreportcard.com/badge/github.com/Trozz/terraform-provider-pocketid)](https://goreportcard.com/report/github.com/Trozz/terraform-provider-pocketid)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
@@ -198,6 +199,47 @@ Acceptance tests require a manually configured Pocket-ID instance:
 
 See [TESTING.md](TESTING.md) for detailed testing instructions and strategies.
 
+### Test Analytics
+
+This project uses [Codecov](https://codecov.io) for code coverage and test analytics:
+
+[![codecov](https://codecov.io/gh/Trozz/terraform-provider-pocketid/branch/main/graph/badge.svg)](https://codecov.io/gh/Trozz/terraform-provider-pocketid)
+
+#### Features
+
+- **Code Coverage**: Track test coverage across all packages
+- **Test Analytics**: Monitor test performance and identify flaky tests
+- **Failed Test Reporting**: Get detailed reports on test failures
+- **PR Comments**: Automatic coverage reports on pull requests
+
+#### Running Tests with JUnit Output
+
+For detailed test reporting, use `gotestsum`:
+
+```bash
+# Install gotestsum if not already installed
+go install gotest.tools/gotestsum@latest
+
+# Run tests with JUnit XML output
+make test-junit
+
+# Or run in CI format
+make test-ci
+```
+
+This generates:
+- `coverage.out` - Code coverage report
+- `junit.xml` - JUnit format test results for test analytics
+
+#### Local Coverage Report
+
+Generate an HTML coverage report:
+
+```bash
+make test-coverage
+# Opens coverage.html in your default browser
+```
+
 ### Local Development
 
 1. Start a local Pocket-ID instance:
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,89 @@
+# Codecov configuration for Terraform PocketID Provider
+# https://docs.codecov.com/docs/codecovyml-reference
+
+# Coverage configuration
+coverage:
+  precision: 2
+  round: down
+  range: "30...100"
+
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+        paths:
+          - "internal/"
+        if_not_found: success
+        if_ci_failed: error
+        informational: false
+        only_pulls: false
+
+    patch:
+      default:
+        target: 80%
+        threshold: 10%
+        if_not_found: success
+        if_ci_failed: error
+        informational: false
+        only_pulls: false
+
+# Test analytics configuration
+# https://docs.codecov.com/docs/test-analytics
+test_analytics:
+  enabled: true
+
+# Flags configuration for different test types
+flags:
+  unittests:
+    paths:
+      - internal/
+    carryforward: true
+
+# Comment configuration
+comment:
+  layout: "reach,diff,flags,tree,betaprofiling"
+  behavior: default
+  require_changes: false
+  require_base: true
+  require_head: true
+  show_carryforward_flags: true
+  show_critical_paths: true
+
+  # Test results in PR comments
+  show_test_results: true
+
+# Ignore certain files/paths
+ignore:
+  - "**/*_test.go"
+  - "**/testdata/**"
+  - "examples/**"
+  - "docs/**"
+  - "*.md"
+  - "go.mod"
+  - "go.sum"
+  - ".github/**"
+  - ".gitignore"
+  - "LICENSE"
+  - "Makefile"
+  - ".golangci.yml"
+  - ".goreleaser.yml"
+
+# Parsers configuration
+parsers:
+  junit:
+    branch_detection:
+      conditional: true
+      loop: true
+      method: false
+      macro: false
+
+# GitHub integration
+github_checks:
+  annotations: true
+
+# Codecov CI settings
+codecov:
+  require_ci_to_pass: true
+  notify:
+    wait_for_ci: true
