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
152 // Parse os SOFT_SERVE environment variables
153 if err := cfg.ParseEnv(); err != nil {
154 return err
155 }
156
157 // Override the database data source if we're using postgres
158 // so we can create a temporary database for the tests.
159 if cfg.DB.Driver == "postgres" {
160 err, cleanup := setupPostgres(e.T(), cfg)
161 if err != nil {
162 return err
163 }
164 if cleanup != nil {
165 e.Defer(cleanup)
166 }
167 }
168
169 for _, env := range cfg.Environ() {
170 parts := strings.SplitN(env, "=", 2)
171 if len(parts) != 2 {
172 e.T().Fatal("invalid environment variable", env)
173 }
174 e.Setenv(parts[0], parts[1])
175 }
176
177 return nil
178 },
179 })
180}
181
182func cmdSoft(key ssh.Signer) func(ts *testscript.TestScript, neg bool, args []string) {
183 return func(ts *testscript.TestScript, neg bool, args []string) {
184 cli, err := ssh.Dial(
185 "tcp",
186 net.JoinHostPort("localhost", ts.Getenv("SSH_PORT")),
187 &ssh.ClientConfig{
188 User: "admin",
189 Auth: []ssh.AuthMethod{ssh.PublicKeys(key)},
190 HostKeyCallback: ssh.InsecureIgnoreHostKey(),
191 },
192 )
193 ts.Check(err)
194 defer cli.Close()
195
196 sess, err := cli.NewSession()
197 ts.Check(err)
198 defer sess.Close()
199
200 sess.Stdout = ts.Stdout()
201 sess.Stderr = ts.Stderr()
202
203 check(ts, sess.Run(strings.Join(args, " ")), neg)
204 }
205}
206
207func cmdUI(key ssh.Signer) func(ts *testscript.TestScript, neg bool, args []string) {
208 return func(ts *testscript.TestScript, neg bool, args []string) {
209 if len(args) < 1 {
210 ts.Fatalf("usage: ui <quoted string input>")
211 return
212 }
213
214 cli, err := ssh.Dial(
215 "tcp",
216 net.JoinHostPort("localhost", ts.Getenv("SSH_PORT")),
217 &ssh.ClientConfig{
218 User: "git",
219 Auth: []ssh.AuthMethod{ssh.PublicKeys(key)},
220 HostKeyCallback: ssh.InsecureIgnoreHostKey(),
221 },
222 )
223 check(ts, err, neg)
224 defer cli.Close()
225
226 sess, err := cli.NewSession()
227 check(ts, err, neg)
228 defer sess.Close()
229
230 // XXX: this is a hack to make the UI tests work
231 // cmp command always complains about an extra newline
232 // in the output
233 defer ts.Stdout().Write([]byte("\n"))
234
235 sess.Stdout = ts.Stdout()
236 sess.Stderr = ts.Stderr()
237
238 stdin, err := sess.StdinPipe()
239 check(ts, err, neg)
240
241 err = sess.RequestPty("dumb", 40, 80, ssh.TerminalModes{})
242 check(ts, err, neg)
243 check(ts, sess.Start(""), neg)
244
245 in, err := strconv.Unquote(args[0])
246 check(ts, err, neg)
247 reader := strings.NewReader(in)
248 go func() {
249 defer stdin.Close()
250 for {
251 r, _, err := reader.ReadRune()
252 if err == io.EOF {
253 break
254 }
255 check(ts, err, neg)
256 stdin.Write([]byte(string(r))) // nolint: errcheck
257
258 // Wait for the UI to process the input
259 time.Sleep(100 * time.Millisecond)
260 }
261 }()
262
263 check(ts, sess.Wait(), neg)
264 }
265}
266
267// P.S. Windows sucks!
268func cmdDos2Unix(ts *testscript.TestScript, neg bool, args []string) {
269 if neg {
270 ts.Fatalf("unsupported: ! dos2unix")
271 }
272 if len(args) < 1 {
273 ts.Fatalf("usage: dos2unix paths...")
274 }
275 for _, arg := range args {
276 filename := ts.MkAbs(arg)
277 data, err := os.ReadFile(filename)
278 if err != nil {
279 ts.Fatalf("%s: %v", filename, err)
280 }
281
282 // Replace all '\r\n' with '\n'.
283 data = bytes.ReplaceAll(data, []byte{'\r', '\n'}, []byte{'\n'})
284
285 if err := os.WriteFile(filename, data, 0o644); err != nil {
286 ts.Fatalf("%s: %v", filename, err)
287 }
288 }
289}
290
291var sshConfig = `
292Host *
293 UserKnownHostsFile %q
294 StrictHostKeyChecking no
295 IdentityAgent none
296 IdentitiesOnly yes
297 ServerAliveInterval 60
298`
299
300func cmdGit(key string) func(ts *testscript.TestScript, neg bool, args []string) {
301 return func(ts *testscript.TestScript, neg bool, args []string) {
302 ts.Check(os.WriteFile(
303 ts.Getenv("SSH_KNOWN_CONFIG_FILE"),
304 []byte(fmt.Sprintf(sshConfig, ts.Getenv("SSH_KNOWN_HOSTS_FILE"))),
305 0o600,
306 ))
307 sshArgs := []string{
308 "-F", filepath.ToSlash(ts.Getenv("SSH_KNOWN_CONFIG_FILE")),
309 "-i", filepath.ToSlash(key),
310 }
311 ts.Setenv(
312 "GIT_SSH_COMMAND",
313 strings.Join(append([]string{"ssh"}, sshArgs...), " "),
314 )
315 // Disable git prompting for credentials.
316 ts.Setenv("GIT_TERMINAL_PROMPT", "0")
317 args = append([]string{
318 "-c", "user.email=john@example.com",
319 "-c", "user.name=John Doe",
320 }, args...)
321 check(ts, ts.Exec("git", args...), neg)
322 }
323}
324
325func cmdMkfile(ts *testscript.TestScript, neg bool, args []string) {
326 if len(args) < 2 {
327 ts.Fatalf("usage: mkfile path content")
328 }
329 check(ts, os.WriteFile(
330 ts.MkAbs(args[0]),
331 []byte(strings.Join(args[1:], " ")),
332 0o644,
333 ), neg)
334}
335
336func check(ts *testscript.TestScript, err error, neg bool) {
337 if neg && err == nil {
338 ts.Fatalf("expected error, got nil")
339 }
340 if !neg {
341 ts.Check(err)
342 }
343}
344
345func cmdReadfile(ts *testscript.TestScript, neg bool, args []string) {
346 ts.Stdout().Write([]byte(ts.ReadFile(args[0])))
347}
348
349func cmdEnvfile(ts *testscript.TestScript, neg bool, args []string) {
350 if len(args) < 1 {
351 ts.Fatalf("usage: envfile key=file...")
352 }
353
354 for _, arg := range args {
355 parts := strings.SplitN(arg, "=", 2)
356 if len(parts) != 2 {
357 ts.Fatalf("usage: envfile key=file...")
358 }
359 key := parts[0]
360 file := parts[1]
361 ts.Setenv(key, strings.TrimSpace(ts.ReadFile(file)))
362 }
363}
364
365func cmdNewWebhook(ts *testscript.TestScript, neg bool, args []string) {
366 type webhookSite struct {
367 UUID string `json:"uuid"`
368 }
369
370 if len(args) != 1 {
371 ts.Fatalf("usage: new-webhook <env-name>")
372 }
373
374 const whSite = "https://webhook.site"
375 req, err := http.NewRequest(http.MethodPost, whSite+"/token", nil)
376 check(ts, err, neg)
377
378 resp, err := http.DefaultClient.Do(req)
379 check(ts, err, neg)
380
381 defer resp.Body.Close()
382 var site webhookSite
383 check(ts, json.NewDecoder(resp.Body).Decode(&site), neg)
384
385 ts.Setenv(args[0], whSite+"/"+site.UUID)
386}
387
388func cmdCurl(ts *testscript.TestScript, neg bool, args []string) {
389 var verbose bool
390 var headers []string
391 var data string
392 method := http.MethodGet
393
394 cmd := &cobra.Command{
395 Use: "curl",
396 Args: cobra.MinimumNArgs(1),
397 RunE: func(cmd *cobra.Command, args []string) error {
398 url, err := url.Parse(args[0])
399 if err != nil {
400 return err
401 }
402
403 req, err := http.NewRequest(method, url.String(), nil)
404 if err != nil {
405 return err
406 }
407
408 if data != "" {
409 req.Body = io.NopCloser(strings.NewReader(data))
410 }
411
412 if verbose {
413 fmt.Fprintf(cmd.ErrOrStderr(), "< %s %s\n", req.Method, url.String())
414 }
415
416 for _, header := range headers {
417 parts := strings.SplitN(header, ":", 2)
418 if len(parts) != 2 {
419 return fmt.Errorf("invalid header: %s", header)
420 }
421 req.Header.Add(strings.TrimSpace(parts[0]), strings.TrimSpace(parts[1]))
422 }
423
424 if userInfo := url.User; userInfo != nil {
425 password, _ := userInfo.Password()
426 req.SetBasicAuth(userInfo.Username(), password)
427 }
428
429 if verbose {
430 for key, values := range req.Header {
431 for _, value := range values {
432 fmt.Fprintf(cmd.ErrOrStderr(), "< %s: %s\n", key, value)
433 }
434 }
435 }
436
437 resp, err := http.DefaultClient.Do(req)
438 if err != nil {
439 return err
440 }
441
442 if verbose {
443 fmt.Fprintf(ts.Stderr(), "> %s\n", resp.Status)
444 for key, values := range resp.Header {
445 for _, value := range values {
446 fmt.Fprintf(cmd.ErrOrStderr(), "> %s: %s\n", key, value)
447 }
448 }
449 }
450
451 defer resp.Body.Close()
452 buf, err := io.ReadAll(resp.Body)
453 if err != nil {
454 return err
455 }
456
457 cmd.Print(string(buf))
458
459 return nil
460 },
461 }
462
463 cmd.SetArgs(args)
464 cmd.SetOut(ts.Stdout())
465 cmd.SetErr(ts.Stderr())
466
467 cmd.Flags().BoolVarP(&verbose, "verbose", "v", verbose, "verbose")
468 cmd.Flags().StringArrayVarP(&headers, "header", "H", nil, "HTTP header")
469 cmd.Flags().StringVarP(&method, "request", "X", method, "HTTP method")
470 cmd.Flags().StringVarP(&data, "data", "d", data, "HTTP data")
471
472 check(ts, cmd.Execute(), neg)
473}
474
475func cmdWaitforserver(ts *testscript.TestScript, neg bool, args []string) {
476 // wait until the server is up
477 for {
478 conn, _ := net.DialTimeout(
479 "tcp",
480 net.JoinHostPort("localhost", fmt.Sprintf("%s", ts.Getenv("SSH_PORT"))),
481 time.Second,
482 )
483 if conn != nil {
484 conn.Close()
485 break
486 }
487 }
488}
489
490func cmdStopserver(ts *testscript.TestScript, neg bool, args []string) {
491 // stop the server
492 resp, err := http.DefaultClient.Head(fmt.Sprintf("%s/__stop", ts.Getenv("SOFT_SERVE_HTTP_PUBLIC_URL")))
493 check(ts, err, neg)
494 defer resp.Body.Close()
495 time.Sleep(time.Second * 2) // Allow some time for the server to stop
496}
497
498func setupPostgres(t testscript.T, cfg *config.Config) (error, func()) {
499 // Indicates postgres
500 // Create a disposable database
501 rnd := rand.New(rand.NewSource(time.Now().UnixNano()))
502 dbName := fmt.Sprintf("softserve_test_%d", rnd.Int63())
503 dbDsn := cfg.DB.DataSource
504 if dbDsn == "" {
505 cfg.DB.DataSource = "postgres://postgres@localhost:5432/postgres?sslmode=disable"
506 }
507
508 dbUrl, err := url.Parse(cfg.DB.DataSource)
509 if err != nil {
510 return err, nil
511 }
512
513 scheme := dbUrl.Scheme
514 if scheme == "" {
515 scheme = "postgres"
516 }
517
518 host := dbUrl.Hostname()
519 if host == "" {
520 host = "localhost"
521 }
522
523 connInfo := fmt.Sprintf("host=%s sslmode=disable", host)
524 username := dbUrl.User.Username()
525 if username != "" {
526 connInfo += fmt.Sprintf(" user=%s", username)
527 password, ok := dbUrl.User.Password()
528 if ok {
529 username = fmt.Sprintf("%s:%s", username, password)
530 connInfo += fmt.Sprintf(" password=%s", password)
531 }
532 username = fmt.Sprintf("%s@", username)
533 } else {
534 connInfo += " user=postgres"
535 username = "postgres@"
536 }
537
538 port := dbUrl.Port()
539 if port != "" {
540 connInfo += fmt.Sprintf(" port=%s", port)
541 port = fmt.Sprintf(":%s", port)
542 }
543
544 cfg.DB.DataSource = fmt.Sprintf("%s://%s%s%s/%s?sslmode=disable",
545 scheme,
546 username,
547 host,
548 port,
549 dbName,
550 )
551
552 // Create the database
553 dbx, err := db.Open(context.TODO(), cfg.DB.Driver, connInfo)
554 if err != nil {
555 return err, nil
556 }
557
558 if _, err := dbx.Exec("CREATE DATABASE " + dbName); err != nil {
559 return err, nil
560 }
561
562 return nil, func() {
563 dbx, err := db.Open(context.TODO(), cfg.DB.Driver, connInfo)
564 if err != nil {
565 t.Fatal("failed to open database", dbName, err)
566 }
567
568 if _, err := dbx.Exec("DROP DATABASE " + dbName); err != nil {
569 t.Fatal("failed to drop database", dbName, err)
570 }
571 }
572}