runner/internal/app/cmd/exec_test.go

// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package cmd

import (
	"bytes"
	"os"
	"path/filepath"
	"strings"
	"testing"

	"gitea.com/gitea/runner/act/artifactcache"
	"gitea.com/gitea/runner/act/runner"
	"gitea.com/gitea/runner/internal/pkg/config"

	"gitea.dev/actionslib/pkg/model"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"go.yaml.in/yaml/v4"
)

func TestExecuteArgsResolve(t *testing.T) {
	workdir := t.TempDir()
	args := &executeArgs{workdir: workdir}

	require.Empty(t, args.resolve(""))
	require.Equal(t, filepath.Join(workdir, "sub", "file"), args.resolve("sub/file"))

	abs := filepath.Join(workdir, "abs")
	require.Equal(t, abs, args.resolve(abs))
}

func TestSharedToolCache(t *testing.T) {
	shared, err := sharedToolCache(config.ToolCacheModeShared)
	require.NoError(t, err)
	require.True(t, shared)

	shared, err = sharedToolCache(config.ToolCacheModeNone)
	require.NoError(t, err)
	require.False(t, shared)

	_, err = sharedToolCache("everyone")
	require.ErrorContains(t, err, "tool-cache-mode")
}

func TestExecuteArgsPaths(t *testing.T) {
	workdir := t.TempDir()
	args := &executeArgs{
		workdir:       workdir,
		workflowsPath: ".gitea/workflows",
		envfile:       ".env",
	}

	require.Equal(t, filepath.Join(workdir, ".gitea/workflows"), args.WorkflowsPath())
	require.Equal(t, filepath.Join(workdir, ".env"), args.Envfile())
	require.Equal(t, workdir, args.Workdir())
}

func TestExecuteArgsLoadInputs(t *testing.T) {
	require.Empty(t, (&executeArgs{}).LoadInputs())

	dir := t.TempDir()
	envFile := filepath.Join(dir, ".env")
	require.NoError(t, os.WriteFile(envFile, []byte("BAZ=qux\nOVERRIDE=from_file\n"), 0o600))

	args := &executeArgs{inputs: []string{"FOO=bar", "EMPTY", "WITH=eq=sign", "OVERRIDE=from_cli"}, inputfile: envFile}
	require.Equal(t, map[string]string{
		"FOO":      "bar",
		"EMPTY":    "",
		"WITH":     "eq=sign",
		"BAZ":      "qux",
		"OVERRIDE": "from_cli",
	}, args.LoadInputs())
}

func TestExecuteArgsEventJSON(t *testing.T) {
	payload := func(content string) string {
		path := filepath.Join(t.TempDir(), "event.json")
		require.NoError(t, os.WriteFile(path, []byte(content), 0o600))
		return path
	}

	tests := []struct {
		name      string
		eventpath string
		inputs    []string
		expected  string
	}{
		{
			name:      "keeps a payload without inputs to merge",
			eventpath: payload(`{"inputs": {"kept": "from_event"}}`),
			expected:  `{"inputs": {"kept": "from_event"}}`,
		},
		{
			name:      "overrides the event inputs it names, keeping the rest",
			eventpath: payload(`{"inputs": {"kept": "from_event", "named": "from_event"}}`),
			inputs:    []string{"named=from_cli"},
			expected:  `{"inputs": {"kept": "from_event", "named": "from_cli"}}`,
		},
		{
			name:      "adds inputs to a payload carrying none",
			eventpath: payload(`{"repository": {"name": "test-repo"}}`),
			inputs:    []string{"flag=val"},
			expected:  `{"repository": {"name": "test-repo"}, "inputs": {"flag": "val"}}`,
		},
		{
			name:      "handles a null payload",
			eventpath: payload("null"),
			inputs:    []string{"flag=val"},
			expected:  `{"inputs": {"flag": "val"}}`,
		},
		{
			name:     "builds a payload without an event file",
			inputs:   []string{"flag=val"},
			expected: `{"inputs": {"flag": "val"}}`,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			eventJSON, err := (&executeArgs{eventpath: tt.eventpath, inputs: tt.inputs}).eventJSON()
			require.NoError(t, err)
			require.JSONEq(t, tt.expected, eventJSON)
		})
	}

	args := &executeArgs{inputs: []string{"flag=val"}}
	config, err := args.runnerConfig("workflow_dispatch", nil, nil, 0, false)
	require.NoError(t, err)
	require.JSONEq(t, `{"inputs": {"flag": "val"}}`, config.EventJSON)
	require.Equal(t, "workflow_dispatch", config.EventName) // the inputs context stays empty without it
}

func TestExecuteArgsLoadVars(t *testing.T) {
	require.Empty(t, (&executeArgs{}).LoadVars())

	args := &executeArgs{vars: []string{"FOO=bar", "EMPTY", "WITH=eq=sign"}}
	require.Equal(t, map[string]string{
		"FOO":   "bar",
		"EMPTY": "",
		"WITH":  "eq=sign",
	}, args.LoadVars())
}

func TestExecuteArgsLoadSecrets(t *testing.T) {
	t.Setenv("FROMENV", "from-env-value")

	args := &executeArgs{secrets: []string{"token=abc", "fromenv"}}
	require.Equal(t, map[string]string{
		"TOKEN":   "abc",
		"FROMENV": "from-env-value",
	}, args.LoadSecrets())
}

