Merge pull request #316 from siddhikhapare/upstashplugin

Upstash shell plugin added

plugins/upstash/api_key.go

@@ -0,0 +1,82 @@
+package upstash
+
+import (
+	"context"
+
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/importer"
+	"github.com/1Password/shell-plugins/sdk/provision"
+	"github.com/1Password/shell-plugins/sdk/schema"
+	"github.com/1Password/shell-plugins/sdk/schema/credname"
+	"github.com/1Password/shell-plugins/sdk/schema/fieldname"
+)
+
+func APIKey() schema.CredentialType {
+	return schema.CredentialType{
+		Name:          credname.APIKey,
+		DocsURL:       sdk.URL("https://docs.upstash.com/redis/account/developerapi#create-an-api-key"),
+		ManagementURL: sdk.URL("https://console.upstash.com/account/api"),
+		Fields: []schema.CredentialField{
+			{
+				Name:                fieldname.APIKey,
+				MarkdownDescription: "API Key used to authenticate to Upstash.",
+				Secret:              true,
+				Composition: &schema.ValueComposition{
+					Length: 36,
+					Charset: schema.Charset{
+						Lowercase: true,
+						Digits:    true,
+						Symbols:   true,
+					},
+				},
+			},
+			{
+				Name:                fieldname.Email,
+				MarkdownDescription: "Email used to authenticate to Upstash.",
+				Composition: &schema.ValueComposition{
+					Charset: schema.Charset{
+						Uppercase: true,
+						Lowercase: true,
+						Digits:    true,
+						Symbols:   true,
+					},
+				},
+			},
+		},
+		DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping),
+		Importer: importer.TryAll(
+			importer.TryEnvVarPair(defaultEnvVarMapping),
+			TryUpstashConfigFile(),
+		)}
+}
+
+var defaultEnvVarMapping = map[string]sdk.FieldName{
+	"UPSTASH_API_KEY": fieldname.APIKey,
+	"UPSTASH_EMAIL":   fieldname.Email,
+}
+
+func TryUpstashConfigFile() sdk.Importer {
+	return importer.TryFile("~/.upstash.json", func(ctx context.Context, contents importer.FileContents, in sdk.ImportInput, out *sdk.ImportAttempt) {
+		var config Config
+		if err := contents.ToJSON(&config); err != nil {
+			out.AddError(err)
+			return
+		}
+
+		if config.APIKey == "" && config.Email == "" {
+			return
+		}
+
+		out.AddCandidate(sdk.ImportCandidate{
+			Fields: map[sdk.FieldName]string{
+				fieldname.APIKey: config.APIKey,
+				fieldname.Email:  config.Email,
+			},
+		})
+	})
+}
+
+type Config struct {
+	APIKey string `json:"apiKey"`
+	Email  string `json:"email"`
+}

plugins/upstash/api_key_test.go

@@ -0,0 +1,59 @@
+package upstash
+
+import (
+	"testing"
+
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/plugintest"
+	"github.com/1Password/shell-plugins/sdk/schema/fieldname"
+)
+
+func TestAPIKeyProvisioner(t *testing.T) {
+	plugintest.TestProvisioner(t, APIKey().DefaultProvisioner, map[string]plugintest.ProvisionCase{
+		"default": {
+			ItemFields: map[sdk.FieldName]string{
+				fieldname.APIKey: "d68850db-69f7-qxe9pubcmjnqfgyexample",
+				fieldname.Email:  "wendy@appleseed.com",
+			},
+			ExpectedOutput: sdk.ProvisionOutput{
+				Environment: map[string]string{
+					"UPSTASH_API_KEY": "d68850db-69f7-qxe9pubcmjnqfgyexample",
+					"UPSTASH_EMAIL":   "wendy@appleseed.com",
+				},
+			},
+		},
+	})
+}
+
+func TestAPIKeyImporter(t *testing.T) {
+	plugintest.TestImporter(t, APIKey().Importer, map[string]plugintest.ImportCase{
+		"environment": {
+			Environment: map[string]string{
+				"UPSTASH_API_KEY": "d68850db-69f7-qxe9pubcmjnqfgyexample",
+				"UPSTASH_EMAIL":   "wendy@appleseed.com",
+			},
+			ExpectedCandidates: []sdk.ImportCandidate{
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.APIKey: "d68850db-69f7-qxe9pubcmjnqfgyexample",
+						fieldname.Email:  "wendy@appleseed.com",
+					},
+				},
+			},
+		},
+
+		"config file": {
+			Files: map[string]string{
+				"~/.upstash.json": plugintest.LoadFixture(t, ".upstash.json"),
+			},
+			ExpectedCandidates: []sdk.ImportCandidate{
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.APIKey: "d68850db-69f7-qxe9pubcmjnqfgyexample",
+						fieldname.Email:  "wendy@appleseed.com",
+					},
+				},
+			},
+		},
+	})
+}

plugins/upstash/plugin.go

@@ -0,0 +1,22 @@
+package upstash
+
+import (
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/schema"
+)
+
+func New() schema.Plugin {
+	return schema.Plugin{
+		Name: "upstash",
+		Platform: schema.PlatformInfo{
+			Name:     "Upstash",
+			Homepage: sdk.URL("https://upstash.com"),
+		},
+		Credentials: []schema.CredentialType{
+			APIKey(),
+		},
+		Executables: []schema.Executable{
+			UpstashCLI(),
+		},
+	}
+}

plugins/upstash/test-fixtures/.upstash.json

@@ -0,0 +1,4 @@
+{
+    "apiKey":"d68850db-69f7-qxe9pubcmjnqfgyexample",
+    "email" : "wendy@appleseed.com"
+}

plugins/upstash/upstash.go

@@ -0,0 +1,28 @@
+package upstash
+
+import (
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/needsauth"
+	"github.com/1Password/shell-plugins/sdk/schema"
+	"github.com/1Password/shell-plugins/sdk/schema/credname"
+)
+
+func UpstashCLI() schema.Executable {
+	return schema.Executable{
+		Name:    "Upstash CLI",
+		Runs:    []string{"upstash"},
+		DocsURL: sdk.URL("https://github.com/upstash/cli"),
+		NeedsAuth: needsauth.IfAll(
+			needsauth.NotForHelpOrVersion(),
+			needsauth.NotWithoutArgs(),
+			needsauth.NotWhenContainsArgs("--config"),
+			needsauth.NotWhenContainsArgs("-c"),
+			needsauth.NotWhenContainsArgs("auth"),
+		),
+		Uses: []schema.CredentialUsage{
+			{
+				Name: credname.APIKey,
+			},
+		},
+	}
+}