-
Notifications
You must be signed in to change notification settings - Fork 5.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add support for git remote resources #10811
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| /* | ||
| Copyright 2020 Docker Compose CLI authors | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package remote | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "path/filepath" | ||
| "regexp" | ||
| "strconv" | ||
|
|
||
| "github.com/compose-spec/compose-go/cli" | ||
| "github.com/compose-spec/compose-go/loader" | ||
| "github.com/compose-spec/compose-go/types" | ||
| "github.com/docker/compose/v2/pkg/api" | ||
| "github.com/moby/buildkit/util/gitutil" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| func GitRemoteLoaderEnabled() (bool, error) { | ||
| if v := os.Getenv("COMPOSE_EXPERIMENTAL_GIT_REMOTE"); v != "" { | ||
| enabled, err := strconv.ParseBool(v) | ||
| if err != nil { | ||
| return false, errors.Wrap(err, "COMPOSE_EXPERIMENTAL_GIT_REMOTE environment variable expects boolean value") | ||
| } | ||
| return enabled, err | ||
| } | ||
| return false, nil | ||
| } | ||
|
|
||
| func NewGitRemoteLoader() (loader.ResourceLoader, error) { | ||
| var base string | ||
| if cacheHome := os.Getenv("XDG_CACHE_HOME"); cacheHome != "" { | ||
| base = cacheHome | ||
| } else { | ||
| home, err := os.UserHomeDir() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| base = filepath.Join(home, ".cache") | ||
| } | ||
| cache := filepath.Join(base, "docker-compose") | ||
|
|
||
| err := os.MkdirAll(cache, 0o700) | ||
| return gitRemoteLoader{ | ||
| cache: cache, | ||
| }, err | ||
| } | ||
|
|
||
| type gitRemoteLoader struct { | ||
| cache string | ||
| } | ||
|
|
||
| func (g gitRemoteLoader) Accept(path string) bool { | ||
| _, err := gitutil.ParseGitRef(path) | ||
| return err == nil | ||
| } | ||
|
|
||
| var commitSHA = regexp.MustCompile(`^[a-f0-9]{40}$`) | ||
|
|
||
| func (g gitRemoteLoader) Load(ctx context.Context, path string) (string, error) { | ||
| ref, err := gitutil.ParseGitRef(path) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| if ref.Commit == "" { | ||
| ref.Commit = "HEAD" // default branch | ||
| } | ||
|
|
||
| if !commitSHA.MatchString(ref.Commit) { | ||
| cmd := exec.CommandContext(ctx, "git", "ls-remote", "--exit-code", ref.Remote, ref.Commit) | ||
| cmd.Env = g.gitCommandEnv() | ||
| out, err := cmd.Output() | ||
| if err != nil { | ||
| if cmd.ProcessState.ExitCode() == 2 { | ||
| return "", errors.Wrapf(err, "repository does not contain ref %s, output: %q", path, string(out)) | ||
| } | ||
| return "", err | ||
| } | ||
| if len(out) < 40 { | ||
| return "", fmt.Errorf("unexpected git command output: %q", string(out)) | ||
| } | ||
| sha := string(out[:40]) | ||
| if !commitSHA.MatchString(sha) { | ||
| return "", fmt.Errorf("invalid commit sha %q", sha) | ||
| } | ||
| ref.Commit = sha | ||
| } | ||
|
|
||
| local := filepath.Join(g.cache, ref.Commit) | ||
| if _, err := os.Stat(local); os.IsNotExist(err) { | ||
| err = g.checkout(ctx, local, ref) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| } | ||
|
|
||
| if ref.SubDir != "" { | ||
| local = filepath.Join(local, ref.SubDir) | ||
| } | ||
| stat, err := os.Stat(local) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| if stat.IsDir() { | ||
| local, err = findFile(cli.DefaultFileNames, local) | ||
| } | ||
| return local, err | ||
| } | ||
|
|
||
| func (g gitRemoteLoader) checkout(ctx context.Context, path string, ref *gitutil.GitRef) error { | ||
| err := os.MkdirAll(path, 0o700) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| err = exec.CommandContext(ctx, "git", "init", path).Run() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| cmd := exec.CommandContext(ctx, "git", "remote", "add", "origin", ref.Remote) | ||
| cmd.Dir = path | ||
| err = cmd.Run() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| cmd = exec.CommandContext(ctx, "git", "fetch", "--depth=1", "origin", ref.Commit) | ||
| cmd.Env = g.gitCommandEnv() | ||
| cmd.Dir = path | ||
| err = cmd.Run() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| cmd = exec.CommandContext(ctx, "git", "checkout", ref.Commit) | ||
| cmd.Dir = path | ||
| err = cmd.Run() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (g gitRemoteLoader) gitCommandEnv() []string { | ||
| env := types.NewMapping(os.Environ()) | ||
| if env["GIT_TERMINAL_PROMPT"] == "" { | ||
| // Disable prompting for passwords by Git until user explicitly asks for it. | ||
| env["GIT_TERMINAL_PROMPT"] = "0" | ||
| } | ||
| if env["GIT_SSH"] == "" && env["GIT_SSH_COMMAND"] == "" { | ||
| // Disable any ssh connection pooling by Git and do not attempt to prompt the user. | ||
| env["GIT_SSH_COMMAND"] = "ssh -o ControlMaster=no -o BatchMode=yes" | ||
| } | ||
| v := values(env) | ||
| return v | ||
| } | ||
|
|
||
| func findFile(names []string, pwd string) (string, error) { | ||
| for _, n := range names { | ||
| f := filepath.Join(pwd, n) | ||
| if fi, err := os.Stat(f); err == nil && !fi.IsDir() { | ||
| return f, nil | ||
| } | ||
| } | ||
| return "", api.ErrNotFound | ||
| } | ||
|
|
||
| var _ loader.ResourceLoader = gitRemoteLoader{} | ||
|
|
||
| func values(m types.Mapping) []string { | ||
| values := make([]string, 0, len(m)) | ||
| for k, v := range m { | ||
| values = append(values, fmt.Sprintf("%s=%s", k, v)) | ||
| } | ||
| return values | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doing background Git fetches is always tricky because of credential helpers.
Take a look at https://github.com/tilt-dev/go-get/blob/295ccc6550921a9766a7294360a77a4d8704d826/get.go#L18-L55
I'd clone
os.Environ()and then conditionally addGIT_TERMINAL_PROMPT/GIT_SSH_COMMANDto the env passed to the exec'd processes.