policies/changes.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 (
	"github.com/GoogleCloudPlatform/osconfig/packages"

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

// changes represents the delta between the actual and the desired package installation state.
type changes struct {
	packagesToInstall []string
	packagesToUpgrade []string
	packagesToRemove  []string
}

// getNecessaryChanges compares the current state and the desired state to determine which packages
// need to be installed, upgraded, or removed.
func getNecessaryChanges(installedPkgs []*packages.PkgInfo, upgradablePkgs []*packages.PkgInfo, installPkgs, removePkgs, updatePkgs []*agentendpointpb.Package) changes {
	installedPkgMap := make(map[string]bool)
	for _, pkg := range installedPkgs {
		installedPkgMap[pkg.Name] = true
	}

	upgradeablePkgMap := make(map[string]bool)
	for _, pkg := range upgradablePkgs {
		upgradeablePkgMap[pkg.Name] = true
	}

	var pkgsToInstall []string
	var pkgsToRemove []string
	var pkgsToUpgrade []string

	for _, pkg := range installPkgs {
		if _, ok := installedPkgMap[pkg.Name]; !ok {
			pkgsToInstall = append(pkgsToInstall, pkg.Name)
		}
	}

	for _, pkg := range removePkgs {
		if _, ok := installedPkgMap[pkg.Name]; ok {
			pkgsToRemove = append(pkgsToRemove, pkg.Name)
		}
	}

	for _, pkg := range updatePkgs {
		if _, ok := upgradeablePkgMap[pkg.Name]; ok {
			pkgsToUpgrade = append(pkgsToUpgrade, pkg.Name)
			continue
		}
		// If not installed we need to install it.
		if _, ok := installedPkgMap[pkg.Name]; !ok {
			pkgsToInstall = append(pkgsToInstall, pkg.Name)
		}
	}

	return changes{
		packagesToInstall: pkgsToInstall,
		packagesToUpgrade: pkgsToUpgrade,
		packagesToRemove:  pkgsToRemove,
	}
}