diff --git a/plugins/ibmcloud/api_key.go b/plugins/ibmcloud/api_key.go new file mode 100644 index 000000000..7853d95cd --- /dev/null +++ b/plugins/ibmcloud/api_key.go @@ -0,0 +1,40 @@ +package ibmcloud + +import ( + "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://cloud.ibm.com/docs/account?topic=account-userapikey"), + ManagementURL: sdk.URL("https://cloud.ibm.com/iam/apikeys"), + Fields: []schema.CredentialField{ + { + Name: fieldname.APIKey, + MarkdownDescription: "API Key used to authenticate to IBM Cloud.", + Secret: true, + Composition: &schema.ValueComposition{ + Length: 44, + Charset: schema.Charset{ + Uppercase: true, + Lowercase: true, + Digits: true, + }, + }, + }, + }, + DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping), + Importer: importer.TryAll( + importer.TryEnvVarPair(defaultEnvVarMapping), + )} +} + +var defaultEnvVarMapping = map[string]sdk.FieldName{ + "IBMCLOUD_API_KEY": fieldname.APIKey, +} diff --git a/plugins/ibmcloud/api_key_test.go b/plugins/ibmcloud/api_key_test.go new file mode 100644 index 000000000..064dc146f --- /dev/null +++ b/plugins/ibmcloud/api_key_test.go @@ -0,0 +1,41 @@ +package ibmcloud + +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: "tjLKgtZ5MSkC9zhSVGCeSfbxBbqr7KCbkfFaHEXAMPLE", + }, + ExpectedOutput: sdk.ProvisionOutput{ + Environment: map[string]string{ + "IBMCLOUD_API_KEY": "tjLKgtZ5MSkC9zhSVGCeSfbxBbqr7KCbkfFaHEXAMPLE", + }, + }, + }, + }) +} + +func TestAPIKeyImporter(t *testing.T) { + plugintest.TestImporter(t, APIKey().Importer, map[string]plugintest.ImportCase{ + "environment": { + Environment: map[string]string{ + "IBMCLOUD_API_KEY": "tjLKgtZ5MSkC9zhSVGCeSfbxBbqr7KCbkfFaHEXAMPLE", + }, + ExpectedCandidates: []sdk.ImportCandidate{ + { + Fields: map[sdk.FieldName]string{ + fieldname.APIKey: "tjLKgtZ5MSkC9zhSVGCeSfbxBbqr7KCbkfFaHEXAMPLE", + }, + }, + }, + }, + }) +} diff --git a/plugins/ibmcloud/ibmcloud.go b/plugins/ibmcloud/ibmcloud.go new file mode 100644 index 000000000..97544f382 --- /dev/null +++ b/plugins/ibmcloud/ibmcloud.go @@ -0,0 +1,35 @@ +package ibmcloud + +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 IBMCloudCLI() schema.Executable { + return schema.Executable{ + Name: "IBM Cloud CLI", + Runs: []string{"ibmcloud"}, + DocsURL: sdk.URL("https://cloud.ibm.com/docs/cli"), + NeedsAuth: needsauth.IfAll( + needsauth.NotForHelpOrVersion(), + needsauth.NotWithoutArgs(), + needsauth.NotWhenContainsArgs("-u"), + needsauth.NotWhenContainsArgs("-p"), + needsauth.NotWhenContainsArgs("--apikey"), + needsauth.NotWhenContainsArgs("--cr-token"), + needsauth.NotWhenContainsArgs("--vpc-cri"), + needsauth.NotWhenContainsArgs("--profile"), + needsauth.NotWhenContainsArgs("--sso"), + needsauth.NotWhenContainsArgs("-c"), + needsauth.NotWhenContainsArgs("--no-account"), + needsauth.NotWhenContainsArgs("logout"), + ), + Uses: []schema.CredentialUsage{ + { + Name: credname.APIKey, + }, + }, + } +} diff --git a/plugins/ibmcloud/plugin.go b/plugins/ibmcloud/plugin.go new file mode 100644 index 000000000..c40623aae --- /dev/null +++ b/plugins/ibmcloud/plugin.go @@ -0,0 +1,22 @@ +package ibmcloud + +import ( + "github.com/1Password/shell-plugins/sdk" + "github.com/1Password/shell-plugins/sdk/schema" +) + +func New() schema.Plugin { + return schema.Plugin{ + Name: "ibmcloud", + Platform: schema.PlatformInfo{ + Name: "IBM Cloud", + Homepage: sdk.URL("https://www.ibm.com/cloud"), + }, + Credentials: []schema.CredentialType{ + APIKey(), + }, + Executables: []schema.Executable{ + IBMCloudCLI(), + }, + } +}