act/pkg/runner/step.go

package runner

import (
	"context"
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"regexp"
	"strings"

	"github.com/nektos/act/pkg/common"
	"github.com/nektos/act/pkg/container"
	"github.com/nektos/act/pkg/model"
	log "github.com/sirupsen/logrus"
)

func (rc *RunContext) StepEnv(step *model.Step) map[string]string {
	var env map[string]string
	job := rc.Run.Job()
	if job.Container != nil {
		env = mergeMaps(rc.GetEnv(), job.Container.Env, step.GetEnv())
	} else {
		env = mergeMaps(rc.GetEnv(), step.GetEnv())
	}

	for k, v := range env {
		env[k] = rc.ExprEval.Interpolate(v)
	}
	return env
}

func (rc *RunContext) setupEnv(containerSpec *model.ContainerSpec, step *model.Step) common.Executor {
	return func(ctx context.Context) error {
		containerSpec.Env = rc.withGithubEnv(rc.StepEnv(step))
		return nil
	}
}

func (rc *RunContext) newContainerCleaner() common.Executor {
	job := rc.Run.Job()
	containerSpec := new(model.ContainerSpec)
	containerSpec.Name = rc.createContainerName()
	containerSpec.Reuse = false

	if job.Container != nil {
		containerSpec.Image = job.Container.Image
	} else {
		platformName := rc.ExprEval.Interpolate(rc.Run.Job().RunsOn)
		containerSpec.Image = rc.Config.Platforms[strings.ToLower(platformName)]
	}
	containerSpec.Entrypoint = "bash --noprofile --norc -o pipefail -c echo 'cleaning up'"
	return common.NewPipelineExecutor(
		rc.pullImage(containerSpec),
		rc.runContainer(containerSpec),
	)
}

func (rc *RunContext) newStepExecutor(step *model.Step) common.Executor {
	job := rc.Run.Job()
	containerSpec := new(model.ContainerSpec)
	containerSpec.Name = rc.createContainerName()
	containerSpec.Reuse = true

	if job.Container != nil {
		containerSpec.Image = job.Container.Image
	} else {
		platformName := rc.ExprEval.Interpolate(rc.Run.Job().RunsOn)
		containerSpec.Image = rc.Config.Platforms[strings.ToLower(platformName)]
	}

	switch step.Type() {
	case model.StepTypeRun:
		if job.Container != nil {
			containerSpec.Ports = job.Container.Ports
			containerSpec.Volumes = job.Container.Volumes
			containerSpec.Options = job.Container.Options
		}
		return common.NewPipelineExecutor(
			rc.setupEnv(containerSpec, step),
			rc.setupShellCommand(containerSpec, step.Shell, step.Run),
			rc.pullImage(containerSpec),
			rc.runContainer(containerSpec),
		)

	case model.StepTypeUsesDockerURL:
		containerSpec.Image = strings.TrimPrefix(step.Uses, "docker://")
		containerSpec.Name = rc.createStepContainerName(step.ID)
		containerSpec.Entrypoint = step.With["entrypoint"]
		containerSpec.Args = step.With["args"]
		containerSpec.Reuse = rc.Config.ReuseContainers
		return common.NewPipelineExecutor(
			rc.setupEnv(containerSpec, step),
			rc.pullImage(containerSpec),
			rc.runContainer(containerSpec),
		)

	case model.StepTypeUsesActionLocal:
		return common.NewPipelineExecutor(
			rc.setupEnv(containerSpec, step),
			rc.setupAction(containerSpec, filepath.Join(rc.Config.Workdir, step.Uses)),
			applyWith(containerSpec, step),
			rc.pullImage(containerSpec),
			rc.runContainer(containerSpec),
		)
	case model.StepTypeUsesActionRemote:
		remoteAction := newRemoteAction(step.Uses)
		if remoteAction.Org == "actions" && remoteAction.Repo == "checkout" {
			return func(ctx context.Context) error {
				common.Logger(ctx).Debugf("Skipping actions/checkout")
				return nil
			}
		}
		cloneDir, err := ioutil.TempDir(rc.Tempdir, remoteAction.Repo)
		if err != nil {
			return common.NewErrorExecutor(err)
		}
		return common.NewPipelineExecutor(
			common.NewGitCloneExecutor(common.NewGitCloneExecutorInput{
				URL: remoteAction.CloneURL(),
				Ref: remoteAction.Ref,
				Dir: cloneDir,
			}),
			rc.setupEnv(containerSpec, step),
			rc.setupAction(containerSpec, filepath.Join(cloneDir, remoteAction.Path)),
			applyWith(containerSpec, step),
			rc.pullImage(containerSpec),
			rc.runContainer(containerSpec),
		)
	}

	return common.NewErrorExecutor(fmt.Errorf("Unable to determine how to run job:%s step:%+v", rc.Run, step))
}

func applyWith(containerSpec *model.ContainerSpec, step *model.Step) common.Executor {
	return func(ctx context.Context) error {
		if entrypoint, ok := step.With["entrypoint"]; ok {
			containerSpec.Entrypoint = entrypoint
		}
		if args, ok := step.With["args"]; ok {
			containerSpec.Args = args
		}
		return nil
	}
}

