test: make cmd testable

This commit is contained in:
Li Jie
2025-01-14 10:50:43 +08:00
parent 25a3e19384
commit 8749923f1a
9 changed files with 186 additions and 249 deletions

1
.github/codecov.yml vendored
View File

@@ -1,4 +1,3 @@
coverage: coverage:
ignore: ignore:
- "compiler/chore" - "compiler/chore"
- "compiler/cmd"

View File

@@ -23,6 +23,7 @@ import (
"github.com/goplus/llgo/compiler/cmd/internal/base" "github.com/goplus/llgo/compiler/cmd/internal/base"
"github.com/goplus/llgo/compiler/internal/build" "github.com/goplus/llgo/compiler/internal/build"
"github.com/goplus/llgo/compiler/internal/mockable"
) )
// llgo build // llgo build
@@ -47,6 +48,6 @@ func runCmd(cmd *base.Command, args []string) {
_, err := build.Do(args, conf) _, err := build.Do(args, conf)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, err) fmt.Fprintln(os.Stderr, err)
os.Exit(1) mockable.Exit(1)
} }
} }

View File

@@ -29,6 +29,7 @@ import (
"unicode/utf8" "unicode/utf8"
"github.com/goplus/llgo/compiler/cmd/internal/base" "github.com/goplus/llgo/compiler/cmd/internal/base"
"github.com/goplus/llgo/compiler/internal/mockable"
) )
// Help implements the 'help' command. // Help implements the 'help' command.
@@ -49,7 +50,7 @@ Args:
helpSuccess += " " + strings.Join(args[:i], " ") helpSuccess += " " + strings.Join(args[:i], " ")
} }
fmt.Fprintf(os.Stderr, "llgo help %s: unknown help topic. Run '%s'.\n", strings.Join(args, " "), helpSuccess) fmt.Fprintf(os.Stderr, "llgo help %s: unknown help topic. Run '%s'.\n", strings.Join(args, " "), helpSuccess)
os.Exit(2) mockable.Exit(2)
} }
if len(cmd.Commands) > 0 { if len(cmd.Commands) > 0 {
@@ -98,7 +99,7 @@ func tmpl(w io.Writer, text string, data interface{}) {
if ew.err != nil { if ew.err != nil {
// I/O error writing. Ignore write on closed pipe. // I/O error writing. Ignore write on closed pipe.
if strings.Contains(ew.err.Error(), "pipe") { if strings.Contains(ew.err.Error(), "pipe") {
os.Exit(1) mockable.Exit(1)
} }
log.Fatalf("writing output: %v", ew.err) log.Fatalf("writing output: %v", ew.err)
} }

View File

@@ -23,6 +23,7 @@ import (
"github.com/goplus/llgo/compiler/cmd/internal/base" "github.com/goplus/llgo/compiler/cmd/internal/base"
"github.com/goplus/llgo/compiler/internal/build" "github.com/goplus/llgo/compiler/internal/build"
"github.com/goplus/llgo/compiler/internal/mockable"
) )
// llgo install // llgo install
@@ -40,6 +41,6 @@ func runCmd(cmd *base.Command, args []string) {
_, err := build.Do(args, conf) _, err := build.Do(args, conf)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, err) fmt.Fprintln(os.Stderr, err)
os.Exit(1) mockable.Exit(1)
} }
} }

View File

@@ -25,6 +25,7 @@ import (
"github.com/goplus/llgo/compiler/cmd/internal/base" "github.com/goplus/llgo/compiler/cmd/internal/base"
"github.com/goplus/llgo/compiler/internal/build" "github.com/goplus/llgo/compiler/internal/build"
"github.com/goplus/llgo/compiler/internal/mockable"
) )
var ( var (
@@ -68,7 +69,7 @@ func runCmdEx(_ *base.Command, args []string, mode build.Mode) {
_, err = build.Do(args, conf) _, err = build.Do(args, conf)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, err) fmt.Fprintln(os.Stderr, err)
os.Exit(1) mockable.Exit(1)
} }
} }

View File

