src/sys/pkg/bin/pm/build/snapshot_test.go

// Copyright 2020 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 build

import (
	"reflect"
	"sort"
	"testing"
)

// merkleRootGenerator allows test cases to hand generate sequential merkle roots
type merkleRootGenerator MerkleRoot

// Value returns the current MerkleRoot
func (b *merkleRootGenerator) Value() MerkleRoot {
	return MerkleRoot(*b)
}

// Next moves to and returns the next sequential merkle root
func (b *merkleRootGenerator) Next() MerkleRoot {
	b[1]++
	return b.Value()
}

// NextEpoch moves to and returns the start of the next block of merkle roots
func (b *merkleRootGenerator) NextEpoch() MerkleRoot {
	b[0]++
	b[1] = 0
	return b.Value()
}

// snapshotBuilder allows test cases to hand generate Snapshot structures
type snapshotBuilder struct {
	t        *testing.T
	snapshot Snapshot

	currentBlobID merkleRootGenerator
}

type fileRef = PackageFileRef

func newSnapshotBuilder(t *testing.T) *snapshotBuilder {
	return &snapshotBuilder{
		t: t,
		snapshot: Snapshot{
			Packages: map[string]Package{},
			Blobs:    map[MerkleRoot]BlobInfo{},
		},
	}
}

func (b *snapshotBuilder) ensurePackage(name string) {
	if _, ok := b.snapshot.Packages[name]; !ok {
		b.snapshot.Packages[name] = Package{
			Files: map[string]MerkleRoot{},
		}
	}
}

// IncrementMerkleRootEpoch moves to the start of the next block of merkle roots
func (b *snapshotBuilder) IncrementMerkleRootEpoch() *snapshotBuilder {
	b.currentBlobID.NextEpoch()
	return b
}

// IncrementMerkleRoot moves to the next sequential merkle root
func (b *snapshotBuilder) IncrementMerkleRoot() *snapshotBuilder {
	b.currentBlobID.Next()
	return b
}

// Package declares a new package with the given tags
func (b *snapshotBuilder) Package(pkg string, tags ...string) *snapshotBuilder {
	if _, ok := b.snapshot.Packages[pkg]; ok {
		b.t.Fatal("Package already defined")
	}
	b.snapshot.Packages[pkg] = Package{
		Files: map[string]MerkleRoot{},
		Tags:  tags,
	}
	return b
}

// File defines a new file with the given size, included at the given locations
func (b *snapshotBuilder) File(size uint64, refs ...fileRef) *snapshotBuilder {
	if len(refs) == 0 {
		b.t.Fatal("File called without any file refs")
	}
	b.IncrementMerkleRoot()
	b.snapshot.Blobs[b.currentBlobID.Value()] = BlobInfo{Size: size}

	for _, ref := range refs {
		b.ensurePackage(ref.Name)
		b.snapshot.Packages[ref.Name].Files[ref.Path] = b.currentBlobID.Value()
	}

	return b
}

// Build finalizes and returns the Snapshot
func (b *snapshotBuilder) Build() Snapshot {
	if err := b.snapshot.Verify(); err != nil {
		b.t.Fatal(err)
	}
	return b.snapshot
}

