[feat]: [CI-16417]: added support fallback binary url (#37)

Author: Sapa96

go.mod

@@ -6,6 +6,7 @@ replace github.com/nektos/act => github.com/harness/nektos-act v0.0.0-2023031417
 
 require (
 	github.com/buildkite/yaml v2.1.0+incompatible
+	github.com/cenkalti/backoff/v4 v4.3.0
 	github.com/ghodss/yaml v1.0.0
 	github.com/go-git/go-git/v5 v5.6.1
 	github.com/google/go-cmp v0.5.9
@@ -29,7 +30,6 @@ require (
 	github.com/acomagu/bufpipe v1.0.4 // indirect
 	github.com/adrg/xdg v0.4.0 // indirect
 	github.com/andreaskoch/go-fswatch v1.0.0 // indirect
-	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/cloudflare/circl v1.3.2 // indirect
 	github.com/containerd/containerd v1.7.0 // indirect
 	github.com/creack/pty v1.1.18 // indirect

plugin/harness/execer.go

@@ -50,22 +50,27 @@ func (e *Execer) Exec(ctx context.Context) error {
 	// execute the plugin. the execution logic differs
 	// based on programming language.
 	if source := out.Run.Binary.Source; source != "" {
-		return e.runSourceExecutable(ctx, out.Run.Binary.Source)
+		return e.runSourceExecutable(ctx, out.Run.Binary.Source, out.Run.Binary.FallbackSource)
 	} else if module := out.Run.Go.Module; module != "" {
 		return e.runGoExecutable(ctx, module)
 	} else {
 		return e.runShellExecutable(ctx, out)
 	}
 }
 
-func (e *Execer) runSourceExecutable(ctx context.Context, source string) error {
-	parsedURL, err := NewMetadata(source, e.Ref).Generate()
-	if err != nil {
-		return err
-	}
-	binpath, err := file.Download(parsedURL)
+func (e *Execer) runSourceExecutable(ctx context.Context, source string, fallback string) error {
+	binpath, err := e.downloadBinary(source)
 	if err != nil {
-		return err
+		slog.Info("Primary source download failed. Retrying with fallback...")
+
+		if fallback != "" {
+			binpath, err = e.downloadBinary(fallback)
+			if err != nil {
+				return err
+			}
+		} else {
+			return err
+		}
 	}
 
 	if e.DownloadOnly {
@@ -81,6 +86,18 @@ func (e *Execer) runSourceExecutable(ctx context.Context, source string) error {
 	return runCmds(ctx, cmds, e.Environ, e.Workdir, e.Stdout, e.Stderr)
 }
 
+func (e *Execer) downloadBinary(source string) (string, error) {
+	parsedURL, err := NewMetadata(source, e.Ref).Generate()
+	if err != nil {
+		return "", err
+	}
+	binpath, err := file.Download(parsedURL)
+	if err != nil {
+		return "", err
+	}
+	return binpath, nil
+}
+
 func (e *Execer) runGoExecutable(ctx context.Context, module string) error {
 	// if the plugin is a Go module
 	binpath, err := e.buildGoExecutable(ctx, module)

plugin/harness/parse_test.go

@@ -3,3 +3,86 @@
 // license that can be found in the LICENSE file.
 
 package harness
+
+import (
+	"path/filepath"
+	"testing"
+)
+
+func TestParseFile(t *testing.T) {
+	tests := []struct {
+		name     string
+		filename string
+		wantErr  bool
+		validate func(*testing.T, *spec)
+	}{
+		{
+			name:     "valid plugin with binary source",
+			filename: "binary_source.yml",
+			wantErr:  false,
+			validate: func(t *testing.T, s *spec) {
+				wantSource := "https://github.com/drone-plugins/plugin/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst"
+				wantFallback := ""
+
+				if got := s.Run.Binary.Source; got != wantSource {
+					t.Errorf("Expected source %q, got %q", wantSource, got)
+				}
+				if got := s.Run.Binary.FallbackSource; got != wantFallback {
+					t.Errorf("Expected fallback source %q, got %q", wantFallback, got)
+				}
+			},
+		},
+		{
+			name:     "valid plugin with binary source and fallback",
+			filename: "binary_source_fallback.yml",
+			wantErr:  false,
+			validate: func(t *testing.T, s *spec) {
+				wantSource := "https://github.com/drone-plugins/plugin/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst"
+				wantFallback := "https://mirror.example.com/plugin/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst"
+
+				if got := s.Run.Binary.Source; got != wantSource {
+					t.Errorf("Expected source %q, got %q", wantSource, got)
+				}
+				if got := s.Run.Binary.FallbackSource; got != wantFallback {
+					t.Errorf("Expected fallback source %q, got %q", wantFallback, got)
+				}
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			// Use testdata directory
+			testFile := filepath.Join("testdata", tt.filename)
+			got, err := parseFile(testFile)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("parseFile() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+
+			if !tt.wantErr {
+				tt.validate(t, got)
+			}
+		})
+	}
+}
+
+func TestParseBinaryWithFallback(t *testing.T) {
+	yaml := `
+run:
+  binary:
+    source: https://github.com/drone-plugins/drone-meltwater-cache/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst
+    fallback_source: https://backup-mirror.example.com/drone-plugins/drone-meltwater-cache/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst
+`
+	out, err := parseString(yaml)
+	if err != nil {
+		t.Error(err)
+		return
+	}
+	if got, want := out.Run.Binary.Source, "https://github.com/drone-plugins/drone-meltwater-cache/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst"; got != want {
+		t.Errorf("Want source URL %q, got %q", want, got)
+	}
+	if got, want := out.Run.Binary.FallbackSource, "https://backup-mirror.example.com/drone-plugins/drone-meltwater-cache/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst"; got != want {
+		t.Errorf("Want fallback source URL %q, got %q", want, got)
+	}
+}

plugin/harness/testdata/binary_source.yml

@@ -0,0 +1,3 @@
+run:
+  binary:
+    source: https://github.com/drone-plugins/plugin/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst

plugin/harness/testdata/binary_source_fallback.yml

@@ -0,0 +1,4 @@
+run:
+  binary:
+    source: https://github.com/drone-plugins/plugin/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst
+    fallback_source: https://mirror.example.com/plugin/releases/download/{{ release }}/plugin-{{ os }}-{{ arch }}.zst

plugin/harness/types.go

@@ -4,7 +4,9 @@
 
 package harness
 
-import "errors"
+import (
+	"errors"
+)
 
 // spec defines the bitrise plugin.
 type (
@@ -41,7 +43,8 @@ type spec struct {
 			Module string
 		}
 		Binary struct {
-			Source string
+			Source         string
+			FallbackSource string `yaml:"fallback_source,omitempty"`
 		}
 	}
 }