Add comprehensive test coverage reporting and documentation enhancements

- Add code coverage reporting to unit and integration tests
- Enhance testing documentation with coverage details
- Fix core library dependency issue by removing invalid replace directive

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>

Author: tiwillia

.gitignore

@@ -28,6 +28,8 @@
 /config/master.key
 
 /coverage
+coverage-*.out
+coverage-*.html
 
 # Ignore built binaries
 /trex

Makefile

@@ -60,6 +60,8 @@ jwks_url:=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-con
 # Test output files
 unit_test_json_output ?= ${PWD}/unit-test-results.json
 integration_test_json_output ?= ${PWD}/integration-test-results.json
+unit_coverage_output ?= ${PWD}/coverage-unit.out
+integration_coverage_output ?= ${PWD}/coverage-integration.out
 
 # Prints a list of useful targets.
 help:
@@ -74,6 +76,8 @@ help:
 	@echo "make run/docs             run swagger and host the api spec"
 	@echo "make test                 run unit tests"
 	@echo "make test-integration     run integration tests"
+	@echo "make coverage-html        generate HTML coverage reports"
+	@echo "make coverage-func        show function-level coverage summary"
 	@echo "make generate             generate openapi modules"
 	@echo "make image                build docker image"
 	@echo "make push                 push docker image"
@@ -171,7 +175,7 @@ install: check-gopath
 # Examples:
 #   make test TESTFLAGS="-run TestSomething"
 test: install
-	OCM_ENV=testing gotestsum --format short-verbose -- -p 1 -v $(TESTFLAGS) \
+	OCM_ENV=testing gotestsum --format short-verbose -- -p 1 -v -coverprofile=$(unit_coverage_output) -coverpkg=./... $(TESTFLAGS) \
 		./pkg/... \
 		./cmd/...
 .PHONY: test
@@ -185,7 +189,7 @@ test: install
 #   make test-unit-json TESTFLAGS="-run TestSomething"
 ci-test-unit: install
 	@echo $(db_password) > ${PWD}/secrets/db.password
-	OCM_ENV=testing gotestsum --jsonfile-timing-events=$(unit_test_json_output) --format short-verbose -- -p 1 -v $(TESTFLAGS) \
+	OCM_ENV=testing gotestsum --jsonfile-timing-events=$(unit_test_json_output) --format short-verbose -- -p 1 -v -coverprofile=$(unit_coverage_output) -coverpkg=./... $(TESTFLAGS) \
 		./pkg/... \
 		./cmd/...
 .PHONY: ci-test-unit
@@ -202,7 +206,7 @@ ci-test-unit: install
 #   make test-integration TESTFLAGS="-short"                skips long-run tests
 ci-test-integration: install
 	@echo $(db_password) > ${PWD}/secrets/db.password
-	OCM_ENV=testing gotestsum --jsonfile-timing-events=$(integration_test_json_output) --format $(TEST_SUMMARY_FORMAT) -- -p 1 -ldflags -s -v -timeout 1h $(TESTFLAGS) \
+	OCM_ENV=testing gotestsum --jsonfile-timing-events=$(integration_test_json_output) --format $(TEST_SUMMARY_FORMAT) -- -p 1 -ldflags -s -v -timeout 1h -coverprofile=$(integration_coverage_output) -coverpkg=./... $(TESTFLAGS) \
 			./test/integration
 .PHONY: ci-test-integration
 
@@ -218,7 +222,7 @@ ci-test-integration: install
 #   make test-integration TESTFLAGS="-short"                skips long-run tests
 test-integration: install
 	@echo $(db_password) > ${PWD}/secrets/db.password
-	OCM_ENV=testing gotestsum --format $(TEST_SUMMARY_FORMAT) -- -p 1 -ldflags -s -v -timeout 1h $(TESTFLAGS) \
+	OCM_ENV=testing gotestsum --format $(TEST_SUMMARY_FORMAT) -- -p 1 -ldflags -s -v -timeout 1h -coverprofile=$(integration_coverage_output) -coverpkg=./... $(TESTFLAGS) \
 			./test/integration
 .PHONY: test-integration
 
