Skip to content
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.

Sign up for GitHub

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

Jump to bottom

use git checkout instead of switch #173

Merged
merged 2 commits into from
May 24, 2023
Merged

use git checkout instead of switch #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbd85dd
use git checkout instead of switch
mike-hoang May 19, 2023
ce6a7d5
attempt resouce download only if uri is a git repo
mike-hoang May 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions pkg/devfile/parser/parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ import (
var downloadGitRepoResources = func(url string, destDir string, httpTimeout *int, token string) error {
var returnedErr error

gitUrl, err := git.NewGitUrlWithURL(url)
if err != nil {
return err
}
if util.IsGitProviderRepo(url) {
gitUrl, err := git.NewGitUrlWithURL(url)
if err != nil {
return err
}

if gitUrl.IsGitProviderRepo() {
if !gitUrl.IsFile || gitUrl.Revision == "" || !strings.Contains(gitUrl.Path, OutputDevfileYamlPath) {
return fmt.Errorf("error getting devfile from url: failed to retrieve %s", url)
}
Expand Down
60 changes: 43 additions & 17 deletions pkg/devfile/parser/parse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
"bytes"
"context"
"fmt"
"github.com/devfile/library/v2/pkg/util"
"io/ioutil"
"net"
"net/http"
Expand Down Expand Up @@ -2862,7 +2863,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
tt.args.devFileObj.Data.AddComponents(plugincomp)

}
downloadGitRepoResources = mockDownloadGitRepoResources(&git.GitUrl{}, "")
downloadGitRepoResources = mockDownloadGitRepoResources("", &git.GitUrl{}, "")
err := parseParentAndPlugin(tt.args.devFileObj, &resolutionContextTree{}, resolverTools{})

// Unexpected error
Expand Down Expand Up @@ -3082,7 +3083,7 @@ func Test_parseParentAndPlugin_RecursivelyReference(t *testing.T) {
httpTimeout: &httpTimeout,
}

downloadGitRepoResources = mockDownloadGitRepoResources(&git.GitUrl{}, "")
downloadGitRepoResources = mockDownloadGitRepoResources("", &git.GitUrl{}, "")
err := parseParentAndPlugin(devFileObj, &resolutionContextTree{}, tool)
// devfile has a cycle in references: main devfile -> uri: http://127.0.0.1:8080 -> name: testcrd, namespace: defaultnamespace -> uri: http://127.0.0.1:8090 -> uri: http://127.0.0.1:8080
expectedErr := fmt.Sprintf("devfile has an cycle in references: main devfile -> uri: %s%s -> name: %s, namespace: %s -> uri: %s%s -> uri: %s%s", httpPrefix, uri1, name, namespace,
Expand Down Expand Up @@ -4174,7 +4175,7 @@ func Test_parseFromURI(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
downloadGitRepoResources = mockDownloadGitRepoResources(&git.GitUrl{}, "")
downloadGitRepoResources = mockDownloadGitRepoResources("", &git.GitUrl{}, "")
got, err := parseFromURI(tt.importReference, tt.curDevfileCtx, &resolutionContextTree{}, resolverTools{})
if (err != nil) != (tt.wantErr != nil) {
t.Errorf("Test_parseFromURI() unexpected error: %v, wantErr %v", err, tt.wantErr)
Expand Down Expand Up @@ -4227,12 +4228,15 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
IsFile: true,
}

validUrl := "https://raw.githubusercontent.com/devfile/library/main/devfile.yaml"

invalidTokenError := "failed to clone repo with token, ensure that the url and token is correct"
invalidGitSwitchError := "failed to switch repo to revision*"
invalidDevfilePathError := "error getting devfile from url: failed to retrieve*"

tests := []struct {
name string
url string
gitUrl *git.GitUrl
token string
destDir string
Expand All @@ -4244,6 +4248,7 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
}{
{
name: "private parent devfile",
url: validUrl,
gitUrl: validGitUrl,
token: validToken,
importReference: v1.ImportReference{
Expand All @@ -4257,6 +4262,7 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
},
{
name: "public parent devfile",
url: validUrl,
gitUrl: validGitUrl,
token: "",
importReference: v1.ImportReference{
Expand All @@ -4271,6 +4277,7 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
{
// a valid parent url must contain a revision
name: "private parent devfile without a revision",
url: "https://raw.githubusercontent.com/devfile/library/devfile.yaml",
gitUrl: &git.GitUrl{
Protocol: "https",
Host: "raw.githubusercontent.com",
Expand All @@ -4289,8 +4296,22 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
wantError: &invalidDevfilePathError,
wantResources: []string{},
},
{
name: "public parent devfile that is not from a git provider",
url: "http://localhost:5000/devfile.yaml",
gitUrl: &git.GitUrl{},
token: "",
importReference: v1.ImportReference{
ImportReferenceUnion: v1.ImportReferenceUnion{
Uri: server.URL,
},
},
wantDevFile: minimalDevfile,
wantResources: []string{},
},
{
name: "public parent devfile with no devfile path",
url: "https://github.com/devfile/library",
gitUrl: &git.GitUrl{
Protocol: "https",
Host: "github.com",
Expand All @@ -4309,6 +4330,7 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
},
{
name: "public parent devfile with invalid devfile path",
url: "https://raw.githubusercontent.com/devfile/library/main/text.txt",
gitUrl: &git.GitUrl{
Protocol: "https",
Host: "raw.githubusercontent.com",
Expand All @@ -4329,6 +4351,7 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
},
{
name: "private parent devfile with invalid token",
url: validUrl,
gitUrl: validGitUrl,
token: invalidToken,
importReference: v1.ImportReference{
Expand All @@ -4341,6 +4364,7 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
},
{
name: "private parent devfile with invalid revision",
url: "https://raw.githubusercontent.com/devfile/library/invalid-revision/devfile.yaml",
gitUrl: &git.GitUrl{
Protocol: "https",
Host: "raw.githubusercontent.com",
Expand Down Expand Up @@ -4371,7 +4395,7 @@ func Test_parseFromURI_GitProviders(t *testing.T) {
}

// tt.gitUrl is the parent devfile URL
downloadGitRepoResources = mockDownloadGitRepoResources(tt.gitUrl, tt.token)
downloadGitRepoResources = mockDownloadGitRepoResources(tt.url, tt.gitUrl, tt.token)
got, err := parseFromURI(tt.importReference, curDevfileContext, &resolutionContextTree{}, resolverTools{})

// validate even if we want an error; check that no files are copied to destDir
Expand Down Expand Up @@ -4422,20 +4446,21 @@ func validateGitResourceFunctions(t *testing.T, wantFiles []string, wantResource
}
}

func mockDownloadGitRepoResources(gURL *git.GitUrl, mockToken string) func(url string, destDir string, httpTimeout *int, token string) error {
func mockDownloadGitRepoResources(uri string, gURL *git.GitUrl, mockToken string) func(url string, destDir string, httpTimeout *int, token string) error {
return func(url string, destDir string, httpTimeout *int, token string) error {
// this converts the real git URL to a mock URL
mockGitUrl := git.MockGitUrl{
Protocol: gURL.Protocol,
Host: gURL.Host,
Owner: gURL.Owner,
Repo: gURL.Repo,
Revision: gURL.Revision,
Path: gURL.Path,
IsFile: gURL.IsFile,
}

if mockGitUrl.IsGitProviderRepo() {
if util.IsGitProviderRepo(uri) {
// this converts the real git URL to a mock URL
mockGitUrl := git.MockGitUrl{
Protocol: gURL.Protocol,
Host: gURL.Host,
Owner: gURL.Owner,
Repo: gURL.Repo,
Revision: gURL.Revision,
Path: gURL.Path,
IsFile: gURL.IsFile,
}

if !mockGitUrl.IsFile || mockGitUrl.Revision == "" || !strings.Contains(mockGitUrl.Path, OutputDevfileYamlPath) {
return fmt.Errorf("error getting devfile from url: failed to retrieve %s", url+"/"+mockGitUrl.Path)
}
Expand Down Expand Up @@ -4466,6 +4491,7 @@ func mockDownloadGitRepoResources(gURL *git.GitUrl, mockToken string) func(url s
if err != nil {
return err
}

}

return nil
Expand Down Expand Up @@ -4862,7 +4888,7 @@ func Test_DownloadGitRepoResources(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
destDir := t.TempDir()
downloadGitRepoResources = mockDownloadGitRepoResources(&tt.gitUrl, tt.token)
downloadGitRepoResources = mockDownloadGitRepoResources(tt.url, &tt.gitUrl, tt.token)
err := downloadGitRepoResources(tt.url, destDir, &httpTimeout, tt.token)
if (err != nil) && (tt.wantErr != true) {
t.Errorf("Unexpected error = %v", err)
Expand Down
4 changes: 2 additions & 2 deletions pkg/git/git.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,13 +139,13 @@ func (g *GitUrl) CloneGitRepo(destDir string) error {
}

if g.Revision != "" {
_, err := execute(destDir, "git", "switch", "--detach", "origin/"+g.Revision)
_, err := execute(destDir, "git", "checkout", g.Revision)
if err != nil {
err = os.RemoveAll(destDir)
if err != nil {
return err
}
return fmt.Errorf("failed to switch repo to revision. repo dir: %v, revision: %v", destDir, g.Revision)
return fmt.Errorf("failed to switch repo to revision. repo dir: %v, revision: %v, error: %v", destDir, g.Revision, err)
}
}

Expand Down
63 changes: 59 additions & 4 deletions pkg/git/git_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,8 +400,6 @@ func Test_IsPublic(t *testing.T) {
}

func Test_CloneGitRepo(t *testing.T) {
tempInvalidDir := t.TempDir()

invalidGitUrl := GitUrl{
Protocol: "",
Host: "",
Expand All @@ -419,9 +417,42 @@ func Test_CloneGitRepo(t *testing.T) {
token: "fake-github-token",
}

validGitHubRepoBranch := GitUrl{
Protocol: "https",
Host: "github.com",
Owner: "devfile-resources",
Repo: "python-src-docker",
Revision: "testbranch",
}

validGitHubRepoCommit := GitUrl{
Protocol: "https",
Host: "github.com",
Owner: "devfile-resources",
Repo: "python-src-docker",
Revision: "bb00eeffc638f2657a0c752ef934a9b6dc87e2c1",
}

validGitHubRepoInvalidCommit := GitUrl{
Protocol: "https",
Host: "github.com",
Owner: "devfile-resources",
Repo: "python-src-docker",
Revision: "lkjatbasdlkfja0c752ef93faskj4bowdf1",
}

validGitHubRepoTag := GitUrl{
Protocol: "https",
Host: "github.com",
Owner: "OpenLiberty",
Repo: "devfile-stack",
Revision: "maven-0.7.0",
}

privateRepoBadTokenErr := "failed to clone repo with token*"
publicRepoInvalidUrlErr := "failed to clone repo without a token"
missingDestDirErr := "failed to clone repo, destination directory*"
switchRevisionErr := "failed to switch repo to revision*"

tests := []struct {
name string
Expand All @@ -438,19 +469,43 @@ func Test_CloneGitRepo(t *testing.T) {
{
name: "should fail with invalid git url",
gitUrl: invalidGitUrl,
destDir: tempInvalidDir,
destDir: "",
wantErr: publicRepoInvalidUrlErr,
},
{
name: "should fail to clone invalid private git url with a bad token",
gitUrl: invalidPrivateGitHubRepo,
destDir: tempInvalidDir,
destDir: "",
wantErr: privateRepoBadTokenErr,
},
{
name: "should clone valid git url with branch revision",
gitUrl: validGitHubRepoBranch,
destDir: "",
},
{
name: "should clone valid git url with commit revision",
gitUrl: validGitHubRepoCommit,
destDir: "",
},
{
name: "should clone valid git url with tag revision",
gitUrl: validGitHubRepoTag,
destDir: "",
},
{
name: "should fail to clone valid git url with invalid commit",
gitUrl: validGitHubRepoInvalidCommit,
destDir: "",
wantErr: switchRevisionErr,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.destDir == "" {
tt.destDir = t.TempDir()
}
err := tt.gitUrl.CloneGitRepo(tt.destDir)
if (err != nil) != (tt.wantErr != "") {
t.Errorf("Unxpected error: %t, want: %v", err, tt.wantErr)
Expand Down
7 changes: 3 additions & 4 deletions pkg/git/mock.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"net/url"
"os"
"path/filepath"
"strings"
)

type MockGitUrl struct {
Expand Down Expand Up @@ -70,8 +69,8 @@ var mockExecute = func(baseDir string, cmd CommandType, args ...string) ([]byte,
return []byte(""), nil
}

if len(args) > 0 && args[0] == "switch" {
revision := strings.TrimPrefix(args[2], "origin/")
if len(args) > 0 && args[0] == "checkout" {
revision := args[1]
if revision != "invalid-revision" {
resourceFile, err := os.OpenFile(filepath.Clean(baseDir)+"/resource.file", os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600)
if err != nil {
Expand Down Expand Up @@ -122,7 +121,7 @@ func (m *MockGitUrl) CloneGitRepo(destDir string) error {
}

if m.Revision != "" {
_, err := mockExecute(destDir, "git", "switch", "--detach", "origin/"+m.Revision)
_, err := mockExecute(destDir, "git", "checkout", m.Revision)
if err != nil {
return fmt.Errorf("failed to switch repo to revision. repo dir: %v, revision: %v", destDir, m.Revision)
}
Expand Down