@@ -32,6 +32,7 @@ import (
"github.com/goplus/llgo/compiler/cmd/internal/install" "github.com/goplus/llgo/compiler/cmd/internal/install"
"github.com/goplus/llgo/compiler/cmd/internal/run" "github.com/goplus/llgo/compiler/cmd/internal/run"
"github.com/goplus/llgo/compiler/cmd/internal/version" "github.com/goplus/llgo/compiler/cmd/internal/version"
"github.com/goplus/llgo/compiler/internal/mockable"
) )
func mainUsage() { func mainUsage() {
@@ -77,7 +78,7 @@ BigCmdLoop:
bigCmd = cmd bigCmd = cmd
if len(args) == 0 { if len(args) == 0 {
help.PrintUsage(os.Stderr, bigCmd) help.PrintUsage(os.Stderr, bigCmd)
os.Exit(2) mockable.Exit(2)
} }
if args[0] == "help" { if args[0] == "help" {
help.Help(os.Stderr, append(strings.Split(base.CmdName, " "), args[1:]...)) help.Help(os.Stderr, append(strings.Split(base.CmdName, " "), args[1:]...))
@@ -97,6 +98,6 @@ BigCmdLoop:
helpArg = " " + base.CmdName[:i] helpArg = " " + base.CmdName[:i]
} }
fmt.Fprintf(os.Stderr, "llgo %s: unknown command\nRun 'llgo help%s' for usage.\n", base.CmdName, helpArg) fmt.Fprintf(os.Stderr, "llgo %s: unknown command\nRun 'llgo help%s' for usage.\n", base.CmdName, helpArg)
os.Exit(2) mockable.Exit(2)
} }
} }

View File

