Add ReleaseKit version reporting
This commit is contained in:
@@ -2,9 +2,11 @@ package cli
|
||||
|
||||
import (
|
||||
"context"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"gitea.maximumdirect.net/eric/ReleaseKit/buildinfo"
|
||||
"gitea.maximumdirect.net/eric/audita/internal/core/schema"
|
||||
"gitea.maximumdirect.net/eric/audita/internal/framework/llm"
|
||||
)
|
||||
@@ -42,6 +44,9 @@ func Run(ctx context.Context, args []string, stdout, stderr io.Writer) int {
|
||||
case "config":
|
||||
writeConfigUsage(stdout)
|
||||
return 0
|
||||
case "version":
|
||||
writeVersionUsage(stdout)
|
||||
return 0
|
||||
}
|
||||
}
|
||||
|
||||
@@ -56,12 +61,47 @@ func Run(ctx context.Context, args []string, stdout, stderr io.Writer) int {
|
||||
if args[0] == "config" {
|
||||
return runConfig(ctx, args[1:], stdout, stderr)
|
||||
}
|
||||
if args[0] == "version" {
|
||||
return runVersion(args[1:], stdout, stderr)
|
||||
}
|
||||
|
||||
fmt.Fprintf(stderr, "audita: unknown command %q\n\n", args[0])
|
||||
writeRootUsage(stderr)
|
||||
return 2
|
||||
}
|
||||
|
||||
func runVersion(args []string, stdout, stderr io.Writer) int {
|
||||
if len(args) == 1 && (args[0] == "-h" || args[0] == "--help") {
|
||||
writeVersionUsage(stdout)
|
||||
return 0
|
||||
}
|
||||
for _, arg := range args {
|
||||
if arg == "-h" || arg == "--help" {
|
||||
fmt.Fprintln(stderr, "audita version: help flags cannot be combined with other arguments")
|
||||
fmt.Fprintln(stderr)
|
||||
writeVersionUsage(stderr)
|
||||
return 2
|
||||
}
|
||||
}
|
||||
flags := flag.NewFlagSet("version", flag.ContinueOnError)
|
||||
flags.SetOutput(stderr)
|
||||
flags.Usage = func() { writeVersionUsage(stderr) }
|
||||
if err := flags.Parse(args); err != nil {
|
||||
if err == flag.ErrHelp {
|
||||
writeVersionUsage(stdout)
|
||||
return 0
|
||||
}
|
||||
return 2
|
||||
}
|
||||
if positional := flags.Args(); len(positional) > 0 {
|
||||
fmt.Fprintf(stderr, "audita version: unexpected argument %q\n\n", positional[0])
|
||||
writeVersionUsage(stderr)
|
||||
return 2
|
||||
}
|
||||
fmt.Fprintf(stdout, "audita %s\n", buildinfo.Version())
|
||||
return 0
|
||||
}
|
||||
|
||||
func runConfig(ctx context.Context, args []string, stdout, stderr io.Writer) int {
|
||||
if len(args) == 0 || isHelpCommand(args) || args[0] == "--help" || args[0] == "-h" {
|
||||
writeConfigUsage(stdout)
|
||||
@@ -177,11 +217,19 @@ func writeRootUsage(w io.Writer) {
|
||||
fmt.Fprintln(w, "Commands:")
|
||||
fmt.Fprintln(w, " process Process a transcript JSON file")
|
||||
fmt.Fprintln(w, " config Validate and inspect config")
|
||||
fmt.Fprintln(w, " version Print the Audita version")
|
||||
fmt.Fprintln(w)
|
||||
fmt.Fprintln(w, "Example:")
|
||||
fmt.Fprintln(w, " audita process transcript.json --glossary glossary.yaml --output corrected.json")
|
||||
}
|
||||
|
||||
func writeVersionUsage(w io.Writer) {
|
||||
fmt.Fprintln(w, "Print the Audita version.")
|
||||
fmt.Fprintln(w)
|
||||
fmt.Fprintln(w, "Usage:")
|
||||
fmt.Fprintln(w, " audita version")
|
||||
}
|
||||
|
||||
func writeConfigUsage(w io.Writer) {
|
||||
fmt.Fprintln(w, "Validate and inspect Audita config.")
|
||||
fmt.Fprintln(w)
|
||||
|
||||
72
internal/cli/version_test.go
Normal file
72
internal/cli/version_test.go
Normal file
@@ -0,0 +1,72 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"gitea.maximumdirect.net/eric/ReleaseKit/buildinfo"
|
||||
)
|
||||
|
||||
func TestVersionCommandRunsWithoutApplicationSetup(t *testing.T) {
|
||||
t.Chdir(t.TempDir())
|
||||
var stdout, stderr bytes.Buffer
|
||||
if code := Run(context.Background(), []string{"version"}, &stdout, &stderr); code != 0 {
|
||||
t.Fatalf("exit=%d, stdout=%q, stderr=%q", code, stdout.String(), stderr.String())
|
||||
}
|
||||
if got, want := stdout.String(), fmt.Sprintf("audita %s\n", buildinfo.Version()); got != want {
|
||||
t.Fatalf("stdout=%q, want %q", got, want)
|
||||
}
|
||||
if got := stderr.String(); got != "" {
|
||||
t.Fatalf("stderr=%q, want empty", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestVersionCommandHelp(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
name string
|
||||
args []string
|
||||
want string
|
||||
}{
|
||||
{name: "root help", args: []string{"--help"}, want: "version Print the Audita version"},
|
||||
{name: "help version", args: []string{"help", "version"}, want: "audita version"},
|
||||
{name: "short flag", args: []string{"version", "-h"}, want: "audita version"},
|
||||
{name: "long flag", args: []string{"version", "--help"}, want: "audita version"},
|
||||
} {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
var stdout, stderr bytes.Buffer
|
||||
if code := Run(context.Background(), test.args, &stdout, &stderr); code != 0 {
|
||||
t.Fatalf("exit=%d, stdout=%q, stderr=%q", code, stdout.String(), stderr.String())
|
||||
}
|
||||
if !strings.Contains(stdout.String(), test.want) {
|
||||
t.Fatalf("stdout=%q, want %q", stdout.String(), test.want)
|
||||
}
|
||||
if got := stderr.String(); got != "" {
|
||||
t.Fatalf("stderr=%q, want empty", got)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestVersionCommandRejectsUnexpectedArguments(t *testing.T) {
|
||||
for _, args := range [][]string{
|
||||
{"version", "extra"},
|
||||
{"version", "--unknown"},
|
||||
{"version", "--help", "extra"},
|
||||
} {
|
||||
t.Run(strings.Join(args, " "), func(t *testing.T) {
|
||||
var stdout, stderr bytes.Buffer
|
||||
if code := Run(context.Background(), args, &stdout, &stderr); code != 2 {
|
||||
t.Fatalf("exit=%d, stdout=%q, stderr=%q", code, stdout.String(), stderr.String())
|
||||
}
|
||||
if got := stdout.String(); got != "" {
|
||||
t.Fatalf("stdout=%q, want empty", got)
|
||||
}
|
||||
if got := stderr.String(); got == "" {
|
||||
t.Fatal("expected usage error on stderr")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user