Skip to content

set custom User-Agent header for BlackDuck API requests #5782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hgresa24 wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −0
Open

set custom User-Agent header for BlackDuck API requests #5782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions cmd/detectExecuteScan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ func newBlackduckSystem(config detectExecuteScanOptions) *blackduckSystem {
sys := blackduckSystem{
Client: bd.NewClient(config.Token, config.ServerURL, &piperhttp.Client{}),
}
commitShortSHA := "unknown"
if len(GitCommit) >= 7 {
commitShortSHA = GitCommit[:7]
}
sys.Client.UserAgent = fmt.Sprintf("piper-detectExecuteScan-%s", commitShortSHA)
return &sys
}

Expand Down
5 changes: 5 additions & 0 deletions pkg/blackduck/blackduck.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ type Client struct {
httpClient piperhttp.Sender
serverURL string
projectVersion *ProjectVersion
UserAgent string
}

// NewClient creates a new BlackDuck client
Expand Down Expand Up @@ -543,6 +544,10 @@ func (b *Client) sendRequest(method, apiEndpoint string, params map[string]strin
header.Add("Authorization", fmt.Sprintf("Bearer %v", b.BearerToken))
}

if b.UserAgent != "" {
header.Set("User-Agent", b.UserAgent)
}

response, err := b.httpClient.SendRequest(method, blackDuckAPIUrl.String(), nil, header, nil)
if err != nil {
return responseBody, fmt.Errorf("request to BlackDuck API failed: %w", err)
Expand Down
Loading