kata-containers/src/runtime/virtcontainers/pkg/agent/protocols/grpc/utils_test.go

//
// Copyright (c) 2017 Intel Corporation
//
// SPDX-License-Identifier: Apache-2.0
//

package grpc

import (
	"encoding/json"
	"os"
	"reflect"
	"testing"

	"github.com/opencontainers/runtime-spec/specs-go"
	"github.com/stretchr/testify/assert"
)

const ociConfigFile = "config.json"

func assertProcessIsEqual(t *testing.T, ociProcess *specs.Process, grpcProcess *Process) {
	assert := assert.New(t)

	// Process checks: User
	assert.Equal(grpcProcess.User.UID, ociProcess.User.UID)
	assert.Equal(grpcProcess.User.GID, ociProcess.User.GID)

	// Process checks: Capabilities
	assert.Equal(grpcProcess.Capabilities.Bounding, ociProcess.Capabilities.Bounding)
	assert.Equal(grpcProcess.Capabilities.Effective, ociProcess.Capabilities.Effective)
	assert.Equal(grpcProcess.Capabilities.Inheritable, ociProcess.Capabilities.Inheritable)
	assert.Equal(grpcProcess.Capabilities.Permitted, ociProcess.Capabilities.Permitted)
	assert.Equal(grpcProcess.Capabilities.Ambient, ociProcess.Capabilities.Ambient)
}

func assertIsEqual(t *testing.T, ociSpec *specs.Spec, grpcSpec *Spec) {
	assert := assert.New(t)

	// Version check
	assert.Equal(grpcSpec.Version, ociSpec.Version)

	// Process checks:
	assertProcessIsEqual(t, ociSpec.Process, grpcSpec.Process)

	// Annotations checks: Annotations
	assert.Equal(len(grpcSpec.Annotations), len(ociSpec.Annotations))

	for k := range grpcSpec.Annotations {
		assert.Equal(grpcSpec.Annotations[k], ociSpec.Annotations[k])
	}

	// Linux checks: Devices
	assert.Equal(len(grpcSpec.Linux.Resources.Devices), len(ociSpec.Linux.Resources.Devices))
	assert.Equal(len(grpcSpec.Linux.Resources.Devices), 1)
	assert.Equal(grpcSpec.Linux.Resources.Devices[0].Access, "rwm")

	// Linux checks: Block IO, for checking embedded structures copy
	assert.NotNil(ociSpec.Linux.Resources.BlockIO.LeafWeight)
	assert.NotNil(ociSpec.Linux.Resources.BlockIO.Weight)
	assert.EqualValues(grpcSpec.Linux.Resources.BlockIO.Weight, *ociSpec.Linux.Resources.BlockIO.Weight)
	assert.EqualValues(grpcSpec.Linux.Resources.BlockIO.LeafWeight, *ociSpec.Linux.Resources.BlockIO.LeafWeight)
	assert.NotEqual(len(grpcSpec.Linux.Resources.BlockIO.WeightDevice), 0)
	assert.Equal(len(grpcSpec.Linux.Resources.BlockIO.WeightDevice), len(grpcSpec.Linux.Resources.BlockIO.WeightDevice))
	assert.EqualValues(grpcSpec.Linux.Resources.BlockIO.WeightDevice[0].Major, ociSpec.Linux.Resources.BlockIO.WeightDevice[0].Major)
	assert.EqualValues(grpcSpec.Linux.Resources.BlockIO.WeightDevice[0].Minor, ociSpec.Linux.Resources.BlockIO.WeightDevice[0].Minor)
	assert.NotNil(ociSpec.Linux.Resources.BlockIO.WeightDevice[0].LeafWeight)
	assert.NotNil(ociSpec.Linux.Resources.BlockIO.WeightDevice[0].Weight)
	assert.EqualValues(grpcSpec.Linux.Resources.BlockIO.WeightDevice[0].Weight, *ociSpec.Linux.Resources.BlockIO.WeightDevice[0].Weight)
	assert.EqualValues(grpcSpec.Linux.Resources.BlockIO.WeightDevice[0].LeafWeight, *ociSpec.Linux.Resources.BlockIO.WeightDevice[0].LeafWeight)

	// Linux checks: Namespaces
	assert.Equal(len(grpcSpec.Linux.Namespaces), len(ociSpec.Linux.Namespaces))
	assert.Equal(len(grpcSpec.Linux.Namespaces), 5)

	for i := range grpcSpec.Linux.Namespaces {
		assert.Equal(grpcSpec.Linux.Namespaces[i].Type, (string)(ociSpec.Linux.Namespaces[i].Type)) //nolint:unconvert
		assert.Equal(grpcSpec.Linux.Namespaces[i].Path, (string)(ociSpec.Linux.Namespaces[i].Path)) //nolint:unconvert
	}
}

