Merge pull request #58 from frizzr/patch-1

Added support for legacy Helm chart repositories
puzzle · Jan 30, 2025 · 60ba913 · 60ba913
2 parents e4398d1 + 70722ec
commit 60ba913
Show file tree

Hide file tree

Showing 2 changed files with 130 additions and 29 deletions.
diff --git a/helm/dagger.json b/helm/dagger.json
@@ -1,5 +1,6 @@
 {
   "name": "helm",
+  "engineVersion": "v0.14.0",
   "sdk": "go",
-  "engineVersion": "v0.14.0"
+  "source": "."
 }
diff --git a/helm/main.go b/helm/main.go
@@ -26,18 +26,20 @@ type PushOpts struct {
 	Password   *dagger.Secret
 }
 
-func (p PushOpts) getChartFqdn(name string) string {
+func (p PushOpts) getProtocol() string {
 	if p.Oci {
-		return fmt.Sprintf("oci://%s/%s/%s", p.Registry, p.Repository, name)
+		return "oci"
+	} else {
+		return "https"
 	}
-	return fmt.Sprintf("%s/%s/%s", p.Registry, p.Repository, name)
 }
 
 func (p PushOpts) getRepoFqdn() string {
-	if p.Oci {
-		return fmt.Sprintf("oci://%s/%s", p.Registry, p.Repository)
-	}
-	return fmt.Sprintf("%s/%s", p.Registry, p.Repository)
+	return fmt.Sprintf("%s://%s/%s", p.getProtocol(),  p.Registry, p.Repository)
+}
+
+func (p PushOpts) getChartFqdn(name string) string {
+	return fmt.Sprintf("%s/%s", p.getRepoFqdn(), name)
 }
 
 // Get and display the version of the Helm Chart located inside the given directory.
@@ -58,7 +60,7 @@ func (h *Helm) Version(
 	return strings.TrimSpace(version), nil
 }
 
-// Packages and pushes a Helm chart to a specified OCI-compatible registry with authentication.
+// Packages and pushes a Helm chart to a specified OCI-compatible (by default) registry with authentication.
 //
 // Returns true if the chart was successfully pushed, or false if the chart already exists, with error handling for push failures.
 //
@@ -70,6 +72,19 @@ func (h *Helm) Version(
 //	  --username $REGISTRY_HELM_USER \
 //	  --password env:REGISTRY_HELM_PASSWORD \
 //	  --directory ./examples/testdata/mychart/
+//
+// Example usage for pushing to a legacy (non-OCI) Helm repository assuming the repo name is 'helm'. If your target URL
+// requires a vendor-specific path prefix (for example, JFrog Artifactory usually requires 'artifactory' before the repo
+// name) then add it before the repository name. If you want to put the chart in a subpath in
+// the repository, then append that to the end of the repository name.
+//
+//	dagger call package-push \
+//		--registry registry.puzzle.ch \
+//		--repository vendor-specific-prefix/helm/optional/subpath/in/repository \
+//		--username $REGISTRY_HELM_USER \
+//		--password env:REGISTRY_HELM_PASSWORD \
+//		--directory ./examples/testdata/mychart/ \
+//		--use-non-oci-helm-repo=true
 func (h *Helm) PackagePush(
 	// method call context
 	ctx context.Context,
@@ -83,11 +98,15 @@ func (h *Helm) PackagePush(
 	username string,
 	// registry login password
 	password *dagger.Secret,
+	// use a non-OCI (legacy) Helm repository
+	// +optional
+	// +default=false
+	useNonOciHelmRepo bool,    // Dev note: We are forced to use default=false due to https://github.com/dagger/dagger/issues/8810
 ) (bool, error) {
 	opts := PushOpts{
 		Registry:   registry,
 		Repository: repository,
-		Oci:        true,
+		Oci:        !useNonOciHelmRepo,
 		Username:   username,
 		Password:   password,
 	}
@@ -110,38 +129,47 @@ func (h *Helm) PackagePush(
 	}
 
 	name = strings.TrimSpace(name)
+	pkgFile := fmt.Sprintf("%s-%s.tgz", name, version)
 
-	c, err = c.
-		WithEnvVariable("REGISTRY_URL", opts.Registry).
-		WithEnvVariable("REGISTRY_USERNAME", opts.Username).
-		WithSecretVariable("REGISTRY_PASSWORD", opts.Password).
-		WithExec([]string{"sh", "-c", `echo ${REGISTRY_PASSWORD} | helm registry login ${REGISTRY_URL} --username ${REGISTRY_USERNAME} --password-stdin`}).
-		Sync(ctx)
+	chartExists, err := h.doesChartExistOnRepo(ctx, c, &opts, name, version)
 	if err != nil {
 		return false, err
 	}
 
-	//TODO: Refactor with return
-	c, err = c.WithExec([]string{"sh", "-c", fmt.Sprintf("helm show chart %s --version %s; echo -n $? > /ec", opts.getChartFqdn(name), version)}).Sync(ctx)
-	if err != nil {
-		return false, err
+	if chartExists {
+		return false, nil
 	}
 
-	exc, err := c.File("/ec").Contents(ctx)
+	c, err = c.WithExec([]string{"helm", "dependency", "update", "."}).
+		WithExec([]string{"helm", "package", "."}).
+		WithExec([]string{"sh", "-c", "ls"}).
+		Sync(ctx)
+
 	if err != nil {
 		return false, err
 	}
 
-	if exc == "0" {
-		//Chart exists
-		return false, nil
+	if useNonOciHelmRepo {
+		curlCmd := []string{
+			`curl --variable %REGISTRY_USERNAME`,
+			`--variable %REGISTRY_PASSWORD`,
+			`--expand-user "{{REGISTRY_USERNAME}}:{{REGISTRY_PASSWORD}}"`,
+			`-T`,
+			pkgFile,
+			opts.getRepoFqdn() + "/",
+		}
+
+		c, err = c.
+			WithEnvVariable("REGISTRY_USERNAME", opts.Username).
+			WithSecretVariable("REGISTRY_PASSWORD", opts.Password).
+			WithExec([]string{"sh", "-c", strings.Join(curlCmd, " ")}).
+			Sync(ctx)
+	} else {
+		c, err = c.
+			WithExec([]string{"helm", "push", pkgFile, opts.getRepoFqdn()}).
+			Sync(ctx)
 	}
 
-	_, err = c.WithExec([]string{"helm", "dependency", "update", "."}).
-		WithExec([]string{"helm", "package", "."}).
-		WithExec([]string{"sh", "-c", "ls"}).
-		WithExec([]string{"helm", "push", fmt.Sprintf("%s-%s.tgz", name, version), opts.getRepoFqdn()}).
-		Sync(ctx)
 	if err != nil {
 		return false, err
 	}
@@ -203,6 +231,78 @@ func (h *Helm) Lint(
 	return out, nil
 }
 
+func (h *Helm) doesChartExistOnRepo(
+	ctx context.Context,
+	c *dagger.Container,
+	opts *PushOpts,
+	name string,
+	version string,
+) (bool, error) {
+	if opts.Oci {
+		c, err := c.
+			WithEnvVariable("REGISTRY_URL", opts.Registry).
+			WithEnvVariable("REGISTRY_USERNAME", opts.Username).
+			WithSecretVariable("REGISTRY_PASSWORD", opts.Password).
+			WithExec([]string{"sh", "-c", `echo ${REGISTRY_PASSWORD} | helm registry login ${REGISTRY_URL} --username ${REGISTRY_USERNAME} --password-stdin`}).
+			Sync(ctx)
+		if err != nil {
+			return false, err
+		}
+
+		//TODO: Refactor with return
+		c, err = c.WithExec([]string{"sh", "-c", fmt.Sprintf("helm show chart %s --version %s; echo -n $? > /ec", opts.getChartFqdn(name), version)}).Sync(ctx)
+		if err != nil {
+			return false, err
+		}
+
+		exc, err := c.File("/ec").Contents(ctx)
+		if err != nil {
+			return false, err
+		}
+
+		if exc == "0" {
+			//Chart exists
+			return true, nil
+		} 
+
+		return false, nil
+	}
+	// else non-OCI
+	pkgFile := fmt.Sprintf("%s-%s.tgz", name, version)
+	// Do a GET of the chart but with response headers only so we do not download the chart
+	curlCmd := []string{
+		`curl --variable %REGISTRY_USERNAME`,
+			 `--variable %REGISTRY_PASSWORD`,
+			 `--expand-user "{{REGISTRY_USERNAME}}:{{REGISTRY_PASSWORD}}"`,
+			 opts.getChartFqdn(pkgFile),
+			 `--output /dev/null`,
+			 `--silent -Iw '%{http_code}'`,
+	}
+
+	httpCode, err := c.
+		WithEnvVariable("REGISTRY_USERNAME", opts.Username).
+		WithSecretVariable("REGISTRY_PASSWORD", opts.Password).
+		WithExec([]string{"sh", "-c", strings.Join(curlCmd, " ")}).
+		Stdout(ctx)
+
+	if err != nil {
+		return false, err
+	}
+
+	httpCode = strings.TrimSpace(httpCode)
+
+	if httpCode == "200" {
+		// Chart exists
+		return true, nil
+	}
+
+	if httpCode == "404" {
+		return false, nil
+	}
+
+	return false, fmt.Errorf("Server returned error code %s checking for chart existence on server.", httpCode)
+}
+
 func (h *Helm) hasMissingDependencies(
 	// method call context
 	ctx context.Context,