github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/pkg/transportrequest/gitutils_test.go

//go:build unit
// +build unit

package transportrequest

import (
	pipergit "github.com/SAP/jenkins-library/pkg/git"
	"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/plumbing/object"
	"github.com/go-git/go-git/v5/plumbing/storer"
	"github.com/go-git/go-git/v5/storage/memory"
	"github.com/stretchr/testify/assert"
	"io"
	"testing"
)

type commitIteratorMock struct {
	commits []object.Commit
	index   int
}

func (iter *commitIteratorMock) Next() (*object.Commit, error) {
	i := iter.index
	iter.index++

	if i >= len(iter.commits) {
		return nil, io.EOF // real iterators also behave like this
	}
	return &iter.commits[i], nil
}

func (iter *commitIteratorMock) ForEach(cb func(c *object.Commit) error) error {
	for {
		c, err := iter.Next()
		if err == io.EOF {
			break
		}
		if err != nil {
			return err
		}

		err = cb(c)
		if err == storer.ErrStop {
			break
		}
		if err != nil {
			return err
		}
	}

	return nil
}

func (iter *commitIteratorMock) Close() {

}

type TrGitUtilsMock struct {
}

func (m *TrGitUtilsMock) PlainOpen(path string) (*git.Repository, error) {
	return git.Init(memory.NewStorage(), memfs.New())
}

func TestRetrieveLabelStraightForward(t *testing.T) {

	t.Run("single commit tests", func(t *testing.T) {

		runTest := func(testConfig []string) {
			t.Run(testConfig[0], func(t *testing.T) {
				commitIter := &commitIteratorMock{
					commits: []object.Commit{
						object.Commit{
							Hash:    plumbing.NewHash("3434343434343434343434343434343434343434"),
							Message: testConfig[1],
						},
					},
				}
				labels, err := FindLabelsInCommits(commitIter, "TransportRequest")
				if assert.NoError(t, err) {
					expected := testConfig[2:]
					if assert.Len(t, labels, len(expected)) {
						assert.Subset(t, expected, labels)
					}
				}
			})
		}

		tests := [][]string{
			[]string{
				"straight forward",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 12345678",
				"12345678",
			},
			[]string{
				"trailing spaces after our value",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 12345678  ",
				"12345678",
			},
			[]string{
				"trailing text after our value",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 12345678 aaa",
			},
			[]string{
				"leading whitespace before our label",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\n   TransportRequest: 12345678",
				"12345678",
			},
			[]string{
				"leading text before our label",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\naaa TransportRequest: 12345678",
			},
			[]string{
				"whitespaces before column",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest  : 12345678",
				"12345678",
			},
			[]string{
				"no whitespaces after column",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest  :12345678",
				"12345678",
			},
			[]string{
				"two times the same id in the same commit",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest : 12345678\nTransportRequest : 12345678",
				"12345678",
			},
			[]string{
				// we report the ids, this is basically an invalid state, but needs to be filtered out by the caller
				"two different ids in the same commit",
				"this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest : 12345678\nTransportRequest : 87654321",
				"12345678", "87654321",
			},
		}

		for _, testConfig := range tests {
			runTest(testConfig)
		}
	})

	t.Run("multi commit tests", func(t *testing.T) {

		t.Run("two different ids in different commits", func(t *testing.T) {
			commitIter := &commitIteratorMock{
				commits: []object.Commit{
					object.Commit{
						Hash:    plumbing.NewHash("3434343434343434343434343434343434343434"),
						Message: "this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 12345678",
					},
					object.Commit{
						Hash:    plumbing.NewHash("1212121212121212121212121212121212121212"),
						Message: "this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 87654321",
					},
				},
			}
			labels, err := FindLabelsInCommits(commitIter, "TransportRequest")
			if assert.NoError(t, err) {
				assert.Equal(t, []string{"12345678", "87654321"}, labels)
			}
		})

		t.Run("two different ids in different commits agains, order needs to be the same", func(t *testing.T) {
			commitIter := &commitIteratorMock{
				commits: []object.Commit{
					object.Commit{
						Hash:    plumbing.NewHash("1212121212121212121212121212121212121212"),
						Message: "this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 87654321",
					},
					object.Commit{
						Hash:    plumbing.NewHash("3434343434343434343434343434343434343434"),
						Message: "this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 12345678",
					},
				},
			}
			labels, err := FindLabelsInCommits(commitIter, "TransportRequest")
			if assert.NoError(t, err) {
				assert.Equal(t, []string{"12345678", "87654321"}, labels)
			}
		})

		t.Run("the same id in different commits", func(t *testing.T) {
			commitIter := &commitIteratorMock{
				commits: []object.Commit{
					object.Commit{
						Hash:    plumbing.NewHash("3434343434343434343434343434343434343434"),
						Message: "this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 12345678",
					},
					object.Commit{
						Hash:    plumbing.NewHash("1212121212121212121212121212121212121212"),
						Message: "this is a commit with TransportRequestId\n\nThis is the first line of the message body\nTransportRequest: 12345678",
					},
				},
			}
			labels, err := FindLabelsInCommits(commitIter, "TransportRequest")
			if assert.NoError(t, err) {
				expected := []string{"12345678"}
				if assert.Len(t, labels, len(expected)) {
					assert.Subset(t, expected, labels)
				}
			}
		})
		t.Run("default label with default reg ex", func(t *testing.T) {
			commitIter := &commitIteratorMock{
				commits: []object.Commit{
					object.Commit{
						Hash:    plumbing.NewHash("3434343434343434343434343434343434343434"),
						Message: "TransportRequest: 12345678",
					},
				},
			}
			labels, err := FindLabelsInCommits(commitIter, "TransportRequest\\s?:")
			if assert.NoError(t, err) {
				assert.Equal(t, "12345678", labels[0])
			}
		})
	})
}

