| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080 |
- package executor
- import (
- "os"
- "path/filepath"
- "strings"
- "testing"
- "time"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "github.com/OliveTin/OliveTin/internal/auth"
- authpublic "github.com/OliveTin/OliveTin/internal/auth/authpublic"
- config "github.com/OliveTin/OliveTin/internal/config"
- "github.com/OliveTin/OliveTin/internal/entities"
- )
- func testingExecutor() (*Executor, *config.Config) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- a1 := &config.Action{
- Title: "Do some tickles",
- Shell: "echo 'Tickling {{ person }}'",
- Arguments: []config.ActionArgument{
- {
- Name: "person",
- Type: "ascii",
- },
- },
- }
- cfg.Actions = append(cfg.Actions, a1)
- cfg.Sanitize()
- return e, cfg
- }
- func TestCreateExecutorAndExec(t *testing.T) {
- e, cfg := testingExecutor()
- req := ExecutionRequest{
- AuthenticatedUser: &authpublic.AuthenticatedUser{Username: "MrTickle"},
- Cfg: cfg,
- Arguments: map[string]string{
- "person": "yourself",
- },
- }
- // Ensure bindings are available and set the binding to the only configured action
- e.RebuildActionMap()
- if len(cfg.Actions) > 0 {
- req.Binding = e.FindBindingWithNoEntity(cfg.Actions[0])
- }
- assert.NotNil(t, e, "Create an executor")
- wg, _ := e.ExecRequest(&req)
- wg.Wait()
- assert.Equal(t, int32(0), req.logEntry.ExitCode, "Exit code is zero")
- }
- func TestStepRequestActionPopulateLogEntryResolvesEntityTemplates(t *testing.T) {
- req := &ExecutionRequest{
- logEntry: &InternalLogEntry{},
- Binding: &ActionBinding{
- Action: &config.Action{
- Title: "Do something with {{ project.name }}",
- Icon: "{{ project.icon }}",
- },
- Entity: &entities.Entity{
- Data: map[string]any{
- "name": "foo",
- "icon": "🐰",
- },
- UniqueKey: "foo-key",
- },
- },
- }
- stepRequestActionPopulateLogEntry(req)
- assert.Equal(t, "Do something with foo", req.logEntry.ActionTitle)
- assert.Equal(t, "🐰", req.logEntry.ActionIcon)
- assert.Equal(t, "Do something with {{ project.name }}", req.logEntry.ActionConfigTitle)
- assert.Equal(t, "foo-key", req.logEntry.EntityPrefix)
- }
- func TestExecNonExistant(t *testing.T) {
- e, cfg := testingExecutor()
- req := ExecutionRequest{
- // Binding: e.FindBindingWithNoEntity("waffles"),
- logEntry: &InternalLogEntry{},
- Cfg: cfg,
- }
- wg, _ := e.ExecRequest(&req)
- wg.Wait()
- assert.Equal(t, int32(-1337), req.logEntry.ExitCode, "Log entry is set to an internal error code")
- assert.Equal(t, "💩", req.logEntry.ActionIcon, "Log entry icon is a poop (not found)")
- }
- func TestArgumentNameCamelCase(t *testing.T) {
- req := newExecRequest()
- req.Binding.Action = &config.Action{
- Title: "Do some tickles",
- Shell: "echo 'Tickling {{ personName }}'",
- Arguments: []config.ActionArgument{
- {
- Name: "personName",
- Type: "ascii",
- },
- },
- }
- req.Arguments = map[string]string{
- "personName": "Fred",
- }
- out, err := parseActionArguments(req)
- assert.Equal(t, "echo 'Tickling Fred'", out)
- assert.Nil(t, err)
- }
- func TestArgumentNameSnakeCase(t *testing.T) {
- req := newExecRequest()
- req.Binding.Action = &config.Action{
- Title: "Do some tickles",
- Shell: "echo 'Tickling {{ person_name }}'",
- Arguments: []config.ActionArgument{
- {
- Name: "person_name",
- Type: "ascii",
- },
- },
- }
- req.Arguments = map[string]string{
- "person_name": "Fred",
- }
- out, err := parseActionArguments(req)
- assert.Equal(t, "echo 'Tickling Fred'", out)
- assert.Nil(t, err)
- }
- func TestGetLogsEmpty(t *testing.T) {
- e, cfg := testingExecutor()
- assert.Equal(t, int64(10), cfg.LogHistoryPageSize, "Logs page size should be 10")
- logs, paging := e.GetLogTrackingIds(0, 10)
- assert.NotNil(t, logs, "Logs should not be nil")
- assert.Equal(t, 0, len(logs), "No logs yet")
- assert.Equal(t, int64(0), paging.CountRemaining, "There should be no remaining logs")
- }
- func TestGetLogsLessThanPageSize(t *testing.T) {
- e, cfg := testingExecutor()
- cfg.Actions = append(cfg.Actions, &config.Action{
- Title: "blat",
- Shell: "date",
- })
- cfg.Sanitize()
- // Rebuild action map to include newly added action
- e.RebuildActionMap()
- assert.Equal(t, int64(10), cfg.LogHistoryPageSize, "Logs page size should be 10")
- logEntries, paging := e.GetLogTrackingIds(0, 10)
- assert.Equal(t, 0, len(logEntries), "There should be 0 logs")
- assert.Zero(t, paging.CountRemaining, "There should be no remaining logs")
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- logEntries, paging = e.GetLogTrackingIds(0, 10)
- assert.Equal(t, 7, len(logEntries), "There should be 7 logs")
- assert.Zero(t, paging.CountRemaining, "There should be no remaining logs")
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- execNewReqAndWait(e, "blat", cfg)
- logEntries, paging = e.GetLogTrackingIds(0, 10)
- assert.Equal(t, 10, len(logEntries), "There should be 10 logs")
- assert.Equal(t, int64(2), paging.CountRemaining, "There should be 1 remaining logs")
- }
- func execNewReqAndWait(e *Executor, title string, cfg *config.Config) {
- req := &ExecutionRequest{
- // ActionTitle: title,
- Cfg: cfg,
- }
- // Ensure we have a binding for the requested title
- e.RebuildActionMap()
- var action *config.Action
- for _, a := range cfg.Actions {
- if a.Title == title {
- action = a
- break
- }
- }
- if action != nil {
- req.Binding = e.FindBindingWithNoEntity(action)
- }
- wg, _ := e.ExecRequest(req)
- wg.Wait()
- }
- func TestGetPagingIndexes(t *testing.T) {
- assert.Zero(t, getPagingStartIndex(5, 0), "Testing start index from empty list")
- assert.Equal(t, int64(4), getPagingStartIndex(5, 10), "Testing start index from mid point")
- assert.Equal(t, int64(9), getPagingStartIndex(-1, 10), "Testing start index with negative offset")
- assert.Equal(t, int64(0), getPagingStartIndex(15, 10), "Testing start index with large offset")
- assert.Equal(t, int64(9), getPagingStartIndex(0, 10), "Testing start index with zero count")
- }
- func TestUnsetRequiredArgument(t *testing.T) {
- req := newExecRequest()
- req.Binding.Action = &config.Action{
- Title: "Print your name",
- Shell: "echo 'Your name is: {{ name }}'",
- Arguments: []config.ActionArgument{
- {
- Name: "name",
- Type: "ascii",
- },
- },
- }
- req.Arguments = map[string]string{}
- out, err := parseActionArguments(req)
- assert.Equal(t, "", out)
- assert.NotNil(t, err)
- }
- func TestUnusedArgumentStillPassesTypeSafetyCheck(t *testing.T) {
- req := newExecRequest()
- req.Binding.Action = &config.Action{
- Title: "Print your name",
- Shell: "echo 'Your name is: {{ name }}'",
- Arguments: []config.ActionArgument{
- {
- Name: "name",
- Type: "ascii",
- },
- {
- Name: "age",
- Type: "int",
- },
- },
- }
- req.Arguments = map[string]string{
- "name": "Fred",
- "age": "Not an integer",
- }
- out, err := parseActionArguments(req)
- assert.Equal(t, "", out)
- assert.NotNil(t, err)
- }
- // https://github.com/OliveTin/OliveTin/issues/564
- func TestMangleInvalidArgumentValues(t *testing.T) {
- e, cfg := testingExecutor()
- a1 := &config.Action{
- Title: "Validate my date without seconds because I am from an Android phone",
- Shell: "echo 'The date is: {{ date }}'",
- Arguments: []config.ActionArgument{
- {
- Name: "date",
- Type: "datetime",
- },
- },
- }
- cfg.Actions = append(cfg.Actions, a1)
- cfg.Sanitize()
- // Build bindings for newly added action
- e.RebuildActionMap()
- req := ExecutionRequest{
- // Action: a1,
- AuthenticatedUser: auth.UserFromSystem(cfg, "testuser"),
- Cfg: cfg,
- Arguments: map[string]string{
- "date": "1990-01-10T12:00", // Invalid format, should be without seconds
- },
- }
- // Set binding to our appended action
- req.Binding = e.FindBindingWithNoEntity(a1)
- wg, _ := e.ExecRequest(&req)
- wg.Wait()
- assert.NotNil(t, req.logEntry, "Log entry should not be nil")
- assert.Equal(t, req.logEntry.Output, "The date is: 1990-01-10T12:00:00\n", "Date should be mangled to a valid format")
- }
- func TestWebhookRejectsShellExecution(t *testing.T) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- a1 := &config.Action{
- Title: "Webhook Shell Reject",
- Shell: "echo '{{ msg }}'",
- Arguments: []config.ActionArgument{
- {Name: "msg", Type: "ascii"},
- },
- }
- cfg.Actions = append(cfg.Actions, a1)
- cfg.Sanitize()
- e.RebuildActionMap()
- req := ExecutionRequest{
- Tags: []string{"webhook"},
- AuthenticatedUser: auth.UserFromSystem(cfg, "webhook"),
- Cfg: cfg,
- Arguments: map[string]string{"msg": "hello"},
- Binding: e.FindBindingWithNoEntity(a1),
- }
- wg, _ := e.ExecRequest(&req)
- wg.Wait()
- assert.NotNil(t, req.logEntry)
- assert.Equal(t, int32(-1337), req.logEntry.ExitCode)
- assert.Contains(t, req.logEntry.Output, "webhooks cannot use Shell execution")
- }
- func TestWebhookAllowsExecExecution(t *testing.T) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- a1 := &config.Action{
- Title: "Webhook Exec OK",
- Exec: []string{"echo", "{{ msg }}"},
- Arguments: []config.ActionArgument{
- {Name: "msg", Type: "ascii"},
- },
- }
- cfg.Actions = append(cfg.Actions, a1)
- cfg.Sanitize()
- e.RebuildActionMap()
- req := ExecutionRequest{
- Tags: []string{"webhook"},
- AuthenticatedUser: auth.UserFromSystem(cfg, "webhook"),
- Cfg: cfg,
- Arguments: map[string]string{"msg": "hello"},
- Binding: e.FindBindingWithNoEntity(a1),
- }
- wg, _ := e.ExecRequest(&req)
- wg.Wait()
- assert.NotNil(t, req.logEntry)
- assert.Equal(t, int32(0), req.logEntry.ExitCode)
- assert.Contains(t, req.logEntry.Output, "hello")
- }
- func TestWebhookRejectsShellAfterCompleted(t *testing.T) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- a1 := &config.Action{
- Title: "Webhook After Shell Reject",
- Exec: []string{"echo", "{{ msg }}"},
- ShellAfterCompleted: "echo after",
- Arguments: []config.ActionArgument{
- {Name: "msg", Type: "ascii"},
- },
- }
- cfg.Actions = append(cfg.Actions, a1)
- cfg.Sanitize()
- e.RebuildActionMap()
- req := ExecutionRequest{
- Tags: []string{"webhook"},
- AuthenticatedUser: auth.UserFromSystem(cfg, "webhook"),
- Cfg: cfg,
- Arguments: map[string]string{"msg": "hello"},
- Binding: e.FindBindingWithNoEntity(a1),
- }
- wg, _ := e.ExecRequest(&req)
- wg.Wait()
- assert.NotNil(t, req.logEntry)
- assert.Contains(t, req.logEntry.Output, "webhooks cannot use shellAfterCompleted")
- }
- func TestShellAfterCompletedUsesOutputEnvSafely(t *testing.T) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- injectedPath := filepath.Join(t.TempDir(), "olivetin-injected")
- expectedMainOutput := "'; touch " + injectedPath + "; echo '"
- a1 := &config.Action{
- Title: "After completion escape",
- Shell: "printf %s \"" + expectedMainOutput + "\"",
- ShellAfterCompleted: "printf %s {{ output }}",
- }
- cfg.Actions = append(cfg.Actions, a1)
- cfg.Sanitize()
- e.RebuildActionMap()
- req := ExecutionRequest{
- AuthenticatedUser: auth.UserFromSystem(cfg, "cron"),
- Cfg: cfg,
- Binding: e.FindBindingWithNoEntity(a1),
- }
- wg, _ := e.ExecRequest(&req)
- wg.Wait()
- assert.NotNil(t, req.logEntry)
- assert.Equal(t, int32(0), req.logEntry.ExitCode)
- assert.True(t, strings.HasPrefix(req.logEntry.Output, expectedMainOutput))
- assert.Contains(t, req.logEntry.Output, "OliveTin::shellAfterCompleted stdout\n"+expectedMainOutput)
- _, err := os.Stat(injectedPath)
- assert.True(t, os.IsNotExist(err), "shellAfterCompleted must not execute injected commands from output")
- }
- func TestShellAfterCompletedBlocksArgumentsOutputInjection(t *testing.T) {
- payload := func(injectedPath string) string {
- return "x; touch " + injectedPath + "; #"
- }
- cases := []struct {
- name string
- sac string
- }{
- {"legacy", "printf %s {{ output }}"},
- {"legacy compact", "printf %s {{output}}"},
- {"legacy extra spaces", "printf %s {{ output }}"},
- {"modern Arguments", "printf %s {{ .Arguments.output }}"},
- {"modern compact", "printf %s {{.Arguments.output}}"},
- {"modern exitCode still env", "printf %s {{ .Arguments.exitCode }}"},
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- injectedPath := filepath.Join(t.TempDir(), "injected")
- mainPayload := payload(injectedPath)
- a1 := &config.Action{
- Title: "sac-injection-" + tc.name,
- Shell: "printf %s \"" + mainPayload + "\"",
- ShellAfterCompleted: tc.sac,
- }
- cfg.Actions = append(cfg.Actions, a1)
- cfg.Sanitize()
- e.RebuildActionMap()
- req := ExecutionRequest{
- AuthenticatedUser: auth.UserFromSystem(cfg, "cron"),
- Cfg: cfg,
- Binding: e.FindBindingWithNoEntity(a1),
- }
- wg, _ := e.ExecRequest(&req)
- wg.Wait()
- _, err := os.Stat(injectedPath)
- assert.True(t, os.IsNotExist(err), "shellAfterCompleted must not execute injected commands via %q", tc.sac)
- })
- }
- }
- func TestSubstituteShellAfterCompletedEnvRefs(t *testing.T) {
- cases := []struct {
- in string
- want string
- }{
- {`printf %s {{ output }}`, `printf %s "$OUTPUT"`},
- {`printf %s {{output}}`, `printf %s "$OUTPUT"`},
- {`printf %s {{ output }}`, `printf %s "$OUTPUT"`},
- {`printf %s {{ .Arguments.output }}`, `printf %s "$OUTPUT"`},
- {`printf %s {{.Arguments.output}}`, `printf %s "$OUTPUT"`},
- {`echo {{ exitCode }}`, `echo "$EXITCODE"`},
- {`echo {{ .Arguments.exitCode }}`, `echo "$EXITCODE"`},
- {`echo {{ .Arguments.exitCode }}`, `echo "$EXITCODE"`},
- }
- for _, tc := range cases {
- assert.Equal(t, tc.want, substituteShellAfterCompletedEnvRefs(tc.in))
- }
- }
- func TestShellAfterTemplateArgsOmitsOutputAndExitCode(t *testing.T) {
- args := map[string]string{
- "output": "evil; id",
- "exitCode": "1",
- "ot_username": "alice",
- "ot_executionTrackingId": "track-1",
- }
- templateArgs := shellAfterTemplateArgs(args)
- assert.NotContains(t, templateArgs, "output")
- assert.NotContains(t, templateArgs, "exitCode")
- assert.Equal(t, "alice", templateArgs["ot_username"])
- assert.Equal(t, "track-1", templateArgs["ot_executionTrackingId"])
- assert.Equal(t, "evil; id", args["output"], "env args map must keep output for OUTPUT=")
- }
- func TestFilterToDefinedArgumentsOnly(t *testing.T) {
- req := newExecRequest()
- req.Binding.Action = &config.Action{
- Title: "Filter test",
- Shell: "echo '{{ name }}'",
- Arguments: []config.ActionArgument{
- {Name: "name", Type: "ascii"},
- },
- }
- req.Arguments = map[string]string{
- "name": "Alice",
- "webhook_path": "/malicious/$(id)",
- "extra_undefined": "ignored",
- }
- filterToDefinedArgumentsOnly(req)
- assert.Equal(t, "Alice", req.Arguments["name"])
- assert.Empty(t, req.Arguments["webhook_path"])
- assert.Empty(t, req.Arguments["extra_undefined"])
- }
- func TestFilterToDefinedArgumentsDropsReservedPrefixArgs(t *testing.T) {
- req := newExecRequest()
- req.Binding.Action = &config.Action{
- Title: "Filter test",
- Shell: "echo test",
- Arguments: []config.ActionArgument{},
- }
- req.Arguments = map[string]string{
- "ot_executionTrackingId": "track-123",
- "ot_username": "webhook",
- }
- filterToDefinedArgumentsOnly(req)
- assert.Empty(t, req.Arguments["ot_executionTrackingId"])
- assert.Empty(t, req.Arguments["ot_username"])
- }
- func TestStepParseArgsInjectsSystemArgsAfterFiltering(t *testing.T) {
- req := newExecRequest()
- req.TrackingID = "server-track-456"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice"}
- req.Binding.Action = &config.Action{
- Title: "Filter then inject",
- Shell: "echo test",
- Arguments: []config.ActionArgument{
- {Name: "name", Type: "ascii"},
- },
- }
- req.Arguments = map[string]string{
- "name": "Alice",
- "ot_executionTrackingId": "attacker-track",
- "ot_username": "mallory",
- "ot_custom": "polluted",
- }
- assert.True(t, stepParseArgs(req))
- assert.Equal(t, "Alice", req.Arguments["name"])
- assert.Equal(t, "server-track-456", req.Arguments["ot_executionTrackingId"])
- assert.Equal(t, "alice", req.Arguments["ot_username"])
- assert.Empty(t, req.Arguments["ot_custom"])
- }
- func TestStepParseArgsDropsReservedPrefixArgsFromEnvironment(t *testing.T) {
- req := newExecRequest()
- req.TrackingID = "server-track-456"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice@example.com"}
- req.Binding.Action = &config.Action{
- Title: "No reserved prefix pollution",
- Shell: "echo test",
- Arguments: []config.ActionArgument{},
- }
- req.Arguments = map[string]string{
- "ot_custom": "polluted",
- }
- assert.True(t, stepParseArgs(req))
- env := buildEnv(req.Arguments)
- assert.False(t, containsEnvPrefix(env, "OT_CUSTOM="))
- assert.True(t, containsEnvPrefix(env, "OT_USERNAME=alice@example.com"))
- assert.True(t, containsEnvPrefix(env, "OT_EXECUTIONTRACKINGID=server-track-456"))
- }
- func TestSystemArgumentDefinitionsAreReservedAndShellSafe(t *testing.T) {
- unsafeTypes := map[string]struct{}{
- "email": {},
- "password": {},
- "raw_string_multiline": {},
- "url": {},
- "very_dangerous_raw_string": {},
- }
- seen := map[string]struct{}{}
- for _, arg := range systemArgumentDefinitions {
- assert.True(t, strings.HasPrefix(arg.Name, config.ReservedArgumentNamePrefix))
- assert.NotEmpty(t, arg.Type)
- assert.True(t, arg.RejectNull)
- _, duplicate := seen[arg.Name]
- assert.False(t, duplicate, "duplicate system argument definition %q", arg.Name)
- seen[arg.Name] = struct{}{}
- _, unsafe := unsafeTypes[arg.Type]
- assert.False(t, unsafe, "system argument %q uses unsafe type %q", arg.Name, arg.Type)
- }
- }
- func TestValidatedSystemArgsMatchesSystemArgumentDefinitions(t *testing.T) {
- req := newExecRequest()
- req.TrackingID = "server-track-456"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice@example.com"}
- args, err := validatedSystemArgs(req)
- assert.Nil(t, err)
- assert.Len(t, args, len(systemArgumentDefinitions))
- for _, arg := range systemArgumentDefinitions {
- assert.Contains(t, args, arg.Name)
- }
- }
- func TestBuildShellAfterArgsOnlyAddsExpectedNonSystemArgs(t *testing.T) {
- req := newExecRequest()
- req.logEntry = &InternalLogEntry{
- Output: "hello",
- ExitCode: 7,
- }
- req.TrackingID = "server-track-456"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice@example.com"}
- req.Binding.Action = &config.Action{ShellAfterCompleted: "echo test"}
- args, err := buildShellAfterArgs(req)
- assert.Nil(t, err)
- assert.Len(t, args, len(systemArgumentDefinitions)+2)
- assert.Contains(t, args, "output")
- assert.Contains(t, args, "exitCode")
- for _, arg := range systemArgumentDefinitions {
- assert.Contains(t, args, arg.Name)
- }
- }
- func TestStepParseArgsAllowsEmailUsernameSystemArg(t *testing.T) {
- req := newExecRequest()
- req.logEntry = &InternalLogEntry{}
- req.TrackingID = "server-track-456"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice@example.com"}
- req.Binding.Action = &config.Action{
- Title: "Email username",
- Shell: "echo test",
- Arguments: []config.ActionArgument{},
- }
- assert.True(t, stepParseArgs(req))
- assert.Equal(t, "alice@example.com", req.Arguments["ot_username"])
- }
- func TestStepParseArgsFailsWhenUsernameSystemArgIsInvalid(t *testing.T) {
- req := newExecRequest()
- req.logEntry = &InternalLogEntry{}
- req.TrackingID = "server-track-456"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice;id"}
- req.Binding.Action = &config.Action{
- Title: "Invalid system arg",
- Shell: "echo test",
- Arguments: []config.ActionArgument{},
- }
- assert.False(t, stepParseArgs(req))
- assert.Contains(t, req.logEntry.Output, `system argument "ot_username" failed validation`)
- assert.Empty(t, req.Arguments["ot_username"])
- }
- func TestStepParseArgsFailsWhenTrackingIDSystemArgIsInvalid(t *testing.T) {
- req := newExecRequest()
- req.logEntry = &InternalLogEntry{}
- req.TrackingID = "track/../../bad"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice"}
- req.Binding.Action = &config.Action{
- Title: "Invalid tracking ID",
- Shell: "echo test",
- Arguments: []config.ActionArgument{},
- }
- assert.False(t, stepParseArgs(req))
- assert.Contains(t, req.logEntry.Output, `system argument "ot_executionTrackingId" failed validation`)
- assert.Empty(t, req.Arguments["ot_executionTrackingId"])
- }
- func TestBuildShellAfterArgsUsesValidatedSystemArgs(t *testing.T) {
- req := newExecRequest()
- req.logEntry = &InternalLogEntry{
- Output: "hello",
- ExitCode: 7,
- }
- req.TrackingID = "server-track-456"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice@example.com"}
- req.Binding.Action = &config.Action{
- Title: "Shell after",
- ShellAfterCompleted: "echo test",
- }
- args, err := buildShellAfterArgs(req)
- assert.Nil(t, err)
- assert.Equal(t, "alice@example.com", args["ot_username"])
- assert.Equal(t, "server-track-456", args["ot_executionTrackingId"])
- assert.Equal(t, "hello", args["output"])
- assert.Equal(t, "7", args["exitCode"])
- }
- func TestBuildShellAfterArgsFailsWhenSystemArgIsInvalid(t *testing.T) {
- req := newExecRequest()
- req.logEntry = &InternalLogEntry{}
- req.TrackingID = "server-track-456"
- req.AuthenticatedUser = &authpublic.AuthenticatedUser{Username: "alice;id"}
- req.Binding.Action = &config.Action{
- Title: "Shell after invalid username",
- ShellAfterCompleted: "echo test",
- }
- args, err := buildShellAfterArgs(req)
- assert.Nil(t, args)
- assert.NotNil(t, err)
- assert.Contains(t, err.Error(), `system argument "ot_username" failed validation`)
- }
- func containsEnvPrefix(env []string, prefix string) bool {
- for _, item := range env {
- if strings.HasPrefix(item, prefix) {
- return true
- }
- }
- return false
- }
- func TestTriggerExecutesTriggeredAction(t *testing.T) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- helloAction := &config.Action{
- Title: "Hello world",
- Shell: "echo 'Hello World!'",
- }
- triggerAction := &config.Action{
- Title: "Simple action that triggers another action",
- Shell: "echo 'Hi'",
- Triggers: []string{"Hello world"},
- }
- cfg.Actions = append(cfg.Actions, helloAction, triggerAction)
- cfg.Sanitize()
- e.RebuildActionMap()
- finishedTitles := make(chan string, 4)
- collector := &executionFinishedCollector{ch: finishedTitles}
- e.AddListener(collector)
- req := &ExecutionRequest{
- AuthenticatedUser: auth.UserFromSystem(cfg, "testuser"),
- Cfg: cfg,
- Binding: e.FindBindingWithNoEntity(triggerAction),
- }
- wg, _ := e.ExecRequest(req)
- wg.Wait()
- var got []string
- for i := 0; i < 2; i++ {
- select {
- case title := <-finishedTitles:
- got = append(got, title)
- case <-time.After(2 * time.Second):
- t.Fatalf("timed out waiting for execution %d; got %v", i+1, got)
- }
- }
- assert.Contains(t, got, "Hello world", "triggered action must run")
- assert.Contains(t, got, "Simple action that triggers another action", "triggering action must run")
- }
- func TestTriggerUnknownActionTitleSkipsWithoutPanic(t *testing.T) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- triggerAction := &config.Action{
- Title: "Action with bad trigger",
- Shell: "echo 'ok'",
- Triggers: []string{"Nonexistent action"},
- }
- cfg.Actions = append(cfg.Actions, triggerAction)
- cfg.Sanitize()
- e.RebuildActionMap()
- finishedTitles := make(chan string, 4)
- collector := &executionFinishedCollector{ch: finishedTitles}
- e.AddListener(collector)
- req := &ExecutionRequest{
- AuthenticatedUser: auth.UserFromSystem(cfg, "testuser"),
- Cfg: cfg,
- Binding: e.FindBindingWithNoEntity(triggerAction),
- }
- wg, _ := e.ExecRequest(req)
- wg.Wait()
- var got []string
- select {
- case title := <-finishedTitles:
- got = append(got, title)
- case <-time.After(500 * time.Millisecond):
- }
- assert.Len(t, got, 1, "only the triggering action runs; unknown trigger is skipped")
- if len(got) > 0 {
- assert.Equal(t, "Action with bad trigger", got[0])
- }
- }
- type executionFinishedCollector struct {
- ch chan string
- }
- func (c *executionFinishedCollector) OnExecutionStarted(_ *InternalLogEntry) {}
- func (c *executionFinishedCollector) OnExecutionFinished(entry *InternalLogEntry) {
- c.ch <- entry.ActionTitle
- }
- func (c *executionFinishedCollector) OnOutputChunk(_ []byte, _ string) {}
- func (c *executionFinishedCollector) OnActionMapRebuilt() {}
- func TestSanitizeLogFilename(t *testing.T) {
- tests := []struct {
- title string
- want string
- }{
- {"Echo Test", "Echo Test"},
- {"Create/update Monthly Report", "Create_update Monthly Report"},
- {`path\with\backslashes`, "path_with_backslashes"},
- {`a:b*c?d"e<f>g|h`, "a_b_c_d_e_f_g_h"},
- {"has\x00nul", "has_nul"},
- {"tab\there\nand\rreturn", "tab_here_and_return"},
- }
- for _, tt := range tests {
- assert.Equal(t, tt.want, sanitizeLogFilename(tt.title), "title=%q", tt.title)
- }
- }
- func TestStepSaveLogSanitizesSlashInTitle(t *testing.T) {
- resultsDir := t.TempDir()
- outputDir := t.TempDir()
- started := time.Unix(1714333384, 0)
- trackingID := "5e2dc9e5-b6b3-445b-bff9-c2082b0bbbb2"
- title := "Create/update Monthly Report"
- req := &ExecutionRequest{
- Cfg: &config.Config{
- SaveLogs: config.SaveLogsConfig{
- ResultsDirectory: resultsDir,
- OutputDirectory: outputDir,
- },
- },
- Binding: &ActionBinding{
- Action: &config.Action{},
- },
- logEntry: &InternalLogEntry{
- ActionTitle: title,
- DatetimeStarted: started,
- ExecutionTrackingID: trackingID,
- Output: "report ok",
- },
- }
- assert.True(t, stepSaveLog(req))
- expectedBase := "Create_update Monthly Report.1714333384." + trackingID
- resultsPath := filepath.Join(resultsDir, expectedBase+".yaml")
- outputPath := filepath.Join(outputDir, expectedBase+".log")
- assert.FileExists(t, resultsPath)
- assert.FileExists(t, outputPath)
- resultsEntries, err := os.ReadDir(resultsDir)
- assert.NoError(t, err)
- assert.Len(t, resultsEntries, 1, "results file must be flat under resultsDirectory, not a subdirectory")
- data, err := os.ReadFile(resultsPath)
- assert.NoError(t, err)
- assert.Contains(t, string(data), title, "YAML content keeps the original action title")
- output, err := os.ReadFile(outputPath)
- assert.NoError(t, err)
- assert.Equal(t, "report ok", string(output))
- }
- func TestStepSaveLogKeepsSafeTitleFilename(t *testing.T) {
- resultsDir := t.TempDir()
- started := time.Unix(1714333384, 0)
- trackingID := "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
- req := &ExecutionRequest{
- Cfg: &config.Config{
- SaveLogs: config.SaveLogsConfig{
- ResultsDirectory: resultsDir,
- },
- },
- Binding: &ActionBinding{
- Action: &config.Action{},
- },
- logEntry: &InternalLogEntry{
- ActionTitle: "Echo Test",
- DatetimeStarted: started,
- ExecutionTrackingID: trackingID,
- },
- }
- assert.True(t, stepSaveLog(req))
- expectedPath := filepath.Join(resultsDir, "Echo Test.1714333384."+trackingID+".yaml")
- assert.FileExists(t, expectedPath)
- }
- func TestStepSaveLogSanitizesNULInTitle(t *testing.T) {
- resultsDir := t.TempDir()
- outputDir := t.TempDir()
- started := time.Unix(1714333384, 0)
- trackingID := "bbbbbbbb-cccc-dddd-eeee-ffffffffffff"
- title := "Bad\x00Title"
- req := &ExecutionRequest{
- Cfg: &config.Config{
- SaveLogs: config.SaveLogsConfig{
- ResultsDirectory: resultsDir,
- OutputDirectory: outputDir,
- },
- },
- Binding: &ActionBinding{
- Action: &config.Action{},
- },
- logEntry: &InternalLogEntry{
- ActionTitle: title,
- DatetimeStarted: started,
- ExecutionTrackingID: trackingID,
- Output: "nul ok",
- },
- }
- assert.True(t, stepSaveLog(req))
- expectedBase := "Bad_Title.1714333384." + trackingID
- resultsPath := filepath.Join(resultsDir, expectedBase+".yaml")
- outputPath := filepath.Join(outputDir, expectedBase+".log")
- assert.FileExists(t, resultsPath)
- assert.FileExists(t, outputPath)
- assert.NotContains(t, resultsPath, "\x00")
- assert.NotContains(t, outputPath, "\x00")
- output, err := os.ReadFile(outputPath)
- assert.NoError(t, err)
- assert.Equal(t, "nul ok", string(output))
- }
- func TestStepSaveLogReturnsFalseWhenDependenciesMissing(t *testing.T) {
- started := time.Unix(1714333384, 0)
- valid := &ExecutionRequest{
- Cfg: &config.Config{},
- Binding: &ActionBinding{
- Action: &config.Action{},
- },
- logEntry: &InternalLogEntry{
- ActionTitle: "Echo",
- DatetimeStarted: started,
- ExecutionTrackingID: "cccccccc-dddd-eeee-ffff-000000000000",
- },
- }
- assert.False(t, stepSaveLog(nil))
- assert.False(t, stepSaveLog(&ExecutionRequest{}))
- missingLog := *valid
- missingLog.logEntry = nil
- assert.False(t, stepSaveLog(&missingLog))
- missingBinding := *valid
- missingBinding.Binding = nil
- assert.False(t, stepSaveLog(&missingBinding))
- missingAction := *valid
- missingAction.Binding = &ActionBinding{}
- assert.False(t, stepSaveLog(&missingAction))
- missingCfg := *valid
- missingCfg.Cfg = nil
- assert.False(t, stepSaveLog(&missingCfg))
- }
- func TestLogEntryOutputAvailableWhileRunning(t *testing.T) {
- cfg := config.DefaultConfig()
- e := DefaultExecutor(cfg)
- action := &config.Action{
- Title: "Slow output",
- Shell: "echo hello-mid-run; sleep 2",
- }
- cfg.Actions = append(cfg.Actions, action)
- cfg.Sanitize()
- e.RebuildActionMap()
- binding := e.FindBindingWithNoEntity(action)
- require.NotNil(t, binding)
- wg, trackingID := e.ExecRequest(&ExecutionRequest{
- Binding: binding,
- Cfg: cfg,
- AuthenticatedUser: auth.UserFromSystem(cfg, "testuser"),
- })
- var sawOutputWhileRunning bool
- require.Eventually(t, func() bool {
- snapshot, ok := e.SnapshotLog(trackingID)
- if !ok {
- return false
- }
- if snapshot.ExecutionFinished {
- return false
- }
- if strings.Contains(snapshot.Output, "hello-mid-run") {
- sawOutputWhileRunning = true
- return true
- }
- return false
- }, 2*time.Second, 10*time.Millisecond)
- wg.Wait()
- require.True(t, sawOutputWhileRunning, "expected Output to contain printed text before ExecutionFinished")
- snapshot, ok := e.SnapshotLog(trackingID)
- require.True(t, ok)
- assert.True(t, snapshot.ExecutionFinished)
- assert.Contains(t, snapshot.Output, "hello-mid-run")
- }
|