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