Merge pull request #263 from arunsathiya/fix/164-missing-field-name

fix(new-plugin): Set only the last word of the credential name as the field name, if it's larger than seven characters

Author: SimonBarendse

cmd/contrib/main.go

@@ -189,21 +189,18 @@ func newPlugin() error {
 		}
 	}
 
-	// As a placeholder, assume the field name is the short version (max 7 chars) of the credential name, starting
-	// from the last word. For example:
+	// As a placeholder, assume the field name is the short version (max 7 chars) of the credential name, starting from the last word.
+	//
+	// When the last word of the credential name is greater than seven characters, the last word is used as the field name.
+	//
+	// For example:
 	// "Personal Access Token" => "Token"
 	// "Secret Key" => "Key"
 	// "API Key" => "API Key"
-	var fieldNameSplit []string
+	// "GitHub API Key" => "API Key"
+	// "Credentials" => "Credentials"
 	lengthCutoff := 7
-	for i := range credNameSplit {
-		word := credNameSplit[len(credNameSplit)-1-i]
-		if len(strings.Join(append(fieldNameSplit, word), " ")) > lengthCutoff {
-			break
-		}
-
-		fieldNameSplit = append([]string{word}, fieldNameSplit...)
-	}
+	fieldNameSplit := fieldNameSplitFromCredNameSplit(credNameSplit, lengthCutoff)
 	result.FieldName = strings.Join(fieldNameSplit, " ")
 	result.FieldNameUpperCamelCase = strings.Join(fieldNameSplit, "")
 	result.CredentialEnvVarName = strings.ToUpper(strings.Join(append([]string{result.Name}, fieldNameSplit...), "_"))
@@ -636,3 +633,28 @@ func generateRegistryJSON() error {
 	}
 	return os.WriteFile(filepath.Join("plugins", "registry.json"), b, 0600)
 }
+
+// fieldNameSplitFromCredNameSplit takes in a credential name split array and returns a field name split array.
+//
+// As a placeholder, assume the field name is the short version (max 7 chars, including space between words) of the credential name, starting from the last word.
+//
+// When the last word of the credential name is greater than seven characters, the last word is used as the field name.
+//
+// For example:
+//
+//	"Personal Access Token" => "Token"
+//	"Secret Key" => "Key"
+//	"API Key" => "API Key"
+//	"GitHub API Key" => "API Key"
+//	"Credentials" => "Credentials"
+func fieldNameSplitFromCredNameSplit(credNameSplit []string, lengthCutoff int) []string {
+	fieldNameSplit := []string{credNameSplit[len(credNameSplit)-1]}
+	for i := len(credNameSplit) - 2; i >= 0; i-- {
+		word := credNameSplit[i]
+		if len(strings.Join(append(fieldNameSplit, word), " ")) > lengthCutoff {
+			break
+		}
+		fieldNameSplit = append([]string{word}, fieldNameSplit...)
+	}
+	return fieldNameSplit
+}

cmd/contrib/main_test.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -27,3 +28,41 @@ func TestValidateCredentialNameReturnError(t *testing.T) {
 		})
 	}
 }
+
+type FieldNameSplitFromCredNameSplit struct {
+	FieldNameSplit []string
+	CredNameSplit  []string
+}
+
+func TestValidateFieldNameSplitFromCredNameSplit(t *testing.T) {
+	lengthCutoff := 7
+	cases := []FieldNameSplitFromCredNameSplit{
+		{
+			CredNameSplit:  []string{"Personal", "Access", "Token"},
+			FieldNameSplit: []string{"Token"},
+		},
+		{
+			CredNameSplit:  []string{"Secret", "Key"},
+			FieldNameSplit: []string{"Key"},
+		},
+		{
+			CredNameSplit:  []string{"API", "Key"},
+			FieldNameSplit: []string{"API", "Key"},
+		},
+		{
+			CredNameSplit:  []string{"GitHub", "API", "Key"},
+			FieldNameSplit: []string{"API", "Key"},
+		},
+		{
+			CredNameSplit:  []string{"Credentials"},
+			FieldNameSplit: []string{"Credentials"},
+		},
+	}
+
+	for _, c := range cases {
+		t.Run(strings.Join(c.CredNameSplit, " "), func(t *testing.T) {
+			fieldNameSplit := fieldNameSplitFromCredNameSplit(c.CredNameSplit, lengthCutoff)
+			assert.Equal(t, c.FieldNameSplit, fieldNameSplit)
+		})
+	}
+}