Generate unique branch if one is not specified (#32)

Author: Megan-Wright

cmd/services/main.go

@@ -56,7 +56,7 @@ var (
 		&cli.StringFlag{
 			Name:  branchNameFlag,
 			Usage: "the name to use for the newly created branch",
-			Value: "test-branch",
+			Value: "",
 		},
 		&cli.StringFlag{
 			Name:     cacheDirFlag,

go.mod

@@ -5,6 +5,7 @@ go 1.13
 require (
 	github.com/golang/protobuf v1.3.2 // indirect
 	github.com/google/go-cmp v0.3.0
+	github.com/google/uuid v1.1.1
 	github.com/jenkins-x/go-scm v1.5.77
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32 // indirect

go.sum

@@ -20,6 +20,7 @@ github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5y
 github.com/google/go-cmp v0.3.0 h1:crn/baboCvb5fXaQ0IJ1SGTsTVrWpDsCWC8EGETZijY=
 github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
+github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=
 github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/googleapis/gnostic v0.0.0-20170729233727-0c5108395e2d/go.mod h1:sJBsCZ4ayReDTBIg8b9dl28c5xFWyhBTVRp3pOg5EKY=
 github.com/h2non/gock v1.0.9 h1:17gCehSo8ZOgEsFKpQgqHiR7VLyjxdAG3lkhVvO9QZU=

pkg/avancement/service_manager.go

@@ -6,12 +6,15 @@ import (
 	"log"
 	"net/url"
 	"path"
+	"strings"
 
 	"github.com/jenkins-x/go-scm/scm"
 
 	"github.com/rhd-gitops-example/services/pkg/git"
 	"github.com/rhd-gitops-example/services/pkg/local"
 	"github.com/rhd-gitops-example/services/pkg/util"
+
+	"github.com/google/uuid"
 )
 
 type ServiceManager struct {
@@ -87,6 +90,22 @@ func (s *ServiceManager) Promote(serviceName, fromURL, toURL, newBranchName stri
 		}
 	}(keepCache, &reposToDelete)
 
+	var localSource git.Source
+	var errorSource error
+	if fromLocalRepo(fromURL) {
+		localSource = s.localFactory(fromURL, s.debug)
+	} else {
+		source, errorSource = s.checkoutSourceRepo(fromURL, fromBranch)
+		if errorSource != nil {
+			return fmt.Errorf("failed to checkout repo: %w", errorSource)
+		}
+		reposToDelete = append(reposToDelete, source)
+	}
+
+	if newBranchName == "" {
+		newBranchName = generateBranch(source)
+	}
+
 	destination, err := s.checkoutDestinationRepo(toURL, newBranchName)
 	if err != nil {
 		return fmt.Errorf("failed to checkout repo: %w", err)
@@ -95,23 +114,17 @@ func (s *ServiceManager) Promote(serviceName, fromURL, toURL, newBranchName stri
 
 	var copied []string
 	if fromLocalRepo(fromURL) {
-		localSource := s.localFactory(fromURL, s.debug)
 		copied, err = local.CopyConfig(serviceName, localSource, destination)
 		if err != nil {
 			return fmt.Errorf("failed to setup local repo: %w", err)
 		}
 	} else {
-		source, err = s.checkoutSourceRepo(fromURL, fromBranch)
-		if err != nil {
-			return fmt.Errorf("failed to checkout repo: %w", err)
-		}
-		reposToDelete = append(reposToDelete, source)
-
 		copied, err = git.CopyService(serviceName, source, destination)
 		if err != nil {
 			return fmt.Errorf("failed to copy service: %w", err)
 		}
 	}
+
 	if err := destination.StageFiles(copied...); err != nil {
 		return fmt.Errorf("failed to stage files: %w", err)
 	}
@@ -212,3 +225,11 @@ func fromLocalRepo(s string) bool {
 	}
 	return false
 }
+
+func generateBranch(repo git.Repo) string {
+	uniqueString := uuid.New()
+	runes := []rune(uniqueString.String())
+	branchName := repo.GetName() + "-" + repo.GetCommitID() + "-" + string(runes[0:5])
+	branchName = strings.Replace(branchName, "\n","",-1)
+	return branchName
+}

pkg/avancement/service_manager_test.go

@@ -6,6 +6,7 @@ import (
 	"path/filepath"
 	"strings"
 	"testing"
+	"regexp"
 
 	"github.com/jenkins-x/go-scm/scm"
 	fakescm "github.com/jenkins-x/go-scm/scm/driver/fake"
@@ -174,6 +175,20 @@ func TestPromoteWithCacheDeletionFailure(t *testing.T) {
 	devRepo.AssertDeletedFromCache(t)
 }
 
+func TestGenerateBranchWithSuccess(t *testing.T) {
+    repo := mock.New("/dev", "master")
+	GenerateBranchWithSuccess(t, repo)
+}
+
+func GenerateBranchWithSuccess(t *testing.T, repo git.Repo) {
+	branch := generateBranch(repo)
+	nameRegEx := "^([0-9A-Za-z]+)-([0-9a-z]{7})-([0-9A-Za-z]{5})$"
+	_, err := regexp.Match(nameRegEx, []byte(branch))
+	if err != nil {
+		t.Fatalf("failed to generate a branch name matching pattern %s", nameRegEx)
+	}
+}
+
 type mockSource struct {
 	files     []string
 	localPath string

pkg/git/interface.go

@@ -20,6 +20,8 @@ type Source interface {
 type Repo interface {
 	Destination
 	Source
+	GetName() string
+	GetCommitID() string
 	Clone() error
 	Checkout(branch string) error
 	CheckoutAndCreate(branch string) error

pkg/git/mock/mock.go

@@ -34,6 +34,10 @@ type Repository struct {
 
 	deleted   bool
 	DeleteErr error
+
+	commitID string
+
+	repoName string
 }
 
 // New creates and returns a new git.Cache implementation that operates entirely
@@ -50,6 +54,16 @@ func (m *Repository) Checkout(branch string) error {
 	return m.checkoutErr
 }
 
+func (m *Repository) GetName() string {
+	m.repoName = "fakeRepoName"
+	return m.repoName
+}
+
+func (m *Repository) GetCommitID() string {
+	m.commitID = "fakeCommitString"
+	return m.commitID
+}
+
 // CheckoutAndCreate fulfils the git.Repo interface.
 func (m *Repository) CheckoutAndCreate(branch string) error {
 	if m.branchesCreated == nil {

pkg/git/repository.go

@@ -60,6 +60,15 @@ func (r *Repository) CheckoutAndCreate(branch string) error {
 	return err
 }
 
+func (r *Repository) GetName() string {
+	return r.repoName
+}
+
+func (r *Repository) GetCommitID() string {
+	commitID, _ := r.execGit(r.repoPath(), nil, "rev-parse", "--short", "HEAD")
+	return string(commitID)
+}
+
 func (r *Repository) Walk(base string, cb func(prefix, name string) error) error {
 	repoBase := r.repoPath(base)
 	prefix := filepath.Dir(repoBase) + "/"