-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
583 additions
and
7 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/go-resty/resty/v2" | ||
| log "github.com/sirupsen/logrus" | ||
|
|
||
| "github.com/cyralinc/dmap/scan" | ||
| ) | ||
|
|
||
| const ( | ||
| dataLabelsPath = "/v1/datalabels" | ||
| classificationsPath = "/v1/repositories/{repoExternalID}/classifications" | ||
| ) | ||
|
|
||
| // Classifications is the Dmap API representation of a set of data | ||
| // classifications. | ||
| type Classifications struct { | ||
| Classifications []Classification `json:"classifications"` | ||
| } | ||
|
|
||
| // Labels is the Dmap API representation of a set of data labels. | ||
| type Labels struct { | ||
| Labels []Label `json:"labels"` | ||
| } | ||
|
|
||
| // Classification is the Dmap API representation of a single data | ||
| // classification. | ||
| type Classification struct { | ||
| Label string `json:"label"` | ||
| AttributePath []string `json:"attributePath"` | ||
| } | ||
|
|
||
| // Label is the Dmap API representation of a single data label. | ||
| type Label struct { | ||
| Name string `json:"name"` | ||
| Description string `json:"description"` | ||
| Tags []string `json:"tags"` | ||
| } | ||
|
|
||
| // RequestError is an error that occurs when an HTTP request to the Dmap API | ||
| // fails. | ||
| type RequestError struct { | ||
| StatusCode int | ||
| Status string | ||
| Body string | ||
| } | ||
|
|
||
| // Error returns a string representation of the RequestError, and implements | ||
| // the error interface. | ||
| func (e RequestError) Error() string { | ||
| return fmt.Sprintf("HTTP request error: status = %s, status code = %d, body = %s", e.Status, e.StatusCode, e.Body) | ||
| } | ||
|
|
||
| // DmapClient is a client for the Dmap HTTP API. | ||
| type DmapClient struct { | ||
| client *resty.Client | ||
| } | ||
|
|
||
| // NewDmapClient creates a new DmapClient. | ||
| func NewDmapClient(baseURL, clientID, clientSecret string) *DmapClient { | ||
| client := resty.New(). | ||
| SetBaseURL(baseURL). | ||
| SetBasicAuth(clientID, clientSecret). | ||
| SetLogger(log.StandardLogger()) | ||
| if log.GetLevel() == log.DebugLevel || log.GetLevel() == log.TraceLevel { | ||
| client.SetDebug(true) | ||
| } | ||
| return &DmapClient{client: client} | ||
| } | ||
|
|
||
| // UpsertLabels upserts the given labels to the Dmap API. All existing labels | ||
| // are replaced with the given labels. If an error occurs, it is returned. | ||
| func (c *DmapClient) UpsertLabels(ctx context.Context, labels Labels) error { | ||
| resp, err := c.client.R(). | ||
| SetContext(ctx). | ||
| SetBody(labels). | ||
| Put(dataLabelsPath) | ||
| if err != nil || resp.IsError() { | ||
| if err == nil { | ||
| err = RequestError{ | ||
| StatusCode: resp.StatusCode(), | ||
| Status: resp.Status(), | ||
| Body: resp.String(), | ||
| } | ||
| } | ||
| return fmt.Errorf("HTTP request error upserting labels: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // UpsertClassifications upserts the given classifications to the Dmap API for | ||
| // the given repository external ID. All existing classifications for the | ||
| // repository are replaced with the given classifications. If an error occurs, | ||
| // it is returned. | ||
| func (c *DmapClient) UpsertClassifications( | ||
| ctx context.Context, | ||
| repoExternalID string, | ||
| classifications Classifications, | ||
| ) error { | ||
| resp, err := c.client.R(). | ||
| SetContext(ctx). | ||
| SetBody(classifications). | ||
| SetPathParams(map[string]string{"repoExternalID": repoExternalID}). | ||
| Put(classificationsPath) | ||
| if err != nil || resp.IsError() { | ||
| if err == nil { | ||
| err = RequestError{ | ||
| StatusCode: resp.StatusCode(), | ||
| Status: resp.Status(), | ||
| Body: resp.String(), | ||
| } | ||
| } | ||
| return fmt.Errorf( | ||
| "HTTP request error upserting classifications for repo external ID %s: %w", | ||
| repoExternalID, | ||
| err, | ||
| ) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // PublishRepoScanResults publishes the given repository scan results (labels | ||
| // and classifications) to the Dmap API. If an error occurs, it is returned. | ||
| // Note that this operation is not atomic and may result in partial updates to | ||
| // the Dmap API if an error occurs. | ||
| func (c *DmapClient) PublishRepoScanResults( | ||
| ctx context.Context, | ||
| repoExternalID string, | ||
| results *scan.RepoScanResults, | ||
| ) error { | ||
| labels := make([]Label, len(results.Labels)) | ||
| for i, label := range results.Labels { | ||
| labels[i] = Label{ | ||
| Name: label.Name, | ||
| Description: label.Description, | ||
| Tags: label.Tags, | ||
| } | ||
| } | ||
| if err := c.UpsertLabels(ctx, Labels{Labels: labels}); err != nil { | ||
| return fmt.Errorf("error upserting labels: %w", err) | ||
| } | ||
| classifications := make([]Classification, 0, len(results.Classifications)) | ||
| for _, classification := range results.Classifications { | ||
| for label := range classification.Labels { | ||
| classifications = append( | ||
| classifications, | ||
| Classification{ | ||
| Label: label, | ||
| AttributePath: classification.AttributePath, | ||
| }, | ||
| ) | ||
| } | ||
| } | ||
| if err := c.UpsertClassifications( | ||
| ctx, | ||
| repoExternalID, | ||
| Classifications{Classifications: classifications}, | ||
| ); err != nil { | ||
| return fmt.Errorf("error upserting classifications for repo external ID %s: %w", repoExternalID, err) | ||
| } | ||
| return nil | ||
| } |
Oops, something went wrong.