Skip to content

Commit

Permalink
Add more test cases and fix bug
Browse files Browse the repository at this point in the history
Remove increase in x index count when iterating args sin mage file.
  • Loading branch information
perrito666 committed Nov 19, 2023
1 parent 7934dd6 commit 594383f
Show file tree
Hide file tree
Showing 3 changed files with 137 additions and 3 deletions.
102 changes: 101 additions & 1 deletion mage/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1881,7 +1881,7 @@ func TestExtraArgs(t *testing.T) {
stdout := &bytes.Buffer{}
inv := Invocation{
Dir: "./testdata/extra_args",
Stderr: os.Stderr,
Stderr: ioutil.Discard,
Stdout: stdout,
Args: []string{"targetOne"},
ExtraArgs: []string{"--", "-baz", "foo", "bar"},
Expand All @@ -1897,6 +1897,106 @@ func TestExtraArgs(t *testing.T) {
}
}

func TestExtraArgsWithContext(t *testing.T) {
stdout := &bytes.Buffer{}
inv := Invocation{
Dir: "./testdata/extra_args",
Stderr: ioutil.Discard,
Stdout: stdout,
Args: []string{"targetTwo"},
ExtraArgs: []string{"--", "-baz", "foo", "bar"},
}

code := Invoke(inv)
if code != 0 {
t.Fatalf("expected 0, but got %v", code)
}
expected := "Context is nil: false\nmg.ExtraArgs{\"-baz\", \"foo\", \"bar\"}\n"
if stdout.String() != expected {
t.Fatalf("expected %q, but got %q", expected, stdout.String())
}
}

func TestExtraArgsWithContextAndString(t *testing.T) {
stdout := &bytes.Buffer{}
inv := Invocation{
Dir: "./testdata/extra_args",
Stderr: ioutil.Discard,
Stdout: stdout,
Args: []string{"targetThree", "stringvalue"},
ExtraArgs: []string{"--", "-baz", "foo", "bar"},
}

code := Invoke(inv)
if code != 0 {
t.Fatalf("expected 0, but got %v", code)
}
expected := "Context is nil: false\nmg.ExtraArgs{\"-baz\", \"foo\", \"bar\"}\nstringvalue\n"
if stdout.String() != expected {
t.Fatalf("expected %q, but got %q", expected, stdout.String())
}
}

func TestExtraArgsWithContextAndStringAndInt(t *testing.T) {
stdout := &bytes.Buffer{}
inv := Invocation{
Dir: "./testdata/extra_args",
Stderr: ioutil.Discard,
Stdout: stdout,
Args: []string{"targetFour", "stringvalue", "2"},
ExtraArgs: []string{"--", "-baz", "foo", "bar"},
}

code := Invoke(inv)
if code != 0 {
t.Fatalf("expected 0, but got %v", code)
}
expected := "Context is nil: false\nmg.ExtraArgs{\"-baz\", \"foo\", \"bar\"}\nstringvalue\n2\n"
if stdout.String() != expected {
t.Fatalf("expected %q, but got %q", expected, stdout.String())
}
}

func TestExtraArgsWithoutContextAndStringAndInt(t *testing.T) {
stdout := &bytes.Buffer{}
inv := Invocation{
Dir: "./testdata/extra_args",
Stderr: ioutil.Discard,
Stdout: stdout,
Args: []string{"targetFive", "stringvalue", "2"},
ExtraArgs: []string{"--", "-baz", "foo", "bar"},
}

code := Invoke(inv)
if code != 0 {
t.Fatalf("expected 0, but got %v", code)
}
expected := "mg.ExtraArgs{\"-baz\", \"foo\", \"bar\"}\nstringvalue\n2\n"
if stdout.String() != expected {
t.Fatalf("expected %q, but got %q", expected, stdout.String())
}
}

func TestExtraArgsWithoutContextAndStringAndIntNonOrdered(t *testing.T) {
stdout := &bytes.Buffer{}
inv := Invocation{
Dir: "./testdata/extra_args",
Stderr: ioutil.Discard,
Stdout: stdout,
Args: []string{"targetSix", "stringvalue", "2"},
ExtraArgs: []string{"--", "-baz", "foo", "bar"},
}

code := Invoke(inv)
if code != 0 {
t.Fatalf("expected 0, but got %v", code)
}
expected := "mg.ExtraArgs{\"-baz\", \"foo\", \"bar\"}\nstringvalue\n2\n"
if stdout.String() != expected {
t.Fatalf("expected %q, but got %q", expected, stdout.String())
}
}

// / This code liberally borrowed from https://github.com/rsc/goversion/blob/master/version/exe.go

type (
Expand Down
35 changes: 35 additions & 0 deletions mage/testdata/extra_args/extra.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package main

import (
"context"
"fmt"

"github.com/magefile/mage/mg"
Expand All @@ -12,3 +13,37 @@ import (
func TargetOne(extra mg.ExtraArgs) {
fmt.Printf("%#v\n", extra)
}

func TargetTwo(ctx context.Context, extra mg.ExtraArgs) {
fmt.Printf("Context is nil: %t\n", ctx == nil)
fmt.Printf("%#v\n", extra)
}

func TargetThree(ctx context.Context, extra mg.ExtraArgs, aString string) error {
fmt.Printf("Context is nil: %t\n", ctx == nil)
fmt.Printf("%#v\n", extra)
fmt.Printf("%s\n", aString)
return nil
}

func TargetFour(ctx context.Context, extra mg.ExtraArgs, aString string, anInt int) error {
fmt.Printf("Context is nil: %t\n", ctx == nil)
fmt.Printf("%#v\n", extra)
fmt.Printf("%s\n", aString)
fmt.Printf("%d\n", anInt)
return nil
}

func TargetFive(extra mg.ExtraArgs, aString string, anInt int) error {
fmt.Printf("%#v\n", extra)
fmt.Printf("%s\n", aString)
fmt.Printf("%d\n", anInt)
return nil
}

func TargetSix(aString string, anInt int, extra mg.ExtraArgs) error {
fmt.Printf("%#v\n", extra)
fmt.Printf("%s\n", aString)
fmt.Printf("%d\n", anInt)
return nil
}
3 changes: 1 addition & 2 deletions parse/parse.go
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,7 @@ func (f Function) ExecCode() string {
switch arg.Type {
case "mg.ExtraArgs":
parseargs += fmt.Sprintf(`
arg%d := args.ExtraArgs
x++`, x)
arg%d := args.ExtraArgs`, x) // do not advance x index, this is not part of .Args
case "string":
parseargs += fmt.Sprintf(`
arg%d := args.Args[x]
Expand Down

0 comments on commit 594383f

Please sign in to comment.