@@ -242,12 +246,37 @@ run/docs:
 	docker run -d -p 80:8080 -e SWAGGER_JSON=/trex.yaml -v $(PWD)/openapi/rh-trex.yaml:/trex.yaml swaggerapi/swagger-ui
 .PHONY: run/docs
 
+# Run coverage reports
+coverage-html:
+	@if [ -f $(unit_coverage_output) ]; then \
+		go tool cover -html=$(unit_coverage_output) -o coverage-unit.html; \
+		echo "Unit test coverage report generated: coverage-unit.html"; \
+	fi
+	@if [ -f $(integration_coverage_output) ]; then \
+		go tool cover -html=$(integration_coverage_output) -o coverage-integration.html; \
+		echo "Integration test coverage report generated: coverage-integration.html"; \
+	fi
+.PHONY: coverage-html
+
+coverage-func:
+	@if [ -f $(unit_coverage_output) ]; then \
+		echo "=== Unit Test Coverage ==="; \
+		go tool cover -func=$(unit_coverage_output); \
+	fi
+	@if [ -f $(integration_coverage_output) ]; then \
+		echo "=== Integration Test Coverage ==="; \
+		go tool cover -func=$(integration_coverage_output); \
+	fi
+.PHONY: coverage-func
+
 # Delete temporary files
 clean:
 	rm -rf \
 		$(binary) \
 		templates/*-template.json \
 		data/generated/openapi/*.json \
+		coverage-*.out \
+		coverage-*.html \
 .PHONY: clean
 
 .PHONY: cmds

docs/framework-development/README.md

@@ -66,12 +66,15 @@ make test
 ## Testing Framework Changes
 
 ```bash
-# Unit tests
+# Unit tests with coverage
 make test
 
-# Integration tests  
+# Integration tests with coverage
 make test-integration
 
+# Generate coverage reports
+make coverage-html
+
 # Test generator
 go run ./scripts/generate/main.go --kind TestEntity
 make generate
@@ -81,6 +84,8 @@ make test
 go run ./scripts/clone/main.go --name test-clone --destination /tmp/test
 ```
 
+For detailed testing information, see the **[Testing Guide](../reference/testing-guide.md)**.
+
 ## Code Style
 
 - **Semantic naming** - Clear, purpose-driven names

docs/operations/README.md

@@ -23,8 +23,9 @@ make binary            # Build TRex
 make run               # Start the service
 
 # Development workflow
-make test              # Run unit tests
-make test-integration  # Run integration tests
+make test              # Run unit tests with coverage
+make test-integration  # Run integration tests with coverage
+make coverage-html     # Generate coverage reports
 make db/teardown       # Clean up database
 ```
 

docs/operations/local-development.md

@@ -63,13 +63,21 @@ rh-trex=# \dt
 ## Testing
 
 ```shell
-# Run unit tests
+# Run unit tests with coverage
 make test
 
-# Run integration tests
+# Run integration tests with coverage
 make test-integration
+
+# Generate HTML coverage reports
+make coverage-html
+
+# View coverage summary in terminal
+make coverage-func
 ```
 
+For comprehensive testing documentation, see the **[Testing Guide](../reference/testing-guide.md)**.
+
 ## Running the Service
 
 ```shell

docs/reference/README.md

@@ -11,6 +11,7 @@ Complete technical reference for TRex APIs, configuration, and commands.
 
 - **[Configuration Options](configuration-options.md)** - All environment variables and settings
 - **[Command Reference](command-reference.md)** - CLI commands and options
+- **[Testing Guide](testing-guide.md)** - Comprehensive testing and code coverage documentation
 
 ## Technical Specifications
 

docs/reference/command-reference.md

@@ -53,14 +53,17 @@ make db/migrate             # Equivalent to: ./trex migrate
 
 ### Testing Commands
 ```bash
-# Run unit tests
+# Run unit tests (with coverage)
 make test
 
-# Run integration tests
+# Run integration tests (with coverage)
 make test-integration
 
-# Run tests with coverage
-make test-coverage
+# Generate HTML coverage reports
+make coverage-html
+
+# Show function-level coverage summary
+make coverage-func
 
 # Run CI tests (JSON output)
 make ci-test-unit