github.com/jenkins-x/jx/v2@v2.1.155/pkg/cmd/step/git/step_git_merge_test.go

// +build unit

package git

import (
	"fmt"
	"io"
	"io/ioutil"
	"os"
	"strings"
	"testing"

	"github.com/jenkins-x/jx/v2/pkg/cmd/opts/step"

	"github.com/jenkins-x/jx-logging/pkg/log"
	"github.com/jenkins-x/jx/v2/pkg/cmd/opts"
	"github.com/jenkins-x/jx/v2/pkg/gits/testhelpers"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

func TestStepGitMerge(t *testing.T) {
	RegisterFailHandler(Fail)
	RunSpecs(t, "Step Git Merge Suite")
}

var _ = Describe("step git merge", func() {
	var (
		masterSha  string
		branchBSha string
		branchCSha string
		repoDir    string
		err        error
		testReader *os.File
		testWriter *os.File
	)

	BeforeEach(func() {
		By("capturing log output")
		testReader, testWriter, _ = os.Pipe()
		log.SetOutput(testWriter)
		_ = log.SetLevel("info")
	})

	BeforeEach(func() {
		repoDir, err = ioutil.TempDir("", "jenkins-x-git-test-repo-")
		By(fmt.Sprintf("creating a test repository in '%s'", repoDir))
		Expect(err).NotTo(HaveOccurred())
		testhelpers.GitCmd(Fail, repoDir, "init")

		By("adding single commit on master branch")
		testhelpers.WriteFile(Fail, repoDir, "a.txt", "a")
		testhelpers.Add(Fail, repoDir)
		masterSha = testhelpers.Commit(Fail, repoDir, "a commit")

		By("creating branch 'b' and adding a commit")
		testhelpers.Branch(Fail, repoDir, "b")
		testhelpers.WriteFile(Fail, repoDir, "b.txt", "b")
		testhelpers.Add(Fail, repoDir)
		branchBSha = testhelpers.Commit(Fail, repoDir, "b commit")

		By("creating branch 'c' and adding a commit")
		testhelpers.Checkout(Fail, repoDir, "master")
		testhelpers.Branch(Fail, repoDir, "c")
		testhelpers.WriteFile(Fail, repoDir, "c.txt", "c")
		testhelpers.Add(Fail, repoDir)
		branchCSha = testhelpers.Commit(Fail, repoDir, "c commit")

		By("checking out master")
		testhelpers.Checkout(Fail, repoDir, "master")
	})

	AfterEach(func() {
		By("closing test stdout")
		_ = testWriter.Close()
	})

	AfterEach(func() {
		By("deleting temp repo")
		_ = os.RemoveAll(repoDir)
	})

	Context("with command line options", func() {
		It("succeeds", func() {
			currentHeadSha := testhelpers.HeadSha(Fail, repoDir)
			Expect(currentHeadSha).Should(Equal(masterSha))

			options := StepGitMergeOptions{
				StepOptions: step.StepOptions{
					CommonOptions: &opts.CommonOptions{},
				},
				SHAs:       []string{branchBSha},
				Dir:        repoDir,
				BaseBranch: "master",
				BaseSHA:    masterSha,
			}

			err := options.Run()
			Expect(err).NotTo(HaveOccurred())

			currentHeadSha = testhelpers.HeadSha(Fail, repoDir)
			Expect(currentHeadSha).Should(Equal(branchBSha))
		})
	})

	Context("with PULL_REFS", func() {
		BeforeEach(func() {
			err := os.Setenv("PULL_REFS", fmt.Sprintf("master:%s,b:%s", masterSha, branchBSha))
			Expect(err).NotTo(HaveOccurred())
		})

		AfterEach(func() {
			err := os.Unsetenv("PULL_REFS")
			Expect(err).NotTo(HaveOccurred())
		})

		It("succeeds", func() {
			currentHeadSha := testhelpers.HeadSha(Fail, repoDir)
			Expect(currentHeadSha).Should(Equal(masterSha))

			options := StepGitMergeOptions{
				StepOptions: step.StepOptions{
					CommonOptions: &opts.CommonOptions{},
				},
				Dir: repoDir,
			}

			err := options.Run()
			Expect(err).NotTo(HaveOccurred())

			currentHeadSha = testhelpers.HeadSha(Fail, repoDir)
			Expect(currentHeadSha).Should(Equal(branchBSha))
		})
	})

	Context("with multiple merge SHAs in PULL_REFS", func() {
		BeforeEach(func() {
			err := os.Setenv("PULL_REFS", fmt.Sprintf("master:%s,c:%s,b:%s", masterSha, branchCSha, branchBSha))
			Expect(err).NotTo(HaveOccurred())

		})

		AfterEach(func() {
			err := os.Unsetenv("PULL_REFS")
			Expect(err).NotTo(HaveOccurred())
		})

		It("merges all shas and creates a merge commit", func() {
			currentHeadSha := testhelpers.HeadSha(Fail, repoDir)
			Expect(currentHeadSha).Should(Equal(masterSha))

			options := StepGitMergeOptions{
				StepOptions: step.StepOptions{
					CommonOptions: &opts.CommonOptions{
						Verbose: true,
					},
				},
				Dir: repoDir,
			}

			err := options.Run()
			Expect(err).NotTo(HaveOccurred())

			out, err := read(testReader, testWriter)
			Expect(err).NotTo(HaveOccurred())

			logLines := strings.Split(out, "\n")
			logLines = deleteEmpty(logLines)
			Expect(len(logLines)).Should(Equal(4))
			indices := []int{1, 2, 3}
			for _, i := range indices {
				Expect(strings.TrimSpace(logLines[i])).Should(MatchRegexp("Merged SHA .* with commit message .* into base branch master"))
			}
		})
	})

	Context("with no options and no PULL_REFS", func() {
		It("logs warning", func() {
			options := StepGitMergeOptions{
				StepOptions: step.StepOptions{
					CommonOptions: &opts.CommonOptions{},
				},
				Dir: repoDir,
			}

			out := log.CaptureOutput(func() {
				err := options.Run()
				Expect(err).NotTo(HaveOccurred())

				currentHeadSha := testhelpers.HeadSha(Fail, repoDir)
				Expect(currentHeadSha).Should(Equal(masterSha))
			})

			Expect(out).Should(ContainSubstring("no SHAs to merge"))
		})
	})
})

func read(r io.Reader, w io.Closer) (string, error) {
	err := w.Close()
	if err != nil {
		return "", err
	}
	data, err := ioutil.ReadAll(r)
	if err != nil {
		return "", err
	}
	return string(data), nil
}

func deleteEmpty(s []string) []string {
	var clean []string
	for _, str := range s {
		if str != "" {
			clean = append(clean, str)
		}
	}
	return clean
}