1package testscript
2
3import (
4 "bytes"
5 "context"
6 "encoding/json"
7 "flag"
8 "fmt"
9 "io"
10 "math/rand"
11 "net"
12 "net/http"
13 "net/url"
14 "os"
15 "os/exec"
16 "path/filepath"
17 "runtime"
18 "strconv"
19 "strings"
20 "testing"
21 "time"
22
23 "github.com/charmbracelet/keygen"
24 "github.com/charmbracelet/soft-serve/pkg/config"
25 "github.com/charmbracelet/soft-serve/pkg/db"
26 "github.com/charmbracelet/soft-serve/pkg/test"
27 "github.com/rogpeppe/go-internal/testscript"
28 "github.com/spf13/cobra"
29 "golang.org/x/crypto/ssh"
30)
31
32var (
33 update = flag.Bool("update", false, "update script files")
34 binPath string
35)
36
37func TestMain(m *testing.M) {
38 tmp, err := os.MkdirTemp("", "soft-serve*")
39 if err != nil {
40 fmt.Fprintf(os.Stderr, "failed to create temporary directory: %s", err)
41 os.Exit(1)
42 }
43 defer os.RemoveAll(tmp)
44
45 binPath = filepath.Join(tmp, "soft")
46 if runtime.GOOS == "windows" {
47 binPath += ".exe"
48 }
49
50 // Build the soft binary with -cover flag.
51 cmd := exec.Command("go", "build", "-race", "-cover", "-o", binPath, filepath.Join("..", "cmd", "soft"))
52 if err := cmd.Run(); err != nil {
53 fmt.Fprintf(os.Stderr, "failed to build soft-serve binary: %s", err)
54 os.Exit(1)
55 }
56
57 // Run tests
58 os.Exit(m.Run())
59
60 // Add binPath to PATH
61 os.Setenv("PATH", fmt.Sprintf("%s%c%s", os.Getenv("PATH"), os.PathListSeparator, filepath.Dir(binPath)))
62}
63
64func TestScript(t *testing.T) {
65 flag.Parse()
66
67 mkkey := func(name string) (string, *keygen.SSHKeyPair) {
68 path := filepath.Join(t.TempDir(), name)
69 pair, err := keygen.New(path, keygen.WithKeyType(keygen.Ed25519), keygen.WithWrite())
70 if err != nil {
71 t.Fatal(err)
72 }
73 return path, pair
74 }
75
76 key, admin1 := mkkey("admin1")
77 _, admin2 := mkkey("admin2")
78 _, user1 := mkkey("user1")
79
80 testscript.Run(t, testscript.Params{
81 Dir: "./testdata/",
82 UpdateScripts: *update,
83 RequireExplicitExec: true,
84 Cmds: map[string]func(ts *testscript.TestScript, neg bool, args []string){
85 "soft": cmdSoft(admin1.Signer()),
86 "usoft": cmdSoft(user1.Signer()),
87 "git": cmdGit(key),
88 "curl": cmdCurl,
89 "mkfile": cmdMkfile,
90 "envfile": cmdEnvfile,
91 "readfile": cmdReadfile,
92 "dos2unix": cmdDos2Unix,
93 "new-webhook": cmdNewWebhook,
94 "waitforserver": cmdWaitforserver,
95 "stopserver": cmdStopserver,
96 "ui": cmdUI(admin1.Signer()),
97 "uui": cmdUI(user1.Signer()),
98 },
99 Setup: func(e *testscript.Env) error {
100 // Add binPath to PATH
101 e.Setenv("PATH", fmt.Sprintf("%s%c%s", filepath.Dir(binPath), os.PathListSeparator, e.Getenv("PATH")))
102
103 data := t.TempDir()
104 sshPort := test.RandomPort()
105 sshListen := fmt.Sprintf("localhost:%d", sshPort)
106 gitPort := test.RandomPort()
107 gitListen := fmt.Sprintf("localhost:%d", gitPort)
108 httpPort := test.RandomPort()
109 httpListen := fmt.Sprintf("localhost:%d", httpPort)
110 statsPort := test.RandomPort()
111 statsListen := fmt.Sprintf("localhost:%d", statsPort)
112 serverName := "Test Soft Serve"
113
114 e.Setenv("DATA_PATH", data)
115 e.Setenv("SSH_PORT", fmt.Sprintf("%d", sshPort))
116 e.Setenv("HTTP_PORT", fmt.Sprintf("%d", httpPort))
117 e.Setenv("ADMIN1_AUTHORIZED_KEY", admin1.AuthorizedKey())
118 e.Setenv("ADMIN2_AUTHORIZED_KEY", admin2.AuthorizedKey())
119 e.Setenv("USER1_AUTHORIZED_KEY", user1.AuthorizedKey())
120 e.Setenv("SSH_KNOWN_HOSTS_FILE", filepath.Join(t.TempDir(), "known_hosts"))
121 e.Setenv("SSH_KNOWN_CONFIG_FILE", filepath.Join(t.TempDir(), "config"))
122
123 // This is used to set up test specific configuration and http endpoints
124 e.Setenv("SOFT_SERVE_TESTRUN", "1")
125
126 // This will disable the default lipgloss renderer colors
127 e.Setenv("SOFT_SERVE_NO_COLOR", "1")
128
129 // Soft Serve debug environment variables
130 for _, env := range []string{
131 "SOFT_SERVE_DEBUG",
132 "SOFT_SERVE_VERBOSE",
133 } {
134 if v, ok := os.LookupEnv(env); ok {
135 e.Setenv(env, v)
136 }
137 }
138
139 // TODO: test different configs
140 cfg := config.DefaultConfig()
141 cfg.DataPath = data
142 cfg.Name = serverName
143 cfg.InitialAdminKeys = []string{admin1.AuthorizedKey()}
144 cfg.SSH.ListenAddr = sshListen
145 cfg.SSH.PublicURL = "ssh://" + sshListen
146 cfg.Git.ListenAddr = gitListen
147 cfg.HTTP.ListenAddr = httpListen
148 cfg.HTTP.PublicURL = "http://" + httpListen
149 cfg.Stats.ListenAddr = statsListen
150 cfg.LFS.Enabled = true
151 // cfg.LFS.SSHEnabled = true
152
153 // Parse os SOFT_SERVE environment variables
154 if err := cfg.ParseEnv(); err != nil {
155 return err
156 }
157
158 // Override the database data source if we're using postgres
159 // so we can create a temporary database for the tests.
160 if cfg.DB.Driver == "postgres" {
161 err, cleanup := setupPostgres(e.T(), cfg)
162 if err != nil {
163 return err
164 }
165 if cleanup != nil {
166 e.Defer(cleanup)
167 }
168 }
169
170 for _, env := range cfg.Environ() {
171 parts := strings.SplitN(env, "=", 2)
172 if len(parts) != 2 {
173 e.T().Fatal("invalid environment variable", env)
174 }
175 e.Setenv(parts[0], parts[1])
176 }
177
178 return nil
179 },
180 })
181}
182
183func cmdSoft(key ssh.Signer) func(ts *testscript.TestScript, neg bool, args []string) {
184 return func(ts *testscript.TestScript, neg bool, args []string) {
185 cli, err := ssh.Dial(
186 "tcp",
187 net.JoinHostPort("localhost", ts.Getenv("SSH_PORT")),
188 &ssh.ClientConfig{
189 User: "admin",
190 Auth: []ssh.AuthMethod{ssh.PublicKeys(key)},
191 HostKeyCallback: ssh.InsecureIgnoreHostKey(),
192 },
193 )
194 ts.Check(err)
195 defer cli.Close()
196
197 sess, err := cli.NewSession()
198 ts.Check(err)
199 defer sess.Close()
200
201 sess.Stdout = ts.Stdout()
202 sess.Stderr = ts.Stderr()
203
204 check(ts, sess.Run(strings.Join(args, " ")), neg)
205 }
206}
207
208func cmdUI(key ssh.Signer) func(ts *testscript.TestScript, neg bool, args []string) {
209 return func(ts *testscript.TestScript, neg bool, args []string) {
210 if len(args) < 1 {
211 ts.Fatalf("usage: ui <quoted string input>")
212 return
213 }
214
215 cli, err := ssh.Dial(
216 "tcp",
217 net.JoinHostPort("localhost", ts.Getenv("SSH_PORT")),
218 &ssh.ClientConfig{
219 User: "git",
220 Auth: []ssh.AuthMethod{ssh.PublicKeys(key)},
221 HostKeyCallback: ssh.InsecureIgnoreHostKey(),
222 },
223 )
224 check(ts, err, neg)
225 defer cli.Close()
226
227 sess, err := cli.NewSession()
228 check(ts, err, neg)
229 defer sess.Close()
230
231 // XXX: this is a hack to make the UI tests work
232 // cmp command always complains about an extra newline
233 // in the output
234 defer ts.Stdout().Write([]byte("\n"))
235
236 sess.Stdout = ts.Stdout()
237 sess.Stderr = ts.Stderr()
238
239 stdin, err := sess.StdinPipe()
240 check(ts, err, neg)
241
242 in, err := strconv.Unquote(args[0])
243 check(ts, err, neg)
244 reader := strings.NewReader(in)
245 go func() {
246 defer stdin.Close()
247 for {
248 r, _, err := reader.ReadRune()
249 if err == io.EOF {
250 break
251 }
252 check(ts, err, neg)
253 stdin.Write([]byte(string(r))) // nolint: errcheck
254
255 // Wait for the UI to process the input
256 time.Sleep(100 * time.Millisecond)
257 }
258 }()
259
260 err = sess.RequestPty("dumb", 40, 80, ssh.TerminalModes{})
261 check(ts, err, neg)
262 check(ts, sess.Run(""), neg)
263 }
264}
265
266// P.S. Windows sucks!
267func cmdDos2Unix(ts *testscript.TestScript, neg bool, args []string) {
268 if neg {
269 ts.Fatalf("unsupported: ! dos2unix")
270 }
271 if len(args) < 1 {
272 ts.Fatalf("usage: dos2unix paths...")
273 }
274 for _, arg := range args {
275 filename := ts.MkAbs(arg)
276 data, err := os.ReadFile(filename)
277 if err != nil {
278 ts.Fatalf("%s: %v", filename, err)
279 }
280
281 // Replace all '\r\n' with '\n'.
282 data = bytes.ReplaceAll(data, []byte{'\r', '\n'}, []byte{'\n'})
283
284 if err := os.WriteFile(filename, data, 0o644); err != nil {
285 ts.Fatalf("%s: %v", filename, err)
286 }
287 }
288}
289
290var sshConfig = `
291Host *
292 UserKnownHostsFile %q
293 StrictHostKeyChecking no
294 IdentityAgent none
295 IdentitiesOnly yes
296 ServerAliveInterval 60
297`
298
299func cmdGit(key string) func(ts *testscript.TestScript, neg bool, args []string) {
300 return func(ts *testscript.TestScript, neg bool, args []string) {
301 ts.Check(os.WriteFile(
302 ts.Getenv("SSH_KNOWN_CONFIG_FILE"),
303 []byte(fmt.Sprintf(sshConfig, ts.Getenv("SSH_KNOWN_HOSTS_FILE"))),
304 0o600,
305 ))
306 sshArgs := []string{
307 "-F", filepath.ToSlash(ts.Getenv("SSH_KNOWN_CONFIG_FILE")),
308 "-i", filepath.ToSlash(key),
309 }
310 ts.Setenv(
311 "GIT_SSH_COMMAND",
312 strings.Join(append([]string{"ssh"}, sshArgs...), " "),
313 )
314 // Disable git prompting for credentials.
315 ts.Setenv("GIT_TERMINAL_PROMPT", "0")
316 args = append([]string{
317 "-c", "user.email=john@example.com",
318 "-c", "user.name=John Doe",
319 }, args...)
320 check(ts, ts.Exec("git", args...), neg)
321 }
322}
323
324func cmdMkfile(ts *testscript.TestScript, neg bool, args []string) {
325 if len(args) < 2 {
326 ts.Fatalf("usage: mkfile path content")
327 }
328 check(ts, os.WriteFile(
329 ts.MkAbs(args[0]),
330 []byte(strings.Join(args[1:], " ")),
331 0o644,
332 ), neg)
333}
334
335func check(ts *testscript.TestScript, err error, neg bool) {
336 if neg && err == nil {
337 ts.Fatalf("expected error, got nil")
338 }
339 if !neg {
340 ts.Check(err)
341 }
342}
343
344func cmdReadfile(ts *testscript.TestScript, neg bool, args []string) {
345 ts.Stdout().Write([]byte(ts.ReadFile(args[0])))
346}
347
348func cmdEnvfile(ts *testscript.TestScript, neg bool, args []string) {
349 if len(args) < 1 {
350 ts.Fatalf("usage: envfile key=file...")
351 }
352
353 for _, arg := range args {
354 parts := strings.SplitN(arg, "=", 2)
355 if len(parts) != 2 {
356 ts.Fatalf("usage: envfile key=file...")
357 }
358 key := parts[0]
359 file := parts[1]
360 ts.Setenv(key, strings.TrimSpace(ts.ReadFile(file)))
361 }
362}
363
364func cmdNewWebhook(ts *testscript.TestScript, neg bool, args []string) {
365 type webhookSite struct {
366 UUID string `json:"uuid"`
367 }
368
369 if len(args) != 1 {
370 ts.Fatalf("usage: new-webhook <env-name>")
371 }
372
373 const whSite = "https://webhook.site"
374 req, err := http.NewRequest(http.MethodPost, whSite+"/token", nil)
375 check(ts, err, neg)
376
377 resp, err := http.DefaultClient.Do(req)
378 check(ts, err, neg)
379
380 defer resp.Body.Close()
381 var site webhookSite
382 check(ts, json.NewDecoder(resp.Body).Decode(&site), neg)
383
384 ts.Setenv(args[0], whSite+"/"+site.UUID)
385}
386
387func cmdCurl(ts *testscript.TestScript, neg bool, args []string) {
388 var verbose bool
389 var headers []string
390 var data string
391 method := http.MethodGet
392
393 cmd := &cobra.Command{
394 Use: "curl",
395 Args: cobra.MinimumNArgs(1),
396 RunE: func(cmd *cobra.Command, args []string) error {
397 url, err := url.Parse(args[0])
398 if err != nil {
399 return err
400 }
401
402 req, err := http.NewRequest(method, url.String(), nil)
403 if err != nil {
404 return err
405 }
406
407 if data != "" {
408 req.Body = io.NopCloser(strings.NewReader(data))
409 }
410
411 if verbose {
412 fmt.Fprintf(cmd.ErrOrStderr(), "< %s %s\n", req.Method, url.String())
413 }
414
415 for _, header := range headers {
416 parts := strings.SplitN(header, ":", 2)
417 if len(parts) != 2 {
418 return fmt.Errorf("invalid header: %s", header)
419 }
420 req.Header.Add(strings.TrimSpace(parts[0]), strings.TrimSpace(parts[1]))
421 }
422
423 if userInfo := url.User; userInfo != nil {
424 password, _ := userInfo.Password()
425 req.SetBasicAuth(userInfo.Username(), password)
426 }
427
428 if verbose {
429 for key, values := range req.Header {
430 for _, value := range values {
431 fmt.Fprintf(cmd.ErrOrStderr(), "< %s: %s\n", key, value)
432 }
433 }
434 }
435
436 resp, err := http.DefaultClient.Do(req)
437 if err != nil {
438 return err
439 }
440
441 if verbose {
442 fmt.Fprintf(ts.Stderr(), "> %s\n", resp.Status)
443 for key, values := range resp.Header {
444 for _, value := range values {
445 fmt.Fprintf(cmd.ErrOrStderr(), "> %s: %s\n", key, value)
446 }
447 }
448 }
449
450 defer resp.Body.Close()
451 buf, err := io.ReadAll(resp.Body)
452 if err != nil {
453 return err
454 }
455
456 cmd.Print(string(buf))
457
458 return nil
459 },
460 }
461
462 cmd.SetArgs(args)
463 cmd.SetOut(ts.Stdout())
464 cmd.SetErr(ts.Stderr())
465
466 cmd.Flags().BoolVarP(&verbose, "verbose", "v", verbose, "verbose")
467 cmd.Flags().StringArrayVarP(&headers, "header", "H", nil, "HTTP header")
468 cmd.Flags().StringVarP(&method, "request", "X", method, "HTTP method")
469 cmd.Flags().StringVarP(&data, "data", "d", data, "HTTP data")
470
471 check(ts, cmd.Execute(), neg)
472}
473
474func cmdWaitforserver(ts *testscript.TestScript, neg bool, args []string) {
475 // wait until the server is up
476 for {
477 conn, _ := net.DialTimeout(
478 "tcp",
479 net.JoinHostPort("localhost", fmt.Sprintf("%s", ts.Getenv("SSH_PORT"))),
480 time.Second,
481 )
482 if conn != nil {
483 conn.Close()
484 break
485 }
486 }
487}
488
489func cmdStopserver(ts *testscript.TestScript, neg bool, args []string) {
490 // stop the server
491 resp, err := http.DefaultClient.Head(fmt.Sprintf("%s/__stop", ts.Getenv("SOFT_SERVE_HTTP_PUBLIC_URL")))
492 check(ts, err, neg)
493 defer resp.Body.Close()
494 time.Sleep(time.Second * 2) // Allow some time for the server to stop
495}
496
497func setupPostgres(t testscript.T, cfg *config.Config) (error, func()) {
498 // Indicates postgres
499 // Create a disposable database
500 rnd := rand.New(rand.NewSource(time.Now().UnixNano()))
501 dbName := fmt.Sprintf("softserve_test_%d", rnd.Int63())
502 dbDsn := cfg.DB.DataSource
503 if dbDsn == "" {
504 cfg.DB.DataSource = "postgres://postgres@localhost:5432/postgres?sslmode=disable"
505 }
506
507 dbUrl, err := url.Parse(cfg.DB.DataSource)
508 if err != nil {
509 return err, nil
510 }
511
512 scheme := dbUrl.Scheme
513 if scheme == "" {
514 scheme = "postgres"
515 }
516
517 host := dbUrl.Hostname()
518 if host == "" {
519 host = "localhost"
520 }
521
522 connInfo := fmt.Sprintf("host=%s sslmode=disable", host)
523 username := dbUrl.User.Username()
524 if username != "" {
525 connInfo += fmt.Sprintf(" user=%s", username)
526 password, ok := dbUrl.User.Password()
527 if ok {
528 username = fmt.Sprintf("%s:%s", username, password)
529 connInfo += fmt.Sprintf(" password=%s", password)
530 }
531 username = fmt.Sprintf("%s@", username)
532 } else {
533 connInfo += " user=postgres"
534 username = "postgres@"
535 }
536
537 port := dbUrl.Port()
538 if port != "" {
539 connInfo += fmt.Sprintf(" port=%s", port)
540 port = fmt.Sprintf(":%s", port)
541 }
542
543 cfg.DB.DataSource = fmt.Sprintf("%s://%s%s%s/%s?sslmode=disable",
544 scheme,
545 username,
546 host,
547 port,
548 dbName,
549 )
550
551 // Create the database
552 dbx, err := db.Open(context.TODO(), cfg.DB.Driver, connInfo)
553 if err != nil {
554 return err, nil
555 }
556
557 if _, err := dbx.Exec("CREATE DATABASE " + dbName); err != nil {
558 return err, nil
559 }
560
561 return nil, func() {
562 dbx, err := db.Open(context.TODO(), cfg.DB.Driver, connInfo)
563 if err != nil {
564 t.Fatal("failed to open database", dbName, err)
565 }
566
567 if _, err := dbx.Exec("DROP DATABASE " + dbName); err != nil {
568 t.Fatal("failed to drop database", dbName, err)
569 }
570 }
571}