comments

Author: davidgamero

.github/workflows/integration-linux.yml

@@ -444,8 +444,6 @@ jobs:
           npm install -g [email protected]
           ajv validate -s test/update_dry_run_schema.json -d test/temp/update_dry_run.json
       - run: ./draft -v update -d ./langtest/ -a webapp_routing --variable ingress-tls-cert-keyvault-uri=test.cert.keyvault.uri --variable ingress-use-osm-mtls=true --variable ingress-host=host1
-      - name: print manifests
-        run: cat ./langtest/manifests/*
       - name: start minikube
         id: minikube
         uses: medyagh/setup-minikube@master

cmd/setup-gh.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"path/filepath"
 	"strings"
+	"unicode"
 
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
 	"github.com/Azure/draft/pkg/cred"
@@ -40,7 +41,7 @@ application and service principle, and will configure that application to trust
 			}
 			az, err := providers.NewAzClient(azCred)
 			if err != nil {
-				return fmt.Errorf("getting credentials: %w", err)
+				return fmt.Errorf("creating azure client: %w", err)
 			}
 			sc.AzClient = az
 
@@ -83,15 +84,20 @@ func fillSetUpConfig(sc *providers.SetUpCmd, gh providers.GhClient) error {
 	}
 
 	if sc.AppName == "" {
-		// make the default app name the current directory name plus "workflow" and a string
+		// Set the application name; default is the current directory name plus "-workflow".
 
 		// get the current directory name
-		dir, err := os.Getwd()
+		currentDir, err := os.Getwd()
 		if err != nil {
 			return fmt.Errorf("getting current directory: %w", err)
 		}
-		dirBase := filepath.Base(dir)
-		defaultAppName := dirBase + "-workflow"
+		defaultAppName := fmt.Sprintf("%s-workflow", filepath.Base(currentDir))
+		defaultAppName, err = toValidAppName(defaultAppName)
+		if err != nil {
+			log.Debugf("unable to convert default app name %q to a valid name: %v", defaultAppName, err)
+			log.Debugf("using default app name %q", defaultAppName)
+			defaultAppName = "my-workflow"
+		}
 
 		appName, err := PromptAppName(sc.AzClient, defaultAppName)
 		if err != nil {
@@ -132,14 +138,56 @@ func fillSetUpConfig(sc *providers.SetUpCmd, gh providers.GhClient) error {
 	if sc.Repo == "" {
 		repo, err := PromptGitHubRepoWithOwner(gh)
 		if err != nil {
-			return fmt.Errorf("prompting github repo: %w", err)
+			return fmt.Errorf("failed to prompt for GitHub repository: %w", err)
+		}
+		if repo == "" {
+			return errors.New("github repo cannot be empty")
 		}
 		sc.Repo = repo
 	}
 
 	return nil
 }
 
+func toValidAppName(name string) (string, error) {
+	// replace all underscores with hyphens
+	validName := strings.ReplaceAll(name, "_", "-")
+	// replace all spaces with hyphens
+	validName = strings.ReplaceAll(validName, " ", "-")
+
+	// remove leading non-alphanumeric characters
+	for i, r := range validName {
+		if unicode.IsLetter(r) || unicode.IsNumber(r) {
+			validName = validName[i:]
+			break
+		}
+	}
+
+	// remove trailing non-alphanumeric characters
+	for i := len(validName) - 1; i >= 0; i-- {
+		r := rune(validName[i])
+		if unicode.IsLetter(r) || unicode.IsNumber(r) {
+			validName = validName[:i+1]
+			break
+		}
+	}
+
+	// remove all characters except alphanumeric, '-', '.'
+	var builder strings.Builder
+	for _, r := range validName {
+		if unicode.IsLetter(r) || unicode.IsNumber(r) || r == '-' || r == '.' {
+			builder.WriteRune(r)
+		}
+	}
+
+	// lowercase the name
+	validName = strings.ToLower(builder.String())
+	if validName == "" {
+		return "", fmt.Errorf("app name '%s' could not be converted to a valid name", name)
+	}
+	return validName, nil
+}
+
 func runProviderSetUp(ctx context.Context, sc *providers.SetUpCmd, s spinner.Spinner, gh providers.GhClient) error {
 	provider := strings.ToLower(sc.Provider)
 	if provider == "azure" {
@@ -154,17 +202,34 @@ func runProviderSetUp(ctx context.Context, sc *providers.SetUpCmd, s spinner.Spi
 	return nil
 }
 
-func PromptAppName(az providers.AzClientInterface, defaultAppName string) (string, error) {
-	validate := func(input string) error {
-		if input == "" {
-			return errors.New("app name cannot be empty")
+func ValidateAppName(name string) error {
+	if name == "" {
+		return errors.New("app name cannot be empty")
+	}
+	// only alphanumeric and hyphen
+	for _, r := range name {
+		if unicode.IsLetter(r) || unicode.IsNumber(r) || r == '-' || r == '.' {
+			continue
 		}
-		return nil
+		return fmt.Errorf("character %q not allowed: app name must be alphanumeric with hyphens and periods", r)
 	}
+	// cannot start with a capital letter
+	if unicode.IsUpper(rune(name[0])) {
+		return errors.New("app name cannot start with a capital letter")
+	}
+	if name[0] == '-' || name[len(name)-1] == '-' {
+		return errors.New("app name cannot start or end with a hyphen")
+	}
+	if name[0] == '.' || name[len(name)-1] == '.' {
+		return errors.New("app name cannot start or end with a period")
+	}
+	return nil
+}
 
+func PromptAppName(az providers.AzClientInterface, defaultAppName string) (string, error) {
 	appNamePrompt := &promptui.Prompt{
 		Label:    "Enter app registration name",
-		Validate: validate,
+		Validate: ValidateAppName,
 		Default:  defaultAppName,
 	}
 	appName, err := appNamePrompt.Run()

cmd/setup-gh_test.go

@@ -28,3 +28,60 @@ func TestSetUpConfig(t *testing.T) {
 
 	assert.True(t, err == nil)
 }
+
+func TestToValidAppName(t *testing.T) {
+	testCases := []struct {
+		testCaseName string
+		nameInput    string
+		expected     string
+		shouldError  bool
+	}{
+		{
+			testCaseName: "valid name",
+			nameInput:    "valid-name",
+			expected:     "valid-name",
+		},
+		{
+			testCaseName: "name with spaces",
+			nameInput:    "name with spaces",
+			expected:     "name-with-spaces",
+		},
+		{
+			testCaseName: "name with special characters",
+			nameInput:    "name!@#$%^&*()",
+			expected:     "name",
+		},
+		{
+			testCaseName: "cannot start with a period",
+			nameInput:    ".name",
+			expected:     "name",
+		},
+		{
+			testCaseName: "cannot start or end with hyphen",
+			nameInput:    "----name--",
+			expected:     "name",
+		},
+		{
+			testCaseName: "name that can't be made valid",
+			expected:     ".**(__)",
+			shouldError:  true,
+		},
+		{
+			testCaseName: "dots and hypens allowed in the middle",
+			nameInput:    "name.-.name",
+			expected:     "name.-.name",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.testCaseName, func(t *testing.T) {
+			result, err := toValidAppName(tc.nameInput)
+			if tc.shouldError {
+				assert.Error(t, err)
+			} else {
+				assert.Equal(t, tc.expected, result)
+			}
+		})
+	}
+
+}

test/integration/swift/helm.yaml

@@ -10,10 +10,6 @@ deployVariables:
     value: "testapp"
   - name: "IMAGENAME"
     value: "host.minikube.internal:5001/testapp"
-  - name: "CPULIMIT"
-    value: "3"
-  - name: "MEMLIMIT"
-    value: "2Gi"
 languageVariables:
   - name: "VERSION"
     value: "5.5"

test/integration/swift/kustomize.yaml

@@ -10,10 +10,6 @@ deployVariables:
     value: "testapp"
   - name: "IMAGENAME"
     value: "host.minikube.internal:5001/testapp"
-  - name: "CPULIMIT"
-    value: "3"
-  - name: "MEMLIMIT"
-    value: "2Gi"
 languageVariables:
   - name: "VERSION"
     value: "5.5"

test/integration/swift/manifest.yaml

@@ -10,10 +10,6 @@ deployVariables:
     value: "testapp"
   - name: "IMAGENAME"
     value: "host.minikube.internal:5001/testapp"
-  - name: "CPULIMIT"
-    value: "3"
-  - name: "MEMLIMIT"
-    value: "2Gi"
 languageVariables:
   - name: "VERSION"
     value: "5.5"