feat: add package naming for deploy v0.5

.github/workflows/golangci-lint.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-          go-version: '1.25.5'
+          go-version: '1.26.1'
           cache: true
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v8

main.go

@@ -18,7 +18,7 @@ import (
 
 var (
 	// use build flags to set these values - ie: go build -ldflags "-X main.version=1.0.0"
-	apiVersion = "v0.4"
+	apiVersion = "v0.5"
 	version    = "dev"
 	buildDate  = "2021-09-01T00:00:00Z"
 	commit     = "0000"

pkg/api/deployment.go

@@ -216,9 +216,12 @@ type Capabilities struct {
 
 type CreatePackageResponse struct {
 	PackageID string `json:"packageId"`
+	Name      string `json:"name"`
+	Version   int    `json:"version"`
 }
 
 type CreatePackageArgs struct {
+	Name            string       `json:"name"`
 	SourceCodeKey   string       `json:"sourceCodeKey"`
 	Entrypoint      []string     `json:"entrypoint"`
 	Capabilities    Capabilities `json:"capabilities"`

pkg/api/deployment_test.go

@@ -653,11 +653,11 @@ func TestCreatePackage(t *testing.T) {
 		{
 			name: "201-happy-path",
 			mock: mock{
-				mockResponse: `{"packageId":"package-id"}`,
+				mockResponse: `{"packageId":"package-id","name":"my-app","version":1}`,
 				status:       http.StatusCreated,
 			},
 			want: want{
-				output: CreatePackageResponse{PackageID: "package-id"},
+				output: CreatePackageResponse{PackageID: "package-id", Name: "my-app", Version: 1},
 				err:    nil,
 			},
 		},
@@ -718,7 +718,7 @@ func TestCreatePackage(t *testing.T) {
 
 			deploymentClient := NewDeploymentClient("https://example.com", "v0.3", client, nil)
 
-			createPackageArgs := CreatePackageArgs{SourceCodeKey: "source-code-key", Entrypoint: []string{"node", "index.js"}, Capabilities: Capabilities{Messages: "v1"}}
+			createPackageArgs := CreatePackageArgs{Name: "my-app", SourceCodeKey: "source-code-key", Entrypoint: []string{"node", "index.js"}, Capabilities: Capabilities{Messages: "v1"}}
 			output, err := deploymentClient.CreatePackage(t.Context(), createPackageArgs)
 			if tt.want.err != nil {
 				require.EqualError(t, err, tt.want.err.Error())

pkg/format/format.go

@@ -253,6 +253,15 @@ func PrintAPIError(out *iostreams.IOStreams, err error, httpErr *api.Error) stri
 
 var errorRegex = regexp.MustCompile("^[^:]+")
 
+var dockerNameRe = regexp.MustCompile(`[^a-z0-9._-]`)
+
+func SanitizeDockerImageName(name string) string {
+	name = strings.ToLower(name)
+	name = dockerNameRe.ReplaceAllString(name, "-")
+	name = strings.Trim(name, ".-_")
+	return name
+}
+
 func extractFinalErrorMessage(err error) (string, error) {
 	matches := errorRegex.FindStringSubmatch(err.Error())
 	if len(matches) > 0 {

pkg/format/format_test.go

@@ -294,6 +294,56 @@ func TestGetRegionOptions(t *testing.T) {
 	require.Equal(t, expectedOptions.AliasLookup, options.AliasLookup)
 }
 
+func TestSanitizeDockerImageName(t *testing.T) {
+	tests := []struct {
+		name  string
+		input string
+		want  string
+	}{
+		{
+			name:  "already-valid",
+			input: "my-app-dev",
+			want:  "my-app-dev",
+		},
+		{
+			name:  "uppercase-conversion",
+			input: "My-App-Dev",
+			want:  "my-app-dev",
+		},
+		{
+			name:  "special-chars-replaced",
+			input: "my app@dev!",
+			want:  "my-app-dev",
+		},
+		{
+			name:  "leading-trailing-separators-trimmed",
+			input: "---my-app---",
+			want:  "my-app",
+		},
+		{
+			name:  "periods-preserved",
+			input: "my.app.dev",
+			want:  "my.app.dev",
+		},
+		{
+			name:  "underscores-preserved",
+			input: "my_app_dev",
+			want:  "my_app_dev",
+		},
+		{
+			name:  "mixed-special-chars",
+			input: "...Project Name!!--instance",
+			want:  "project-name----instance",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := SanitizeDockerImageName(tt.input)
+			require.Equal(t, tt.want, got)
+		})
+	}
+}
+
 func TestGetTemplateOptions(t *testing.T) {
 	templateNames := []api.Product{
 		{Name: "template1", ID: "1"},

tests/integration/mocks/main.go

@@ -10,11 +10,11 @@ import (
 )
 
 func main() {
-	http.HandleFunc("/v0.4/packages/source", uploadTgzHandler)
-	http.HandleFunc("/v0.4/packages", createPackageHandler)
-	http.HandleFunc("/v0.4/packages/test-package-id/build/watch", watchDeploymentHandler)
-	http.HandleFunc("/v0.4/deployments/validate", validateDeploymentHandler)
-	http.HandleFunc("/v0.4/deployments", deployInstanceHandler)
+	http.HandleFunc("/v0.5/packages/source", uploadTgzHandler)
+	http.HandleFunc("/v0.5/packages", createPackageHandler)
+	http.HandleFunc("/v0.5/packages/test-package-id/build/watch", watchDeploymentHandler)
+	http.HandleFunc("/v0.5/deployments/validate", validateDeploymentHandler)
+	http.HandleFunc("/v0.5/deployments", deployInstanceHandler)
 	http.HandleFunc("/releases/latest", getLatestReleaseHandler)
 
 	fmt.Println("Server started on port 80")
@@ -42,10 +42,12 @@ func uploadTgzHandler(w http.ResponseWriter, _ *http.Request) {
 
 type CreatePackageResponse struct {
 	PackageID string `json:"packageId"`
+	Name      string `json:"name"`
+	Version   int    `json:"version"`
 }
 
 func createPackageHandler(w http.ResponseWriter, _ *http.Request) {
-	mockResponse := CreatePackageResponse{PackageID: "test-package-id"}
+	mockResponse := CreatePackageResponse{PackageID: "test-package-id", Name: "test-dev", Version: 1}
 	w.Header().Set("Content-Type", "application/json")
 	jsonResponse, err := json.Marshal(mockResponse)
 	if err != nil {

vcr/deploy/deploy.go

@@ -523,7 +523,10 @@ func createPackage(ctx context.Context, opts *Options, uploadResp api.UploadResp
 		return api.CreatePackageResponse{}, fmt.Errorf("failed to get runtime: %w", err)
 	}
 
+	packageName := format.SanitizeDockerImageName(opts.ProjectName + "-" + opts.InstanceName)
+
 	createPackageArgs := api.CreatePackageArgs{
+		Name:            packageName,
 		SourceCodeKey:   uploadResp.SourceCodeKey,
 		Entrypoint:      opts.manifest.Instance.Entrypoint,
 		BuildScriptPath: opts.manifest.Instance.BuildScript,
@@ -537,7 +540,7 @@ func createPackage(ctx context.Context, opts *Options, uploadResp api.UploadResp
 		return api.CreatePackageResponse{}, fmt.Errorf("failed to create package: %w", err)
 	}
 
-	fmt.Fprintf(io.Out, "%s Package created: package_id=%q\n", c.SuccessIcon(), createPkgResp.PackageID)
+	fmt.Fprintf(io.Out, "%s Package created: package_id=%q name=%q version=%d\n", c.SuccessIcon(), createPkgResp.PackageID, createPkgResp.Name, createPkgResp.Version)
 
 	fmt.Fprintf(io.Out, "%s Waiting for build to start...\n", c.Blue(cmdutil.InfoIcon))
 	err = opts.DeploymentClient().WatchDeployment(ctx, opts.IOStreams(), createPkgResp.PackageID)

vcr/deploy/deploy_test.go

@@ -105,14 +105,15 @@ func TestDeploy(t *testing.T) {
 				DeployUploadTgzReturnErr:   nil,
 
 				DeployCreatePackageArgs: api.CreatePackageArgs{
+					Name:            "test-dev",
 					SourceCodeKey:   "test-key",
 					Entrypoint:      []string{"node", "index.js"},
 					BuildScriptPath: "",
 					Capabilities:    api.Capabilities{Messages: "v1"},
 					Runtime:         "nodejs16",
 				},
 				DeployCreatePackageTimes:          1,
-				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id"},
+				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id", Name: "test-dev", Version: 1},
 				DeployCreatePackageReturnErr:      nil,
 
 				DeployWatchDeploymentPackageID: "test-package-id",
@@ -135,7 +136,7 @@ func TestDeploy(t *testing.T) {
 				DeployDeployInstanceReturnErr:      nil,
 			},
 			want: want{
-				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\"\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
+				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\" name=\"test-dev\" version=1\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
 			},
 		},
 
@@ -164,14 +165,15 @@ func TestDeploy(t *testing.T) {
 				DeployUploadTgzReturnErr:   nil,
 
 				DeployCreatePackageArgs: api.CreatePackageArgs{
+					Name:            "test-dev",
 					SourceCodeKey:   "test-key",
 					Entrypoint:      []string{"node", "index.js"},
 					BuildScriptPath: "",
 					Capabilities:    api.Capabilities{Messages: "v1"},
 					Runtime:         "nodejs16",
 				},
 				DeployCreatePackageTimes:          1,
-				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id"},
+				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id", Name: "test-dev", Version: 1},
 				DeployCreatePackageReturnErr:      nil,
 
 				DeployWatchDeploymentPackageID: "test-package-id",
@@ -194,7 +196,7 @@ func TestDeploy(t *testing.T) {
 				DeployDeployInstanceReturnErr:      nil,
 			},
 			want: want{
-				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\"\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
+				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\" name=\"test-dev\" version=1\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
 			},
 		},
 		{
@@ -222,14 +224,15 @@ func TestDeploy(t *testing.T) {
 				DeployUploadTgzReturnErr:   nil,
 
 				DeployCreatePackageArgs: api.CreatePackageArgs{
+					Name:            "test-dev",
 					SourceCodeKey:   "test-key",
 					Entrypoint:      []string{"node", "index.js"},
 					BuildScriptPath: "",
 					Capabilities:    api.Capabilities{Messages: "v1"},
 					Runtime:         "nodejs16",
 				},
 				DeployCreatePackageTimes:          1,
-				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id"},
+				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id", Name: "test-dev", Version: 1},
 				DeployCreatePackageReturnErr:      nil,
 
 				DeployWatchDeploymentPackageID: "test-package-id",
@@ -260,7 +263,7 @@ func TestDeploy(t *testing.T) {
 				DeployDeployInstanceReturnErr:      nil,
 			},
 			want: want{
-				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\"\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
+				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\" name=\"test-dev\" version=1\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
 			},
 		},
 		{
@@ -288,14 +291,15 @@ func TestDeploy(t *testing.T) {
 				DeployUploadTgzReturnErr:   nil,
 
 				DeployCreatePackageArgs: api.CreatePackageArgs{
+					Name:            "test-dev",
 					SourceCodeKey:   "test-key",
 					Entrypoint:      []string{"node", "index.js"},
 					BuildScriptPath: "",
 					Capabilities:    api.Capabilities{Messages: "v1"},
 					Runtime:         "nodejs16",
 				},
 				DeployCreatePackageTimes:          1,
-				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id"},
+				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id", Name: "test-dev", Version: 1},
 				DeployCreatePackageReturnErr:      nil,
 
 				DeployWatchDeploymentPackageID: "test-package-id",
@@ -319,7 +323,7 @@ func TestDeploy(t *testing.T) {
 				DeployDeployInstanceReturnErr:      nil,
 			},
 			want: want{
-				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\"\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
+				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\" name=\"test-dev\" version=1\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
 			},
 		},
 		{
@@ -347,14 +351,15 @@ func TestDeploy(t *testing.T) {
 				DeployUploadTgzReturnErr:   nil,
 
 				DeployCreatePackageArgs: api.CreatePackageArgs{
+					Name:            "test-dev",
 					SourceCodeKey:   "test-key",
 					Entrypoint:      []string{"node", "index.js"},
 					BuildScriptPath: "",
 					Capabilities:    api.Capabilities{Messages: "v1"},
 					Runtime:         "nodejs16",
 				},
 				DeployCreatePackageTimes:          1,
-				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id"},
+				DeployReturnCreatePackageResponse: api.CreatePackageResponse{PackageID: "test-package-id", Name: "test-dev", Version: 1},
 				DeployCreatePackageReturnErr:      nil,
 
 				DeployWatchDeploymentPackageID: "test-package-id",
@@ -385,7 +390,7 @@ func TestDeploy(t *testing.T) {
 				DeployDeployInstanceReturnErr:      nil,
 			},
 			want: want{
-				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\"\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
+				stdout: "✓ Project \"test\" retrieved: project_id=\"id\"\n✓ Deployment parameters validated\n✓ Source code uploaded.\n✓ Package created: package_id=\"test-package-id\" name=\"test-dev\" version=1\nℹ Waiting for build to start...\n✓ Package \"test-package-id\" built successfully\n/-------\n| Instance has been deployed!\n| Instance id: test-instance-id\n| Instance service name: test-service-name\n| Instance host address: \x1b[0;1;33mtest-host-url\x1b[0m\n\\-------\n",
 			},
 		},
 		{