func TestOCItoGRPC(t *testing.T) {
	assert := assert.New(t)
	var ociSpec specs.Spec

	configJSONBytes, err := os.ReadFile(ociConfigFile)
	assert.NoError(err, "Could not open OCI config file")

	err = json.Unmarshal(configJSONBytes, &ociSpec)
	assert.NoError(err, "Could not unmarshall OCI config file")

	spec, err := OCItoGRPC(&ociSpec)
	assert.NoError(err, "Could not convert OCI config file")
	assertIsEqual(t, &ociSpec, spec)
}

func TestProcessOCItoGRPC(t *testing.T) {
	assert := assert.New(t)
	var ociSpec specs.Spec

	configJSONBytes, err := os.ReadFile(ociConfigFile)
	assert.NoError(err, "Could not open OCI config file")

	err = json.Unmarshal(configJSONBytes, &ociSpec)
	assert.NoError(err, "Could not unmarshall OCI config file")

	process, err := ProcessOCItoGRPC(ociSpec.Process)
	assert.NoError(err, "Could not convert OCI config file")
	assertProcessIsEqual(t, ociSpec.Process, process)
}

func TestProcessGRPCtoOCI(t *testing.T) {
	assert := assert.New(t)

	var ociSpec specs.Spec

	configJSONBytes, err := os.ReadFile(ociConfigFile)
	assert.NoError(err, "Could not open OCI config file")

	err = json.Unmarshal(configJSONBytes, &ociSpec)
	assert.NoError(err, "Could not unmarshall OCI config file")

	grpcProcess, err := ProcessOCItoGRPC(ociSpec.Process)
	assert.NoError(err, "Could not convert OCI config file")

	newOciProcess, err := ProcessGRPCtoOCI(grpcProcess)
	assert.NoError(err, "Could not convert gRPC structure")

	assertProcessIsEqual(t, newOciProcess, grpcProcess)
}

func testCopyValue(t *testing.T, to, from interface{}) {
	assert := assert.New(t)

	err := copyValue(reflect.ValueOf(to).Elem(), reflect.ValueOf(from))
	assert.NoError(err, "Could not copy to %v", reflect.ValueOf(from).Kind())
	assert.Equal(reflect.ValueOf(to).Elem().Interface(), reflect.ValueOf(from).Interface())
}

func TestCopyValueString(t *testing.T) {
	from := "foobar"
	to := new(string)

	testCopyValue(t, to, from)
}

func TestCopyValueSlice(t *testing.T) {
	from := []string{"foobar", "barfoo"}
	to := new([]string)

	testCopyValue(t, to, from)
}

func TestCopyValueStruc(t *testing.T) {
	type dummyStruct struct {
		S string
		I int
	}

	from := dummyStruct{
		S: "foobar",
		I: 18,
	}
	to := new(dummyStruct)

	testCopyValue(t, to, from)
}

func TestCopyValueMap(t *testing.T) {
	from := map[string]string{
		"key1": "value1",
		"key2": "value2",
	}
	to := new(map[string]string)

	testCopyValue(t, to, from)
}