package cmd import ( "bufio" "context" "fmt" "os" "path/filepath" "regexp" "runtime" "runtime/debug" "strings" "github.com/AlecAivazis/survey/v2" "github.com/andreaskoch/go-fswatch" "github.com/joho/godotenv" "github.com/mitchellh/go-homedir" gitignore "github.com/sabhiram/go-gitignore" log "github.com/sirupsen/logrus" "github.com/spf13/cobra" "github.com/nektos/act/pkg/artifacts" "github.com/nektos/act/pkg/common" "github.com/nektos/act/pkg/container" "github.com/nektos/act/pkg/model" "github.com/nektos/act/pkg/runner" ) // Execute is the entry point to running the CLI func Execute(ctx context.Context, version string) { input := new(Input) var rootCmd = &cobra.Command{ Use: "act [event name to run] [flags]\n\nIf no event name passed, will default to \"on: push\"\nIf actions handles only one event it will be used as default instead of \"on: push\"", Short: "Run GitHub actions locally by specifying the event name (e.g. `push`) or an action name directly.", Args: cobra.MaximumNArgs(1), RunE: newRunCommand(ctx, input), PersistentPreRun: setupLogging, Version: version, SilenceUsage: true, } rootCmd.Flags().BoolP("watch", "w", false, "watch the contents of the local repo and run when files change") rootCmd.Flags().BoolP("list", "l", false, "list workflows") rootCmd.Flags().BoolP("graph", "g", false, "draw workflows") rootCmd.Flags().StringP("job", "j", "", "run a specific job ID") rootCmd.Flags().BoolP("bug-report", "", false, "Display system information for bug report") rootCmd.Flags().StringVar(&input.remoteName, "remote-name", "origin", "git remote name that will be used to retrieve url of git repo") rootCmd.Flags().StringArrayVarP(&input.secrets, "secret", "s", []string{}, "secret to make available to actions with optional value (e.g. -s mysecret=foo or -s mysecret)") rootCmd.Flags().StringArrayVarP(&input.envs, "env", "", []string{}, "env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv)") rootCmd.Flags().StringArrayVarP(&input.platforms, "platform", "P", []string{}, "custom image to use per platform (e.g. -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04)") rootCmd.Flags().BoolVarP(&input.reuseContainers, "reuse", "r", false, "don't remove container(s) on successfully completed workflow(s) to maintain state between runs") rootCmd.Flags().BoolVarP(&input.bindWorkdir, "bind", "b", false, "bind working directory to container, rather than copy") rootCmd.Flags().BoolVarP(&input.forcePull, "pull", "p", false, "pull docker image(s) even if already present") rootCmd.Flags().BoolVarP(&input.forceRebuild, "rebuild", "", false, "rebuild local action docker image(s) even if already present") rootCmd.Flags().BoolVarP(&input.autodetectEvent, "detect-event", "", false, "Use first event type from workflow as event that triggered the workflow") rootCmd.Flags().StringVarP(&input.eventPath, "eventpath", "e", "", "path to event JSON file") rootCmd.Flags().StringVar(&input.defaultBranch, "defaultbranch", "", "the name of the main branch") rootCmd.Flags().BoolVar(&input.privileged, "privileged", false, "use privileged mode") rootCmd.Flags().StringVar(&input.usernsMode, "userns", "", "user namespace to use") rootCmd.Flags().BoolVar(&input.useGitIgnore, "use-gitignore", true, "Controls whether paths specified in .gitignore should be copied into container") rootCmd.Flags().StringArrayVarP(&input.containerCapAdd, "container-cap-add", "", []string{}, "kernel capabilities to add to the workflow containers (e.g. --container-cap-add SYS_PTRACE)") rootCmd.Flags().StringArrayVarP(&input.containerCapDrop, "container-cap-drop", "", []string{}, "kernel capabilities to remove from the workflow containers (e.g. --container-cap-drop SYS_PTRACE)") rootCmd.Flags().BoolVar(&input.autoRemove, "rm", false, "automatically remove container(s)/volume(s) after a workflow(s) failure") rootCmd.Flags().StringArrayVarP(&input.replaceGheActionWithGithubCom, "replace-ghe-action-with-github-com", "", []string{}, "If you are using GitHub Enterprise Server and allow specified actions from GitHub (github.com), you can set actions on this. (e.g. --replace-ghe-action-with-github-com =github/super-linter)") rootCmd.Flags().StringVar(&input.replaceGheActionTokenWithGithubCom, "replace-ghe-action-token-with-github-com", "", "If you are using replace-ghe-action-with-github-com and you want to use private actions on GitHub, you have to set personal access token") rootCmd.PersistentFlags().StringVarP(&input.actor, "actor", "a", "nektos/act", "user that triggered the event") rootCmd.PersistentFlags().StringVarP(&input.workflowsPath, "workflows", "W", "./.github/workflows/", "path to workflow file(s)") rootCmd.PersistentFlags().BoolVarP(&input.noWorkflowRecurse, "no-recurse", "", false, "Flag to disable running workflows from subdirectories of specified path in '--workflows'/'-W' flag") rootCmd.PersistentFlags().StringVarP(&input.workdir, "directory", "C", ".", "working directory") rootCmd.PersistentFlags().BoolP("verbose", "v", false, "verbose output") rootCmd.PersistentFlags().BoolVar(&input.jsonLogger, "json", false, "Output logs in json format") rootCmd.PersistentFlags().BoolVarP(&input.noOutput, "quiet", "q", false, "disable logging of output from steps") rootCmd.PersistentFlags().BoolVarP(&input.dryrun, "dryrun", "n", false, "dryrun mode") rootCmd.PersistentFlags().StringVarP(&input.secretfile, "secret-file", "", ".secrets", "file with list of secrets to read from (e.g. --secret-file .secrets)") rootCmd.PersistentFlags().BoolVarP(&input.insecureSecrets, "insecure-secrets", "", false, "NOT RECOMMENDED! Doesn't hide secrets while printing logs.") rootCmd.PersistentFlags().StringVarP(&input.envfile, "env-file", "", ".env", "environment file to read and use as env in the containers") rootCmd.PersistentFlags().StringVarP(&input.containerArchitecture, "container-architecture", "", "", "Architecture which should be used to run containers, e.g.: linux/amd64. If not specified, will use host default architecture. Requires Docker server API Version 1.41+. Ignored on earlier Docker server platforms.") rootCmd.PersistentFlags().StringVarP(&input.containerDaemonSocket, "container-daemon-socket", "", "/var/run/docker.sock", "Path to Docker daemon socket which will be mounted to containers") rootCmd.PersistentFlags().StringVarP(&input.githubInstance, "github-instance", "", "github.com", "GitHub instance to use. Don't use this if you are not using GitHub Enterprise Server.") rootCmd.PersistentFlags().StringVarP(&input.artifactServerPath, "artifact-server-path", "", "", "Defines the path where the artifact server stores uploads and retrieves downloads from. If not specified the artifact server will not start.") rootCmd.PersistentFlags().StringVarP(&input.artifactServerPort, "artifact-server-port", "", "34567", "Defines the port where the artifact server listens (will only bind to localhost).") rootCmd.PersistentFlags().BoolVarP(&input.noSkipCheckout, "no-skip-checkout", "", false, "Do not skip actions/checkout") rootCmd.SetArgs(args()) if err := rootCmd.Execute(); err != nil { os.Exit(1) } } func configLocations() []string { home, err := homedir.Dir() if err != nil { log.Fatal(err) } // reference: https://specifications.freedesktop.org/basedir-spec/latest/ar01s03.html var actrcXdg string if xdg, ok := os.LookupEnv("XDG_CONFIG_HOME"); ok && xdg != "" { actrcXdg = filepath.Join(xdg, ".actrc") } else { actrcXdg = filepath.Join(home, ".config", ".actrc") } return []string{ filepath.Join(home, ".actrc"), actrcXdg, filepath.Join(".", ".actrc"), } } func args() []string { actrc := configLocations() args := make([]string, 0) for _, f := range actrc { args = append(args, readArgsFile(f, true)...) } args = append(args, os.Args[1:]...) return args } func bugReport(ctx context.Context, version string) error { var commonSocketPaths = []string{ "/var/run/docker.sock", "/var/run/podman/podman.sock", "$HOME/.colima/docker.sock", "$XDG_RUNTIME_DIR/docker.sock", `\\.\pipe\docker_engine`, } sprintf := func(key, val string) string { return fmt.Sprintf("%-24s%s\n", key, val) } report := sprintf("act version:", version) report += sprintf("GOOS:", runtime.GOOS) report += sprintf("GOARCH:", runtime.GOARCH) report += sprintf("NumCPU:", fmt.Sprint(runtime.NumCPU())) var dockerHost string if dockerHost = os.Getenv("DOCKER_HOST"); dockerHost == "" { dockerHost = "DOCKER_HOST environment variable is unset/empty." } report += sprintf("Docker host:", dockerHost) report += fmt.Sprintln("Sockets found:") for _, p := range commonSocketPaths { if strings.HasPrefix(p, `$`) { v := strings.Split(p, `/`)[0] p = strings.Replace(p, v, os.Getenv(strings.TrimPrefix(v, `$`)), 1) } if _, err := os.Stat(p); err != nil { continue } else { report += fmt.Sprintf("\t%s\n", p) } } report += sprintf("Config files:", "") for _, c := range configLocations() { args := readArgsFile(c, false) if len(args) > 0 { report += fmt.Sprintf("\t%s:\n", c) for _, l := range args { report += fmt.Sprintf("\t\t%s\n", l) } } } vcs, ok := debug.ReadBuildInfo() if ok && vcs != nil { report += fmt.Sprintln("Build info:") vcs := *vcs report += sprintf("\tGo version:", vcs.GoVersion) report += sprintf("\tModule path:", vcs.Path) report += sprintf("\tMain version:", vcs.Main.Version) report += sprintf("\tMain path:", vcs.Main.Path) report += sprintf("\tMain checksum:", vcs.Main.Sum) report += fmt.Sprintln("\tBuild settings:") for _, set := range vcs.Settings { report += sprintf(fmt.Sprintf("\t\t%s:", set.Key), set.Value) } } info, err := container.GetHostInfo(ctx) if err != nil { fmt.Println(report) return err } report += fmt.Sprintln("Docker Engine:") report += sprintf("\tEngine version:", info.ServerVersion) report += sprintf("\tEngine runtime:", info.DefaultRuntime) report += sprintf("\tCgroup version:", info.CgroupVersion) report += sprintf("\tCgroup driver:", info.CgroupDriver) report += sprintf("\tStorage driver:", info.Driver) report += sprintf("\tRegistry URI:", info.IndexServerAddress) report += sprintf("\tOS:", info.OperatingSystem) report += sprintf("\tOS type:", info.OSType) report += sprintf("\tOS version:", info.OSVersion) report += sprintf("\tOS arch:", info.Architecture) report += sprintf("\tOS kernel:", info.KernelVersion) report += sprintf("\tOS CPU:", fmt.Sprint(info.NCPU)) report += sprintf("\tOS memory:", fmt.Sprintf("%d MB", info.MemTotal/1024/1024)) report += fmt.Sprintln("\tSecurity options:") for _, secopt := range info.SecurityOptions { report += fmt.Sprintf("\t\t%s\n", secopt) } fmt.Println(report) return nil } func readArgsFile(file string, split bool) []string { args := make([]string, 0) f, err := os.Open(file) if err != nil { return args } defer func() { err := f.Close() if err != nil { log.Errorf("Failed to close args file: %v", err) } }() scanner := bufio.NewScanner(f) for scanner.Scan() { arg := strings.TrimSpace(scanner.Text()) if strings.HasPrefix(arg, "-") && split { args = append(args, regexp.MustCompile(`\s`).Split(arg, 2)...) } else if !split { args = append(args, arg) } } return args } func setupLogging(cmd *cobra.Command, _ []string) { verbose, _ := cmd.Flags().GetBool("verbose") if verbose { log.SetLevel(log.DebugLevel) } } func readEnvs(path string, envs map[string]string) bool { if _, err := os.Stat(path); err == nil { env, err := godotenv.Read(path) if err != nil { log.Fatalf("Error loading from %s: %v", path, err) } for k, v := range env { envs[k] = v } return true } return false } //nolint:gocyclo func newRunCommand(ctx context.Context, input *Input) func(*cobra.Command, []string) error { return func(cmd *cobra.Command, args []string) error { if input.jsonLogger { log.SetFormatter(&log.JSONFormatter{}) } if ok, _ := cmd.Flags().GetBool("bug-report"); ok { return bugReport(ctx, cmd.Version) } if runtime.GOOS == "darwin" && runtime.GOARCH == "arm64" && input.containerArchitecture == "" { l := log.New() l.SetFormatter(&log.TextFormatter{ DisableQuote: true, DisableTimestamp: true, }) l.Warnf(" \U000026A0 You are using Apple M1 chip and you have not specified container architecture, you might encounter issues while running act. If so, try running it with '--container-architecture linux/amd64'. \U000026A0 \n") } log.Debugf("Loading environment from %s", input.Envfile()) envs := make(map[string]string) if input.envs != nil { for _, envVar := range input.envs { e := strings.SplitN(envVar, `=`, 2) if len(e) == 2 { envs[e[0]] = e[1] } else { envs[e[0]] = "" } } } _ = readEnvs(input.Envfile(), envs) log.Debugf("Loading secrets from %s", input.Secretfile()) secrets := newSecrets(input.secrets) _ = readEnvs(input.Secretfile(), secrets) planner, err := model.NewWorkflowPlanner(input.WorkflowsPath(), input.noWorkflowRecurse) if err != nil { return err } jobID, err := cmd.Flags().GetString("job") if err != nil { return err } // check if we should just list the workflows list, err := cmd.Flags().GetBool("list") if err != nil { return err } // check if we should just draw the graph graph, err := cmd.Flags().GetBool("graph") if err != nil { return err } // collect all events from loaded workflows events := planner.GetEvents() // plan with filtered jobs - to be used for filtering only var filterPlan *model.Plan // Determine the event name to be filtered var filterEventName string = "" if len(args) > 0 { log.Debugf("Using first passed in arguments event for filtering: %s", args[0]) filterEventName = args[0] } else if input.autodetectEvent && len(events) > 0 && len(events[0]) > 0 { // set default event type to first event from many available // this way user dont have to specify the event. log.Debugf("Using first detected workflow event for filtering: %s", events[0]) filterEventName = events[0] } if jobID != "" { log.Debugf("Preparing plan with a job: %s", jobID) filterPlan = planner.PlanJob(jobID) } else if filterEventName != "" { log.Debugf("Preparing plan for a event: %s", filterEventName) filterPlan = planner.PlanEvent(filterEventName) } else { log.Debugf("Preparing plan with all jobs") filterPlan = planner.PlanAll() } if list { return printList(filterPlan) } if graph { return drawGraph(filterPlan) } // plan with triggered jobs var plan *model.Plan // Determine the event name to be triggered var eventName string if len(args) > 0 { log.Debugf("Using first passed in arguments event: %s", args[0]) eventName = args[0] } else if len(events) == 1 && len(events[0]) > 0 { log.Debugf("Using the only detected workflow event: %s", events[0]) eventName = events[0] } else if input.autodetectEvent && len(events) > 0 && len(events[0]) > 0 { // set default event type to first event from many available // this way user dont have to specify the event. log.Debugf("Using first detected workflow event: %s", events[0]) eventName = events[0] } else { log.Debugf("Using default workflow event: push") eventName = "push" } // build the plan for this run if jobID != "" { log.Debugf("Planning job: %s", jobID) plan = planner.PlanJob(jobID) } else { log.Debugf("Planning jobs for event: %s", eventName) plan = planner.PlanEvent(eventName) } // check to see if the main branch was defined defaultbranch, err := cmd.Flags().GetString("defaultbranch") if err != nil { return err } // Check if platforms flag is set, if not, run default image survey if len(input.platforms) == 0 { cfgFound := false cfgLocations := configLocations() for _, v := range cfgLocations { _, err := os.Stat(v) if os.IsExist(err) { cfgFound = true } } if !cfgFound && len(cfgLocations) > 0 { if err := defaultImageSurvey(cfgLocations[0]); err != nil { log.Fatal(err) } input.platforms = readArgsFile(cfgLocations[0], true) } } // run the plan config := &runner.Config{ Actor: input.actor, EventName: eventName, EventPath: input.EventPath(), DefaultBranch: defaultbranch, ForcePull: input.forcePull, ForceRebuild: input.forceRebuild, ReuseContainers: input.reuseContainers, Workdir: input.Workdir(), BindWorkdir: input.bindWorkdir, LogOutput: !input.noOutput, JSONLogger: input.jsonLogger, Env: envs, Secrets: secrets, Token: secrets["GITHUB_TOKEN"], InsecureSecrets: input.insecureSecrets, Platforms: input.newPlatforms(), Privileged: input.privileged, UsernsMode: input.usernsMode, ContainerArchitecture: input.containerArchitecture, ContainerDaemonSocket: input.containerDaemonSocket, UseGitIgnore: input.useGitIgnore, GitHubInstance: input.githubInstance, ContainerCapAdd: input.containerCapAdd, ContainerCapDrop: input.containerCapDrop, AutoRemove: input.autoRemove, ArtifactServerPath: input.artifactServerPath, ArtifactServerPort: input.artifactServerPort, NoSkipCheckout: input.noSkipCheckout, RemoteName: input.remoteName, ReplaceGheActionWithGithubCom: input.replaceGheActionWithGithubCom, ReplaceGheActionTokenWithGithubCom: input.replaceGheActionTokenWithGithubCom, } r, err := runner.New(config) if err != nil { return err } cancel := artifacts.Serve(ctx, input.artifactServerPath, input.artifactServerPort) ctx = common.WithDryrun(ctx, input.dryrun) if watch, err := cmd.Flags().GetBool("watch"); err != nil { return err } else if watch { return watchAndRun(ctx, r.NewPlanExecutor(plan)) } executor := r.NewPlanExecutor(plan).Finally(func(ctx context.Context) error { cancel() return nil }) return executor(ctx) } } func defaultImageSurvey(actrc string) error { var answer string confirmation := &survey.Select{ Message: "Please choose the default image you want to use with act:\n\n - Large size image: +20GB Docker image, includes almost all tools used on GitHub Actions (IMPORTANT: currently only ubuntu-18.04 platform is available)\n - Medium size image: ~500MB, includes only necessary tools to bootstrap actions and aims to be compatible with all actions\n - Micro size image: <200MB, contains only NodeJS required to bootstrap actions, doesn't work with all actions\n\nDefault image and other options can be changed manually in ~/.actrc (please refer to https://github.com/nektos/act#configuration for additional information about file structure)", Help: "If you want to know why act asks you that, please go to https://github.com/nektos/act/issues/107", Default: "Medium", Options: []string{"Large", "Medium", "Micro"}, } err := survey.AskOne(confirmation, &answer) if err != nil { return err } var option string switch answer { case "Large": option = "-P ubuntu-latest=catthehacker/ubuntu:full-latest\n-P ubuntu-latest=catthehacker/ubuntu:full-20.04\n-P ubuntu-18.04=catthehacker/ubuntu:full-18.04\n" case "Medium": option = "-P ubuntu-latest=catthehacker/ubuntu:act-latest\n-P ubuntu-22.04=catthehacker/ubuntu:act-22.04\n-P ubuntu-20.04=catthehacker/ubuntu:act-20.04\n-P ubuntu-18.04=catthehacker/ubuntu:act-18.04\n" case "Micro": option = "-P ubuntu-latest=node:16-buster-slim\n-P -P ubuntu-22.04=node:16-bullseye-slim\n ubuntu-20.04=node:16-buster-slim\n-P ubuntu-18.04=node:16-buster-slim\n" } f, err := os.Create(actrc) if err != nil { return err } _, err = f.WriteString(option) if err != nil { _ = f.Close() return err } err = f.Close() if err != nil { return err } return nil } func watchAndRun(ctx context.Context, fn common.Executor) error { recurse := true checkIntervalInSeconds := 2 dir, err := os.Getwd() if err != nil { return err } var ignore *gitignore.GitIgnore if _, err := os.Stat(filepath.Join(dir, ".gitignore")); !os.IsNotExist(err) { ignore, _ = gitignore.CompileIgnoreFile(filepath.Join(dir, ".gitignore")) } else { ignore = &gitignore.GitIgnore{} } folderWatcher := fswatch.NewFolderWatcher( dir, recurse, ignore.MatchesPath, checkIntervalInSeconds, ) folderWatcher.Start() go func() { for folderWatcher.IsRunning() { if err = fn(ctx); err != nil { break } log.Debugf("Watching %s for changes", dir) for changes := range folderWatcher.ChangeDetails() { log.Debugf("%s", changes.String()) if err = fn(ctx); err != nil { break } log.Debugf("Watching %s for changes", dir) } } }() <-ctx.Done() folderWatcher.Stop() return err }