func TestFinishLabel(t *testing.T) {
	t.Parallel()
	t.Run("default label old", func(t *testing.T) {
		assert.Equal(t, `(?m)^\s*TransportRequest\s?:\s*(\S*)\s*$`, finishLabel("TransportRequest\\s?:"))
	})
	t.Run("default label new", func(t *testing.T) {
		assert.Equal(t, `(?m)^\s*TransportRequest\s*:\s*(\S*)\s*$`, finishLabel("TransportRequest"))
	})

}

func TestFindIDInRange(t *testing.T) {

	// For these functions we have already tests. In order to avoid re-testing
	// we set mocks for these functions.
	logRange = func(repo *git.Repository, from, to string) (object.CommitIter, error) {
		return &commitIteratorMock{}, nil
	}

	defer func() {
		logRange = pipergit.LogRange
		findLabelsInCommits = FindLabelsInCommits
	}()

	t.Run("range is forwarded correctly", func(t *testing.T) {

		var receivedFrom, receivedTo string

		oldLogRangeFunc := logRange
		logRange = func(repo *git.Repository, from, to string) (object.CommitIter, error) {
			receivedFrom = from
			receivedTo = to
			return &commitIteratorMock{}, nil
		}
		defer func() {
			logRange = oldLogRangeFunc
		}()

		findIDInRange("TransportRequest", "master", "HEAD", &TrGitUtilsMock{})

		assert.Equal(t, "master", receivedFrom)
		assert.Equal(t, "HEAD", receivedTo)
	})

	t.Run("no label is found", func(t *testing.T) {

		findLabelsInCommits = func(commits object.CommitIter, label string) ([]string, error) {
			return []string{}, nil
		}

		defer func() {
			findLabelsInCommits = FindLabelsInCommits
		}()

		_, err := findIDInRange("TransportRequest", "master", "HEAD", &TrGitUtilsMock{})

		assert.EqualError(t, err, "No values found for 'TransportRequest' in range 'master..HEAD'")
	})

	t.Run("one label is found", func(t *testing.T) {

		findLabelsInCommits = func(commits object.CommitIter, label string) ([]string, error) {
			return []string{"123456789"}, nil
		}

		defer func() {
			findLabelsInCommits = FindLabelsInCommits
		}()

		label, err := findIDInRange("TransportRequest", "master", "HEAD", &TrGitUtilsMock{})
		if assert.NoError(t, err) {
			assert.Equal(t, "123456789", label)
		}
	})

	t.Run("more than one label is found", func(t *testing.T) {

		findLabelsInCommits = func(commits object.CommitIter, label string) ([]string, error) {
			return []string{"123456789", "987654321"}, nil
		}

		defer func() {
			findLabelsInCommits = FindLabelsInCommits
		}()

		_, err := findIDInRange("TransportRequest", "master", "HEAD", &TrGitUtilsMock{})
		if assert.Error(t, err) {
			// don't want to rely on the order
			assert.Contains(t, err.Error(), "More than one values found for label 'TransportRequest' in range 'master..HEAD'")
			assert.Contains(t, err.Error(), "123456789")
			assert.Contains(t, err.Error(), "987654321")
		}
	})

}