@@ -1,22 +1,62 @@
package main package main
import ( import (
"bytes"
"flag"
"io"
"os" "os"
"path/filepath" "path/filepath"
"strings" "strings"
"testing" "testing"
"github.com/goplus/llgo/compiler/cmd/internal/base" "github.com/goplus/llgo/compiler/internal/mockable"
"github.com/goplus/llgo/compiler/cmd/internal/build"
"github.com/goplus/llgo/compiler/cmd/internal/help"
"github.com/goplus/llgo/compiler/cmd/internal/install"
"github.com/goplus/llgo/compiler/cmd/internal/run"
"github.com/goplus/llgo/compiler/cmd/internal/version"
) )
var origWd string
func init() {
var err error
origWd, err = os.Getwd()
if err != nil {
panic(err)
}
}
type testContext struct {
origLLGORoot string
tmpDir string
}
func setupTest(t *testing.T) *testContext {
ctx := &testContext{}
// Save original state
ctx.origLLGORoot = os.Getenv("LLGO_ROOT")
// Create temporary LLGO_ROOT
tmpDir, err := os.MkdirTemp("", "llgo-root-*")
if err != nil {
t.Fatalf("Failed to create temp dir: %v", err)
}
ctx.tmpDir = tmpDir
// Set LLGO_ROOT
llgoRoot := filepath.Join(origWd, "../../..")
if err := os.Setenv("LLGO_ROOT", llgoRoot); err != nil {
os.RemoveAll(tmpDir)
t.Fatalf("Failed to set LLGO_ROOT: %v", err)
}
t.Logf("LLGO_ROOT set to: %s", llgoRoot)
mockable.EnableMock()
return ctx
}
func teardownTest(ctx *testContext) {
os.Chdir(origWd)
os.Setenv("LLGO_ROOT", ctx.origLLGORoot)
if ctx.tmpDir != "" {
os.RemoveAll(ctx.tmpDir)
}
}
func setupTestProject(t *testing.T) string { func setupTestProject(t *testing.T) string {
// Create a temporary directory for the test project // Create a temporary directory for the test project
tmpDir, err := os.MkdirTemp("", "llgo-test-*") tmpDir, err := os.MkdirTemp("", "llgo-test-*")
@@ -58,12 +98,8 @@ func TestProjectCommands(t *testing.T) {
tmpDir := setupTestProject(t) tmpDir := setupTestProject(t)
defer os.RemoveAll(tmpDir) defer os.RemoveAll(tmpDir)
// Save original working directory and environment ctx := setupTest(t)
origWd, err := os.Getwd() defer teardownTest(ctx)
if err != nil {
t.Fatalf("Failed to get current directory: %v", err)
}
defer os.Chdir(origWd)
// Change to test project directory // Change to test project directory
if err := os.Chdir(tmpDir); err != nil { if err := os.Chdir(tmpDir); err != nil {
@@ -72,150 +108,53 @@ func TestProjectCommands(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
cmd *base.Command
args []string args []string
wantErr bool wantErr bool
}{ }{
{ {
name: "build command", name: "build command",
cmd: build.Cmd, args: []string{"llgo", "build", "."},
args: []string{"."},
wantErr: false, wantErr: false,
}, },
{ {
name: "install command", name: "install command",
cmd: install.Cmd, args: []string{"llgo", "install", "."},
args: []string{"."},
wantErr: false, wantErr: false,
}, },
{ {
name: "run command", name: "run command",
cmd: run.Cmd, args: []string{"llgo", "run", "."},
args: []string{"main.go"}, wantErr: false,
},
{
name: "run command",
args: []string{"llgo", "run", "main.go"},
wantErr: false, wantErr: false,
}, },
} }
// Save original args and flags
oldArgs := os.Args
oldFlagCommandLine := flag.CommandLine
oldStdout := os.Stdout
oldStderr := os.Stderr
defer func() {
os.Args = oldArgs
flag.CommandLine = oldFlagCommandLine
os.Stdout = oldStdout
os.Stderr = oldStderr
}()
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
// Reset flag.CommandLine for each test
flag.CommandLine = flag.NewFlagSet("llgo", flag.ContinueOnError)
// Setup command arguments
args := append([]string{"llgo", tt.cmd.Name()}, tt.args...)
os.Args = args
// Capture output
outR, outW, err := os.Pipe()
if err != nil {
t.Fatalf("Failed to create stdout pipe: %v", err)
}
errR, errW, err := os.Pipe()
if err != nil {
t.Fatalf("Failed to create stderr pipe: %v", err)
}
os.Stdout = outW
os.Stderr = errW
// Run command
done := make(chan struct{})
var outBuf, errBuf bytes.Buffer
go func() {
_, _ = io.Copy(&outBuf, outR)
done <- struct{}{}
}()
go func() {
_, _ = io.Copy(&errBuf, errR)
done <- struct{}{}
}()
panicked := false
func() {
defer func() { defer func() {
if r := recover(); r != nil { if r := recover(); r != nil {
panicked = true if r != "exit" {
t.Logf("%s: Command panicked: %v", tt.name, r) t.Errorf("unexpected panic: %v", r)
}
exitCode := mockable.ExitCode()
if (exitCode != 0) != tt.wantErr {
t.Errorf("got exit code %d, wantErr %v", exitCode, tt.wantErr)
}
} }
outW.Close()
errW.Close()
}() }()
flag.Parse() os.Args = tt.args
base.CmdName = tt.cmd.Name() main()
if !tt.cmd.Runnable() {
t.Fatalf("%s: Command is not runnable", tt.name)
}
// Print current working directory and files for debugging
if cwd, err := os.Getwd(); err == nil {
t.Logf("%s: Current working directory: %s", tt.name, cwd)
if files, err := os.ReadDir("."); err == nil {
t.Log("Files in current directory:")
for _, f := range files {
t.Logf(" %s", f.Name())
}
}
}
// Run the command
tt.cmd.Run(tt.cmd, tt.args)
}()
<-done
<-done
// Check output
outStr := outBuf.String()
errStr := errBuf.String()
if outStr == "" && errStr == "" && !panicked {
t.Logf("%s: Command completed with no output", tt.name)
} else {
if outStr != "" {
t.Logf("%s stdout:\n%s", tt.name, outStr)
}
if errStr != "" {
t.Logf("%s stderr:\n%s", tt.name, errStr)
}
}
// Check if the command succeeded
if !tt.wantErr {
// For build/install commands, check if binary was created // For build/install commands, check if binary was created
if tt.cmd == build.Cmd || tt.cmd == install.Cmd { if strings.HasPrefix(tt.name, "build") || strings.HasPrefix(tt.name, "install") {
binName := "testproject" binName := "testproject"
if _, err := os.Stat(binName); os.IsNotExist(err) { if _, err := os.Stat(binName); os.IsNotExist(err) {
t.Logf("%s: Binary %s was not created", tt.name, binName) t.Errorf("Binary %s was not created", binName)
}
}
// For run command, check if output contains expected string
if tt.cmd == run.Cmd {
if !strings.Contains(outStr, "Hello, LLGO!") {
t.Logf("%s: Expected output to contain 'Hello, LLGO!', got:\n%s", tt.name, outStr)
}
}
// Check for common error indicators, but don't fail the test
if strings.Contains(errStr, "error:") || strings.Contains(errStr, "failed") {
// Ignore LLVM reexported library warning
if !strings.Contains(errStr, "ld: warning: reexported library") {
t.Logf("%s: Command produced error output:\n%s", tt.name, errStr)
}
} }
} }
}) })
@@ -223,119 +162,93 @@ func TestProjectCommands(t *testing.T) {
} }
func TestCommandHandling(t *testing.T) { func TestCommandHandling(t *testing.T) {
// Save original args and flags ctx := setupTest(t)
oldArgs := os.Args defer teardownTest(ctx)
oldFlagCommandLine := flag.CommandLine
defer func() {
os.Args = oldArgs
flag.CommandLine = oldFlagCommandLine
}()
tests := []struct { tests := []struct {
name string name string
args []string args []string
wantErr bool wantErr bool
commands []*base.Command
}{ }{
{ {
name: "version command", name: "version command",
args: []string{"llgo", "version"}, args: []string{"llgo", "version"},
wantErr: false, wantErr: false,
commands: []*base.Command{
version.Cmd,
},
},
{
name: "build command",
args: []string{"llgo", "build"},
wantErr: false,
commands: []*base.Command{
build.Cmd,
},
},
{
name: "unknown command",
args: []string{"llgo", "unknowncommand"},
wantErr: true,
}, },
{ {
name: "help command", name: "help command",
args: []string{"llgo", "help"}, args: []string{"llgo", "help"},
wantErr: false, wantErr: false,
}, },
{
name: "invalid command",
args: []string{"llgo", "invalid"},
wantErr: true,
},
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
// Reset flag.CommandLine for each test
flag.CommandLine = flag.NewFlagSet(tt.args[0], flag.ExitOnError)
os.Args = tt.args
if tt.commands != nil {
base.Llgo.Commands = tt.commands
}
// Capture panic that would normally exit
defer func() { defer func() {
if r := recover(); r != nil { if r := recover(); r != nil {
if !tt.wantErr { if r != "exit" {
t.Errorf("unexpected panic: %v", r) t.Errorf("unexpected panic: %v", r)
} }
exitCode := mockable.ExitCode()
if (exitCode != 0) != tt.wantErr {
t.Errorf("got exit code %d, wantErr %v", exitCode, tt.wantErr)
}
} }
}() }()
flag.Parse() os.Args = tt.args
if len(tt.args) > 1 { main()
base.CmdName = tt.args[1]
}
}) })
} }
} }
func TestHelpCommand(t *testing.T) { func TestHelpCommand(t *testing.T) {
oldArgs := os.Args ctx := setupTest(t)
oldFlagCommandLine := flag.CommandLine defer teardownTest(ctx)
defer func() {
os.Args = oldArgs
flag.CommandLine = oldFlagCommandLine
}()
tests := []struct { tests := []struct {
name string name string
args []string args []string
wantErr bool
}{ }{
{ {
name: "help without subcommand", name: "help build",
args: []string{"llgo", "help"}, args: []string{"llgo", "help", "build"},
wantErr: false,
}, },
{ {
name: "help with subcommand", name: "help install",
args: []string{"llgo", "help", "build"}, args: []string{"llgo", "help", "install"},
wantErr: false, },
{
name: "help run",
args: []string{"llgo", "help", "run"},
},
{
name: "help version",
args: []string{"llgo", "help", "version"},
}, },
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
flag.CommandLine = flag.NewFlagSet(tt.args[0], flag.ExitOnError)
os.Args = tt.args
var buf bytes.Buffer
defer func() { defer func() {
if r := recover(); r != nil { if r := recover(); r != nil {
if !tt.wantErr { if r != "exit" {
t.Errorf("unexpected panic: %v", r) t.Errorf("unexpected panic: %v", r)
} }
exitCode := mockable.ExitCode()
if exitCode != 0 {
t.Errorf("got exit code %d, want 0", exitCode)
}
} }
}() }()
flag.Parse() os.Args = tt.args
args := flag.Args() main()
if len(args) > 0 && args[0] == "help" {
help.Help(&buf, args[1:])
}
}) })
} }
} }

