luet/pkg/installer/finalizer.go

// Copyright © 2019-2021 Ettore Di Giacinto <mudler@gentoo.org>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see <http://www.gnu.org/licenses/>.

package installer

import (
	"os"
	"os/exec"

	"github.com/ghodss/yaml"
	"github.com/mudler/luet/pkg/api/core/types"
	box "github.com/mudler/luet/pkg/box"
	fileHelper "github.com/mudler/luet/pkg/helpers/file"
	"github.com/mudler/luet/pkg/tree"

	"github.com/pkg/errors"
)

type LuetFinalizer struct {
	Shell     []string `json:"shell"`
	Install   []string `json:"install"`
	Uninstall []string `json:"uninstall"` // TODO: Where to store?
}

func (f *LuetFinalizer) RunInstall(ctx types.Context, s *System) error {
	var cmd string
	var args []string
	if len(f.Shell) == 0 {
		// Default to sh otherwise
		cmd = "sh"
		args = []string{"-c"}
	} else {
		cmd = f.Shell[0]
		if len(f.Shell) > 1 {
			args = f.Shell[1:]
		}
	}

	for _, c := range f.Install {
		toRun := append(args, c)
		ctx.Info(":shell: Executing finalizer on ", s.Target, cmd, toRun)
		if s.Target == string(os.PathSeparator) {
			cmd := exec.Command(cmd, toRun...)
			cmd.Env = ctx.GetConfig().FinalizerEnvs.Slice()
			stdoutStderr, err := cmd.CombinedOutput()
			if err != nil {
				return errors.Wrap(err, "Failed running command: "+string(stdoutStderr))
			}
			ctx.Info(string(stdoutStderr))
		} else {
			b := box.NewBox(cmd, toRun, []string{}, ctx.GetConfig().FinalizerEnvs.Slice(), s.Target, false, true, true)
			err := b.Run()
			if err != nil {
				return errors.Wrap(err, "Failed running command ")
			}
		}
	}
	return nil
}

// TODO: We don't store uninstall finalizers ?!
func (f *LuetFinalizer) RunUnInstall(ctx types.Context) error {
	for _, c := range f.Uninstall {
		ctx.Debug("finalizer:", "sh", "-c", c)
		cmd := exec.Command("sh", "-c", c)
		stdoutStderr, err := cmd.CombinedOutput()
		if err != nil {
			return errors.Wrap(err, "Failed running command: "+string(stdoutStderr))
		}
		ctx.Info(string(stdoutStderr))
	}
	return nil
}

func NewLuetFinalizerFromYaml(data []byte) (*LuetFinalizer, error) {
	var p LuetFinalizer
	err := yaml.Unmarshal(data, &p)
	if err != nil {
		return &p, err
	}
	return &p, err
}

func OrderFinalizers(allRepos types.PackageDatabase, toInstall map[string]ArtifactMatch, solution types.PackagesAssertions) ([]*types.Package, error) {
	var toFinalize []*types.Package
	if len(toInstall) == 1 {
		for _, w := range toInstall {
			if fileHelper.Exists(w.Package.Rel(tree.FinalizerFile)) {
				// Finalizers needs to run in order and in sequence.
				ordered, err := solution.Order(allRepos, w.Package.GetFingerPrint())
				if err != nil {
					return toFinalize, errors.Wrap(err, "While order a solution for "+w.Package.HumanReadableString())
				}
			ORDER:
				for _, ass := range ordered {
					if ass.Value {
						installed, ok := toInstall[ass.Package.GetFingerPrint()]
						if !ok {
							// It was a dep already installed in the system, so we can skip it safely
							continue ORDER
						}
						treePackage, err := installed.Repository.GetTree().GetDatabase().FindPackage(ass.Package)
						if err != nil {
							return toFinalize, errors.Wrap(err, "Error getting package "+ass.Package.HumanReadableString())
						}

						toFinalize = append(toFinalize, treePackage)
					}
				}
			}
		}
	} else {
		assertions, err := solution.EnsureOrder()
		if err != nil {
			return toFinalize, err
		}

		for _, o := range assertions {
			if o.Value {
				toFinalize = append(toFinalize, o.Package)
			}
		}
	}

	return toFinalize, nil
}