Merge pull request #258 from 1Password/andi_t/add_credential_name_id

Add IDs to credentials based on their name

Author: AndyTitu

plugins/registry_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	"github.com/1Password/shell-plugins/sdk/schema"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestValidatePlugins(t *testing.T) {
@@ -17,3 +18,12 @@ func TestValidatePlugins(t *testing.T) {
 		}
 	}
 }
+
+func TestAllPluginsHaveUniqueNames(t *testing.T) {
+	var pluginNames []string
+	for _, p := range registry {
+		pluginNames = append(pluginNames, p.Name)
+	}
+
+	assert.True(t, schema.IsStringSliceASet(pluginNames))
+}

sdk/names.go

@@ -1,5 +1,10 @@
 package sdk
 
+import (
+	"regexp"
+	"strings"
+)
+
 // FieldName represents a name of credential field. It should be title-cased.
 // Examples: "Password", "Token", "API Key".
 type FieldName string
@@ -15,3 +20,30 @@ type CredentialName string
 func (n CredentialName) String() string {
 	return string(n)
 }
+
+func (n CredentialName) ID() CredentialTypeID {
+	return CredentialTypeID(credentialNameToSnakeCase(n))
+}
+
+func credentialNameToSnakeCase(name CredentialName) string {
+	const underscore = "_"
+
+	str := name.String()
+
+	charsToReplace := regexp.MustCompile(`[-/,. ]`)
+	str = charsToReplace.ReplaceAllLiteralString(str, underscore)
+
+	multipleUnderscores := regexp.MustCompile(`_+`)
+	str = multipleUnderscores.ReplaceAllString(str, underscore)
+
+	str = strings.TrimPrefix(str, "_")
+	str = strings.TrimSuffix(str, "_")
+
+	return strings.ToLower(str)
+}
+
+type CredentialTypeID string
+
+func (i CredentialTypeID) String() string {
+	return string(i)
+}

sdk/schema/credname/names_test.go

@@ -0,0 +1,70 @@
+package credname
+
+import (
+	"testing"
+
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGettingCredentialIDsFromNames(t *testing.T) {
+	names := []sdk.CredentialName{
+		APIClientCredentials,
+		APIKey,
+		APIToken,
+		AccessKey,
+		AccessToken,
+		AppPassword,
+		AppToken,
+		AuthToken,
+		CLIToken,
+		Credential,
+		Credentials,
+		DatabaseCredentials,
+		LoginDetails,
+		PersonalAPIToken,
+		PersonalAccessToken,
+		RegistryCredentials,
+		SecretKey,
+		sdk.CredentialName(""),
+		sdk.CredentialName("Database-specific Credentials"),
+		sdk.CredentialName("Public/Private Key-Pair"),
+		sdk.CredentialName("Public/Private Key Pair"),
+		sdk.CredentialName("KeyPair"),
+		sdk.CredentialName("___some-test/name "),
+		sdk.CredentialName("this -is/NOT-a, real. _- /  life---- scENARIo..."),
+		sdk.CredentialName("___some,.other test/name-which -is/NOT-a, real. , - ./ - life_scENARIo..."),
+	}
+
+	expectedIDs := []string{
+		"api_client_credentials",
+		"api_key",
+		"api_token",
+		"access_key",
+		"access_token",
+		"app_password",
+		"app_token",
+		"auth_token",
+		"cli_token",
+		"credential",
+		"credentials",
+		"database_credentials",
+		"login_details",
+		"personal_api_token",
+		"personal_access_token",
+		"registry_credentials",
+		"secret_key",
+		"",
+		"database_specific_credentials",
+		"public_private_key_pair",
+		"public_private_key_pair",
+		"keypair",
+		"some_test_name",
+		"this_is_not_a_real_life_scenario",
+		"some_other_test_name_which_is_not_a_real_life_scenario",
+	}
+
+	for i, name := range names {
+		assert.Equal(t, expectedIDs[i], name.ID().String())
+	}
+}

sdk/schema/plugin.go

@@ -84,6 +84,12 @@ func (p Plugin) Validate() (bool, ValidationReport) {
 		Severity:    ValidationSeverityError,
 	})
 
+	report.AddCheck(ValidationCheck{
+		Description: "Credentials are uniquely identifiable inside a plugin",
+		Assertion:   NoDuplicateCredentials(p),
+		Severity:    ValidationSeverityError,
+	})
+
 	return report.IsValid(), report
 }
 

sdk/schema/validation.go

@@ -112,3 +112,27 @@ func CredentialReferencesInCredentialList(plugin Plugin) bool {
 	}
 	return true
 }
+
+func NoDuplicateCredentials(plugin Plugin) bool {
+	var ids []string
+	for _, credential := range plugin.Credentials {
+		ids = append(ids, credential.Name.ID().String())
+	}
+
+	return IsStringSliceASet(ids)
+}
+
+func IsStringSliceASet(slice []string) bool {
+	for i, s := range slice {
+		if i == len(slice)-1 {
+			break
+		}
+		for _, ss := range slice[i+1:] {
+			if ss == s {
+				return false
+			}
+		}
+	}
+
+	return true
+}

sdk/schema/validation_test.go

@@ -135,3 +135,33 @@ func TestPluginValidateEachReportFieldHasError(t *testing.T) {
 
 	assert.False(t, c.Assertion, fmt.Sprintf("\"%s\" validation is erroneous", c.Description))
 }
+
+func TestIsStringSliceASet(t *testing.T) {
+	testCases := []struct {
+		slice     []string
+		assertion bool
+	}{
+		{
+			slice:     []string{"a", "b", "c", "b", "d"},
+			assertion: false,
+		}, {
+			slice:     []string{"a", "a", "a", "a", "a"},
+			assertion: false,
+		}, {
+			slice:     []string{"a", "a", "c", "d", "e"},
+			assertion: false,
+		}, {
+			slice:     []string{"a", "b", "c", "d", "d"},
+			assertion: false,
+		}, {
+			slice:     []string{"a", "b", "c", "d", "e"},
+			assertion: true,
+		}, {
+			slice:     []string{"a", "b", "b", "b", "d"},
+			assertion: false,
+		},
+	}
+	for _, tc := range testCases {
+		assert.Equal(t, tc.assertion, IsStringSliceASet(tc.slice))
+	}
+}