-
-
Notifications
You must be signed in to change notification settings - Fork 625
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(remote): support include git remote (#1652)
- Loading branch information
Showing
9 changed files
with
406 additions
and
12 deletions.
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
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,126 @@ | ||
package taskfile | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"io" | ||
"net/url" | ||
"path/filepath" | ||
"strings" | ||
|
||
"github.com/go-git/go-billy/v5/memfs" | ||
"github.com/go-git/go-git/v5" | ||
"github.com/go-git/go-git/v5/plumbing" | ||
"github.com/go-git/go-git/v5/storage/memory" | ||
giturls "github.com/whilp/git-urls" | ||
|
||
"github.com/go-task/task/v3/errors" | ||
"github.com/go-task/task/v3/internal/execext" | ||
"github.com/go-task/task/v3/internal/filepathext" | ||
) | ||
|
||
// An GitNode is a node that reads a Taskfile from a remote location via Git. | ||
type GitNode struct { | ||
*BaseNode | ||
URL *url.URL | ||
rawUrl string | ||
ref string | ||
path string | ||
} | ||
|
||
func NewGitNode( | ||
entrypoint string, | ||
dir string, | ||
insecure bool, | ||
opts ...NodeOption, | ||
) (*GitNode, error) { | ||
base := NewBaseNode(dir, opts...) | ||
u, err := giturls.Parse(entrypoint) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
basePath, path := func() (string, string) { | ||
x := strings.Split(u.Path, "//") | ||
return x[0], x[1] | ||
}() | ||
ref := u.Query().Get("ref") | ||
|
||
rawUrl := u.String() | ||
|
||
u.RawQuery = "" | ||
u.Path = basePath | ||
|
||
if u.Scheme == "http" && !insecure { | ||
return nil, &errors.TaskfileNotSecureError{URI: entrypoint} | ||
} | ||
return &GitNode{ | ||
BaseNode: base, | ||
URL: u, | ||
rawUrl: rawUrl, | ||
ref: ref, | ||
path: path, | ||
}, nil | ||
} | ||
|
||
func (node *GitNode) Location() string { | ||
return node.rawUrl | ||
} | ||
|
||
func (node *GitNode) Remote() bool { | ||
return true | ||
} | ||
|
||
func (node *GitNode) Read(_ context.Context) ([]byte, error) { | ||
fs := memfs.New() | ||
storer := memory.NewStorage() | ||
_, err := git.Clone(storer, fs, &git.CloneOptions{ | ||
URL: node.URL.String(), | ||
ReferenceName: plumbing.ReferenceName(node.ref), | ||
SingleBranch: true, | ||
Depth: 1, | ||
}) | ||
if err != nil { | ||
return nil, err | ||
} | ||
file, err := fs.Open(node.path) | ||
if err != nil { | ||
return nil, err | ||
} | ||
// Read the entire response body | ||
b, err := io.ReadAll(file) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
return b, nil | ||
} | ||
|
||
func (node *GitNode) ResolveEntrypoint(entrypoint string) (string, error) { | ||
dir, _ := filepath.Split(node.path) | ||
resolvedEntrypoint := fmt.Sprintf("%s//%s", node.URL, filepath.Join(dir, entrypoint)) | ||
if node.ref != "" { | ||
return fmt.Sprintf("%s?ref=%s", resolvedEntrypoint, node.ref), nil | ||
} | ||
return resolvedEntrypoint, nil | ||
} | ||
|
||
func (node *GitNode) ResolveDir(dir string) (string, error) { | ||
path, err := execext.Expand(dir) | ||
if err != nil { | ||
return "", err | ||
} | ||
|
||
if filepathext.IsAbs(path) { | ||
return path, nil | ||
} | ||
|
||
// NOTE: Uses the directory of the entrypoint (Taskfile), not the current working directory | ||
// This means that files are included relative to one another | ||
entrypointDir := filepath.Dir(node.Dir()) | ||
return filepathext.SmartJoin(entrypointDir, path), nil | ||
} | ||
|
||
func (node *GitNode) FilenameAndLastDir() (string, string) { | ||
return filepath.Base(node.path), filepath.Base(filepath.Dir(node.path)) | ||
} |
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,75 @@ | ||
package taskfile | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestGitNode_ssh(t *testing.T) { | ||
node, err := NewGitNode("[email protected]:foo/bar.git//Taskfile.yml?ref=main", "", false) | ||
assert.NoError(t, err) | ||
assert.Equal(t, "main", node.ref) | ||
assert.Equal(t, "Taskfile.yml", node.path) | ||
assert.Equal(t, "ssh://[email protected]/foo/bar.git//Taskfile.yml?ref=main", node.rawUrl) | ||
assert.Equal(t, "ssh://[email protected]/foo/bar.git", node.URL.String()) | ||
entrypoint, err := node.ResolveEntrypoint("common.yml") | ||
assert.NoError(t, err) | ||
assert.Equal(t, "ssh://[email protected]/foo/bar.git//common.yml?ref=main", entrypoint) | ||
} | ||
|
||
func TestGitNode_sshWithDir(t *testing.T) { | ||
node, err := NewGitNode("[email protected]:foo/bar.git//directory/Taskfile.yml?ref=main", "", false) | ||
assert.NoError(t, err) | ||
assert.Equal(t, "main", node.ref) | ||
assert.Equal(t, "directory/Taskfile.yml", node.path) | ||
assert.Equal(t, "ssh://[email protected]/foo/bar.git//directory/Taskfile.yml?ref=main", node.rawUrl) | ||
assert.Equal(t, "ssh://[email protected]/foo/bar.git", node.URL.String()) | ||
entrypoint, err := node.ResolveEntrypoint("common.yml") | ||
assert.NoError(t, err) | ||
assert.Equal(t, "ssh://[email protected]/foo/bar.git//directory/common.yml?ref=main", entrypoint) | ||
} | ||
|
||
func TestGitNode_https(t *testing.T) { | ||
node, err := NewGitNode("https://github.com/foo/bar.git//Taskfile.yml?ref=main", "", false) | ||
assert.NoError(t, err) | ||
assert.Equal(t, "main", node.ref) | ||
assert.Equal(t, "Taskfile.yml", node.path) | ||
assert.Equal(t, "https://github.com/foo/bar.git//Taskfile.yml?ref=main", node.rawUrl) | ||
assert.Equal(t, "https://github.com/foo/bar.git", node.URL.String()) | ||
entrypoint, err := node.ResolveEntrypoint("common.yml") | ||
assert.NoError(t, err) | ||
assert.Equal(t, "https://github.com/foo/bar.git//common.yml?ref=main", entrypoint) | ||
} | ||
|
||
func TestGitNode_httpsWithDir(t *testing.T) { | ||
node, err := NewGitNode("https://github.com/foo/bar.git//directory/Taskfile.yml?ref=main", "", false) | ||
assert.NoError(t, err) | ||
assert.Equal(t, "main", node.ref) | ||
assert.Equal(t, "directory/Taskfile.yml", node.path) | ||
assert.Equal(t, "https://github.com/foo/bar.git//directory/Taskfile.yml?ref=main", node.rawUrl) | ||
assert.Equal(t, "https://github.com/foo/bar.git", node.URL.String()) | ||
entrypoint, err := node.ResolveEntrypoint("common.yml") | ||
assert.NoError(t, err) | ||
assert.Equal(t, "https://github.com/foo/bar.git//directory/common.yml?ref=main", entrypoint) | ||
} | ||
|
||
func TestGitNode_FilenameAndDir(t *testing.T) { | ||
node, err := NewGitNode("https://github.com/foo/bar.git//directory/Taskfile.yml?ref=main", "", false) | ||
assert.NoError(t, err) | ||
filename, dir := node.FilenameAndLastDir() | ||
assert.Equal(t, "Taskfile.yml", filename) | ||
assert.Equal(t, "directory", dir) | ||
|
||
node, err = NewGitNode("https://github.com/foo/bar.git//Taskfile.yml?ref=main", "", false) | ||
assert.NoError(t, err) | ||
filename, dir = node.FilenameAndLastDir() | ||
assert.Equal(t, "Taskfile.yml", filename) | ||
assert.Equal(t, ".", dir) | ||
|
||
node, err = NewGitNode("https://github.com/foo/bar.git//multiple/directory/Taskfile.yml?ref=main", "", false) | ||
assert.NoError(t, err) | ||
filename, dir = node.FilenameAndLastDir() | ||
assert.Equal(t, "Taskfile.yml", filename) | ||
assert.Equal(t, "directory", dir) | ||
} |
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,22 @@ | ||
package taskfile | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestScheme(t *testing.T) { | ||
scheme, err := getScheme("https://github.com/foo/bar.git") | ||
assert.NoError(t, err) | ||
assert.Equal(t, "git", scheme) | ||
scheme, err = getScheme("https://github.com/foo/bar.git?ref=v1//taskfile/common.yml") | ||
assert.NoError(t, err) | ||
assert.Equal(t, "git", scheme) | ||
scheme, err = getScheme("[email protected]:foo/bar.git?ref=main//Taskfile.yml") | ||
assert.NoError(t, err) | ||
assert.Equal(t, "git", scheme) | ||
scheme, err = getScheme("https://github.com/foo/common.yml") | ||
assert.NoError(t, err) | ||
assert.Equal(t, "https", scheme) | ||
} |
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 |
---|---|---|
|
@@ -62,6 +62,16 @@ includes: | |
`TOKEN=my-token task my-remote-namespace:hello` will be resolved by Task to | ||
`https://[email protected]/my-org/my-repo/main/Taskfile.yml` | ||
|
||
## Git nodes | ||
|
||
You can also include a Taskfile from a Git node. We currently support ssh-style and http / https addresses like `[email protected]/foo/bar.git//Taskfiles.yml?ref=v1` and `https://example.com/foo/bar.git//Taskfiles.yml?ref=v1`. | ||
|
||
You need to follow this pattern : `<baseUrl>.git//<path>?ref=<ref>`. | ||
The `ref` parameter, optional, can be a branch name or a tag, if not provided it'll pick up the default branch. | ||
The `path` is the path to the Taskfile in the repository. | ||
|
||
If you want to use the SSH protocol, you need to make sure that your ssh-agent has your private ssh keys added so that they can be used during authentication. | ||
|
||
## Security | ||
|
||
Running commands from sources that you do not control is always a potential | ||
|