Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Add a finding fingerprint to `.envguard-ignore` in the repository root.

### `envguard version`

Print the build version injected at compile time.
Print the resolved build or module version.

## Allowlist Workflow

Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
var version = "dev"

func main() {
if err := cmd.Execute(version); err != nil {
if err := cmd.Execute(resolveVersion(version)); err != nil {
if !errors.Is(err, cmd.ErrFindings) {
fmt.Fprintln(os.Stderr, err)
}
Expand Down
21 changes: 21 additions & 0 deletions version.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package main

import "runtime/debug"

var readBuildInfo = debug.ReadBuildInfo

// resolveVersion prefers an injected build version, then falls back to module build info.
func resolveVersion(injected string) string {
if injected != "" && injected != "dev" {
return injected
}

info, ok := readBuildInfo()
if !ok {
return injected
}
if info.Main.Version == "" || info.Main.Version == "(devel)" {
return injected
}
return info.Main.Version
}
40 changes: 40 additions & 0 deletions version_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package main

import (
"runtime/debug"
"testing"
)

func TestResolveVersionPrefersInjectedVersion(t *testing.T) {
t.Parallel()

if got := resolveVersion("v1.2.3"); got != "v1.2.3" {
t.Fatalf("resolveVersion() = %q, want %q", got, "v1.2.3")
}
}

func TestResolveVersionFallsBackToInjectedDevWhenNoBuildInfoVersion(t *testing.T) {
t.Parallel()

if got := resolveVersion("dev"); got != "dev" {
t.Fatalf("resolveVersion() = %q, want %q", got, "dev")
}
}

func TestResolveVersionFallsBackToBuildInfoVersion(t *testing.T) {
original := readBuildInfo
readBuildInfo = func() (*debug.BuildInfo, bool) {
return &debug.BuildInfo{
Main: debug.Module{
Version: "v0.1.1",
},
}, true
}
t.Cleanup(func() {
readBuildInfo = original
})

if got := resolveVersion("dev"); got != "v0.1.1" {
t.Fatalf("resolveVersion() = %q, want %q", got, "v0.1.1")
}
}
Loading