Improve Unit Test Coverage by cjimti · Pull Request #340 · txn2/kubefwd

cjimti · 2025-12-30T07:22:14Z

This PR adds comprehensive unit tests to improve code coverage across multiple packages, bringing overall coverage from ~62% to 63.5% with significant improvements in individual packages.

Coverage Improvements

Package	Before	After	Change
`pkg/fwdmcp`	63.6%	65.4%	+1.8%
`pkg/fwdmetrics`	65.1%	80.6%	+15.5%
`pkg/fwdapi`	48.0%	56.8%	+8.8%
`pkg/fwdns`	44.8%	46.5%	+1.7%
`pkg/fwdsvcregistry`	67.1%	91.4%	+24.3%
Overall	~62%	63.5%	+1.5%

New Test Files

`pkg/fwdmcp/httpclient_test.go`

Added tests for HTTP client adapter functions:

TestStateReaderHTTP_GetForward - Tests getting a single forward
TestMetricsProviderHTTP_GetServiceSnapshot - Tests service snapshot retrieval
TestDiagnosticsProviderHTTP_GetServiceDiagnostic - Tests service diagnostics
TestDiagnosticsProviderHTTP_GetForwardDiagnostic - Tests forward diagnostics
TestDiagnosticsProviderHTTP_GetNetworkStatus - Tests network status
TestNewAPIUnavailableError - Tests API error constructor

`pkg/fwdmetrics/registry_test.go`

Added tests for metrics registry operations:

TestRegistryRegisterUnregisterService - Service registration lifecycle
TestRegistryGetServiceNotFound - Non-existent service handling
TestRegistryUnregisterPortForward - Port forward unregistration
TestRegistryUnregisterPortForwardWithMultiple - Multiple port forwards
TestRegistryGetAllServices - Get all services
TestRegistryGetTotals - Aggregated totals across services
TestServiceMetricsGetTotals - Service-level totals
TestServiceMetricsRemovePortForward - Port forward removal
TestPortForwardMetricsKey - Key generation
TestPortForwardMetricsServiceKey - Service key generation
TestPortForwardMetricsEnableHTTPSniffing - HTTP sniffing feature

`pkg/fwdmetrics/stream_test.go`

Added tests for metrics stream wrapper:

TestMetricsStreamClose - Stream close delegation
TestMetricsStreamReset - Stream reset delegation
TestMetricsStreamHeaders - Headers passthrough
TestMetricsStreamIdentifier - Stream identifier
TestMetricsStreamMultipleOperations - Combined operations

`pkg/fwdapi/logbuffer_test.go`

Added tests for log buffer functionality:

TestBoundedSize - Size boundary checks (CodeQL CWE-770 compliance)
TestNewLogBuffer - Buffer creation
TestLogBufferAdd - Entry addition
TestLogBufferAddWrap - Ring buffer wrapping
TestLogBufferGetLast - Recent entry retrieval
TestLogBufferGetAll - All entries retrieval
TestLogBufferClear - Buffer clearing
TestLogBufferHookLevels - Logrus hook levels
TestLogBufferHookFire - Hook firing
TestGetLogBuffer - Global buffer singleton
TestGetLogBufferProvider - Provider interface
TestInitLogBuffer - Initialization
TestLogBufferConcurrency - Thread safety

`pkg/fwdapi/manager_test.go` (extended)

Added tests for manager interface setters:

TestManager_SetDiagnosticsProvider
TestManager_SetNamespaceController
TestManager_SetServiceCRUD
TestManager_SetKubernetesDiscovery
TestManager_GetNamespaceManager
TestNamespaceControllerMethods - Interface methods
TestServiceCRUDMethods - CRUD interface methods
TestKubernetesDiscoveryMethods - K8s discovery interface

`pkg/fwdns/manager_test.go` (extended)

Added tests for namespace manager:

TestManager_GetWatcherByKey - Watcher lookup by key
TestNamespaceWatcher_Done - Done channel behavior

`pkg/fwdsvcregistry/fwdsvcregistry_test.go` (extended)

Added tests using fake K8s client:

TestGet_ExistingService - Get existing service
TestGet_NonExistentService - Get non-existent service
TestGetAll - Get all services
TestGetAll_Empty - Empty registry
TestGetByNamespace - Filter by namespace
TestGetByNamespace_DifferentContexts - Multi-context filtering

Testing Approach

httptest-based testing - Used Go's net/http/httptest package for HTTP client tests in fwdmcp
Fake K8s client - Used k8s.io/client-go/kubernetes/fake for testing code that interacts with Kubernetes APIs
Interface mocking - Created mock implementations for interfaces like StateReader, MetricsProvider, ServiceController, etc.
Concurrency testing - Added tests for thread-safe operations with sync.WaitGroup and race condition checks

Packages Not Addressed

Some packages remain at lower coverage due to their nature:

pkg/fwdtui (20.6%) - Requires Bubble Tea TUI mocking framework
pkg/fwdport (57.2%) - Requires SPDY port-forward connection mocking
cmd/kubefwd/services (14.8%) - Integration-level orchestration code
cmd/kubefwd (0%) - CLI entry point

Running Tests

# Run all tests
go test ./...

# Run with coverage
go test -cover ./...

# Generate coverage report
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

# Run specific package tests
go test -v ./pkg/fwdmetrics/...
go test -v ./pkg/fwdsvcregistry/...

Related Issues

Improves project testability for future contributions
Supports OpenSSF Scorecard "Maintained" check

- Includes pinned Python dependencies with hashes for use in documentation generation workflows.

…stallation with hashes

…r handling

… registry behavior, metrics aggregation, and HTTP sniffing.

…, including operations like `Read`, `Write`, `Close`, `Reset`, and header and identifier validation.

…, namespace controller, service CRUD, and Kubernetes discovery integrations

Covers `LogBuffer` behavior including initialization, bounded size, entry addition, retrieval (all, last), clearing, hook levels, logging hooks, and concurrency.

Refactor and expand test coverage for namespace controller, service CRUD, and Kubernetes discovery methods. Includes mock integrations for methods like `AddNamespace`, `ListNamespaces`, `GetNamespace`, `RemoveNamespace`, and corresponding service operations.

Covers `GetWatcherByKey` and `NamespaceWatcher.Done` methods, including watcher retrieval, channel handling, and validation.

Covers service retrieval methods including `Get`, `GetAll`, `GetByNamespace`, and handling of empty and non-existent services, as well as multiple contexts and namespaces.

codecov · 2025-12-30T07:25:43Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.67%. Comparing base (c762a68) to head (c3bdc17).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #340      +/-   ##
==========================================
+ Coverage   61.54%   63.67%   +2.13%     
==========================================
  Files          69       69              
  Lines       11071    11071              
==========================================
+ Hits         6814     7050     +236     
+ Misses       3981     3738     -243     
- Partials      276      283       +7

see 10 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

cjimti added 10 commits December 29, 2025 22:57

Add autogenerated requirements-docs.txt for docs dependencies

06cb795

- Includes pinned Python dependencies with hashes for use in documentation generation workflows.

Switch docs workflow to use requirements-docs.txt for dependency in…

912ee95

…stallation with hashes

Add unit tests for HTTP state readers, metrics, diagnostics, and erro…

d1734e0

…r handling

Add unit tests for pkg/fwdmetrics covering service and port forward…

a5e1dd1

… registry behavior, metrics aggregation, and HTTP sniffing.

Add unit tests for pkg/fwdmetrics covering MetricsStream behavior…

ca93510

…, including operations like `Read`, `Write`, `Close`, `Reset`, and header and identifier validation.

Add unit tests for pkg/fwdapi/manager covering diagnostics provider…

da74b31

…, namespace controller, service CRUD, and Kubernetes discovery integrations

Add unit tests for pkg/fwdapi/logbuffer

fbf27ba

Covers `LogBuffer` behavior including initialization, bounded size, entry addition, retrieval (all, last), clearing, hook levels, logging hooks, and concurrency.

Add unit tests for pkg/fwdns/manager_test

f2ab6f2

Covers `GetWatcherByKey` and `NamespaceWatcher.Done` methods, including watcher retrieval, channel handling, and validation.

Add unit tests for pkg/fwdsvcregistry

c3bdc17

Covers service retrieval methods including `Get`, `GetAll`, `GetByNamespace`, and handling of empty and non-existent services, as well as multiple contexts and namespaces.

cjimti merged commit 41931d2 into master Dec 30, 2025
9 of 11 checks passed

cjimti deleted the fix/security_scorecard branch December 30, 2025 19:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve Unit Test Coverage#340

Improve Unit Test Coverage#340
cjimti merged 10 commits intomasterfrom
fix/security_scorecard

cjimti commented Dec 30, 2025

Uh oh!

codecov bot commented Dec 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

cjimti commented Dec 30, 2025

Coverage Improvements

New Test Files

pkg/fwdmcp/httpclient_test.go

pkg/fwdmetrics/registry_test.go

pkg/fwdmetrics/stream_test.go

pkg/fwdapi/logbuffer_test.go

pkg/fwdapi/manager_test.go (extended)

pkg/fwdns/manager_test.go (extended)

pkg/fwdsvcregistry/fwdsvcregistry_test.go (extended)

Testing Approach

Packages Not Addressed

Running Tests

Related Issues

Uh oh!

codecov bot commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

`pkg/fwdmcp/httpclient_test.go`

`pkg/fwdmetrics/registry_test.go`

`pkg/fwdmetrics/stream_test.go`

`pkg/fwdapi/logbuffer_test.go`

`pkg/fwdapi/manager_test.go` (extended)

`pkg/fwdns/manager_test.go` (extended)

`pkg/fwdsvcregistry/fwdsvcregistry_test.go` (extended)

codecov bot commented Dec 30, 2025 •

edited

Loading