github.com/linuxboot/fiano@v1.2.0/pkg/cbfs/image_test.go

// Copyright 2018-2021 the LinuxBoot 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 cbfs

import (
	"bytes"
	"fmt"
	"io"
	"os"
	"reflect"
	"strings"
	"testing"
)

func TestReadFile(t *testing.T) {
	Debug = t.Logf
	f, err := os.Open("testdata/coreboot.rom")
	if err != nil {
		t.Fatal(err)
	}
	i, err := NewImage(f)
	if err != nil {
		t.Fatal(err)
	}
	t.Logf("%s", i)
}

func TestCompression(t *testing.T) {
	Debug = t.Logf
	f, err := os.Open("testdata/coreboot.rom")
	if err != nil {
		t.Fatal(err)
	}
	i, err := NewImage(f)
	if err != nil {
		t.Fatal(err)
	}
	for s := range i.Segs {
		f := i.Segs[s].GetFile()
		if f.Name == "compression_test1" {
			if f.Compression() != LZ4 {
				t.Errorf("CBFS file '%s' has wrong compression '%s'", f.Name, f.Compression().String())
			}
			d, err := f.Decompress()
			if err != nil {
				t.Fatal(err)
			}
			data := []byte(strings.Repeat("FIANO ROCKS!\n", 1024))
			if !bytes.Equal(data, d) {
				t.Errorf("Decompressed file '%s' has unexpected contents: %s", f.Name, string(d)[0:12])
			}
		} else if f.Name == "compression_test2" {
			if f.Compression() != LZMA {
				t.Errorf("CBFS file '%s' has wrong compression '%s'", f.Name, f.Compression().String())
			}
			d, err := f.Decompress()
			if err != nil {
				t.Fatal(err)
			}

			data := []byte(strings.Repeat("FIANO ROCKS!\n", 1024))
			if !bytes.Equal(data, d) {
				t.Errorf("Decompressed file '%s' has unexpected contents: %s", f.Name, string(d)[0:12])
			}
		} else if f.Name == "fallback/bootblock" {
			if f.Compression() != None {
				t.Errorf("CBFS file '%s' has wrong compression '%s'", f.Name, f.Compression().String())
			}
		}
	}
	t.Logf("%s", i)
}

func TestBogusArchives(t *testing.T) {
	var tests = []struct {
		n    string
		r    io.ReadSeeker
		want string
	}{
		{"Short", bytes.NewReader([]byte("INUXARCHIV")), "cannot find FMAP signature"},
		{"Misaligned", bytes.NewReader([]byte("INUXARCHIVL")), "cannot find FMAP signature"},
	}

	for _, tc := range tests {
		t.Run(tc.n, func(t *testing.T) {
			_, err := NewImage(tc.r)
			if err == nil {
				t.Errorf("got nil, want %v", tc.want)
				return
			}
			e := fmt.Sprintf("%v", err)
			if e != tc.want {
				t.Errorf("got %v, want %v", e, tc.want)
			}
		})
	}
}

func TestReadSimple(t *testing.T) {
	var tests = []struct {
		n    string
		b    []byte
		want string
	}{
		{"Master Only", Master, ""},
	}
	Debug = t.Logf
	for _, tc := range tests {
		t.Run(tc.n, func(t *testing.T) {
			r := bytes.NewReader(tc.b)
			_, err := NewImage(r)
			if err != nil {
				t.Errorf("got %v, want nil", err)
				return
			}
		})
	}
}

func TestConflict(t *testing.T) {
	if err := RegisterFileReader(&SegReader{Type: 2, Name: "CBFSRaw", New: nil}); err == nil {
		t.Fatalf("Registering conflicting entry to type 2, want error, got nil")
	}

}

func TestStringer(t *testing.T) {
	f, err := os.Open("testdata/coreboot.rom")
	if err != nil {
		t.Fatal(err)
	}
	i, err := NewImage(f)
	if err != nil {
		t.Fatal(err)
	}
	s := i.String()

	t.Logf("Image string: %v", s)
}

func TestSimpleWrite(t *testing.T) {
	Debug = t.Logf
	f, err := os.Open("testdata/coreboot.rom")
	if err != nil {
		t.Fatal(err)
	}
	i, err := NewImage(f)
	if err != nil {
		t.Fatal(err)
	}
	f.Close()
	out, err := os.CreateTemp("", "cbfs")
	if err != nil {
		t.Fatal(err)
	}
	defer os.Remove(out.Name())
	if err := i.WriteFile(out.Name(), 0666); err != nil {
		t.Fatal(err)
	}
	out.Close()

	fi, err := os.Stat(out.Name())
	if err != nil {
		t.Fatal(err)
	}
	t.Logf("output file %v", fi)
	old, err := os.ReadFile("testdata/coreboot.rom")
	if err != nil {
		t.Fatal(err)
	}
	new, err := os.ReadFile(out.Name())
	if err != nil {
		t.Fatal(err)
	}
	if !reflect.DeepEqual(old, new) {
		t.Fatalf("testdata/coreboot.rom and %s differ", out.Name())
	}

}

func TestRemovePayload(t *testing.T) {
	Debug = t.Logf
	f, err := os.Open("testdata/coreboot.rom")
	if err != nil {
		t.Fatal(err)
	}
	i, err := NewImage(f)
	if err != nil {
		t.Fatal(err)
	}
	f.Close()
	out, err := os.CreateTemp("", "cbfs")
	if err != nil {
		t.Fatal(err)
	}
	//	defer os.Remove(out.Name())
	if err := i.Remove("fallback/payload"); err != nil {
		t.Fatal(err)
	}
	if err := i.Update(); err != nil {
		t.Fatal(err)
	}
	if err := i.WriteFile(out.Name(), 0666); err != nil {
		t.Fatal(err)
	}
	out.Close()

	fi, err := os.Stat(out.Name())
	if err != nil {
		t.Fatal(err)
	}
	t.Logf("output file %v", fi)
	// FIXME: What is this supposed to do? `removepayload.rom` does not exist
	/*
		f, err = os.Open("testdata/removepayload.rom")
		if err != nil {
			t.Fatal(err)
		}
		old, err := NewImage(f)
		if err != nil {
			t.Fatal(err)
		}
		f.Close()
		f, err = os.Open(out.Name())
		if err != nil {
			t.Fatalf("%s: %v", out.Name(), err)
		}
		new, err := NewImage(f)
		if err != nil {
			t.Fatalf("%s: %v", out.Name(), err)
		}
		f.Close()
		if !reflect.DeepEqual(old, new) {
			t.Errorf("testdata/coreboot.rom and %s differ", out.Name())
		}
		t.Logf("new image is %s", new.String())
	*/

}