Add option to run custom architecture (container platform) (#525)

* Add QEMU to run different architectures

* Update dependencies in `go.mod`

* Add `--container-architecture` flag to specify custom image architecture

Co-authored-by: Casey Lee <cplee@nektos.com>

pkg/runner/run_context.go

@@ -11,11 +11,11 @@ import (
 	"runtime"
 	"strings"
 
-	"github.com/nektos/act/pkg/container"
+	log "github.com/sirupsen/logrus"
 
 	"github.com/nektos/act/pkg/common"
+	"github.com/nektos/act/pkg/container"
 	"github.com/nektos/act/pkg/model"
-	log "github.com/sirupsen/logrus"
 )
 
 // RunContext contains info about current job
@@ -89,6 +89,10 @@ func (rc *RunContext) startJobContainer() common.Executor {
 			binds = append(binds, fmt.Sprintf("%s:%s%s", rc.Config.Workdir, "/github/workspace", bindModifiers))
 		}
 
+		if rc.Config.ContainerArchitecture == "" {
+			rc.Config.ContainerArchitecture = fmt.Sprintf("%s/%s", "linux", runtime.GOARCH)
+		}
+
 		rc.JobContainer = container.NewContainer(&container.NewContainerInput{
 			Cmd:        nil,
 			Entrypoint: []string{"/usr/bin/tail", "-f", "/dev/null"},
@@ -107,6 +111,7 @@ func (rc *RunContext) startJobContainer() common.Executor {
 			Stderr:      logWriter,
 			Privileged:  rc.Config.Privileged,
 			UsernsMode:  rc.Config.UsernsMode,
+			Platform:    rc.Config.ContainerArchitecture,
 		})
 
 		var copyWorkspace bool

pkg/runner/runner.go

@@ -17,21 +17,22 @@ type Runner interface {
 
 // Config contains the config for a new runner
 type Config struct {
-	Actor           string            // the user that triggered the event
-	Workdir         string            // path to working directory
-	BindWorkdir     bool              // bind the workdir to the job container
-	EventName       string            // name of event to run
-	EventPath       string            // path to JSON file to use for event.json in containers
-	DefaultBranch   string            // name of the main branch for this repository
-	ReuseContainers bool              // reuse containers to maintain state
-	ForcePull       bool              // force pulling of the image, if already present
-	LogOutput       bool              // log the output from docker run
-	Env             map[string]string // env for containers
-	Secrets         map[string]string // list of secrets
-	InsecureSecrets bool              // switch hiding output when printing to terminal
-	Platforms       map[string]string // list of platforms
-	Privileged      bool              // use privileged mode
-	UsernsMode      string            // user namespace to use
+	Actor                 string            // the user that triggered the event
+	Workdir               string            // path to working directory
+	BindWorkdir           bool              // bind the workdir to the job container
+	EventName             string            // name of event to run
+	EventPath             string            // path to JSON file to use for event.json in containers
+	DefaultBranch         string            // name of the main branch for this repository
+	ReuseContainers       bool              // reuse containers to maintain state
+	ForcePull             bool              // force pulling of the image, if already present
+	LogOutput             bool              // log the output from docker run
+	Env                   map[string]string // env for containers
+	Secrets               map[string]string // list of secrets
+	InsecureSecrets       bool              // switch hiding output when printing to terminal
+	Platforms             map[string]string // list of platforms
+	Privileged            bool              // use privileged mode
+	UsernsMode            string            // user namespace to use
+	ContainerArchitecture string            // Desired OS/architecture platform for running containers
 }
 
 type runnerImpl struct {

pkg/runner/runner_test.go

@@ -7,10 +7,10 @@ import (
 	"testing"
 
 	"github.com/joho/godotenv"
-	"github.com/nektos/act/pkg/model"
-
 	log "github.com/sirupsen/logrus"
 	"gotest.tools/v3/assert"
+
+	"github.com/nektos/act/pkg/model"
 )
 
 func TestGraphEvent(t *testing.T) {
@@ -32,11 +32,12 @@ func TestGraphEvent(t *testing.T) {
 }
 
 type TestJobFileInfo struct {
-	workdir      string
-	workflowPath string
-	eventName    string
-	errorMessage string
-	platforms    map[string]string
+	workdir               string
+	workflowPath          string
+	eventName             string
+	errorMessage          string
+	platforms             map[string]string
+	containerArchitecture string
 }
 
 func runTestJobFile(ctx context.Context, t *testing.T, tjfi TestJobFileInfo) {
@@ -45,11 +46,12 @@ func runTestJobFile(ctx context.Context, t *testing.T, tjfi TestJobFileInfo) {
 		assert.NilError(t, err, workdir)
 		fullWorkflowPath := filepath.Join(workdir, tjfi.workflowPath)
 		runnerConfig := &Config{
-			Workdir:         workdir,
-			BindWorkdir:     true,
-			EventName:       tjfi.eventName,
-			Platforms:       tjfi.platforms,
-			ReuseContainers: false,
+			Workdir:               workdir,
+			BindWorkdir:           true,
+			EventName:             tjfi.eventName,
+			Platforms:             tjfi.platforms,
+			ReuseContainers:       false,
+			ContainerArchitecture: tjfi.containerArchitecture,
 		}
 		runner, err := New(runnerConfig)
 		assert.NilError(t, err, tjfi.workflowPath)
@@ -77,23 +79,42 @@ func TestRunEvent(t *testing.T) {
 		"ubuntu-latest": "node:12.20.1-buster-slim",
 	}
 	tables := []TestJobFileInfo{
-		{"testdata", "basic", "push", "", platforms},
-		{"testdata", "fail", "push", "exit with `FAILURE`: 1", platforms},
-		{"testdata", "runs-on", "push", "", platforms},
-		{"testdata", "job-container", "push", "", platforms},
-		{"testdata", "job-container-non-root", "push", "", platforms},
-		{"testdata", "uses-docker-url", "push", "", platforms},
-		{"testdata", "remote-action-docker", "push", "", platforms},
-		{"testdata", "remote-action-js", "push", "", platforms},
-		{"testdata", "local-action-docker-url", "push", "", platforms},
-		{"testdata", "local-action-dockerfile", "push", "", platforms},
-		{"testdata", "local-action-js", "push", "", platforms},
-		{"testdata", "matrix", "push", "", platforms},
-		{"testdata", "matrix-include-exclude", "push", "", platforms},
-		{"testdata", "commands", "push", "", platforms},
-		{"testdata", "workdir", "push", "", platforms},
-		// {"testdata", "issue-228", "push", "", platforms}, // TODO [igni]: Remove this once everything passes
-		{"testdata", "defaults-run", "push", "", platforms},
+		{"testdata", "basic", "push", "", platforms, "linux/amd64"},
+		{"testdata", "fail", "push", "exit with `FAILURE`: 1", platforms, "linux/amd64"},
+		{"testdata", "runs-on", "push", "", platforms, "linux/amd64"},
+		{"testdata", "job-container", "push", "", platforms, "linux/amd64"},
+		{"testdata", "job-container-non-root", "push", "", platforms, "linux/amd64"},
+		{"testdata", "uses-docker-url", "push", "", platforms, "linux/amd64"},
+		{"testdata", "remote-action-docker", "push", "", platforms, "linux/amd64"},
+		{"testdata", "remote-action-js", "push", "", platforms, "linux/amd64"},
+		{"testdata", "local-action-docker-url", "push", "", platforms, "linux/amd64"},
+		{"testdata", "local-action-dockerfile", "push", "", platforms, "linux/amd64"},
+		{"testdata", "local-action-js", "push", "", platforms, "linux/amd64"},
+		{"testdata", "matrix", "push", "", platforms, "linux/amd64"},
+		{"testdata", "matrix-include-exclude", "push", "", platforms, "linux/amd64"},
+		{"testdata", "commands", "push", "", platforms, "linux/amd64"},
+		{"testdata", "workdir", "push", "", platforms, "linux/amd64"},
+		// {"testdata", "issue-228", "push", "", platforms, "linux/amd64"}, // TODO [igni]: Remove this once everything passes
+		{"testdata", "defaults-run", "push", "", platforms, "linux/amd64"},
+
+		// linux/arm64
+		{"testdata", "basic", "push", "", platforms, "linux/arm64"},
+		{"testdata", "fail", "push", "exit with `FAILURE`: 1", platforms, "linux/arm64"},
+		{"testdata", "runs-on", "push", "", platforms, "linux/arm64"},
+		{"testdata", "job-container", "push", "", platforms, "linux/arm64"},
+		{"testdata", "job-container-non-root", "push", "", platforms, "linux/arm64"},
+		{"testdata", "uses-docker-url", "push", "", platforms, "linux/arm64"},
+		{"testdata", "remote-action-docker", "push", "", platforms, "linux/arm64"},
+		{"testdata", "remote-action-js", "push", "", platforms, "linux/arm64"},
+		{"testdata", "local-action-docker-url", "push", "", platforms, "linux/arm64"},
+		{"testdata", "local-action-dockerfile", "push", "", platforms, "linux/arm64"},
+		{"testdata", "local-action-js", "push", "", platforms, "linux/arm64"},
+		{"testdata", "matrix", "push", "", platforms, "linux/arm64"},
+		{"testdata", "matrix-include-exclude", "push", "", platforms, "linux/arm64"},
+		{"testdata", "commands", "push", "", platforms, "linux/arm64"},
+		{"testdata", "workdir", "push", "", platforms, "linux/arm64"},
+		// {"testdata", "issue-228", "push", "", platforms, "linux/arm64"}, // TODO [igni]: Remove this once everything passes
+		{"testdata", "defaults-run", "push", "", platforms, "linux/arm64"},
 	}
 	log.SetLevel(log.DebugLevel)
 

pkg/runner/step_context.go

@@ -10,8 +10,8 @@ import (
 	"runtime"
 	"strings"
 
-	log "github.com/sirupsen/logrus"
 	"github.com/kballard/go-shellquote"
+	log "github.com/sirupsen/logrus"
 
 	"github.com/nektos/act/pkg/common"
 	"github.com/nektos/act/pkg/container"
@@ -217,6 +217,10 @@ func (sc *StepContext) newStepContainer(ctx context.Context, image string, cmd [
 		binds = append(binds, fmt.Sprintf("%s:%s%s", rc.Config.Workdir, "/github/workspace", bindModifiers))
 	}
 
+	if rc.Config.ContainerArchitecture == "" {
+		rc.Config.ContainerArchitecture = fmt.Sprintf("%s/%s", "linux", runtime.GOARCH)
+	}
+
 	stepContainer := container.NewContainer(&container.NewContainerInput{
 		Cmd:        cmd,
 		Entrypoint: entrypoint,
@@ -235,6 +239,7 @@ func (sc *StepContext) newStepContainer(ctx context.Context, image string, cmd [
 		Stderr:      logWriter,
 		Privileged:  rc.Config.Privileged,
 		UsernsMode:  rc.Config.UsernsMode,
+		Platform:    rc.Config.ContainerArchitecture,
 	})
 	return stepContainer
 }
@@ -354,10 +359,35 @@ func (sc *StepContext) runAction(actionDir string, actionPath string) common.Exe
 				image = fmt.Sprintf("act-%s", strings.TrimLeft(image, "-"))
 				image = strings.ToLower(image)
 				contextDir := filepath.Join(actionDir, actionPath, action.Runs.Main)
+
+				exists, err := container.ImageExistsLocally(ctx, image, "any")
+				if err != nil {
+					return err
+				}
+
+				if exists {
+					wasRemoved, err := container.DeleteImage(ctx, image)
+					if err != nil {
+						return err
+					}
+					if !wasRemoved {
+						return fmt.Errorf("failed to delete image '%s'", image)
+					}
+				}
+
 				prepImage = container.NewDockerBuildExecutor(container.NewDockerBuildExecutorInput{
 					ContextDir: contextDir,
 					ImageTag:   image,
+					Platform:   rc.Config.ContainerArchitecture,
 				})
+				exists, err = container.ImageExistsLocally(ctx, image, rc.Config.ContainerArchitecture)
+				if err != nil {
+					return err
+				}
+
+				if !exists {
+					return err
+				}
 			}
 
 			cmd, err := shellquote.Split(step.With["args"])

pkg/runner/step_context_test.go

@@ -12,10 +12,14 @@ func TestStepContextExecutor(t *testing.T) {
 		"ubuntu-latest": "node:12.20.1-buster-slim",
 	}
 	tables := []TestJobFileInfo{
-		{"testdata", "uses-github-empty", "push", "Expected format {org}/{repo}[/path]@ref", platforms},
-		{"testdata", "uses-github-noref", "push", "Expected format {org}/{repo}[/path]@ref", platforms},
-		{"testdata", "uses-github-root", "push", "", platforms},
-		{"testdata", "uses-github-path", "push", "", platforms},
+		{"testdata", "uses-github-empty", "push", "Expected format {org}/{repo}[/path]@ref", platforms, "linux/amd64"},
+		{"testdata", "uses-github-noref", "push", "Expected format {org}/{repo}[/path]@ref", platforms, "linux/amd64"},
+		{"testdata", "uses-github-root", "push", "", platforms, "linux/amd64"},
+		{"testdata", "uses-github-path", "push", "", platforms, "linux/amd64"},
+		{"testdata", "uses-github-empty", "push", "Expected format {org}/{repo}[/path]@ref", platforms, "linux/arm64"},
+		{"testdata", "uses-github-noref", "push", "Expected format {org}/{repo}[/path]@ref", platforms, "linux/arm64"},
+		{"testdata", "uses-github-root", "push", "", platforms, "linux/arm64"},
+		{"testdata", "uses-github-path", "push", "", platforms, "linux/arm64"},
 	}
 	// These tests are sufficient to only check syntax.
 	ctx := common.WithDryrun(context.Background(), true)