✨ feature: List artifacts + inspect individual artifacts #22
Conversation
queer
commented
Mar 23, 2023
queer
commented
cmd/helpdocs/artifact.md
Outdated
| # artifact command help docs | ||
|
|
||
| TODO |
There was a problem hiding this comment.
Unsure how to best fill this out
| func GetArtifact(client graphql.Client, orgID string, artifactID string) (*Artifact, error) { | ||
| // TODO(amy): The backend needs to permit service accounts to run this query! |
There was a problem hiding this comment.
I haaaaaaaaate it and should/probably-will follow up w/ a PR for this
There was a problem hiding this comment.
There’s nothing more permanent than a temporary solution ;)
|
|
||
| query getAllArtifacts($organizationId: ID!) { | ||
| artifacts(organizationId: $organizationId, input: {}) { | ||
| next | ||
| items { | ||
| id | ||
| name | ||
| type | ||
| data | ||
| artifactDefinition { | ||
| id | ||
| name | ||
| schema | ||
| url | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| query getAllArtifactsPaginated($organizationId: ID!, $after: String!) { | ||
| artifacts(organizationId: $organizationId, input: {after: $after}) { | ||
| next | ||
| items { | ||
| id | ||
| name | ||
| type | ||
| data | ||
| artifactDefinition { | ||
| id | ||
| name | ||
| schema | ||
| url | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Awkward and I hate it, but I can't pass a nil string when the query is getAllArtifacts($orgId: ID!, $after: String)? Maybe I'm just not used to Go's type system...
There was a problem hiding this comment.
Not sure I follow. Is the backend typed not nil? I see a “!” In the Gql
you’ll need a string pointer to pass nil or pass a “nilish” string “”
| var artifactInfoCommand = &cobra.Command{ | ||
| Use: "info <artifact id>", | ||
| Aliases: []string{"i"}, | ||
| Short: "Get information about an artifact", |
There was a problem hiding this comment.
I’d like to keep the CLI verb oriented get/list/create
| func runListArtifacts(cmd *cobra.Command, args []string) error { | ||
| c := config.Get() | ||
| client := api.NewClient(c.URL, c.APIKey) | ||
| artifacts, err := api.GetAllArtifacts(client, c.OrgID) |
There was a problem hiding this comment.
Push all logic and presentation down into commands/
| return err | ||
| } | ||
|
|
||
| fmt.Println("Artifacts:") |
There was a problem hiding this comment.
Use a bubble tea table for presenting a table of items
| func runArtifactInfo(cmd *cobra.Command, args []string) error { | ||
| c := config.Get() | ||
| client := api.NewClient(c.URL, c.APIKey) | ||
| artifact, err := api.GetArtifact(client, c.OrgID, args[0]) |
There was a problem hiding this comment.
Same notes as above regarding command and bubble tea. We are trying to keep the cobra command as soon as possible and encapsulate all of the display logic.
| ID string | ||
| Type string | ||
| ArtifactDefinition ArtifactDefinition | ||
| Data interface{} |
There was a problem hiding this comment.
I believe this is a map[string]interface{} since it’s JSON data
| func GetArtifact(client graphql.Client, orgID string, artifactID string) (*Artifact, error) { | ||
| // TODO(amy): The backend needs to permit service accounts to run this query! |
There was a problem hiding this comment.
There’s nothing more permanent than a temporary solution ;)
| {"massdriver/azure-service-principal"}, | ||
| {"massdriver/gcp-service-account"}, | ||
| {"massdriver/kubernetes-cluster"}, | ||
| {"massdriver/aws-iam-role", "AWS IAM Role", ""}, |
There was a problem hiding this comment.
Why are these changing? This is specifically for integrating credentials definitions not all artifacts … we also have a mediocre inflector that does this. If we need it elsewhere we should bring it up from the arttdef table UI component as a strict function Titleize()
but also still curious why credential struct being modified wrt listing all artifacts
| id | ||
| name | ||
| type | ||
| data |
There was a problem hiding this comment.
Suspect re: data here. @xpositivityx are we auditing this field access?
|
|
||
| query getAllArtifacts($organizationId: ID!) { | ||
| artifacts(organizationId: $organizationId, input: {}) { | ||
| next | ||
| items { | ||
| id | ||
| name | ||
| type | ||
| data | ||
| artifactDefinition { | ||
| id | ||
| name | ||
| schema | ||
| url | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| query getAllArtifactsPaginated($organizationId: ID!, $after: String!) { | ||
| artifacts(organizationId: $organizationId, input: {after: $after}) { | ||
| next | ||
| items { | ||
| id | ||
| name | ||
| type | ||
| data | ||
| artifactDefinition { | ||
| id | ||
| name | ||
| schema | ||
| url | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Not sure I follow. Is the backend typed not nil? I see a “!” In the Gql
you’ll need a string pointer to pass nil or pass a “nilish” string “”
| "github.com/massdriver-cloud/mass/internal/api" | ||
| ) | ||
|
|
||
| func GetAllArtifacts(client graphql.Client, orgID string, name string) ([]api.Artifact, error) { |
There was a problem hiding this comment.
ListArtifacts to stay consistent
logic in your cobra commands should be moved here + tests
Goal is to make commands/ testable versions of the cobra commands but without any terminal I/O flag parsing outputting to files etc
