From d4a4b4b4e3a6aef7d2177e63812bbfe088aaac57 Mon Sep 17 00:00:00 2001 From: Gusted Date: Sat, 6 Apr 2024 15:43:45 +0200 Subject: [PATCH] Add unit tests for update git hook - Add unit tests. - Handle the 'impossible' case of not enough arguments. - Ref: https://codeberg.org/forgejo/forgejo/pulls/2834 (cherry picked from commit dad799fa4603a8ce7eb6f6d92930f652e73a5724) --- cmd/hook.go | 8 ++++-- cmd/hook_test.go | 72 ++++++++++++++++++++++++++++++++++-------------- 2 files changed, 58 insertions(+), 22 deletions(-) diff --git a/cmd/hook.go b/cmd/hook.go index a29d15628e..04df7ce18c 100644 --- a/cmd/hook.go +++ b/cmd/hook.go @@ -302,8 +302,12 @@ func runHookUpdate(c *cli.Context) error { ctx, cancel := installSignals() defer cancel() - // The last three arguments given to the hook are in order: reference name, old commit ID and new commit ID. - args := os.Args[len(os.Args)-3:] + if c.NArg() != 3 { + return nil + } + args := c.Args().Slice() + + // The arguments given to the hook are in order: reference name, old commit ID and new commit ID. refFullName := git.RefName(args[0]) newCommitID := args[2] diff --git a/cmd/hook_test.go b/cmd/hook_test.go index 89dafeaa57..91731f77c0 100644 --- a/cmd/hook_test.go +++ b/cmd/hook_test.go @@ -24,6 +24,24 @@ import ( "github.com/urfave/cli/v2" ) +// Capture what's being written into a standard file descriptor. +func captureOutput(t *testing.T, stdFD *os.File) (finish func() (output string)) { + t.Helper() + + r, w, err := os.Pipe() + require.NoError(t, err) + resetStdout := test.MockVariableValue(stdFD, *w) + + return func() (output string) { + w.Close() + resetStdout() + + out, err := io.ReadAll(r) + require.NoError(t, err) + return string(out) + } +} + func TestPktLine(t *testing.T) { ctx := context.Background() @@ -121,27 +139,9 @@ func TestDelayWriter(t *testing.T) { app := cli.NewApp() app.Commands = []*cli.Command{subcmdHookPreReceive} - // Capture what's being written into stdout - captureStdout := func(t *testing.T) (finish func() (output string)) { - t.Helper() - - r, w, err := os.Pipe() - require.NoError(t, err) - resetStdout := test.MockVariableValue(os.Stdout, *w) - - return func() (output string) { - w.Close() - resetStdout() - - out, err := io.ReadAll(r) - require.NoError(t, err) - return string(out) - } - } - t.Run("Should delay", func(t *testing.T) { defer test.MockVariableValue(&setting.Git.VerbosePushDelay, time.Millisecond*500)() - finish := captureStdout(t) + finish := captureOutput(t, os.Stdout) err = app.Run([]string{"./forgejo", "pre-receive"}) require.NoError(t, err) @@ -153,7 +153,7 @@ func TestDelayWriter(t *testing.T) { t.Run("Shouldn't delay", func(t *testing.T) { defer test.MockVariableValue(&setting.Git.VerbosePushDelay, time.Second*5)() - finish := captureStdout(t) + finish := captureOutput(t, os.Stdout) err = app.Run([]string{"./forgejo", "pre-receive"}) require.NoError(t, err) @@ -177,3 +177,35 @@ func TestPushOptions(t *testing.T) { "option-double": "another=value", }, pushOptions()) } + +func TestRunHookUpdate(t *testing.T) { + app := cli.NewApp() + app.Commands = []*cli.Command{subcmdHookUpdate} + + t.Run("Removal of internal reference", func(t *testing.T) { + defer test.MockVariableValue(&cli.OsExiter, func(code int) {})() + defer test.MockVariableValue(&setting.IsProd, false)() + finish := captureOutput(t, os.Stderr) + + err := app.Run([]string{"./forgejo", "update", "refs/pull/1/head", "0a51ae26bc73c47e2f754560c40904cf14ed51a9", "0000000000000000000000000000000000000000"}) + out := finish() + assert.Error(t, err) + + assert.Contains(t, out, "The deletion of refs/pull/1/head is skipped as it's an internal reference.") + }) + + t.Run("Update of internal reference", func(t *testing.T) { + err := app.Run([]string{"./forgejo", "update", "refs/pull/1/head", "0a51ae26bc73c47e2f754560c40904cf14ed51a9", "0000000000000000000000000000000000000001"}) + assert.NoError(t, err) + }) + + t.Run("Removal of branch", func(t *testing.T) { + err := app.Run([]string{"./forgejo", "update", "refs/head/main", "0a51ae26bc73c47e2f754560c40904cf14ed51a9", "0000000000000000000000000000000000000000"}) + assert.NoError(t, err) + }) + + t.Run("Not enough arguments", func(t *testing.T) { + err := app.Run([]string{"./forgejo", "update"}) + assert.NoError(t, err) + }) +}