View File

@@ -38,6 +38,7 @@ import (
"github.com/goplus/llgo/compiler/cl" "github.com/goplus/llgo/compiler/cl"
"github.com/goplus/llgo/compiler/internal/env" "github.com/goplus/llgo/compiler/internal/env"
"github.com/goplus/llgo/compiler/internal/mockable"
"github.com/goplus/llgo/compiler/internal/packages" "github.com/goplus/llgo/compiler/internal/packages"
"github.com/goplus/llgo/compiler/internal/typepatch" "github.com/goplus/llgo/compiler/internal/typepatch"
"github.com/goplus/llgo/compiler/ssa/abi" "github.com/goplus/llgo/compiler/ssa/abi"
@@ -221,15 +222,11 @@ func Do(args []string, conf *Config) ([]Package, error) {
} }
if mode != ModeBuild { if mode != ModeBuild {
nErr := 0
for _, pkg := range initial { for _, pkg := range initial {
if pkg.Name == "main" { if pkg.Name == "main" {
nErr += linkMainPkg(ctx, pkg, pkgs, linkArgs, conf, mode, verbose) linkMainPkg(ctx, pkg, pkgs, linkArgs, conf, mode, verbose)
} }
} }
if nErr > 0 {
os.Exit(nErr)
}
} }
return dpkg, nil return dpkg, nil
} }
@@ -290,7 +287,7 @@ func buildAllPkgs(ctx *context, initial []*packages.Package, verbose bool) (pkgs
fmt.Fprintln(os.Stderr, "cannot build SSA for package", errPkg) fmt.Fprintln(os.Stderr, "cannot build SSA for package", errPkg)
} }
if len(errPkgs) > 0 { if len(errPkgs) > 0 {
os.Exit(1) mockable.Exit(1)
} }
built := ctx.built built := ctx.built
for _, aPkg := range pkgs { for _, aPkg := range pkgs {
@@ -372,7 +369,7 @@ func buildAllPkgs(ctx *context, initial []*packages.Package, verbose bool) (pkgs
return return
} }
func linkMainPkg(ctx *context, pkg *packages.Package, pkgs []*aPackage, linkArgs []string, conf *Config, mode Mode, verbose bool) (nErr int) { func linkMainPkg(ctx *context, pkg *packages.Package, pkgs []*aPackage, linkArgs []string, conf *Config, mode Mode, verbose bool) {
pkgPath := pkg.PkgPath pkgPath := pkg.PkgPath
name := path.Base(pkgPath) name := path.Base(pkgPath)
app := conf.OutFile app := conf.OutFile
@@ -458,11 +455,6 @@ func linkMainPkg(ctx *context, pkg *packages.Package, pkgs []*aPackage, linkArgs
if verbose || mode != ModeRun { if verbose || mode != ModeRun {
fmt.Fprintln(os.Stderr, "#", pkgPath) fmt.Fprintln(os.Stderr, "#", pkgPath)
} }
defer func() {
if e := recover(); e != nil {
nErr = 1
}
}()
// add rpath and find libs // add rpath and find libs
exargs := make([]string, 0, ctx.nLibdir<<1) exargs := make([]string, 0, ctx.nLibdir<<1)
@@ -506,12 +498,11 @@ func linkMainPkg(ctx *context, pkg *packages.Package, pkgs []*aPackage, linkArgs
cmd.Stderr = os.Stderr cmd.Stderr = os.Stderr
cmd.Run() cmd.Run()
if s := cmd.ProcessState; s != nil { if s := cmd.ProcessState; s != nil {
os.Exit(s.ExitCode()) mockable.Exit(s.ExitCode())
} }
case ModeCmpTest: case ModeCmpTest:
cmpTest(filepath.Dir(pkg.GoFiles[0]), pkgPath, app, conf.GenExpect, conf.RunArgs) cmpTest(filepath.Dir(pkg.GoFiles[0]), pkgPath, app, conf.GenExpect, conf.RunArgs)
} }
return
} }
func buildPkg(ctx *context, aPkg *aPackage, verbose bool) (cgoLdflags []string, err error) { func buildPkg(ctx *context, aPkg *aPackage, verbose bool) (cgoLdflags []string, err error) {

View File

@@ -0,0 +1,29 @@
package mockable
import (
"os"
)
var (
exitFunc = os.Exit
exitCode int
)
// EnableMock enables mocking of os.Exit
func EnableMock() {
exitCode = 0
exitFunc = func(code int) {
exitCode = code
panic("exit")
}
}
// Exit calls the current exit function
func Exit(code int) {
exitFunc(code)
}
// ExitCode returns the last exit code from a mocked Exit call
func ExitCode() int {
return exitCode
}