tools/integration/testsharder/images_test.go

// Copyright 2021 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package testsharder

import (
	"os"
	"path/filepath"
	"testing"

	"github.com/google/go-cmp/cmp"

	"go.fuchsia.dev/fuchsia/tools/build"
)

func mockImages(t *testing.T) ([]build.Image, string) {
	t.Helper()
	imgs := []build.Image{
		{
			PaveArgs: []string{"--boot", "--zircona"},
			Name:     "zircon-a",
			Path:     "fuchsia.zbi",
			Label:    "//build/images:fuchsia-zbi",
			Type:     "zbi",
		},
		{
			PaveZedbootArgs: []string{"--zirconr"},
			Name:            "zircon-r",
			Path:            "zedboot.zbi",
			Label:           "//build/images:zedboot-zbi",
			Type:            "zbi",
		},
		{
			NetbootArgs: []string{"--boot"},
			Name:        "netboot",
			Path:        "netboot.zbi",
			Label:       "//build/images:netboot-zbi",
			Type:        "zbi",
		},
		{
			Name:  "qemu-kernel",
			Path:  "multiboot.bin",
			Label: "//build/images:qemu-kernel",
			Type:  "kernel",
		},
		{
			Name:  "other-qemu-kernel",
			Path:  "other-qemu-kernel.bin",
			Label: "//build/images:other-qemu-kernel",
			Type:  "kernel",
		},
		{
			Name:  "storage-full",
			Path:  "obj/build/images/fuchsia/fuchsia/fvm.blk",
			Label: "//build/images/fuchsia/my-fvm",
			Type:  "blk",
		},
		{
			Name:  "my-zbi",
			Path:  "my.zbi",
			Label: "//build/images:my-zbi",
			Type:  "zbi",
		},
		{
			Name:  "my-vbmeta",
			Path:  "my.vbmeta",
			Label: "//build/images:my-vbmeta",
			Type:  "vbmeta",
		},
	}
	imgDir := t.TempDir()
	for _, img := range imgs {
		path := filepath.Join(imgDir, img.Path)
		dir := filepath.Dir(path)
		if err := os.MkdirAll(dir, os.ModePerm); err != nil {
			t.Fatalf("MkdirAll(%s) failed: %s", dir, err)
		}
		f, err := os.Create(path)
		if err != nil {
			t.Fatalf("Create(%s) failed: %s", path, err)
		}
		defer f.Close()
	}
	return imgs, imgDir
}

func TestAddImageDeps(t *testing.T) {
	imgs, imgDir := mockImages(t)
	testCases := []struct {
		name           string
		pave           bool
		imageOverrides build.ImageOverrides
		deviceType     string
		want           []string
	}{
		{
			name:       "emulator image deps",
			deviceType: "AEMU",
			pave:       false,
			want:       []string{"fuchsia.zbi", "images.json", "multiboot.bin", "obj/build/images/fuchsia/fuchsia/fvm.blk"},
		},
		{
			name:       "paving image deps",
			deviceType: "NUC",
			pave:       true,
			want:       []string{"fuchsia.zbi", "images.json", "zedboot.zbi"},
		},
		{
			name:       "netboot image deps",
			deviceType: "NUC",
			pave:       false,
			want:       []string{"images.json", "netboot.zbi", "zedboot.zbi"},
		},
		{
			name:           "emulator env with qemu kernel override",
			deviceType:     "AEMU",
			pave:           false,
			imageOverrides: build.ImageOverrides{ZBI: "//build/images:my-zbi", QEMUKernel: "//build/images:other-qemu-kernel"},
			want:           []string{"images.json", "my.zbi", "other-qemu-kernel.bin"},
		},
		{
			name:           "emulator env with no qemu kernel override",
			deviceType:     "AEMU",
			pave:           false,
			imageOverrides: build.ImageOverrides{ZBI: "//build/images:my-zbi"},
			want:           []string{"images.json", "multiboot.bin", "my.zbi"},
		},
		{
			name:           "hardware env with image overrides",
			deviceType:     "NUC",
			pave:           false,
			imageOverrides: build.ImageOverrides{ZBI: "//build/images:my-zbi", VBMeta: "//build/images:my-vbmeta"},
			want:           []string{"images.json", "my.vbmeta", "my.zbi", "zedboot.zbi"},
		},
		{
			name:       "GCE image deps",
			deviceType: "GCE",
			pave:       false,
			want:       []string{"images.json"},
		},
		{
			name: "host-test only shard image deps",
			pave: false,
		},
	}
	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			s := &Shard{
				ImageOverrides: tc.imageOverrides,
				Env: build.Environment{
					Dimensions: build.DimensionSet{
						"device_type": tc.deviceType,
					},
				},
			}
			AddImageDeps(s, imgDir, imgs, tc.pave)
			if diff := cmp.Diff(tc.want, s.Deps); diff != "" {
				t.Errorf("AddImageDeps(%v, %v, %t) failed: (-want +got): \n%s", s, imgs, tc.pave, diff)
			}
		})
	}
}