Render CLI Shell plugin

plugins/render/api_key.go

@@ -0,0 +1,85 @@
+package render
+
+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"
+ "gopkg.in/yaml.v2"
+)
+
+type Config struct {
+ Profiles map[string]Profile
+}
+
+type Profile struct {
+ APIKey string `yaml:"apiKey"`
+}
+
+func APIKey() schema.CredentialType {
+ return schema.CredentialType{
+ Name: credname.APIKey,
+ DocsURL: sdk.URL("https://render.com/docs"),
+ ManagementURL: sdk.URL("https://dashboard.render.com/u/settings#api-keys"),
+ Fields: []schema.CredentialField{
+ {
+ Name: fieldname.APIKey,
+ MarkdownDescription: "API Key used to authenticate to Render.",
+ Secret: true,
+ Composition: &schema.ValueComposition{
+ Length: 30,
+ Charset: schema.Charset{
+ Uppercase: true,
+ Lowercase: true,
+ Digits: true,
+ },
+ },
+ },
+ },
+ DefaultProvisioner: provision.TempFile(renderConfig, provision.AtFixedPath("~/.render/config.yaml")),
+ Importer: TryRenderConfigFile(),
+ }
+}
+
+func renderConfig(in sdk.ProvisionInput) ([]byte, error) {
+ config := Config{
+ Profiles: map[string]Profile{
+ "default": {
+ APIKey: in.ItemFields[fieldname.APIKey],
+ },
+ },
+ }
+
+ contents, err := yaml.Marshal(&config)
+ if err != nil {
+ return nil, err
+ }
+ return []byte(contents), nil
+}
+
+func TryRenderConfigFile() sdk.Importer {
+ return importer.TryFile("~/.render/config.yaml", 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
+ }
+
+ for profileName, profile := range config.Profiles {
+ if profile.APIKey == "" {
+ continue
+ }
+
+ out.AddCandidate(sdk.ImportCandidate{
+ Fields: map[sdk.FieldName]string{
+ fieldname.APIKey: profile.APIKey,
+ },
+ NameHint: importer.SanitizeNameHint(profileName),
+ })
+ }
+ })
+}

plugins/render/api_key_test.go

@@ -0,0 +1,43 @@
+package render
+
+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: "rnd_Z7xMKp4NX1FoQNRyBpZs9yxDbu3i",
+ },
+ ExpectedOutput: sdk.ProvisionOutput{
+ Files: map[string]sdk.OutputFile{
+ "~/.render/config.yaml": {
+ Contents: []byte(plugintest.LoadFixture(t, "config.yaml") + "\n"),
+ },
+ },
+ },
+ },
+ })
+}
+
+func TestAPIKeyImporter(t *testing.T) {
+ plugintest.TestImporter(t, APIKey().Importer, map[string]plugintest.ImportCase{
+ "config file": {
+ Files: map[string]string{
+ "~/.render/config.yaml": plugintest.LoadFixture(t, "config.yaml"),
+ },
+ ExpectedCandidates: []sdk.ImportCandidate{
+ {
+ Fields: map[sdk.FieldName]string{
+ fieldname.APIKey: "rnd_Z7xMKp4NX1FoQNRyBpZs9yxDbu3i",
+ },
+ },
+ },
+ },
+ })
+}

plugins/render/plugin.go

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

plugins/render/render.go

@@ -0,0 +1,30 @@
+package render
+
+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 RenderCLI() schema.Executable {
+ return schema.Executable{
+ Name: "Render CLI",
+ Runs: []string{"render"},
+ DocsURL: sdk.URL("https://render.com/docs/cli"),
+ NeedsAuth: needsauth.IfAll(
+ needsauth.NotForHelpOrVersion(),
+ needsauth.NotWithoutArgs(),
+ needsauth.NotWhenContainsArgs("config"),
+ needsauth.NotWhenContainsArgs("jobs"),
+ needsauth.NotWhenContainsArgs("deploys"),
+ needsauth.NotWhenContainsArgs("repo"),
+ needsauth.NotWhenContainsArgs("services"),
+ ),
+ Uses: []schema.CredentialUsage{
+ {
+ Name: credname.APIKey,
+ },
+ },
+ }
+}

plugins/render/test-fixtures/config.yaml

@@ -0,0 +1,3 @@
+profiles:
+ default:
+ apiKey: rnd_Z7xMKp4NX1FoQNRyBpZs9yxDbu3i