feat: 1Password#201 Completed TODO tasks, tidied tests

ammiranda · Oct 29, 2023 · d475bf1 · d475bf1
1 parent 98153a2
commit d475bf1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 52 deletions.
diff --git a/plugins/shopify/cli_token.go b/plugins/shopify/cli_token.go
@@ -1,8 +1,6 @@
 package shopify
 
 import (
-	"context"
-
 	"github.com/1Password/shell-plugins/sdk"
 	"github.com/1Password/shell-plugins/sdk/importer"
 	"github.com/1Password/shell-plugins/sdk/provision"
@@ -14,16 +12,16 @@ import (
 func CLIToken() schema.CredentialType {
 	return schema.CredentialType{
 		Name:          credname.CLIToken,
-		DocsURL:       sdk.URL("https://shopify.com/docs/cli_token"), // TODO: Replace with actual URL
-		ManagementURL: sdk.URL("https://console.shopify.com/user/security/tokens"), // TODO: Replace with actual URL
+		DocsURL:       sdk.URL("https://shopify.dev/docs/apps/tools/cli/ci-cd#step-2-generate-a-cli-authentication-token"),
+		ManagementURL: sdk.URL("https://partners.shopify.com/"),
 		Fields: []schema.CredentialField{
 			{
 				Name:                fieldname.Token,
 				MarkdownDescription: "Token used to authenticate to Shopify.",
 				Secret:              true,
 				Composition: &schema.ValueComposition{
 					Length: 69,
-					Prefix: "atkn_", // TODO: Check if this is correct
+					Prefix: "atkn_",
 					Charset: schema.Charset{
 						Lowercase: true,
 						Digits:    true,
@@ -34,37 +32,9 @@ func CLIToken() schema.CredentialType {
 		DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping),
 		Importer: importer.TryAll(
 			importer.TryEnvVarPair(defaultEnvVarMapping),
-			TryShopifyConfigFile(),
 		)}
 }
 
 var defaultEnvVarMapping = map[string]sdk.FieldName{
-	"SHOPIFY_TOKEN": fieldname.Token, // TODO: Check if this is correct
-}
-
-// TODO: Check if the platform stores the CLI Token in a local config file, and if so,
-// implement the function below to add support for importing it.
-func TryShopifyConfigFile() sdk.Importer {
-	return importer.TryFile("~/path/to/config/file.yml", func(ctx context.Context, contents importer.FileContents, in sdk.ImportInput, out *sdk.ImportAttempt) {
-		// var config Config
-		// if err := contents.ToYAML(&config); err != nil {
-		// 	out.AddError(err)
-		// 	return
-		// }
-
-		// if config.Token == "" {
-		// 	return
-		// }
-
-		// out.AddCandidate(sdk.ImportCandidate{
-		// 	Fields: map[sdk.FieldName]string{
-		// 		fieldname.Token: config.Token,
-		// 	},
-		// })
-	})
+	"SHOPIFY_TOKEN": fieldname.Token,
 }
-
-// TODO: Implement the config file schema
-// type Config struct {
-//	Token string
-// }
diff --git a/plugins/shopify/cli_token_test.go b/plugins/shopify/cli_token_test.go
@@ -2,16 +2,16 @@ package shopify
 
 import (
 	"testing"
-	
+
 	"github.com/1Password/shell-plugins/sdk"
 	"github.com/1Password/shell-plugins/sdk/plugintest"
 	"github.com/1Password/shell-plugins/sdk/schema/fieldname"
 )
-	
+
 func TestCLITokenProvisioner(t *testing.T) {
 	plugintest.TestProvisioner(t, CLIToken().DefaultProvisioner, map[string]plugintest.ProvisionCase{
 		"default": {
-			ItemFields: map[sdk.FieldName]string{ // TODO: Check if this is correct
+			ItemFields: map[sdk.FieldName]string{
 				fieldname.Token: "atkn_0mgpyi6brmpxduriv7ukpp9r3lcjgsld7357svtw5fey5vlyriyauwxhgexample",
 			},
 			ExpectedOutput: sdk.ProvisionOutput{
@@ -26,7 +26,7 @@ func TestCLITokenProvisioner(t *testing.T) {
 func TestCLITokenImporter(t *testing.T) {
 	plugintest.TestImporter(t, CLIToken().Importer, map[string]plugintest.ImportCase{
 		"environment": {
-			Environment: map[string]string{ // TODO: Check if this is correct
+			Environment: map[string]string{
 				"SHOPIFY_TOKEN": "atkn_0mgpyi6brmpxduriv7ukpp9r3lcjgsld7357svtw5fey5vlyriyauwxhgexample",
 			},
 			ExpectedCandidates: []sdk.ImportCandidate{
@@ -37,19 +37,5 @@ func TestCLITokenImporter(t *testing.T) {
 				},
 			},
 		},
-		// TODO: If you implemented a config file importer, add a test file example in shopify/test-fixtures
-		// and fill the necessary details in the test template below.
-		"config file": {
-			Files: map[string]string{
-				// "~/path/to/config.yml": plugintest.LoadFixture(t, "config.yml"),
-			},
-			ExpectedCandidates: []sdk.ImportCandidate{
-			// 	{
-			// 		Fields: map[sdk.FieldName]string{
-			// 			fieldname.Token: "atkn_0mgpyi6brmpxduriv7ukpp9r3lcjgsld7357svtw5fey5vlyriyauwxhgexample",
-			// 		},
-			// 	},
-			},
-		},
 	})
 }