policies/changes_test.go

//  Copyright 2019 Google Inc. All Rights Reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

package policies

import (
	"reflect"
	"testing"

	"github.com/GoogleCloudPlatform/osconfig/packages"

	"cloud.google.com/go/osconfig/agentendpoint/apiv1beta/agentendpointpb"
)

func TestGetNecessaryChanges(t *testing.T) {
	tests := [...]struct {
		name           string
		installedPkgs  []*packages.PkgInfo
		upgradablePkgs []*packages.PkgInfo
		installPkgs    []*agentendpointpb.Package
		removePkgs     []*agentendpointpb.Package
		updatePkgs     []*agentendpointpb.Package
		want           changes
	}{
		{
			name:           "install from empty",
			installedPkgs:  createPkgInfos(),
			upgradablePkgs: createPkgInfos(),
			installPkgs:    createPackages("foo"),
			removePkgs:     createPackages(),
			updatePkgs:     createPackages(),
			want: changes{
				packagesToInstall: []string{"foo"},
				packagesToUpgrade: []string{},
				packagesToRemove:  []string{},
			},
		},
		{
			name:           "upgrade from empty",
			installedPkgs:  createPkgInfos(),
			upgradablePkgs: createPkgInfos(),
			installPkgs:    createPackages(),
			removePkgs:     createPackages(),
			updatePkgs:     createPackages("foo"),
			want: changes{
				packagesToInstall: []string{"foo"},
				packagesToUpgrade: []string{},
				packagesToRemove:  []string{},
			},
		}, {
			name:           "single upgrade",
			installedPkgs:  createPkgInfos("foo"),
			upgradablePkgs: createPkgInfos("foo"),
			installPkgs:    createPackages(),
			removePkgs:     createPackages(),
			updatePkgs:     createPackages("foo"),
			want: changes{
				packagesToInstall: []string{},
				packagesToUpgrade: []string{"foo"},
				packagesToRemove:  []string{},
			},
		}, {
			name:           "remove",
			installedPkgs:  createPkgInfos("foo"),
			upgradablePkgs: createPkgInfos("foo"),
			installPkgs:    createPackages(),
			removePkgs:     createPackages("foo"),
			updatePkgs:     createPackages(),
			want: changes{
				packagesToInstall: []string{},
				packagesToUpgrade: []string{},
				packagesToRemove:  []string{"foo"},
			},
		}, {
			name:           "mixed",
			installedPkgs:  createPkgInfos("foo", "bar", "buz"),
			upgradablePkgs: createPkgInfos("bar", "boo"),
			installPkgs:    createPackages("foo", "baz"),
			removePkgs:     createPackages("buz"),
			updatePkgs:     createPackages("bar"),
			want: changes{
				packagesToInstall: []string{"baz"},
				packagesToUpgrade: []string{"bar"},
				packagesToRemove:  []string{"buz"},
			},
		},
	}

	for _, tt := range tests {
		got := getNecessaryChanges(tt.installedPkgs, tt.upgradablePkgs, tt.installPkgs, tt.removePkgs, tt.updatePkgs)

		if !equalChanges(&got, &tt.want) {
			t.Errorf("Did not get expected changes for '%s', got: %v, want: %v", tt.name, got, tt.want)
		}
	}
}

func equalChanges(got *changes, want *changes) bool {
	return equalSlices(got.packagesToInstall, want.packagesToInstall) &&
		equalSlices(got.packagesToRemove, want.packagesToRemove) &&
		equalSlices(got.packagesToUpgrade, want.packagesToUpgrade)
}

func equalSlices(got []string, want []string) bool {
	if len(got) == 0 && len(want) == 0 {
		return true
	}
	return reflect.DeepEqual(got, want)
}

func createPkgInfos(names ...string) []*packages.PkgInfo {
	var res []*packages.PkgInfo
	for _, n := range names {
		res = append(res, &packages.PkgInfo{Name: n})
	}
	return res
}

func createPackages(names ...string) []*agentendpointpb.Package {
	var res []*agentendpointpb.Package
	for _, n := range names {
		res = append(res, &agentendpointpb.Package{Name: n})
	}
	return res
}