File: ssh_test.go

package info (click to toggle)
golang-github-cli-go-gh-v2 2.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 496 kB
  • sloc: makefile: 2
file content (163 lines) | stat: -rw-r--r-- 3,705 bytes parent folder | download
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
package ssh

import (
	"errors"
	"fmt"
	"net/url"
	"os"
	"os/exec"
	"testing"

	"github.com/MakeNowJust/heredoc"
	"github.com/cli/safeexec"
)

func TestTranslator(t *testing.T) {
	if _, err := safeexec.LookPath("ssh"); err != nil {
		t.Skip("no ssh found on system")
	}

	tests := []struct {
		name      string
		sshConfig string
		arg       string
		want      string
	}{
		{
			name: "translate SSH URL",
			sshConfig: heredoc.Doc(`
				Host github-*
					Hostname github.com
			`),
			arg:  "ssh://git@github-foo/owner/repo.git",
			want: "ssh://git@github.com/owner/repo.git",
		},
		{
			name: "does not translate HTTPS URL",
			sshConfig: heredoc.Doc(`
				Host github-*
					Hostname github.com
			`),
			arg:  "https://github-foo/owner/repo.git",
			want: "https://github-foo/owner/repo.git",
		},
		{
			name: "treats ssh.github.com as github.com",
			sshConfig: heredoc.Doc(`
				Host github.com
					Hostname ssh.github.com
			`),
			arg:  "ssh://git@github.com/owner/repo.git",
			want: "ssh://git@github.com/owner/repo.git",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			f, err := os.CreateTemp("", "ssh-config.*")
			if err != nil {
				t.Fatalf("error creating file: %v", err)
			}
			_, err = f.WriteString(tt.sshConfig)
			_ = f.Close()
			if err != nil {
				t.Fatalf("error writing ssh config: %v", err)
			}

			tr := &Translator{
				newCommand: func(exe string, args ...string) *exec.Cmd {
					args = append([]string{"-F", f.Name()}, args...)
					return exec.Command(exe, args...)
				},
			}
			u, err := url.Parse(tt.arg)
			if err != nil {
				t.Fatalf("error parsing URL: %v", err)
			}
			res := tr.Translate(u)
			if got := res.String(); got != tt.want {
				t.Errorf("expected %q, got %q", tt.want, got)
			}
		})
	}
}

func TestHelperProcess(t *testing.T) {
	if os.Getenv("GH_WANT_HELPER_PROCESS") != "1" {
		return
	}
	if err := func(args []string) error {
		if len(args) < 3 || args[2] == "error" {
			return errors.New("fatal")
		}
		if args[2] == "empty.io" {
			return nil
		}
		fmt.Fprintf(os.Stdout, "hostname %s\n", args[2])
		return nil
	}(os.Args[3:]); err != nil {
		fmt.Fprintln(os.Stderr, err)
		os.Exit(1)
	}
	os.Exit(0)
}

func TestTranslator_caching(t *testing.T) {
	countLookPath := 0
	countNewCommand := 0
	tr := &Translator{
		lookPath: func(s string) (string, error) {
			countLookPath++
			return "/path/to/ssh", nil
		},
		newCommand: func(exe string, args ...string) *exec.Cmd {
			args = append([]string{"-test.run=TestHelperProcess", "--", exe}, args...)
			c := exec.Command(os.Args[0], args...)
			c.Env = []string{"GH_WANT_HELPER_PROCESS=1"}
			countNewCommand++
			return c
		},
	}

	tests := []struct {
		input  string
		result string
	}{
		{
			input:  "ssh://github1.com/owner/repo.git",
			result: "github1.com",
		},
		{
			input:  "ssh://github2.com/owner/repo.git",
			result: "github2.com",
		},
		{
			input:  "ssh://empty.io/owner/repo.git",
			result: "empty.io",
		},
		{
			input:  "ssh://error/owner/repo.git",
			result: "error",
		},
	}
	for _, tt := range tests {
		t.Run(tt.input, func(t *testing.T) {
			u, err := url.Parse(tt.input)
			if err != nil {
				t.Fatalf("error parsing URL: %v", err)
			}
			if res := tr.Translate(u); res.Host != tt.result {
				t.Errorf("expected github.com, got: %q", res.Host)
			}
			if res := tr.Translate(u); res.Host != tt.result {
				t.Errorf("expected github.com, got: %q (second call)", res.Host)
			}
		})
	}

	if countLookPath != 1 {
		t.Errorf("expected lookPath to happen 1 time; actual: %d", countLookPath)
	}
	if countNewCommand != len(tests) {
		t.Errorf("expected ssh command to shell out %d times; actual: %d", len(tests), countNewCommand)
	}
}