chore: import upstream snapshot with attribution

api/git/update/update.go

@@ -0,0 +1,130 @@
+package update
+
+import (
+	"context"
+	"os"
+	"strings"
+	"time"
+
+	"github.com/pkg/errors"
+
+	portainer "github.com/portainer/portainer/api"
+	"github.com/portainer/portainer/api/filesystem"
+	"github.com/portainer/portainer/api/git"
+	gittypes "github.com/portainer/portainer/api/git/types"
+	"github.com/rs/zerolog/log"
+)
+
+// UpdateGitObject updates a git object based on its config
+func UpdateGitObject(ctx context.Context, gitService portainer.GitService, objId string, gitConfig *gittypes.RepoConfig, enableVersionFolder bool, projectPath string) (bool, string, error) {
+	if gitConfig == nil {
+		return false, "", nil
+	}
+
+	log.Debug().
+		Str("url", gitConfig.URL).
+		Str("ref", gitConfig.ReferenceName).
+		Str("object", objId).
+		Msg("the object has a git config, try to poll from git repository")
+
+	username, password := git.GetCredentials(gitConfig.Authentication)
+
+	fetchCtx, cancel := context.WithTimeout(ctx, time.Minute)
+	newHash, err := gitService.LatestCommitID(
+		fetchCtx,
+		gitConfig.URL,
+		gitConfig.ReferenceName,
+		username,
+		password,
+		gitConfig.TLSSkipVerify,
+	)
+	cancel()
+	if err != nil {
+		if fetchCtx.Err() == context.DeadlineExceeded {
+			log.Error().Str("object", objId).Msg("git fetch timed out after 1 minute")
+		}
+
+		return false, "", errors.WithMessagef(err, "failed to fetch latest commit id of %v", objId)
+	}
+
+	hashChanged := !strings.EqualFold(newHash, gitConfig.ConfigHash)
+
+	if !hashChanged {
+		log.Debug().
+			Str("hash", newHash).
+			Str("url", gitConfig.URL).
+			Str("ref", gitConfig.ReferenceName).
+			Str("object", objId).
+			Msg("git repo is up to date")
+
+		return false, newHash, nil
+	}
+
+	toDir := projectPath
+	if enableVersionFolder {
+		toDir = filesystem.JoinPaths(projectPath, newHash)
+	}
+
+	cloneParams := &cloneRepositoryParameters{
+		url:           gitConfig.URL,
+		ref:           gitConfig.ReferenceName,
+		toDir:         toDir,
+		tlsSkipVerify: gitConfig.TLSSkipVerify,
+	}
+	if gitConfig.Authentication != nil {
+		cloneParams.auth = &gitAuth{
+			username: username,
+			password: password,
+		}
+	}
+
+	if err := cloneGitRepository(ctx, gitService, cloneParams); err != nil {
+		if enableVersionFolder {
+			if removeErr := os.RemoveAll(toDir); removeErr != nil {
+				log.Warn().Err(removeErr).Str("dir", toDir).Msg("failed to remove partial clone directory")
+			}
+		}
+		return false, "", errors.WithMessagef(err, "failed to do a fresh clone of %v", objId)
+	}
+
+	log.Debug().
+		Str("hash", newHash).
+		Str("url", gitConfig.URL).
+		Str("ref", gitConfig.ReferenceName).
+		Str("object", objId).
+		Msg("git repo cloned updated")
+
+	return true, newHash, nil
+}
+
+type cloneRepositoryParameters struct {
+	url   string
+	ref   string
+	toDir string
+	auth  *gitAuth
+	// tlsSkipVerify skips SSL verification when cloning the Git repository
+	tlsSkipVerify bool `example:"false"`
+}
+
+type gitAuth struct {
+	username string
+	password string
+}
+
+func cloneGitRepository(ctx context.Context, gitService portainer.GitService, cloneParams *cloneRepositoryParameters) error {
+	username, password := "", ""
+	if cloneParams.auth != nil {
+		username = cloneParams.auth.username
+		password = cloneParams.auth.password
+	}
+
+	return gitService.CloneRepository(
+		ctx,
+		cloneParams.toDir,
+		cloneParams.url,
+		cloneParams.ref,
+		username,
+		password,
+		cloneParams.tlsSkipVerify,
+	)
+}

api/git/update/validate.go

@@ -0,0 +1,35 @@
+package update
+
+import (
+	"time"
+
+	portainer "github.com/portainer/portainer/api"
+	httperrors "github.com/portainer/portainer/api/http/errors"
+	"github.com/portainer/portainer/pkg/validate"
+)
+
+func ValidateAutoUpdateSettings(autoUpdate *portainer.AutoUpdateSettings) error {
+	if autoUpdate == nil {
+		return nil
+	}
+
+	if autoUpdate.Webhook == "" && autoUpdate.Interval == "" {
+		return httperrors.NewInvalidPayloadError("Webhook or Interval must be provided")
+	}
+
+	if autoUpdate.Webhook != "" && !validate.IsUUID(autoUpdate.Webhook) {
+		return httperrors.NewInvalidPayloadError("invalid Webhook format")
+	}
+
+	if autoUpdate.Interval == "" {
+		return nil
+	}
+
+	if d, err := time.ParseDuration(autoUpdate.Interval); err != nil {
+		return httperrors.NewInvalidPayloadError("invalid Interval format")
+	} else if d < time.Minute {
+		return httperrors.NewInvalidPayloadError("interval must be at least 1 minute")
+	}
+
+	return nil
+}

api/git/update/validate_test.go

@@ -0,0 +1,53 @@
+package update
+
+import (
+	"testing"
+
+	portainer "github.com/portainer/portainer/api"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_ValidateAutoUpdate(t *testing.T) {
+	t.Parallel()
+	tests := []struct {
+		name    string
+		value   *portainer.AutoUpdateSettings
+		wantErr bool
+	}{
+		{
+			name:    "webhook is not a valid UUID",
+			value:   &portainer.AutoUpdateSettings{Webhook: "fake-webhook"},
+			wantErr: true,
+		},
+		{
+			name:    "incorrect interval value",
+			value:   &portainer.AutoUpdateSettings{Interval: "1dd2hh3mm"},
+			wantErr: true,
+		},
+		{
+			name:    "short interval value",
+			value:   &portainer.AutoUpdateSettings{Interval: "1s"},
+			wantErr: true,
+		},
+		{
+			name:    "valid webhook without interval",
+			value:   &portainer.AutoUpdateSettings{Webhook: "8dce8c2f-9ca1-482b-ad20-271e86536ada"},
+			wantErr: false,
+		},
+		{
+			name: "valid auto update",
+			value: &portainer.AutoUpdateSettings{
+				Webhook:  "8dce8c2f-9ca1-482b-ad20-271e86536ada",
+				Interval: "5h30m40s10ms",
+			},
+			wantErr: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := ValidateAutoUpdateSettings(tt.value)
+			assert.Equalf(t, tt.wantErr, err != nil, "received %+v", err)
+		})
+	}
+}