emit an error and exit if the ginkgo invocation includes flags after positional arguments

Author: onsi

ginkgo/command/command.go

@@ -24,7 +24,11 @@ func (c Command) Run(args []string, additionalArgs []string) {
 	if err != nil {
 		AbortWithUsage(err.Error())
 	}
-
+	for _, arg := range args {
+		if strings.HasPrefix(arg, "-") {
+			AbortWith("Malformed arguments - make sure all flags appear {{bold}}after{{/}} the Ginkgo subcommand and {{bold}}before{{/}} your list of packages.\n{{gray}}e.g. 'ginkgo run -p my_package' is valid `ginkgo -p run my_package` is not.{{/}}")
+		}
+	}
 	c.Command(args, additionalArgs)
 }
 

ginkgo/command/command_test.go

@@ -21,8 +21,12 @@ var _ = Describe("Command", func() {
 		fs, err := types.NewGinkgoFlagSet(
 			types.GinkgoFlags{
 				{Name: "contrabulaturally", KeyPath: "C", Usage: "with irridiacy"},
+				{Name: "fillabluster", KeyPath: "F", Usage: "with grace"},
 			},
-			&(struct{ C int }{C: 17}),
+			&(struct {
+				C int
+				F int
+			}{C: 17, F: 12}),
 			types.GinkgoFlagSections{},
 		)
 		Ω(err).ShouldNot(HaveOccurred())
@@ -41,7 +45,7 @@ var _ = Describe("Command", func() {
 		Context("when flags fails to parse", func() {
 			It("aborts with usage", func() {
 				Ω(func() {
-					c.Run([]string{"-not-a-flag=oops"}, []string{"additional", "args"})
+					c.Run([]string{"-not-a-flag=oops"}, []string{"additional", "-args"})
 				}).Should(PanicWith(SatisfyAll(
 					HaveField("ExitCode", 1),
 					HaveField("Error", HaveOccurred()),
@@ -54,14 +58,29 @@ var _ = Describe("Command", func() {
 
 		Context("when flags parse", func() {
 			It("runs the command", func() {
-				c.Run([]string{"-contrabulaturally=16", "and-an-arg", "and-another"}, []string{"additional", "args"})
+				c.Run([]string{"-contrabulaturally=16", "and-an-arg", "and-another"}, []string{"additional", "-args"})
 				Ω(rt).Should(HaveRun("enflabulate"))
 
 				Ω(rt.DataFor("enflabulate")["Args"]).Should(Equal([]string{"and-an-arg", "and-another"}))
-				Ω(rt.DataFor("enflabulate")["AdditionalArgs"]).Should(Equal([]string{"additional", "args"}))
+				Ω(rt.DataFor("enflabulate")["AdditionalArgs"]).Should(Equal([]string{"additional", "-args"}))
 
 			})
 		})
+
+		Context("when flags appear after named arguments", func() {
+			It("fails", func() {
+				Ω(func() {
+					c.Run([]string{"-contrabulaturally=16", "an-arg", "another-arg", "-fillabuster=10"}, []string{"additional", "-args"})
+				}).Should(PanicWith(SatisfyAll(
+					HaveField("ExitCode", 1),
+					HaveField("Error", HaveOccurred()),
+					HaveField("EmitUsage", BeFalse()),
+				)))
+
+				Ω(rt).Should(HaveTrackedNothing())
+			})
+		})
+
 	})
 
 	Describe("Usage", func() {
@@ -85,6 +104,8 @@ var _ = Describe("Command", func() {
 				"",
 				"  --contrabulaturally{{/}} [int] {{gray}}{{/}}",
 				"    {{light-gray}}with irridiacy{{/}}",
+				"  --fillabluster{{/}} [int] {{gray}}{{/}}",
+				"    {{light-gray}}with grace{{/}}",
 				"", "",
 			}, "\n")
 

ginkgo/command/program_test.go

@@ -117,11 +117,11 @@ var _ = Describe("Program", func() {
 
 	Context("when passed arguments and additional arguments", func() {
 		BeforeEach(func() {
-			program.RunAndExit([]string{"omicron", "gamma", "arg1", "-arg2", "--", "addArg1", "addArg2"})
+			program.RunAndExit([]string{"omicron", "gamma", "arg1", "arg2", "--", "addArg1", "addArg2"})
 		})
 		It("passes both in", func() {
 			Ω(rt).Should(HaveTracked("gamma", "exit"))
-			Ω(rt).Should(HaveRunWithData("gamma", "Args", []string{"arg1", "-arg2"}, "AdditionalArgs", []string{"addArg1", "addArg2"}))
+			Ω(rt).Should(HaveRunWithData("gamma", "Args", []string{"arg1", "arg2"}, "AdditionalArgs", []string{"addArg1", "addArg2"}))
 			Ω(rt).Should(HaveRunWithData("exit", "Code", 0))
 			Ω(buf.Contents()).Should(BeEmpty())
 		})