Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c46903e3d2 | ||
|
|
f5c14dff90 | ||
|
|
b602e17622 | ||
|
|
f51680f83c | ||
|
|
03e791cbcd | ||
|
|
2b8f06ea6d | ||
|
|
7afcecd053 |
No files matched your search
+1
-1
@@ -22,7 +22,7 @@ builds:
|
|||||||
flags:
|
flags:
|
||||||
- -trimpath
|
- -trimpath
|
||||||
ldflags:
|
ldflags:
|
||||||
- -s -w -X main.version={{ .Version }}
|
- -s -w -X main.version={{ .Version }} -X main.commit={{ .ShortCommit }} -X main.branch={{ .Branch }}
|
||||||
goos:
|
goos:
|
||||||
- linux
|
- linux
|
||||||
- darwin
|
- darwin
|
||||||
|
|||||||
@@ -2,13 +2,14 @@
|
|||||||
|
|
||||||
```
|
```
|
||||||
gosh - Go Shell
|
gosh - Go Shell
|
||||||
|
Version: 0.2.1 (branch: main, commit: 03e791c)
|
||||||
|
|
||||||
Built-in commands:
|
Built-in commands:
|
||||||
cd [dir] - Change directory (cd with no args goes to home)
|
cd [dir] - Change directory (cd with no args goes to home)
|
||||||
pwd - Print working directory
|
pwd - Print working directory
|
||||||
echo [args] - Echo arguments
|
echo [args] - Echo arguments
|
||||||
exit [code] - Exit shell with optional status code
|
exit [code] - Exit shell with status code (default: $?)
|
||||||
quit [code] - Quit shell with optional status code
|
quit [code] - Quit shell with status code (default: $?)
|
||||||
set VAR=val - Set environment variable
|
set VAR=val - Set environment variable
|
||||||
export VAR=val - Export environment variable
|
export VAR=val - Export environment variable
|
||||||
help - Show this help
|
help - Show this help
|
||||||
@@ -22,11 +23,146 @@ Features:
|
|||||||
override with $GOSH_HISTFILE); lines starting with a space are not saved
|
override with $GOSH_HISTFILE); lines starting with a space are not saved
|
||||||
- Tab completion for commands and file paths
|
- Tab completion for commands and file paths
|
||||||
- Tilde expansion (~, ~/path) at the start of unquoted words
|
- Tilde expansion (~, ~/path) at the start of unquoted words
|
||||||
|
- Colored prompt (user@host green, red for root; directory blue),
|
||||||
|
configurable with $GOSH_COLORS, e.g. GOSH_COLORS='user=1;33:path=36'
|
||||||
|
(keys user, root, path; values are ANSI SGR codes, empty = no color);
|
||||||
|
disabled with $NO_COLOR, TERM=dumb or when output is not a terminal
|
||||||
- Environment variable expansion ($VAR, ${VAR}, ${VAR:-default});
|
- Environment variable expansion ($VAR, ${VAR}, ${VAR:-default});
|
||||||
using an unset variable is an error, use ${VAR:-} for an empty default
|
using an unset variable is an error, use ${VAR:-} for an empty default
|
||||||
|
- Command lists: a ; b (run both), a && b (b only if a succeeded),
|
||||||
|
a || b (b only if a failed); $? is the exit status of the last command
|
||||||
|
- Pipes (a | b) and redirections: < file, > file, >> file, 2> file,
|
||||||
|
2>> file, 2>&1, >&2, &> file (stdout and stderr), &>> file
|
||||||
|
- Non-interactive use: gosh -c 'command', gosh script, command | gosh;
|
||||||
|
the exit status is the one of the last command
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Aufruf
|
||||||
|
|
||||||
|
```
|
||||||
|
gosh [-l] [-i] [script]
|
||||||
|
gosh [-l] -c command
|
||||||
|
gosh -version
|
||||||
|
```
|
||||||
|
|
||||||
|
| Aufruf | Verhalten |
|
||||||
|
|------------------------|------------------------------------------------------------------|
|
||||||
|
| `gosh` | interaktive Shell (wenn stdin ein Terminal ist) |
|
||||||
|
| `gosh -c 'befehl'` | führt den Befehl aus und beendet sich |
|
||||||
|
| `gosh skript.gosh` | führt das Skript Zeile für Zeile aus |
|
||||||
|
| `befehle \| gosh` | liest die Befehle von stdin |
|
||||||
|
| `-i` | erzwingt den interaktiven Modus, auch ohne Terminal |
|
||||||
|
| `-l`, `--login` | Login-Shell (wird akzeptiert, eine Startdatei gibt es noch nicht) |
|
||||||
|
|
||||||
|
Ohne Terminal bricht gosh bei einem fehlgeschlagenen Befehl nicht ab und beendet sich mit dem Exit-Status des letzten Befehls: `127`, wenn ein Befehl nicht gefunden wurde, `126`, wenn er nicht ausführbar ist, `128+n`, wenn er durch Signal `n` beendet wurde. Leere Zeilen und Zeilen, die mit `#` beginnen, werden übersprungen, Skripte können also mit `#!/usr/bin/gosh` beginnen.
|
||||||
|
|
||||||
|
Damit funktionieren auch `ssh host befehl`, `scp` und `rsync`, wenn gosh als Login-Shell gesetzt ist. Befehle lassen sich mit `;`, `&&` und `||` verketten und mit Pipes verbinden, z. B. `ssh host 'cd /srv && git log | head'`.
|
||||||
|
|
||||||
|
### Befehlslisten und Exit-Status
|
||||||
|
|
||||||
|
Mehrere Befehle in einer Zeile werden wie in `sh` verknüpft:
|
||||||
|
|
||||||
|
| Liste | Bedeutung |
|
||||||
|
|------------|---------------------------------------------------|
|
||||||
|
| `a ; b` | erst `a`, dann `b` |
|
||||||
|
| `a && b` | `b` nur, wenn `a` erfolgreich war (Exit-Status 0) |
|
||||||
|
| `a \|\| b` | `b` nur, wenn `a` fehlgeschlagen ist |
|
||||||
|
|
||||||
|
`&&` und `||` werden von links nach rechts ausgewertet, `a && b || c` führt also `c` aus, wenn `a` oder `b` fehlschlägt. Variablen werden erst beim Ausführen des jeweiligen Befehls expandiert, `cd /tmp && echo $PWD` gibt also schon das neue Verzeichnis aus.
|
||||||
|
|
||||||
|
`$?` (bzw. `${?}`) enthält den Exit-Status des letzten Befehls, `exit` ohne Argument beendet gosh mit diesem Status:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ false; echo $?
|
||||||
|
1
|
||||||
|
$ gibtsnicht || echo "Status $?"
|
||||||
|
gosh: gibtsnicht: command not found
|
||||||
|
Status 127
|
||||||
|
```
|
||||||
|
|
||||||
|
Schlägt ein Programm fehl, gibt gosh selbst keine Meldung mehr aus (das Programm meldet den Fehler selbst), nur bei Fehlern von gosh, z. B. wenn ein Befehl nicht gefunden wird.
|
||||||
|
|
||||||
|
### Pipes und Umleitungen
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ls | sort -r | head -3
|
||||||
|
$ make > build.log 2>&1
|
||||||
|
$ grep -c error < build.log
|
||||||
|
```
|
||||||
|
|
||||||
|
| Syntax | Bedeutung |
|
||||||
|
|-----------------|------------------------------------------------------------|
|
||||||
|
| `a \| b` | stdout von `a` wird stdin von `b` |
|
||||||
|
| `< datei` | stdin aus `datei` lesen |
|
||||||
|
| `> datei` | stdout in `datei` schreiben (wird überschrieben) |
|
||||||
|
| `>> datei` | stdout an `datei` anhängen |
|
||||||
|
| `2> datei` | stderr in `datei` schreiben (`2>>` hängt an) |
|
||||||
|
| `2>&1` | stderr dorthin, wohin stdout gerade geht |
|
||||||
|
| `>&2` | stdout dorthin, wohin stderr gerade geht |
|
||||||
|
| `&> datei` | stdout und stderr in `datei` (`&>>` hängt an) |
|
||||||
|
| `> datei` | ohne Befehl: legt `datei` an bzw. leert sie |
|
||||||
|
|
||||||
|
- Umleitungen werden von links nach rechts ausgewertet: `befehl > log 2>&1` schreibt beides in `log`, `befehl 2>&1 > log` schickt stderr dorthin, wo stdout vorher hinging (z. B. in eine Pipe).
|
||||||
|
- Unterstützt werden die Dateideskriptoren 0, 1 und 2. Vor `>` und `<` zählt nur eine Zahl ohne Anführungszeichen als Deskriptor (`2>f`, aber nicht `x2>f` oder `"2">f`).
|
||||||
|
- Operatoren in Anführungszeichen oder mit `\` davor sind normale Zeichen: `echo "a|b" 'c>d' e\>f`.
|
||||||
|
- Der Exit-Status einer Pipeline ist der des letzten Befehls. Beendet sich ein Befehl am Ende (z. B. `head`), bekommt der schreibende Befehl davor `SIGPIPE`, `yes | head -1` endet also sofort.
|
||||||
|
- Die Built-ins `pwd` und `help` lassen sich umleiten und in Pipes verwenden (`help | less`). `cd`, `set`, `export`, `exit` und `quit` verändern die Shell selbst und sind in einer Pipeline nicht erlaubt.
|
||||||
|
- Ein einzelnes `&` (Hintergrundprozesse) gibt es noch nicht, es wird als normales Zeichen übergeben.
|
||||||
|
|
||||||
|
### Farben
|
||||||
|
|
||||||
|
Der Prompt wird über die Umgebungsvariable `GOSH_COLORS` eingefärbt. Sie besteht aus durch `:` getrennten Einträgen `schlüssel=code`:
|
||||||
|
|
||||||
|
| Schlüssel | Teil des Prompts | Standard |
|
||||||
|
|-----------|--------------------------------|---------------------|
|
||||||
|
| `user` | `user@host` | `1;32` (fett grün) |
|
||||||
|
| `root` | `user@host`, wenn man root ist | `1;31` (fett rot) |
|
||||||
|
| `path` | aktuelles Verzeichnis | `1;34` (fett blau) |
|
||||||
|
|
||||||
|
Die Werte sind [ANSI-SGR-Codes](https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters), mehrere werden mit `;` kombiniert:
|
||||||
|
|
||||||
|
- `1` fett, `2` blass, `3` kursiv, `4` unterstrichen
|
||||||
|
- `30`–`37` Vordergrund, `90`–`97` helle Vordergrundfarben, `40`–`47` Hintergrund
|
||||||
|
- `38;5;N` eine der 256 Farben, `38;2;R;G;B` Truecolor (sofern das Terminal es kann)
|
||||||
|
|
||||||
|
Nicht angegebene Schlüssel behalten ihre Standardfarbe, ein leerer Wert (`path=`) schaltet die Farbe für diesen Teil ab. Ungültige Werte werden ignoriert. Da nur Ziffern und `;` erlaubt sind, lassen sich über die Variable keine beliebigen Escape-Sequenzen ins Terminal schreiben. `NO_COLOR` schaltet alle Farben ab.
|
||||||
|
|
||||||
|
Gesetzt wird die Variable z. B. in `~/.profile` oder direkt in gosh (wirkt ab dem nächsten Prompt):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export GOSH_COLORS='user=1;33:path=1;36' # in ~/.profile
|
||||||
|
set 'GOSH_COLORS=user=1;33:path=1;36' # in gosh
|
||||||
|
```
|
||||||
|
|
||||||
|
Ein paar Kombinationen zum Ausprobieren:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Solarized: gelb und cyan
|
||||||
|
GOSH_COLORS='user=33:path=36'
|
||||||
|
|
||||||
|
# Sonnenuntergang: orange und pink (256 Farben)
|
||||||
|
GOSH_COLORS='user=1;38;5;208:path=38;5;205'
|
||||||
|
|
||||||
|
# Matrix: hellgrün und blassgrün
|
||||||
|
GOSH_COLORS='user=1;92:path=2;32'
|
||||||
|
|
||||||
|
# Dracula: lila und pink (Truecolor)
|
||||||
|
GOSH_COLORS='user=1;38;2;189;147;249:path=38;2;255;121;198'
|
||||||
|
|
||||||
|
# Nord: frostblau und hellgrau (Truecolor)
|
||||||
|
GOSH_COLORS='user=1;38;2;136;192;208:path=38;2;216;222;233'
|
||||||
|
|
||||||
|
# Ozean: türkis und kursiv blau
|
||||||
|
GOSH_COLORS='user=1;96:path=3;94'
|
||||||
|
|
||||||
|
# Root-Warnung: weiß auf rotem Hintergrund
|
||||||
|
GOSH_COLORS='root=1;97;41'
|
||||||
|
|
||||||
|
# Dezent: nur das Verzeichnis unterstrichen
|
||||||
|
GOSH_COLORS='user=:path=4'
|
||||||
|
```
|
||||||
|
|
||||||
### Sicherheitshinweise
|
### Sicherheitshinweise
|
||||||
|
|
||||||
- Die History liegt in `$XDG_STATE_HOME/gosh/history` (Standard: `~/.local/state/gosh/history`) und ist nur für den eigenen Benutzer lesbar (Verzeichnis `0700`, Datei `0600`). Mit `GOSH_HISTFILE` lässt sich ein anderer Pfad setzen, mit `GOSH_HISTFILE=` wird die History abgeschaltet.
|
- Die History liegt in `$XDG_STATE_HOME/gosh/history` (Standard: `~/.local/state/gosh/history`) und ist nur für den eigenen Benutzer lesbar (Verzeichnis `0700`, Datei `0600`). Mit `GOSH_HISTFILE` lässt sich ein anderer Pfad setzen, mit `GOSH_HISTFILE=` wird die History abgeschaltet.
|
||||||
@@ -45,6 +181,15 @@ _gosh is not meant for production use, it is just a proof of concept._
|
|||||||
go build ./
|
go build ./
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Die Version lässt sich mit `gosh -version` (oder `--version`, `-V`) abfragen und steht auch in der Ausgabe von `help`:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ gosh -version
|
||||||
|
gosh 0.2.1 (branch: main, commit: 03e791c)
|
||||||
|
```
|
||||||
|
|
||||||
|
Version und Branch werden beim Bauen mit GoReleaser per `-ldflags` gesetzt. Bei einem einfachen `go build` steht dort `dev`, der Commit wird dann aus den von Go eingebetteten Git-Informationen gelesen (mit `-dirty`, falls es uncommittete Änderungen gab).
|
||||||
|
|
||||||
## Release
|
## Release
|
||||||
|
|
||||||
Binaries sowie `.deb`- und `.rpm`-Pakete werden mit [GoReleaser](https://goreleaser.com) gebaut (Konfiguration: `.goreleaser.yaml`).
|
Binaries sowie `.deb`- und `.rpm`-Pakete werden mit [GoReleaser](https://goreleaser.com) gebaut (Konfiguration: `.goreleaser.yaml`).
|
||||||
|
|||||||
+464
-2
@@ -2,6 +2,7 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
|
"errors"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
@@ -648,6 +649,21 @@ func TestExecInput_ExportNoArgs(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestVersionInfo(t *testing.T) {
|
||||||
|
origVersion, origCommit, origBranch := version, commit, branch
|
||||||
|
defer func() { version, commit, branch = origVersion, origCommit, origBranch }()
|
||||||
|
|
||||||
|
version, commit, branch = "1.2.3", "abc1234", "main"
|
||||||
|
if got := versionInfo(); got != "1.2.3 (branch: main, commit: abc1234)" {
|
||||||
|
t.Errorf("versionInfo() = %q", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
branch = ""
|
||||||
|
if got := versionInfo(); got != "1.2.3 (commit: abc1234)" {
|
||||||
|
t.Errorf("versionInfo() without branch = %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestExecInput_Help(t *testing.T) {
|
func TestExecInput_Help(t *testing.T) {
|
||||||
// Just verify help doesn't return an error
|
// Just verify help doesn't return an error
|
||||||
// We can't easily capture stdout in a unit test without a pipe
|
// We can't easily capture stdout in a unit test without a pipe
|
||||||
@@ -843,6 +859,15 @@ func TestShellCompleter_Do(t *testing.T) {
|
|||||||
{"ls " + tmpDir + "/ma", []string{"in.go"}, 2},
|
{"ls " + tmpDir + "/ma", []string{"in.go"}, 2},
|
||||||
{"ls xyz", nil, 3},
|
{"ls xyz", nil, 3},
|
||||||
{"ls ~", []string{"/"}, 1},
|
{"ls ~", []string{"/"}, 1},
|
||||||
|
// Commands are completed after |, ;, && and ||, files after redirections
|
||||||
|
{"ls | gi", []string{"tty "}, 2},
|
||||||
|
{"ls|gi", []string{"tty "}, 2},
|
||||||
|
{"true; gi", []string{"tty "}, 2},
|
||||||
|
{"true && gi", []string{"tty "}, 2},
|
||||||
|
{"false || gi", []string{"tty "}, 2},
|
||||||
|
{"ls > ma", []string{"in.go"}, 2},
|
||||||
|
{"ls 2>ma", []string{"in.go"}, 2},
|
||||||
|
{"cat <ma", []string{"in.go"}, 2},
|
||||||
}
|
}
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
got, length := completeLine(tt.line)
|
got, length := completeLine(tt.line)
|
||||||
@@ -1004,6 +1029,7 @@ func TestSanitize(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestGetPrompt_EscapesControlCharacters(t *testing.T) {
|
func TestGetPrompt_EscapesControlCharacters(t *testing.T) {
|
||||||
|
t.Setenv("NO_COLOR", "1")
|
||||||
origDir, _ := os.Getwd()
|
origDir, _ := os.Getwd()
|
||||||
defer os.Chdir(origDir)
|
defer os.Chdir(origDir)
|
||||||
|
|
||||||
@@ -1024,6 +1050,68 @@ func TestGetPrompt_EscapesControlCharacters(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestBuildPrompt_Color(t *testing.T) {
|
||||||
|
got := buildPrompt("flow", "host", "~/src", false, &defaultColors)
|
||||||
|
want := "\x1b[1;32mflow@host\x1b[0m:\x1b[1;34m~/src\x1b[0m $ "
|
||||||
|
if got != want {
|
||||||
|
t.Errorf("buildPrompt() = %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
|
||||||
|
got = buildPrompt("root", "host", "/", true, &defaultColors)
|
||||||
|
if !strings.HasPrefix(got, "\x1b[1;31mroot@host") {
|
||||||
|
t.Errorf("expected red user for root, got %q", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
got = buildPrompt("flow", "host", "~/src", false, nil)
|
||||||
|
if got != "flow@host:~/src $ " {
|
||||||
|
t.Errorf("buildPrompt() without color = %q", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
colors := promptColors{user: "38;5;208", path: ""}
|
||||||
|
got = buildPrompt("flow", "host", "~/src", false, &colors)
|
||||||
|
if got != "\x1b[38;5;208mflow@host\x1b[0m:~/src $ " {
|
||||||
|
t.Errorf("buildPrompt() with custom colors = %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseColors(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
spec string
|
||||||
|
want promptColors
|
||||||
|
}{
|
||||||
|
{"", defaultColors},
|
||||||
|
{"user=1;33", promptColors{user: "1;33", root: "1;31", path: "1;34"}},
|
||||||
|
{"user=33:root=41;97:path=38;5;208", promptColors{user: "33", root: "41;97", path: "38;5;208"}},
|
||||||
|
{"path=", promptColors{user: "1;32", root: "1;31", path: ""}},
|
||||||
|
{"path=0m\x1b[2J", defaultColors}, // escape sequences are rejected
|
||||||
|
{"path=red", defaultColors}, // only numeric codes
|
||||||
|
{"foo=1:user", defaultColors}, // unknown key, missing value
|
||||||
|
{"user=35::path=36", promptColors{user: "35", root: "1;31", path: "36"}},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
if got := parseColors(tc.spec); got != tc.want {
|
||||||
|
t.Errorf("parseColors(%q) = %+v, want %+v", tc.spec, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildPrompt_ColorEscapesControlCharacters(t *testing.T) {
|
||||||
|
got := buildPrompt("flow", "host", "evil\x1b[2J\x07", false, &defaultColors)
|
||||||
|
if strings.Contains(got, "\x1b[2J") || strings.Contains(got, "\x07") {
|
||||||
|
t.Errorf("prompt contains control characters from path: %q", got)
|
||||||
|
}
|
||||||
|
if !strings.Contains(got, `evil\x1b[2J\x07`) {
|
||||||
|
t.Errorf("expected escaped path in prompt, got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUseColor_NoColor(t *testing.T) {
|
||||||
|
t.Setenv("NO_COLOR", "1")
|
||||||
|
if useColor() {
|
||||||
|
t.Error("expected no color when NO_COLOR is set")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestFilePathCompleter_SkipsControlCharacters(t *testing.T) {
|
func TestFilePathCompleter_SkipsControlCharacters(t *testing.T) {
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
for _, name := range []string{"good", "go\x1b[31mred"} {
|
for _, name := range []string{"good", "go\x1b[31mred"} {
|
||||||
@@ -1095,7 +1183,7 @@ func TestShell_History(t *testing.T) {
|
|||||||
histFile := filepath.Join(t.TempDir(), "gosh", "history")
|
histFile := filepath.Join(t.TempDir(), "gosh", "history")
|
||||||
workDir := t.TempDir()
|
workDir := t.TempDir()
|
||||||
|
|
||||||
cmd := exec.Command(bin)
|
cmd := exec.Command(bin, "-i")
|
||||||
cmd.Dir = workDir
|
cmd.Dir = workDir
|
||||||
cmd.Env = append(os.Environ(), "GOSH_HISTFILE="+histFile)
|
cmd.Env = append(os.Environ(), "GOSH_HISTFILE="+histFile)
|
||||||
cmd.Stdin = strings.NewReader("echo first\n set SECRET=hunter2\nexit\n")
|
cmd.Stdin = strings.NewReader("echo first\n set SECRET=hunter2\nexit\n")
|
||||||
@@ -1127,7 +1215,7 @@ func TestShell_History(t *testing.T) {
|
|||||||
func TestShell_SIGINTKillsOnlyChild(t *testing.T) {
|
func TestShell_SIGINTKillsOnlyChild(t *testing.T) {
|
||||||
bin := buildShell(t)
|
bin := buildShell(t)
|
||||||
|
|
||||||
cmd := exec.Command(bin)
|
cmd := exec.Command(bin, "-i")
|
||||||
// Own process group, so that we can signal it like the terminal does
|
// Own process group, so that we can signal it like the terminal does
|
||||||
cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
|
cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
|
||||||
stdin, err := cmd.StdinPipe()
|
stdin, err := cmd.StdinPipe()
|
||||||
@@ -1158,3 +1246,377 @@ func TestShell_SIGINTKillsOnlyChild(t *testing.T) {
|
|||||||
t.Errorf("child was not interrupted (took %v)", elapsed)
|
t.Errorf("child was not interrupted (took %v)", elapsed)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestExecInput_PassesStdin(t *testing.T) {
|
||||||
|
r, w, err := os.Pipe()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
origStdin := os.Stdin
|
||||||
|
os.Stdin = r
|
||||||
|
defer func() {
|
||||||
|
os.Stdin = origStdin
|
||||||
|
r.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
if _, err := w.WriteString("hello\n"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
w.Close()
|
||||||
|
|
||||||
|
out := filepath.Join(t.TempDir(), "out")
|
||||||
|
t.Setenv("GOSH_TEST_OUT", out)
|
||||||
|
if err := execInput(`sh -c 'read x; printf %s "$x" > "$GOSH_TEST_OUT"'`); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := os.ReadFile(out)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if string(got) != "hello" {
|
||||||
|
t.Errorf("command read %q from stdin, want %q", got, "hello")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExitStatus(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
input string
|
||||||
|
want int
|
||||||
|
}{
|
||||||
|
{"true", 0},
|
||||||
|
{"false", 1},
|
||||||
|
{`sh -c "exit 42"`, 42},
|
||||||
|
{`sh -c "kill -TERM \$\$"`, 128 + 15},
|
||||||
|
{"gosh-no-such-command", 127},
|
||||||
|
{"cd /gosh-no-such-dir", 127},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
if got := exitStatus(execInput(tc.input)); got != tc.want {
|
||||||
|
t.Errorf("exitStatus(execInput(%q)) = %d, want %d", tc.input, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if got := exitStatus(errors.New("other")); got != 1 {
|
||||||
|
t.Errorf("exitStatus(other error) = %d, want 1", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunScript(t *testing.T) {
|
||||||
|
origDir, _ := os.Getwd()
|
||||||
|
defer os.Chdir(origDir)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
script := "#!/usr/bin/gosh\n" +
|
||||||
|
"# comment\n" +
|
||||||
|
"\n" +
|
||||||
|
"cd " + dir + "\n" +
|
||||||
|
" # indented comment\n" +
|
||||||
|
"touch first\n" +
|
||||||
|
"false\n" +
|
||||||
|
"touch second" // no trailing newline
|
||||||
|
if got := runScript(strings.NewReader(script)); got != 0 {
|
||||||
|
t.Errorf("runScript() = %d, want 0", got)
|
||||||
|
}
|
||||||
|
for _, name := range []string{"first", "second"} {
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, name)); err != nil {
|
||||||
|
t.Errorf("expected %s to be created: %v", name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The status of the last command is returned
|
||||||
|
if got := runScript(strings.NewReader("true\nsh -c 'exit 3'\n")); got != 3 {
|
||||||
|
t.Errorf("runScript() = %d, want 3", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRun_Options(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
args []string
|
||||||
|
want int
|
||||||
|
}{
|
||||||
|
{[]string{"-c", "true"}, 0},
|
||||||
|
{[]string{"-c", "false"}, 1},
|
||||||
|
{[]string{"-l", "-c", "sh -c 'exit 5'"}, 5},
|
||||||
|
{[]string{"-c"}, 2},
|
||||||
|
{[]string{"-x"}, 2},
|
||||||
|
{[]string{"/gosh/no/such/script"}, 127},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
if got := run(tc.args); got != tc.want {
|
||||||
|
t.Errorf("run(%q) = %d, want %d", tc.args, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadLine_DoesNotReadAhead(t *testing.T) {
|
||||||
|
r := strings.NewReader("first\nsecond\n")
|
||||||
|
line, err := readLine(r)
|
||||||
|
if line != "first" || err != nil {
|
||||||
|
t.Fatalf("readLine() = %q, %v", line, err)
|
||||||
|
}
|
||||||
|
if r.Len() != len("second\n") {
|
||||||
|
t.Errorf("readLine() consumed more than one line, %d bytes left", r.Len())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSplitList(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
input string
|
||||||
|
want []listItem
|
||||||
|
}{
|
||||||
|
{"", nil},
|
||||||
|
{" ", nil},
|
||||||
|
{"# only a comment", nil},
|
||||||
|
{"ls", []listItem{{"", "ls"}}},
|
||||||
|
{"a; b", []listItem{{"", "a"}, {";", " b"}}},
|
||||||
|
{"a;", []listItem{{"", "a"}}},
|
||||||
|
{"a && b || c", []listItem{{"", "a "}, {"&&", " b "}, {"||", " c"}}},
|
||||||
|
{`echo "a;b" 'c&&d' e\;f`, []listItem{{"", `echo "a;b" 'c&&d' e\;f`}}},
|
||||||
|
{`echo "x\"; y"`, []listItem{{"", `echo "x\"; y"`}}},
|
||||||
|
{"echo ${X:-a;b}; c", []listItem{{"", "echo ${X:-a;b}"}, {";", " c"}}},
|
||||||
|
{"echo a # b; c", []listItem{{"", "echo a "}}},
|
||||||
|
{"echo a#b; c", []listItem{{"", "echo a#b"}, {";", " c"}}},
|
||||||
|
{"echo a|b", []listItem{{"", "echo a|b"}}},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
got, err := splitList(tc.input)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("splitList(%q) returned error: %v", tc.input, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(got, tc.want) {
|
||||||
|
t.Errorf("splitList(%q) = %q, want %q", tc.input, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSplitList_SyntaxErrors(t *testing.T) {
|
||||||
|
for _, input := range []string{"; a", "a ;; b", "&& a", "a &&", "a ||", "a && ; b", "a || && b"} {
|
||||||
|
if _, err := splitList(input); err == nil || !strings.Contains(err.Error(), "syntax error") {
|
||||||
|
t.Errorf("splitList(%q) = %v, want syntax error", input, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecInput_Lists(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
t.Setenv("D", dir)
|
||||||
|
tests := []struct {
|
||||||
|
input string
|
||||||
|
created []string
|
||||||
|
missing []string
|
||||||
|
status int
|
||||||
|
}{
|
||||||
|
{"touch $D/a; touch $D/b", []string{"a", "b"}, nil, 0},
|
||||||
|
{"false; touch $D/c", []string{"c"}, nil, 0},
|
||||||
|
{"true && touch $D/d", []string{"d"}, nil, 0},
|
||||||
|
{"false && touch $D/e", nil, []string{"e"}, 1},
|
||||||
|
{"false || touch $D/f", []string{"f"}, nil, 0},
|
||||||
|
{"true || touch $D/g", nil, []string{"g"}, 0},
|
||||||
|
{"false && touch $D/h || touch $D/i", []string{"i"}, []string{"h"}, 0},
|
||||||
|
{"true && false || touch $D/j", []string{"j"}, nil, 0},
|
||||||
|
{"gosh-no-such-command || touch $D/k", []string{"k"}, nil, 0},
|
||||||
|
{"true && sh -c 'exit 4'", nil, nil, 4},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
execInput(tc.input)
|
||||||
|
if lastStatus != tc.status {
|
||||||
|
t.Errorf("%q: $? = %d, want %d", tc.input, lastStatus, tc.status)
|
||||||
|
}
|
||||||
|
for _, name := range tc.created {
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, name)); err != nil {
|
||||||
|
t.Errorf("%q: expected %s to be created", tc.input, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, name := range tc.missing {
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, name)); err == nil {
|
||||||
|
t.Errorf("%q: %s must not be created", tc.input, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecInput_ExpandsPerCommand(t *testing.T) {
|
||||||
|
origDir, _ := os.Getwd()
|
||||||
|
defer os.Chdir(origDir)
|
||||||
|
dir := t.TempDir()
|
||||||
|
out := filepath.Join(dir, "out")
|
||||||
|
t.Setenv("GOSH_TEST_OUT", out)
|
||||||
|
os.Unsetenv("GOSH_TEST_LIST")
|
||||||
|
defer os.Unsetenv("GOSH_TEST_LIST")
|
||||||
|
|
||||||
|
// The variable is set by the first command and used by the second one
|
||||||
|
err := execInput(`set GOSH_TEST_LIST=hello && sh -c 'printf %s "$GOSH_TEST_LIST" > "$GOSH_TEST_OUT"'`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got, _ := os.ReadFile(out); string(got) != "hello" {
|
||||||
|
t.Errorf("got %q, want %q", got, "hello")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExpandVar_LastStatus(t *testing.T) {
|
||||||
|
execInput("sh -c 'exit 3'")
|
||||||
|
for _, input := range []string{"$?", "${?}"} {
|
||||||
|
words, err := splitWords("echo " + input)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if words[1] != "3" {
|
||||||
|
t.Errorf("%s = %q, want %q", input, words[1], "3")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
execInput("true")
|
||||||
|
if words, _ := splitWords("echo $?"); words[1] != "0" {
|
||||||
|
t.Errorf("$? = %q after true, want 0", words[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecInput_CommandNotFound(t *testing.T) {
|
||||||
|
err := execInput("gosh-no-such-command")
|
||||||
|
if err == nil || err.Error() != "gosh-no-such-command: command not found" {
|
||||||
|
t.Errorf("got %v, want command not found", err)
|
||||||
|
}
|
||||||
|
if lastStatus != 127 {
|
||||||
|
t.Errorf("$? = %d, want 127", lastStatus)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTokenize_Operators(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
input string
|
||||||
|
want []token
|
||||||
|
}{
|
||||||
|
{"a | b", []token{{word: "a"}, {op: "|"}, {word: "b"}}},
|
||||||
|
{"a|b", []token{{word: "a"}, {op: "|"}, {word: "b"}}},
|
||||||
|
{"a > f", []token{{word: "a"}, {op: ">", fd: 1}, {word: "f"}}},
|
||||||
|
{"a >>f", []token{{word: "a"}, {op: ">>", fd: 1}, {word: "f"}}},
|
||||||
|
{"a < f", []token{{word: "a"}, {op: "<", fd: 0}, {word: "f"}}},
|
||||||
|
{"a 2>f", []token{{word: "a"}, {op: ">", fd: 2}, {word: "f"}}},
|
||||||
|
{"a 2>>f", []token{{word: "a"}, {op: ">>", fd: 2}, {word: "f"}}},
|
||||||
|
{"a 2>&1", []token{{word: "a"}, {op: ">&", fd: 2, dup: 1}}},
|
||||||
|
{"a >&2", []token{{word: "a"}, {op: ">&", fd: 1, dup: 2}}},
|
||||||
|
{"a 0<&2", []token{{word: "a"}, {op: "<&", fd: 0, dup: 2}}},
|
||||||
|
{"a &>f", []token{{word: "a"}, {op: "&>", fd: 1}, {word: "f"}}},
|
||||||
|
{"a &>>f", []token{{word: "a"}, {op: "&>>", fd: 1}, {word: "f"}}},
|
||||||
|
// Only a word of unquoted digits is a file descriptor
|
||||||
|
{"a x2>f", []token{{word: "a"}, {word: "x2"}, {op: ">", fd: 1}, {word: "f"}}},
|
||||||
|
{`a "2">f`, []token{{word: "a"}, {word: "2"}, {op: ">", fd: 1}, {word: "f"}}},
|
||||||
|
{"a 2 >f", []token{{word: "a"}, {word: "2"}, {op: ">", fd: 1}, {word: "f"}}},
|
||||||
|
// Quoted and escaped operators are words
|
||||||
|
{`echo "a|b" 'c>d' e\<f`, []token{{word: "echo"}, {word: "a|b"}, {word: "c>d"}, {word: "e<f"}}},
|
||||||
|
// A lone & is a word
|
||||||
|
{"a & b", []token{{word: "a"}, {word: "&"}, {word: "b"}}},
|
||||||
|
{"cat ~|x", []token{{word: "cat"}, {word: getHomeDir()}, {op: "|"}, {word: "x"}}},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
got, err := tokenize(tc.input)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("tokenize(%q) returned error: %v", tc.input, err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(got, tc.want) {
|
||||||
|
t.Errorf("tokenize(%q) = %+v, want %+v", tc.input, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecInput_SyntaxErrors(t *testing.T) {
|
||||||
|
for _, input := range []string{"echo a |", "| echo a", "echo a | | b", "echo a >", "echo a > | b", "echo a >&", "echo a 2>&x", "; a"} {
|
||||||
|
err := execInput(input)
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "syntax error") {
|
||||||
|
t.Errorf("execInput(%q) = %v, want syntax error", input, err)
|
||||||
|
}
|
||||||
|
if lastStatus != 2 {
|
||||||
|
t.Errorf("execInput(%q): $? = %d, want 2", input, lastStatus)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecInput_PipesAndRedirections(t *testing.T) {
|
||||||
|
origDir, _ := os.Getwd()
|
||||||
|
defer os.Chdir(origDir)
|
||||||
|
dir := t.TempDir()
|
||||||
|
os.Chdir(dir)
|
||||||
|
|
||||||
|
read := func(name string) string {
|
||||||
|
data, err := os.ReadFile(filepath.Join(dir, name))
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("reading %s: %v", name, err)
|
||||||
|
}
|
||||||
|
return string(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
input string
|
||||||
|
file string
|
||||||
|
want string
|
||||||
|
status int
|
||||||
|
}{
|
||||||
|
{`printf 'b\na\nc\n' | sort | head -n 2 > out`, "out", "a\nb\n", 0},
|
||||||
|
{"echo one > f1; echo two >> f1", "f1", "one\ntwo\n", 0},
|
||||||
|
{"echo one > f2; echo two > f2", "f2", "two\n", 0},
|
||||||
|
{"tr a-z A-Z < f1 > f3", "f3", "ONE\nTWO\n", 0},
|
||||||
|
{"sh -c 'echo out; echo err >&2' > f4 2>&1", "f4", "out\nerr\n", 0},
|
||||||
|
{"sh -c 'echo out; echo err >&2' &> f5", "f5", "out\nerr\n", 0},
|
||||||
|
{"sh -c 'echo err >&2' 2> f6", "f6", "err\n", 0},
|
||||||
|
// 2>&1 before >file sends stderr to the old stdout (the pipe)
|
||||||
|
{"sh -c 'echo out; echo err >&2' 2>&1 > /dev/null | cat > f7", "f7", "err\n", 0},
|
||||||
|
{"sh -c 'echo err >&2' 2>&1 | tr a-z A-Z > f8", "f8", "ERR\n", 0},
|
||||||
|
// Builtins write to redirections and pipes
|
||||||
|
{"pwd > f9", "f9", dir + "\n", 0},
|
||||||
|
{"pwd | cat > f10", "f10", dir + "\n", 0},
|
||||||
|
{"help | head -n 1 > f11", "f11", "gosh - Go Shell\n", 0},
|
||||||
|
// Errors of builtins go to the redirected stderr
|
||||||
|
{"cd /gosh/no/such/dir 2> f12", "f12", "gosh: chdir /gosh/no/such/dir: no such file or directory\n", 1},
|
||||||
|
// The status of a pipeline is the one of the last command
|
||||||
|
{"false | true > f13", "f13", "", 0},
|
||||||
|
{"true | false > f14", "f14", "", 1},
|
||||||
|
// A redirection without a command creates the file
|
||||||
|
{"> f15", "f15", "", 0},
|
||||||
|
// SIGPIPE ends the writer when the reader exits
|
||||||
|
{"yes | head -n 1 > f16", "f16", "y\n", 0},
|
||||||
|
// A command that is not found does not stop the pipeline
|
||||||
|
{"gosh-no-such-command | echo after > f17", "f17", "after\n", 0},
|
||||||
|
{"echo before | gosh-no-such-command 2> f18", "f18", "", 127},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
execInput(tc.input)
|
||||||
|
if lastStatus != tc.status {
|
||||||
|
t.Errorf("%q: $? = %d, want %d", tc.input, lastStatus, tc.status)
|
||||||
|
}
|
||||||
|
if got := read(tc.file); got != tc.want {
|
||||||
|
t.Errorf("%q: %s = %q, want %q", tc.input, tc.file, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecInput_RedirectionErrors(t *testing.T) {
|
||||||
|
origDir, _ := os.Getwd()
|
||||||
|
defer os.Chdir(origDir)
|
||||||
|
os.Chdir(t.TempDir())
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
input string
|
||||||
|
wantErr string
|
||||||
|
}{
|
||||||
|
{"cat < gosh-no-such-file", "gosh-no-such-file: no such file or directory"},
|
||||||
|
{"echo a > gosh-no-such-dir/f", "gosh-no-such-dir/f: no such file or directory"},
|
||||||
|
{"echo a 3> f", "3: bad file descriptor"},
|
||||||
|
{"echo a 2>&5", "5: bad file descriptor"},
|
||||||
|
{"echo a | cd /", "cd: cannot be used in a pipeline"},
|
||||||
|
{"echo a | exit 3", "exit: cannot be used in a pipeline"},
|
||||||
|
}
|
||||||
|
for _, tc := range tests {
|
||||||
|
err := execInput(tc.input)
|
||||||
|
if err == nil || err.Error() != tc.wantErr {
|
||||||
|
t.Errorf("execInput(%q) = %v, want %q", tc.input, err, tc.wantErr)
|
||||||
|
}
|
||||||
|
if lastStatus != 1 {
|
||||||
|
t.Errorf("execInput(%q): $? = %d, want 1", tc.input, lastStatus)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// The command is not run if a redirection fails
|
||||||
|
if _, err := os.Stat("f"); err == nil {
|
||||||
|
t.Error("file f must not be created for a bad file descriptor")
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in new issue
Block a user