func TestReadEnvs(t *testing.T) {
	dir := t.TempDir()
	envFile := filepath.Join(dir, ".env")
	require.NoError(t, os.WriteFile(envFile, []byte("FOO=bar\nBAZ=qux\n"), 0o600))

	envs := map[string]string{"EXISTING": "keep"}
	require.True(t, readEnvs(envFile, envs))
	require.Equal(t, map[string]string{
		"EXISTING": "keep",
		"FOO":      "bar",
		"BAZ":      "qux",
	}, envs)

	missing := map[string]string{}
	require.False(t, readEnvs(filepath.Join(dir, "does-not-exist"), missing))
	require.Empty(t, missing)
}

func TestRunExecListUsesJobEventAndAllPlans(t *testing.T) {
	planner := &fakeWorkflowPlanner{
		events: []string{"push", "pull_request"},
		plans: map[string]*model.Plan{
			"job:build":  listPlan("build", "Build", "push"),
			"event:push": listPlan("test", "Test", "push"),
			"all":        listPlan("lint", "Lint", "push"),
		},
	}

	var out bytes.Buffer
	require.NoError(t, runExecList(&out, planner, &executeArgs{job: "build"}))
	require.NoError(t, runExecList(&out, planner, &executeArgs{event: "push"}))
	require.NoError(t, runExecList(&out, planner, &executeArgs{autodetectEvent: true}))
	require.NoError(t, runExecList(&out, planner, &executeArgs{}))
	emptyPlanner, err := model.NewWorkflowPlanner(t.TempDir(), false)
	require.NoError(t, err)
	require.NoError(t, runExecList(&out, emptyPlanner, &executeArgs{autodetectEvent: true}))

	require.Contains(t, out.String(), "Build")
	require.Contains(t, out.String(), "Test")
	require.Contains(t, out.String(), "Lint")
	require.Equal(t, []string{"job:build", "event:push", "event:push", "all"}, planner.calls)
}

func TestPrintListReportsDuplicateJobIDs(t *testing.T) {
	workflowA := workflowForList("A", "a.yml", "push", "build", "Build A")
	workflowB := workflowForList("B", "b.yml", "pull_request", "build", "Build B")
	plan := &model.Plan{Stages: []*model.Stage{{
		Runs: []*model.Run{
			{Workflow: workflowA, JobID: "build"},
			{Workflow: workflowB, JobID: "build"},
		},
	}}}

	var out bytes.Buffer
	printList(&out, plan)

	require.Contains(t, out.String(), "Workflow file")
	require.Contains(t, out.String(), "Build A")
	require.Contains(t, out.String(), "Build B")
	require.Contains(t, out.String(), "Detected multiple jobs with the same job name")
}

func TestLoadExecCmdDefinesExpectedFlags(t *testing.T) {
	cmd := loadExecCmd(t.Context())

	for _, name := range []string{
		"list",
		"job",
		"event",
		"workflows",
		"directory",
		"env",
		"secret",
		"var",
		"dryrun",
		"image",
		"gitea-instance",
	} {
		if cmd.Flags().Lookup(name) == nil && cmd.PersistentFlags().Lookup(name) == nil {
			t.Fatalf("expected flag %q to be registered", name)
		}
	}

	require.Equal(t, "exec", cmd.Use)
	require.NoError(t, cmd.Args(cmd, strings.Split("a b c", " ")))
	require.Error(t, cmd.Args(cmd, strings.Fields(strings.Repeat("arg ", 21))))
}

type fakeWorkflowPlanner struct {
	events []string
	plans  map[string]*model.Plan
	calls  []string
}

func (p *fakeWorkflowPlanner) PlanEvent(eventName string) (*model.Plan, error) {
	p.calls = append(p.calls, "event:"+eventName)
	return p.plans["event:"+eventName], nil
}

func (p *fakeWorkflowPlanner) PlanJob(jobName string) (*model.Plan, error) {
	p.calls = append(p.calls, "job:"+jobName)
	return p.plans["job:"+jobName], nil
}

func (p *fakeWorkflowPlanner) PlanAll() (*model.Plan, error) {
	p.calls = append(p.calls, "all")
	return p.plans["all"], nil
}

func (p *fakeWorkflowPlanner) GetEvents() []string {
	return p.events
}

func listPlan(jobID, jobName, event string) *model.Plan {
	workflow := workflowForList("Workflow "+jobID, jobID+".yml", event, jobID, jobName)
	return &model.Plan{Stages: []*model.Stage{{Runs: []*model.Run{{Workflow: workflow, JobID: jobID}}}}}
}

func workflowForList(name, file, event, jobID, jobName string) *model.Workflow {
	return &model.Workflow{
		Name:  name,
		File:  file,
		RawOn: rawOnNode(event),
		Jobs: map[string]*model.Job{
			jobID: {Name: jobName},
		},
	}
}

func rawOnNode(event string) yaml.Node {
	var node yaml.Node
	if err := yaml.Unmarshal([]byte(event), &node); err != nil {
		panic(err)
	}
	return *node.Content[0]
}

func TestExecuteArgsLoadEnvsResultsOrigin(t *testing.T) {
	t.Setenv("ACTIONS_RESULTS_URL", "") // the default is only supplied when nothing else does
	handler, err := artifactcache.StartHandler(artifactcache.Options{Dir: t.TempDir(), OutboundIP: "127.0.0.1"})
	require.NoError(t, err)
	t.Cleanup(func() { _ = handler.Close() })
	args := &executeArgs{cacheHandler: handler}

	envs := args.LoadEnvs()
	assert.Equal(t, handler.ExternalURL(), envs["ACTIONS_RESULTS_URL"],
		"the v2 flag is advertised, so something has to serve that origin")
	assert.Equal(t, "true", envs[runner.CacheServiceV2Env])

	args.envs = []string{"ACTIONS_RESULTS_URL=https://gitea.example"}
	assert.Equal(t, "https://gitea.example", args.LoadEnvs()["ACTIONS_RESULTS_URL"], "a supplied origin wins")
}