Add support for specifying branch and tag name

redhat-developer · Nov 26, 2020 · 85c504b · 85c504b
1 parent e9c294d
commit 85c504b
Showing 1 changed file with 90 additions and 59 deletions.
diff --git a/pkg/odo/cli/component/create.go b/pkg/odo/cli/component/create.go
@@ -881,6 +881,95 @@ func (co *CreateOptions) Validate() (err error) {
 	return nil
 }
 
+func downloadGitProject(starterProject *devfilev1.StarterProject, starterToken, path string) error {
+
+	var projectSource devfilev1.GitLikeProjectSource
+	if starterProject.Git != nil {
+		projectSource = starterProject.Git.GitLikeProjectSource
+	} else {
+		projectSource = starterProject.Github.GitLikeProjectSource
+	}
+
+	remoteName, remoteUrl, revision, err := parsercommon.GetDefaultSource(projectSource)
+	if err != nil {
+		return errors.Wrapf(err, "unable to get default project source for starter project %s", starterProject.Name)
+	}
+
+	if revision != "" {
+		log.Warning("Specifying 'revision' in 'checkoutFrom' is not yet supported in odo.")
+	}
+
+	downloadSpinner := log.Spinnerf("Downloading starter project %s from %s", starterProject.Name, remoteUrl)
+	defer downloadSpinner.End(false)
+
+	// lets consider revision to be a branch name first
+	refName := plumbing.NewBranchReferenceName(revision)
+
+	cloneOptions := &git.CloneOptions{
+		URL:           remoteUrl,
+		RemoteName:    remoteName,
+		ReferenceName: refName,
+		SingleBranch:  true,
+		// we don't need history for starter projects
+		Depth: 1,
+	}
+
+	if starterToken != "" {
+		cloneOptions.Auth = &http.BasicAuth{
+			Username: registryUtil.RegistryUser,
+			Password: starterToken,
+		}
+	}
+
+	originalPath := ""
+	if starterProject.SubDir != "" {
+		originalPath = path
+		path, err = ioutil.TempDir("", "")
+		if err != nil {
+			return err
+		}
+	}
+
+	_, err = git.PlainClone(path, false, cloneOptions)
+
+	if err != nil {
+
+		// it returns the following error if no matching ref found
+		// if we get this error, we are trying again considering revision as tag.
+		if _, ok := err.(git.NoMatchingRefSpecError); !ok {
+			return err
+		}
+
+		// try again to consider revision as tag name
+		cloneOptions.ReferenceName = plumbing.NewTagReferenceName(revision)
+		// remove if any .git folder downloaded in above try
+		_ = os.RemoveAll(filepath.Join(path, ".git"))
+		_, err = git.PlainClone(path, false, cloneOptions)
+		if err != nil {
+			return err
+		}
+	}
+
+	// we don't want to download project be a git repo
+	err = os.RemoveAll(filepath.Join(path, ".git"))
+	if err != nil {
+		// we don't need to return (fail) if this happens
+		log.Warning("Unable to delete .git from cloned starter project")
+	}
+
+	if starterProject.SubDir != "" {
+		err = util.GitSubDir(path, originalPath,
+			starterProject.SubDir)
+		if err != nil {
+			return err
+		}
+	}
+	downloadSpinner.End(true)
+
+	return nil
+
+}
+
 // Downloads first starter project from list of starter projects in devfile
 // Currently type git with a non github url is not supported
 func (co *CreateOptions) downloadStarterProject(devObj parser.DevfileObj, projectPassed string, interactive bool) error {
@@ -929,70 +1018,12 @@ func (co *CreateOptions) downloadStarterProject(devObj parser.DevfileObj, projec
 	log.Info("\nStarter Project")
 
 	if starterProject.Git != nil || starterProject.Github != nil {
+		err := downloadGitProject(starterProject, co.devfileMetadata.starterToken, path)
 
-		var projectSource devfilev1.GitLikeProjectSource
-		if starterProject.Git != nil {
-			projectSource = starterProject.Git.GitLikeProjectSource
-		} else {
-			projectSource = starterProject.Github.GitLikeProjectSource
-		}
-
-		remoteName, remoteUrl, revision, err := parsercommon.GetDefaultSource(projectSource)
-		if err != nil {
-			return errors.Wrapf(err, "unable to get default project source for starter project %s", starterProject.Name)
-		}
-
-		if revision != "" {
-			log.Warning("Specifying 'revision' in 'checkoutFrom' is not yet supported in odo.")
-		}
-
-		downloadSpinner := log.Spinnerf("Downloading starter project %s from %s", starterProject.Name, remoteUrl)
-		defer downloadSpinner.End(false)
-
-		cloneOptions := &git.CloneOptions{
-			URL:           remoteUrl,
-			RemoteName:    remoteName,
-			ReferenceName: plumbing.ReferenceName(revision),
-			SingleBranch:  true,
-			// we don't need history for starter projects
-			Depth: 1,
-		}
-
-		if co.devfileMetadata.starterToken != "" {
-			cloneOptions.Auth = &http.BasicAuth{
-				Username: registryUtil.RegistryUser,
-				Password: co.devfileMetadata.starterToken,
-			}
-		}
-
-		originalPath := ""
-		if starterProject.SubDir != "" {
-			originalPath = path
-			path, err = ioutil.TempDir("", "")
-			if err != nil {
-				return err
-			}
-		}
-		_, err = git.PlainClone(path, false, cloneOptions)
 		if err != nil {
 			return err
 		}
 
-		// we don't want to download project be a git repo
-		err = os.RemoveAll(filepath.Join(path, ".git"))
-		if err != nil {
-			// we don't need to return (fail) if this happens
-			log.Warning("Unable to delete .git from cloned starter project")
-		}
-
-		if starterProject.SubDir != "" {
-			err = util.GitSubDir(path, originalPath,
-				starterProject.SubDir)
-			if err != nil {
-				return err
-			}
-		}
-		downloadSpinner.End(true)
 	} else if starterProject.Zip != nil {
 		url := starterProject.Zip.Location
 		logUrl := starterProject.Zip.Location