func makeTestSnapshot(t *testing.T) Snapshot {
	return newSnapshotBuilder(t).
		Package("system/0", "monolith").
		Package("foo/0", "monolith").
		Package("bar/0", "monolith").
		Package("foobar/0", "monolith").
		Package("optional/0", "available").
		File(1024, fileRef{"system/0", "a"}).
		File(1024, fileRef{"system/0", "b"}).
		File(1024, fileRef{"system/0", "c"}).
		File(1024, fileRef{"system/0", "d"}).
		File(1024, fileRef{"system/0", "e"}).
		File(1024, fileRef{"system/0", "f"}).
		File(1024, fileRef{"system/0", "meta/"}).
		File(1024, fileRef{"foo/0", "bin/app"}).
		File(1024, fileRef{"foo/0", "fileA"}).
		File(1024, fileRef{"foo/0", "meta/"}).
		File(1024, fileRef{"bar/0", "bin/app"}).
		File(1024, fileRef{"bar/0", "fileB"}).
		File(1024, fileRef{"bar/0", "meta/"}).
		File(1024, fileRef{"foobar/0", "bin/app"}).
		File(1024, fileRef{"foobar/0", "meta/"}).
		File(1024, fileRef{"optional/0", "bin/app"}).
		File(1024, fileRef{"optional/0", "meta/"}).
		File(1024,
			fileRef{"foo/0", "lib/ld.so.1"},
			fileRef{"bar/0", "lib/ld.so.1"},
			fileRef{"foobar/0", "lib/ld.so.1"},
			fileRef{"optional/0", "lib/ld.so.1"},
		).
		File(1024,
			fileRef{"foo/0", "lib/libfdio.so"},
			fileRef{"bar/0", "lib/libfdio.so"},
			fileRef{"foobar/0", "lib/libfdio.so"},
			fileRef{"optional/0", "lib/libfdio.so"},
		).
		Build()
}

func verifyFilteredSnapshot(t *testing.T, original Snapshot, filtered Snapshot, expected []string) {
	// Ensure the correct blobs are present
	if err := filtered.Verify(); err != nil {
		t.Errorf("filter produced inconsistent snapshot: %v", err)
	}

	// Package entries should not change
	actual := []string{}
	for name, pkg := range filtered.Packages {
		actual = append(actual, name)
		if !reflect.DeepEqual(pkg, original.Packages[name]) {
			t.Errorf("filter modified a package entry")
		}
	}

	// Only the expected packages should be there
	sort.Strings(actual)
	sort.Strings(expected)
	if !reflect.DeepEqual(actual, expected) {
		t.Errorf("expected %v, got %v", expected, actual)
	}
}

func TestSnapshotFilter_includeAll(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"*"}, []string{})

	if !reflect.DeepEqual(original, filtered) {
		t.Errorf("identity filter did not produce an equivalent Snapshot")
	}
}

func TestSnapshotFilter_includeNone(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{}, []string{})
	verifyFilteredSnapshot(t, original, filtered, []string{})
}

func TestSnapshotFilter_includeSingleTag(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"monolith"}, []string{})
	verifyFilteredSnapshot(t, original, filtered, []string{"system/0", "foo/0", "bar/0", "foobar/0"})

	filtered = original.Filter([]string{"available"}, []string{})
	verifyFilteredSnapshot(t, original, filtered, []string{"optional/0"})
}

func TestSnapshotFilter_matchSingleTag(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"monolith"}, []string{})
	verifyFilteredSnapshot(t, original, filtered, []string{"system/0", "foo/0", "bar/0", "foobar/0"})
}

func TestSnapshotFilter_excludeSingleTag(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"*"}, []string{"available"})
	verifyFilteredSnapshot(t, original, filtered, []string{"system/0", "foo/0", "bar/0", "foobar/0"})
}

func TestSnapshotFilter_excludeSinglePackage(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"*"}, []string{"bar/0"})
	verifyFilteredSnapshot(t, original, filtered, []string{"system/0", "foo/0", "optional/0", "foobar/0"})

	filtered = original.Filter([]string{"*"}, []string{"bar/*"})
	verifyFilteredSnapshot(t, original, filtered, []string{"system/0", "foo/0", "optional/0", "foobar/0"})
}

func TestSnapshotFilter_includeMultiplePackage(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"foo/0", "optional/0"}, []string{})
	verifyFilteredSnapshot(t, original, filtered, []string{"foo/0", "optional/0"})
}

func TestSnapshotFilter_excludeMultiplePackage(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"*"}, []string{"foo/0", "optional/0"})
	verifyFilteredSnapshot(t, original, filtered, []string{"system/0", "bar/0", "foobar/0"})
}

