Feat/custom user agent#14
Merged
Merged
Conversation
Set custom User-Agent header to identify API requests as coming from pup CLI rather than the generic datadog-api-client-go library. This enables better tracking and analytics of pup CLI usage in Datadog API logs. Changes: - Added getUserAgent() function that formats user agent as "pup/<version> (go <version>; os <os>; arch <arch>)" - Set configuration.UserAgent in New() for datadog API client (pkg/client/client.go:77) - Set User-Agent header in RawRequest() for raw HTTP requests (pkg/client/client.go:139) - Imported runtime package for OS/arch information - Imported internal/version package for pup version The user agent will now identify requests as: pup/dev (go go1.21.0; os darwin; arch arm64) This applies to both: 1. API calls through the datadog-api-client-go library 2. Raw HTTP requests through the RawRequest method The format matches datadog-api-client-go's getUserAgent() implementation, using the same structure: "<tool>/<version> (go <version>; os <os>; arch <arch>)" Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add comprehensive unit tests to verify custom User-Agent header is correctly set in both API client and raw HTTP requests. Changes: - Added TestGetUserAgent() to verify user agent format (pkg/client/client_test.go:494) - Added TestRawRequest_UserAgentHeader() to verify header in raw requests (pkg/client/client_test.go:537) - Added TestNew_SetsCustomUserAgent() to verify client configuration (pkg/client/client_test.go:603) - Added runtime and internal/version imports for testing Test results show User-Agent is correctly set as: pup/dev (go go1.25.0; os darwin; arch arm64) All tests pass: ✓ TestGetUserAgent - verifies format and content ✓ TestRawRequest_UserAgentHeader - verifies header in HTTP requests ✓ TestNew_SetsCustomUserAgent - verifies client configuration Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
📊 Test Coverage ReportOverall Coverage: 75.5% Threshold: 80% ❌ Coverage by Package📈 Coverage Status: ❌ FAILED - Coverage below minimum threshold Updated for commit 48c4990 |
…nt tests Replace redundant unit tests with comprehensive integration tests that verify the User-Agent header is set through the entire request flow. Changes: - Removed TestRawRequest_UserAgentHeader() - redundant with integration test - Removed TestNew_SetsCustomUserAgent() - redundant with integration tests - Added TestClient_IntegrationUserAgentInRawRequest() - integration test that verifies User-Agent is set when using RawRequest() method (client_test.go:538) - Added TestClient_IntegrationUserAgentInAPIClient() - integration test that captures actual API client requests using custom HTTP transport to verify User-Agent header is used (client_test.go:628) - Added captureTransport helper type to intercept HTTP requests - Added datadogV1 import for testing with monitors API Final test suite: ✓ TestGetUserAgent() - unit test for getUserAgent() function ✓ TestClient_IntegrationUserAgentInRawRequest() - integration test for RawRequest ✓ TestClient_IntegrationUserAgentInAPIClient() - integration test for API client These integration tests verify the complete flow from New() through actual HTTP requests, ensuring User-Agent is properly configured and used. Coverage maintained at 90.7% Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove TestClient_IntegrationUserAgentInRawRequest() - it was simulating the implementation instead of testing the actual method. RawRequest() just calls getUserAgent() on line 139, which is already covered by TestGetUserAgent() and TestClient_IntegrationUserAgentInAPIClient(). Coverage maintained at 90.7% Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
platinummonkey
approved these changes
Feb 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Use a custom user agent to track requests coming from pup
Checklist