lib: Remove TODO comment regarding -metadata flag.
The intended usage of the -metadata flag is that whenever it is
set on the command-line, the program will dump metadata to stdout
and gracefully terminate.
Originally I had planned to implement this by making the Set
method return a metadata.ErrFlag error. This way the caller of
FlagSet.Parse could check the error against metadata.ErrFlag, and
do whatever they liked.
However there was a bug in the flag package that ignored errors
returned by Set for boolean flags. That's been fixed:
https://github.com/golang/go/commit/bc611a31a5b3003ba6c05d337093f9b83e898209
But there's still a catch. The flag package wraps the errors
returned by Set with its own error. That means the caller of
FlagSet.Parse cannot distinguish the error based on its type or
value.
So I'm giving up and getting rid of the TODO. Calling os.Exit(0)
is ugly, but is fine for all practical purposes.
Change-Id: Id04d3b3d6564327156f9e6c5dbd9301598c161a7
diff --git a/metadata/metadata.go b/metadata/metadata.go
index f345ac0..8ebd53c 100644
--- a/metadata/metadata.go
+++ b/metadata/metadata.go
@@ -320,8 +320,5 @@
func (metadataFlag) Set(string) error {
fmt.Println(BuiltIn.String())
os.Exit(0)
- // TODO(toddw): change os.Exit(0) to return ErrFlag instead. This needs to
- // wait on a bugfix where the standard Go flag package doesn't check the error
- // returned from Set for boolean flags.
return nil
}
diff --git a/metadata/metadata_test.go b/metadata/metadata_test.go
index 4919157..a75b661 100644
--- a/metadata/metadata_test.go
+++ b/metadata/metadata_test.go
@@ -240,9 +240,9 @@
const id, value = "zzzTestID", "abcdefg"
x := FromMap(map[string]string{id: value})
cmdRun := exec.Command("go", "run", "-ldflags="+LDFlag(x), "./testdata/testbin.go", "-metadata")
- outXML, err := cmdRun.Output()
+ outXML, err := cmdRun.CombinedOutput()
if err != nil {
- t.Errorf("%v failed: %v\n%v", cmdRun.Args, err, outXML)
+ t.Errorf("%v failed: %v\n%s", cmdRun.Args, err, outXML)
}
wantXML := `<metadata>
<md id="go.Arch">` + runtime.GOARCH + `</md>