func TestSnapshotFilter_includeWildcardPackage(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"foo*"}, []string{})
	verifyFilteredSnapshot(t, original, filtered, []string{"foo/0", "foobar/0"})
}

func TestSnapshotFilter_excludeWildcardPackage(t *testing.T) {
	original := makeTestSnapshot(t)

	filtered := original.Filter([]string{"*"}, []string{"foo*"})
	verifyFilteredSnapshot(t, original, filtered, []string{"system/0", "bar/0", "optional/0"})
}

func TestSnapshotAddPackage_consistent(t *testing.T) {
	s := newSnapshotBuilder(t).Build()
	var m merkleRootGenerator

	shared := PackageBlobInfo{
		Path:   "shared",
		Size:   42,
		Merkle: m.Next(),
	}

	if err := s.AddPackage("foo/0", []PackageBlobInfo{
		{
			Path:   "a",
			Size:   100,
			Merkle: m.Next(),
		},
		{
			Path:   "b",
			Size:   100,
			Merkle: m.Next(),
		},
		shared,
	}, nil); err != nil {
		t.Errorf("expected success, got %v", err)
	}

	{
		expected := newSnapshotBuilder(t).
			Package("foo/0").
			File(42,
				fileRef{"foo/0", "shared"},
			).
			File(100, fileRef{"foo/0", "a"}).
			File(100, fileRef{"foo/0", "b"}).
			Build()

		if !reflect.DeepEqual(s, expected) {
			t.Errorf("\n%v\n!=\n%v\n", s, expected)
		}
	}

	if err := s.AddPackage("bar/0", []PackageBlobInfo{
		{
			Path:   "a",
			Size:   200,
			Merkle: m.Next(),
		},
		{
			Path:   "b",
			Size:   200,
			Merkle: m.Next(),
		},
		shared,
	}, nil); err != nil {
		t.Errorf("expected success, got %v", err)
	}

	{
		expected := newSnapshotBuilder(t).
			Package("foo/0").
			Package("bar/0").
			File(42,
				fileRef{"foo/0", "shared"},
				fileRef{"bar/0", "shared"},
			).
			File(100, fileRef{"foo/0", "a"}).
			File(100, fileRef{"foo/0", "b"}).
			File(200, fileRef{"bar/0", "a"}).
			File(200, fileRef{"bar/0", "b"}).
			Build()

		if !reflect.DeepEqual(s, expected) {
			t.Errorf("\n%v\n!=\n%v\n", s, expected)
		}
	}
}

func TestSnapshotAddPackage_duplicatePackage(t *testing.T) {
	s := newSnapshotBuilder(t).
		Package("foo/0").
		Build()

	if err := s.AddPackage("foo/0", nil, []string{"b"}); err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	if err := s.AddPackage("foo/0", nil, []string{"a"}); err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	if err := s.AddPackage("foo/0", nil, []string{"a"}); err != nil {
		t.Fatalf("expected nil, got %v", err)
	}
	tags := s.Packages["foo/0"].Tags
	if len(tags) != 2 || tags[0] != "a" || tags[1] != "b" {
		t.Fatalf("expected tags a,b, got %v", s.Packages["foo"].Tags)
	}

	if err := s.AddPackage("foo/0", []PackageBlobInfo{
		{
			Path: "differentFileA",
			Size: 1234,
		},
	}, nil); err == nil {
		t.Error("expected error, got nil")
	}
}

func TestSnapshotAddPackage_inconsistentBlob(t *testing.T) {
	s := newSnapshotBuilder(t).
		Package("foo/0").
		File(100, fileRef{"foo/0", "fileA"}).
		Build()

	merkle := s.Packages["foo/0"].Files["fileA"]

	if err := s.AddPackage("bar/0", []PackageBlobInfo{
		{
			Path:   "differentFileA",
			Size:   s.Blobs[merkle].Size + 1,
			Merkle: merkle,
		},
	}, nil); err == nil {
		t.Errorf("expected err, got nil")
	}
}