github.com/benchkram/bob@v0.0.0-20240314204020-b7a57f2f9be9/test/e2e/multilevelbuild/multilevelbuild_test.go

package multilevelbuildtest

import (
	"bytes"
	"context"
	"fmt"
	"os"
	"os/exec"
	"path/filepath"
	"time"

	"github.com/benchkram/bob/bob"
	"github.com/benchkram/bob/bob/playbook"
	"github.com/benchkram/bob/pkg/file"
	"github.com/benchkram/errz"

	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

type binaryOutputFixture struct {
	path   string
	output string
}

type requiresRebuildFixture struct {
	taskname        string
	requiresRebuild bool
}

var _ = Describe("Test bob multilevel build", func() {
	Context("in a fresh environment", func() {

		It("initializes bob playground", func() {
			Expect(bob.CreatePlayground(bob.PlaygroundOptions{Dir: dir})).NotTo(HaveOccurred())
		})

		It("runs build all", func() {
			ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
			Expect(b.Build(ctx, bob.BuildAllTargetName)).NotTo(HaveOccurred())
			cancel()
		})

		binaries := []binaryOutputFixture{
			{
				path:   filepath.Join(dir, "run"),
				output: "Hello Playground v1\nByebye Playground v1\n",
			},
			{
				path:   filepath.Join(dir, bob.SecondLevelDir, "runsecondlevel"),
				output: "Hello Playground v2\nByebye Playground v2\n",
			},
			{
				path:   filepath.Join(dir, bob.SecondLevelDir, bob.ThirdLevelDir, "runthirdlevel"),
				output: "Hello Playground v3\nByebye Playground v3\n",
			},
		}

		It("checks that the built binaries exist", func() {
			for _, b := range binaries {
				Expect(file.Exists(b.path)).To(BeTrue(), fmt.Sprintf("%s doesn't exist", b.path))
			}
		})

		It("checks that the built binaries produce the expected output", func() {
			for _, b := range binaries {
				cmd := exec.Command("./" + b.path)
				var stdout, stderr bytes.Buffer
				cmd.Stdout = &stdout
				cmd.Stderr = &stderr

				// The binarys are waiting for a ctrl-c
				// to shutdown.
				go func() {
					time.Sleep(500 * time.Millisecond)
					err := cmd.Process.Signal(os.Interrupt)
					Expect(err).NotTo(HaveOccurred())
				}()

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

				Expect(b.output).To(Equal(stderr.String()))
			}
		})

		It("runs build multilinetouch", func() {
			ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
			Expect(b.Build(ctx, "multilinetouch")).NotTo(HaveOccurred())
			cancel()
		})

		It("checks that the touched files really exist", func() {
			files := []string{
				"multilinefile1",
				"multilinefile2",
				"multilinefile3",
				"multilinefile4",
				"multilinefile5",
			}

			for _, f := range files {
				Expect(file.Exists(f)).To(BeTrue(), fmt.Sprintf("%s doesn't exist", f))
			}
		})

		It("checks that we do not require a rebuild of any of the levels", func() {
			fixtures := []requiresRebuildFixture{
				{
					taskname:        bob.BuildAllTargetName,
					requiresRebuild: false,
				},
				{
					taskname:        "second-level/build2",
					requiresRebuild: false,
				},
				{
					taskname:        "second-level/third-level/build3",
					requiresRebuild: false,
				},
			}

			requiresRebuildMustMatchFixtures(b, fixtures)
		})

		It("changes a file of the second-level", func() {
			f := filepath.Join(dir, bob.SecondLevelDir, "main2.go")
			c, err := os.ReadFile(f)
			Expect(err).NotTo(HaveOccurred())

			c = append(c, []byte("// some random comment so the file content is changed")...)

			err = os.WriteFile(f, c, 0644)
			Expect(err).NotTo(HaveOccurred())
		})

		It("checks that we now require a rebuild of the second- and first-level, but not the third-level", func() {
			fixtures := []requiresRebuildFixture{
				{
					taskname:        bob.BuildAllTargetName,
					requiresRebuild: true,
				},
				{
					taskname:        "second-level/build2",
					requiresRebuild: true,
				},
				{
					taskname:        "second-level/third-level/build3",
					requiresRebuild: false,
				},
			}

			requiresRebuildMustMatchFixtures(b, fixtures)
		})

		It("runs build all again", func() {
			ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
			Expect(b.Build(ctx, bob.BuildAllTargetName)).NotTo(HaveOccurred())
			cancel()
		})

		It("checks that we do not require a rebuild of any of the levels", func() {
			fixtures := []requiresRebuildFixture{
				{
					taskname:        bob.BuildAllTargetName,
					requiresRebuild: false,
				},
				{
					taskname:        "second-level/build2",
					requiresRebuild: false,
				},
				{
					taskname:        "second-level/third-level/build3",
					requiresRebuild: false,
				},
			}

			requiresRebuildMustMatchFixtures(b, fixtures)
		})

		It("changes a file of the third-level", func() {
			f := filepath.Join(dir, bob.SecondLevelDir, bob.ThirdLevelDir, "main3.go")
			c, err := os.ReadFile(f)
			Expect(err).NotTo(HaveOccurred())

			c = append(c, []byte("// some random comment so the file content is changed")...)

			err = os.WriteFile(f, c, 0644)
			Expect(err).NotTo(HaveOccurred())
		})

		It("checks that we now require a rebuild of the third-, second- and first-level", func() {
			fixtures := []requiresRebuildFixture{
				{
					taskname:        bob.BuildAllTargetName,
					requiresRebuild: true,
				},
				{
					taskname:        "second-level/build2",
					requiresRebuild: true,
				},
				{
					taskname:        "second-level/third-level/build3",
					requiresRebuild: true,
				},
			}

			err := artifactsClean()
			Expect(err).NotTo(HaveOccurred())
			requiresRebuildMustMatchFixtures(b, fixtures)
		})
	})
})

func requiresRebuildMustMatchFixtures(b *bob.B, fixtures []requiresRebuildFixture) {
	aggregate, err := b.Aggregate()
	Expect(err).NotTo(HaveOccurred())

	err = b.Nix().BuildNixDependenciesInPipeline(aggregate, bob.BuildAllTargetName)
	Expect(err).NotTo(HaveOccurred())

	pb, err := aggregate.Playbook(bob.BuildAllTargetName)
	Expect(err).NotTo(HaveOccurred())

	err = pb.Build(context.Background())
	errz.Log(err)
	Expect(err).NotTo(HaveOccurred())

	for _, f := range fixtures {
		ts, err := pb.TaskStatus(f.taskname)
		Expect(err).NotTo(HaveOccurred())
		requiresRebuild := ts.State() != playbook.StateNoRebuildRequired

		Expect(f.requiresRebuild).To(Equal(requiresRebuild), fmt.Sprintf("task's %q rebuild requirement differ, got: %t, want: %t", f.taskname, requiresRebuild, f.requiresRebuild))
	}
}