archive_tarball_extract.go

package command

import (
	"context"
	"os"
	"path/filepath"

	"github.com/evergreen-ci/evergreen/agent/internal"
	"github.com/evergreen-ci/evergreen/agent/internal/client"
	"github.com/evergreen-ci/evergreen/util"
	"github.com/mitchellh/mapstructure"
	"github.com/pkg/errors"
)

type tarballExtract struct {
	ArchivePath string `mapstructure:"path" plugin:"expand"`

	TargetDirectory string `mapstructure:"destination" plugin:"expand"`

	// a list of filename blobs to exclude when extracting
	ExcludeFiles []string `mapstructure:"exclude_files" plugin:"expand"`

	base
}

func tarballExtractFactory() Command   { return &tarballExtract{} }
func (e *tarballExtract) Name() string { return "archive.targz_extract" }
func (e *tarballExtract) ParseParams(params map[string]interface{}) error {
	if err := mapstructure.Decode(params, e); err != nil {
		return errors.Wrap(err, "decoding mapstructure params")
	}

	if e.ArchivePath == "" {
		return errors.New("archive path must be specified")
	}

	return nil
}

func (e *tarballExtract) Execute(ctx context.Context,
	client client.Communicator, logger client.LoggerProducer, conf *internal.TaskConfig) error {

	if err := util.ExpandValues(e, &conf.Expansions); err != nil {
		return errors.Wrap(err, "applying expansions")
	}

	if e.TargetDirectory == "" {
		return errors.New("must specify a target directory")
	}

	// if the target is a relative path, join it to the working dir
	if !filepath.IsAbs(e.TargetDirectory) {
		e.TargetDirectory = GetWorkingDirectory(conf, e.TargetDirectory)
	}

	if !filepath.IsAbs(e.ArchivePath) {
		e.ArchivePath = GetWorkingDirectory(conf, e.ArchivePath)
	}

	if _, err := os.Stat(e.ArchivePath); os.IsNotExist(err) {
		return errors.Errorf("archive '%s' does not exist", e.ArchivePath)
	}

	archive, err := os.Open(e.ArchivePath)
	if err != nil {
		return errors.Wrapf(err, "reading file '%s'", e.ArchivePath)
	}

	defer func() {
		logger.Task().Notice(errors.Wrapf(archive.Close(), "closing file '%s'", e.ArchivePath))
	}()

	if err := extractTarball(ctx, archive, e.TargetDirectory, e.ExcludeFiles); err != nil {
		return errors.Wrapf(err, "extracting file '%s'", e.ArchivePath)
	}

	return nil
}