func (rc *RunContext) setupShellCommand(containerSpec *model.ContainerSpec, shell string, run string) common.Executor {
	return func(ctx context.Context) error {
		shellCommand := ""

		switch shell {
		case "", "bash":
			shellCommand = "bash --noprofile --norc -eo pipefail {0}"
		case "pwsh":
			shellCommand = "pwsh -command \"& '{0}'\""
		case "python":
			shellCommand = "python {0}"
		case "sh":
			shellCommand = "sh -e -c {0}"
		case "cmd":
			shellCommand = "%ComSpec% /D /E:ON /V:OFF /S /C \"CALL \"{0}\"\""
		case "powershell":
			shellCommand = "powershell -command \"& '{0}'\""
		default:
			shellCommand = shell
		}

		tempScript, err := ioutil.TempFile(rc.Tempdir, ".temp-script-")
		if err != nil {
			return err
		}

		_, err = tempScript.WriteString(fmt.Sprintf("PATH=\"%s:${PATH}\"\n", strings.Join(rc.ExtraPath, ":")))
		if err != nil {
			return err
		}

		run = rc.ExprEval.Interpolate(run)

		if _, err := tempScript.WriteString(run); err != nil {
			return err
		}
		log.Debugf("Wrote command '%s' to '%s'", run, tempScript.Name())
		if err := tempScript.Close(); err != nil {
			return err
		}
		containerPath := fmt.Sprintf("/github/home/%s", filepath.Base(tempScript.Name()))
		containerSpec.Entrypoint = strings.Replace(shellCommand, "{0}", containerPath, 1)
		return nil
	}
}

func (rc *RunContext) setupAction(containerSpec *model.ContainerSpec, actionDir string) common.Executor {
	return func(ctx context.Context) error {
		f, err := os.Open(filepath.Join(actionDir, "action.yml"))
		if os.IsNotExist(err) {
			f, err = os.Open(filepath.Join(actionDir, "action.yaml"))
			if err != nil {
				return err
			}
		} else if err != nil {
			return err
		}

		action, err := model.ReadAction(f)
		if err != nil {
			return err
		}

		for inputID, input := range action.Inputs {
			envKey := regexp.MustCompile("[^A-Z0-9-]").ReplaceAllString(strings.ToUpper(inputID), "_")
			envKey = fmt.Sprintf("INPUT_%s", envKey)
			if _, ok := containerSpec.Env[envKey]; !ok {
				containerSpec.Env[envKey] = input.Default
			}
		}

		switch action.Runs.Using {
		case model.ActionRunsUsingNode12:
			if strings.HasPrefix(actionDir, rc.Config.Workdir) {
				containerSpec.Entrypoint = fmt.Sprintf("node /github/workspace/%s/%s", strings.TrimPrefix(actionDir, rc.Config.Workdir), action.Runs.Main)
			} else if strings.HasPrefix(actionDir, rc.Tempdir) {
				containerSpec.Entrypoint = fmt.Sprintf("node /github/home/%s/%s", strings.TrimPrefix(actionDir, rc.Tempdir), action.Runs.Main)
			}
		case model.ActionRunsUsingDocker:
			if strings.HasPrefix(actionDir, rc.Config.Workdir) {
				containerSpec.Name = rc.createStepContainerName(strings.TrimPrefix(actionDir, rc.Config.Workdir))
			} else if strings.HasPrefix(actionDir, rc.Tempdir) {
				containerSpec.Name = rc.createStepContainerName(strings.TrimPrefix(actionDir, rc.Tempdir))
			}
			containerSpec.Reuse = rc.Config.ReuseContainers
			if strings.HasPrefix(action.Runs.Image, "docker://") {
				containerSpec.Image = strings.TrimPrefix(action.Runs.Image, "docker://")
				containerSpec.Entrypoint = strings.Join(action.Runs.Entrypoint, " ")
				containerSpec.Args = strings.Join(action.Runs.Args, " ")
			} else {
				containerSpec.Image = fmt.Sprintf("%s:%s", containerSpec.Name, "latest")
				contextDir := filepath.Join(actionDir, action.Runs.Main)
				return container.NewDockerBuildExecutor(container.NewDockerBuildExecutorInput{
					ContextDir: contextDir,
					ImageTag:   containerSpec.Image,
				})(ctx)
			}
		}
		return nil
	}
}

type remoteAction struct {
	Org  string
	Repo string
	Path string
	Ref  string
}

func (ra *remoteAction) CloneURL() string {
	return fmt.Sprintf("https://github.com/%s/%s", ra.Org, ra.Repo)
}

func newRemoteAction(action string) *remoteAction {
	r := regexp.MustCompile(`^([^/@]+)/([^/@]+)(/([^@]*))?(@(.*))?$`)
	matches := r.FindStringSubmatch(action)

	ra := new(remoteAction)
	ra.Org = matches[1]
	ra.Repo = matches[2]
	ra.Path = ""
	ra.Ref = "master"
	if len(matches) >= 5 {
		ra.Path = matches[4]
	}
	if len(matches) >= 7 {
		ra.Ref = matches[6]
	}
	return ra
}