1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
// Copyright 2023 Harald Albrecht.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy
// of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations
// under the License.
package enumflag
import (
"io"
"os"
"os/exec"
"path/filepath"
"slices"
"syscall"
"time"
"github.com/onsi/gomega/gbytes"
"github.com/onsi/gomega/gexec"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
. "github.com/thediveo/success"
)
const dummyCommandName = "enumflag-testing"
// See:
// https://serverfault.com/questions/506612/standard-place-for-user-defined-bash-completion-d-scripts/1013395#1013395
const bashComplDirEnv = "BASH_COMPLETION_USER_DIR"
type writer struct {
io.WriteCloser
}
func (w *writer) WriteString(s string) {
GinkgoHelper()
Expect(w.WriteCloser.Write([]byte(s))).Error().NotTo(HaveOccurred())
}
var _ = Describe("flag enum completions end-to-end", Ordered, func() {
var enumflagTestingPath string
var completionsUserDir string
BeforeAll(func() {
By("building a CLI binary for testing")
enumflagTestingPath = Successful(gexec.Build("./test/enumflag-testing"))
DeferCleanup(func() {
gexec.CleanupBuildArtifacts()
})
By("creating a temporary directory for storing completion scripts")
completionsUserDir = Successful(os.MkdirTemp("", "bash-completions-*"))
DeferCleanup(func() {
os.RemoveAll(completionsUserDir)
})
// Notice how the bash-completion FAQ
// https://github.com/scop/bash-completion/blob/master/README.md#faq
// says that the completions must be inside a "completions" sub
// directory of $BASH_COMPLETION_USER_DIR, and not inside
// $BASH_COMPLETION_USER_DIR itself ... yeah, 🤷
Expect(os.Mkdir(filepath.Join(completionsUserDir, "completions"), 0770)).To(Succeed())
By("telling the CLI binary to give us a completion script that we then store away")
session := Successful(
gexec.Start(exec.Command(enumflagTestingPath, "completion", "bash"),
GinkgoWriter, GinkgoWriter))
Eventually(session).Within(5 * time.Second).ProbeEvery(100 * time.Millisecond).
Should(gexec.Exit(0))
completionScript := session.Out.Contents()
Expect(completionScript).To(MatchRegexp(`^# bash completion V2 for`))
Expect(os.WriteFile(filepath.Join(completionsUserDir, "completions", "enumflag-testing"),
completionScript, 0770)).
To(Succeed())
})
Bash := func() (*gexec.Session, *writer) {
GinkgoHelper()
By("creating a new test bash session")
bashCmd := exec.Command("/bin/bash", "--rcfile", "/etc/profile", "-i")
// Run the silly interactive subshell in its own session so we don't get
// funny surprises such as the subshell getting suspended by its parent
// shell...
bashCmd.SysProcAttr = &syscall.SysProcAttr{Setsid: true}
bashCmd.Env = append(slices.Clone(os.Environ()),
bashComplDirEnv+"="+completionsUserDir,
"PATH="+filepath.Dir(enumflagTestingPath)+":"+os.Getenv("PATH"),
)
stdin := &writer{Successful(bashCmd.StdinPipe())}
session := Successful(
gexec.Start(bashCmd, GinkgoWriter, GinkgoWriter))
DeferCleanup(func() {
By("killing the test bash session")
stdin.Close()
session.Kill().Wait(2 * time.Second)
})
return session, stdin
}
var bash *gexec.Session
var bashin *writer
BeforeEach(func() {
bash, bashin = Bash()
// Gomega hack: when trying to run the interactive subshell in its own
// session, creating a new session might be ignored and we get an error
// message on stderr from the subshell. So we need to ignore this
// unwanted "heckling", but Gomega's gbytes does not directly support
// ignoring output. So we resort to (asynchronous) detection of bash's
// heckling and then simply ignore it. This will fast forward over the
// heckling, so the tests then can still correctly proceed.
ch := bash.Err.Detect(`(bash: .*\n)+`)
// Make sure to drain the unbuffered detection channel.
done := make(chan struct{})
defer close(done)
go func() {
for {
select {
case <-ch:
// nothing; just drain
case <-done:
break
}
}
}()
DeferCleanup(func() {
// Note: Gomega currently crashes in CancelDetects() if no
// Detect()'s have been done before.
bash.Err.CancelDetects()
})
})
It("tab-completes the canary's name in $PATH", func() {
By("checking BASH_COMPLETION_USER_DIR")
bashin.WriteString("echo $" + bashComplDirEnv + "\n")
Eventually(bash.Out).Should(gbytes.Say(completionsUserDir))
By("listing the canary in the first search PATH directory")
bashin.WriteString("ls -l ${PATH%%:*}\n")
Eventually(bash.Out).Should(gbytes.Say(dummyCommandName))
By("ensuring the canary is in the PATH and gets completed")
bashin.WriteString(dummyCommandName[:len(dummyCommandName)-4] + "\t")
Eventually(bash.Err).Should(gbytes.Say(dummyCommandName))
})
It("completes canary's test subcommand", func() {
bashin.WriteString(dummyCommandName + " t\t")
Eventually(bash.Err).Should(gbytes.Say(dummyCommandName + " test"))
})
It("completes canary's \"mode\" enum flag name", func() {
bashin.WriteString(dummyCommandName + " test --\t\t")
Eventually(bash.Err).Should(gbytes.Say(
`--help\s+\(help for test\)\s+--mode\s+\(sets foo mode\)`))
})
It("lists enum flag's values", func() {
bashin.WriteString(dummyCommandName + " test --mode \t\t")
Eventually(bash.Err).Should(gbytes.Say(
`bar\s+\(bars the output\)\s+baz\s+\(bazs the output\)\s+foo\s+\(foos the output\)`))
bashin.WriteString("\b=\t\t")
Eventually(bash.Err).Should(gbytes.Say(
`bar\s+\(bars the output\)\s+baz\s+\(bazs the output\)\s+foo\s+\(foos the output\)`))
})
It("completes enum flag's values", func() {
bashin.WriteString(dummyCommandName + " test --mode ba\t\t")
Eventually(bash.Err).Should(gbytes.Say(
`bar\s+\(bars the output\)\s+baz\s+\(bazs the output\)`))
bashin.WriteString("\b\bf\t")
Eventually(bash.Err).Should(gbytes.Say(
`oo `))
})
})
|
