Create package evidence using cli #21
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
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,48 @@ | ||
| package cli | ||
|
|
||
| import ( | ||
| "github.com/jfrog/jfrog-cli-artifactory/evidence" | ||
| "github.com/jfrog/jfrog-cli-core/v2/plugins/components" | ||
| coreConfig "github.com/jfrog/jfrog-cli-core/v2/utils/config" | ||
| "github.com/jfrog/jfrog-client-go/utils/errorutils" | ||
| ) | ||
|
|
||
| type evidencePackageCommand struct { | ||
| ctx *components.Context | ||
| execute execCommandFunc | ||
| } | ||
|
|
||
| func NewEvidencePackageCommand(ctx *components.Context, execute execCommandFunc) EvidenceCommands { | ||
| return &evidencePackageCommand{ | ||
| ctx: ctx, | ||
| execute: execute, | ||
| } | ||
| } | ||
|
|
||
| func (epc *evidencePackageCommand) CreateEvidence(ctx *components.Context, serverDetails *coreConfig.ServerDetails) error { | ||
| err := epc.validateEvidencePackageContext(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| createCmd := evidence.NewCreateEvidencePackage( | ||
| serverDetails, | ||
| epc.ctx.GetStringFlagValue(predicate), | ||
| epc.ctx.GetStringFlagValue(predicateType), | ||
| epc.ctx.GetStringFlagValue(key), | ||
| epc.ctx.GetStringFlagValue(KeyAlias), | ||
| epc.ctx.GetStringFlagValue(packageName), | ||
| epc.ctx.GetStringFlagValue(packageVersion), | ||
| epc.ctx.GetStringFlagValue(packageRepoName)) | ||
| return epc.execute(createCmd) | ||
| } | ||
|
|
||
| func (epc *evidencePackageCommand) validateEvidencePackageContext(ctx *components.Context) error { | ||
| if !ctx.IsFlagSet(packageVersion) || assertValueProvided(ctx, packageVersion) != nil { | ||
| return errorutils.CheckErrorf("'packageVersion' is a mandatory field for creating a Package evidence: --%s", packageVersion) | ||
| } | ||
| if !ctx.IsFlagSet(packageRepoName) || assertValueProvided(ctx, packageRepoName) != nil { | ||
| return errorutils.CheckErrorf("'packageRepoName' is a mandatory field for creating a Package evidence: --%s", packageRepoName) | ||
| } | ||
| return nil | ||
| } | ||
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 |
|---|---|---|
|
|
@@ -12,4 +12,5 @@ var subjectTypes = []string{ | |
| subjectRepoPath, | ||
| releaseBundle, | ||
| buildName, | ||
| packageName, | ||
| } | ||
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,129 @@ | ||
| package evidence | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "github.com/jfrog/jfrog-cli-artifactory/evidence/model" | ||
| "github.com/jfrog/jfrog-cli-core/v2/artifactory/utils" | ||
| "github.com/jfrog/jfrog-cli-core/v2/utils/config" | ||
| coreConfig "github.com/jfrog/jfrog-cli-core/v2/utils/config" | ||
| "github.com/jfrog/jfrog-client-go/artifactory" | ||
| "github.com/jfrog/jfrog-client-go/artifactory/services" | ||
| "github.com/jfrog/jfrog-client-go/metadata" | ||
| "github.com/jfrog/jfrog-client-go/utils/errorutils" | ||
| "github.com/jfrog/jfrog-client-go/utils/log" | ||
| ) | ||
|
|
||
| const leadArtifactQueryTemplate = `{ | ||
|
There was a problem hiding this comment. Why putting a const if you dont use it as const? There was a problem hiding this comment. i tried to change it, but i think also is not bad to have it private const here since its too long and a bit confusing to have it directly inside the small method. |
||
| "query": "{versions(filter: {packageId: \"%s\", name: \"%s\", repositoriesIn: [{name: \"%s\"}]}) { edges { node { repos { name leadFilePath } } } } }" | ||
| }` | ||
|
|
||
| type createEvidencePackage struct { | ||
| createEvidenceBase | ||
| packageName string | ||
| packageVersion string | ||
| packageRepoName string | ||
| } | ||
|
|
||
| func NewCreateEvidencePackage(serverDetails *coreConfig.ServerDetails, predicateFilePath, predicateType, key, keyId, packageName, | ||
| packageVersion, packageRepoName string) Command { | ||
| return &createEvidencePackage{ | ||
| createEvidenceBase: createEvidenceBase{ | ||
| serverDetails: serverDetails, | ||
| predicateFilePath: predicateFilePath, | ||
| predicateType: predicateType, | ||
| key: key, | ||
| keyId: keyId, | ||
| }, | ||
| packageName: packageName, | ||
| packageVersion: packageVersion, | ||
| packageRepoName: packageRepoName, | ||
| } | ||
| } | ||
|
|
||
| func (c *createEvidencePackage) CommandName() string { | ||
| return "create-package-evidence" | ||
| } | ||
|
|
||
| func (c *createEvidencePackage) ServerDetails() (*config.ServerDetails, error) { | ||
| return c.serverDetails, nil | ||
| } | ||
|
|
||
| func (c *createEvidencePackage) Run() error { | ||
| artifactoryClient, err := c.createArtifactoryClient() | ||
| if err != nil { | ||
| log.Error("failed to create Artifactory client", err) | ||
| return err | ||
| } | ||
| metadataClient, err := utils.CreateMetadataServiceManager(c.serverDetails, false) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| packageType, err := c.getPackageType(artifactoryClient) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| leadArtifact, err := c.getPackageVersionLeadArtifact(packageType, metadataClient) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| leadArtifactPath := c.buildLeadArtifactPath(leadArtifact) | ||
| leadArtifactChecksum, err := c.getFileChecksum(leadArtifactPath, artifactoryClient) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| envelope, err := c.createEnvelope(leadArtifactPath, leadArtifactChecksum) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| err = c.uploadEvidence(envelope, leadArtifactPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (c *createEvidencePackage) getPackageType(artifactoryClient artifactory.ArtifactoryServicesManager) (string, error) { | ||
| var request services.RepositoryDetails | ||
| err := artifactoryClient.GetRepository(c.packageRepoName, &request) | ||
| if err != nil { | ||
| return "", errorutils.CheckErrorf("No such package: %s/%s", c.packageRepoName, c.packageVersion) | ||
| } | ||
| return request.PackageType, nil | ||
| } | ||
|
|
||
| func (c *createEvidencePackage) getPackageVersionLeadArtifact(packageType string, metadataClient metadata.Manager) (string, error) { | ||
| body, err := metadataClient.GraphqlQuery(c.createQuery(packageType)) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| res := &model.GraphqlResponse{} | ||
| err = json.Unmarshal(body, res) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| if len(res.Data.Versions.Edges) == 0 { | ||
| return "", errorutils.CheckErrorf("No such package: %s/%s", c.packageRepoName, c.packageVersion) | ||
| } | ||
|
|
||
| // Fetch the leadFilePath based on repoName | ||
| for _, repo := range res.Data.Versions.Edges[0].Node.Repos { | ||
| if repo.Name == c.packageRepoName { | ||
| return repo.LeadFilePath, nil | ||
| } | ||
| } | ||
| return "", errorutils.CheckErrorf("Can't find lead artifact of pacakge: %s/%s", c.packageRepoName, c.packageVersion) | ||
| } | ||
|
|
||
| func (c *createEvidencePackage) createQuery(packageType string) []byte { | ||
| packageId := packageType + "://" + c.packageName | ||
| return []byte(fmt.Sprintf(leadArtifactQueryTemplate, packageId, c.packageVersion, c.packageRepoName)) | ||
| } | ||
|
|
||
| func (c *createEvidencePackage) buildLeadArtifactPath(leadArtifact string) string { | ||
| return fmt.Sprintf("%s/%s", c.packageRepoName, leadArtifact) | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this command, and also in the existing build/release-bundle commands: we should not log the internal names of the variables - having
packageVersionorpackageRepoNamein the logs is confusing.Instead, we should mention only those names, which a client is supposed to use, for example:
--%s is a mandatory parameter for creating a Package evidenceThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done