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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
package main
import (
"bytes"
"crypto/tls"
"crypto/x509"
"fmt"
"io/ioutil"
"net"
"net/http"
"os"
"os/exec"
"strings"
"testing"
"time"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitlab-pages/internal/fixture"
)
type tWriter struct {
t *testing.T
}
func (t *tWriter) Write(b []byte) (int, error) {
t.t.Log(string(bytes.TrimRight(b, "\r\n")))
return len(b), nil
}
// The HTTPS certificate isn't signed by anyone. This http client is set up
// so it can talk to servers using it.
var (
TestHTTPSClient = &http.Client{
Transport: &http.Transport{
TLSClientConfig: &tls.Config{RootCAs: TestCertPool},
},
}
// Use HTTP with a very short timeout to repeatedly check for the server to be
// up. Again, ignore HTTP
QuickTimeoutHTTPSClient = &http.Client{
Transport: &http.Transport{
TLSClientConfig: &tls.Config{RootCAs: TestCertPool},
ResponseHeaderTimeout: 100 * time.Millisecond,
},
}
TestCertPool = x509.NewCertPool()
)
func init() {
if ok := TestCertPool.AppendCertsFromPEM([]byte(fixture.Certificate)); !ok {
fmt.Println("Failed to load cert!")
}
}
func CreateHTTPSFixtureFiles(t *testing.T) (key string, cert string) {
keyfile, err := ioutil.TempFile("", "https-fixture")
require.NoError(t, err)
key = keyfile.Name()
keyfile.Close()
certfile, err := ioutil.TempFile("", "https-fixture")
require.NoError(t, err)
cert = certfile.Name()
certfile.Close()
require.NoError(t, ioutil.WriteFile(key, []byte(fixture.Key), 0644))
require.NoError(t, ioutil.WriteFile(cert, []byte(fixture.Certificate), 0644))
return keyfile.Name(), certfile.Name()
}
// ListenSpec is used to point at a gitlab-pages http server, preserving the
// type of port it is (http, https, proxy)
type ListenSpec struct {
Type string
Host string
Port string
}
func (l ListenSpec) URL(suffix string) string {
scheme := "http"
if l.Type == "https" {
scheme = "https"
}
suffix = strings.TrimPrefix(suffix, "/")
return fmt.Sprintf("%s://%s/%s", scheme, l.JoinHostPort(), suffix)
}
// Returns only once this spec points at a working TCP server
func (l ListenSpec) WaitUntilRequestSucceeds(done chan struct{}) error {
timeout := 5 * time.Second
for start := time.Now(); time.Since(start) < timeout; {
select {
case <-done:
return fmt.Errorf("server has shut down already")
default:
}
req, err := http.NewRequest("GET", l.URL("/"), nil)
if err != nil {
return err
}
response, err := QuickTimeoutHTTPSClient.Transport.RoundTrip(req)
if err != nil {
time.Sleep(100 * time.Millisecond)
continue
}
response.Body.Close()
if code := response.StatusCode; code >= 200 && code < 500 {
return nil
}
time.Sleep(100 * time.Millisecond)
}
return fmt.Errorf("timed out after %v waiting for listener %v", timeout, l)
}
func (l ListenSpec) JoinHostPort() string {
return net.JoinHostPort(l.Host, l.Port)
}
// RunPagesProcess will start a gitlab-pages process with the specified listeners
// and return a function you can call to shut it down again. Use
// GetPageFromProcess to do a HTTP GET against a listener.
//
// If run as root via sudo, the gitlab-pages process will drop privileges
func RunPagesProcess(t *testing.T, pagesPath string, listeners []ListenSpec, promPort string, extraArgs ...string) (teardown func()) {
return runPagesProcess(t, true, pagesPath, listeners, promPort, nil, extraArgs...)
}
func RunPagesProcessWithoutWait(t *testing.T, pagesPath string, listeners []ListenSpec, promPort string, extraArgs ...string) (teardown func()) {
return runPagesProcess(t, false, pagesPath, listeners, promPort, nil, extraArgs...)
}
func RunPagesProcessWithSSLCertFile(t *testing.T, pagesPath string, listeners []ListenSpec, promPort string, sslCertFile string, extraArgs ...string) (teardown func()) {
return runPagesProcess(t, true, pagesPath, listeners, promPort, []string{"SSL_CERT_FILE=" + sslCertFile}, extraArgs...)
}
func RunPagesProcessWithAuth(t *testing.T, pagesPath string, listeners []ListenSpec, promPort string) (teardown func()) {
return runPagesProcess(t, true, pagesPath, listeners, promPort, nil, "-auth-client-id=1",
"-auth-client-secret=1",
"-auth-server=https://gitlab-auth.com",
"-auth-redirect-uri=https://projects.gitlab-example.com/auth",
"-auth-secret=something-very-secret")
}
func RunPagesProcessWithAuthServer(t *testing.T, pagesPath string, listeners []ListenSpec, promPort string, authServer string) (teardown func()) {
return runPagesProcess(t, true, pagesPath, listeners, promPort, nil, "-auth-client-id=1",
"-auth-client-secret=1",
"-auth-server="+authServer,
"-auth-redirect-uri=https://projects.gitlab-example.com/auth",
"-auth-secret=something-very-secret")
}
func RunPagesProcessWithAuthServerWithSSL(t *testing.T, pagesPath string, listeners []ListenSpec, promPort string, sslCertFile string, authServer string) (teardown func()) {
return runPagesProcess(t, true, pagesPath, listeners, promPort, []string{"SSL_CERT_FILE=" + sslCertFile}, "-auth-client-id=1",
"-auth-client-secret=1",
"-auth-server="+authServer,
"-auth-redirect-uri=https://projects.gitlab-example.com/auth",
"-auth-secret=something-very-secret")
}
func runPagesProcess(t *testing.T, wait bool, pagesPath string, listeners []ListenSpec, promPort string, extraEnv []string, extraArgs ...string) (teardown func()) {
_, err := os.Stat(pagesPath)
require.NoError(t, err)
args, tempfiles := getPagesArgs(t, listeners, promPort, extraArgs)
cmd := exec.Command(pagesPath, args...)
cmd.Env = append(os.Environ(), extraEnv...)
cmd.Stdout = &tWriter{t}
cmd.Stderr = &tWriter{t}
require.NoError(t, cmd.Start())
t.Logf("Running %s %v", pagesPath, args)
waitCh := make(chan struct{})
go func() {
cmd.Wait()
for _, tempfile := range tempfiles {
os.Remove(tempfile)
}
close(waitCh)
}()
cleanup := func() {
cmd.Process.Signal(os.Interrupt)
<-waitCh
}
if wait {
for _, spec := range listeners {
if err := spec.WaitUntilRequestSucceeds(waitCh); err != nil {
cleanup()
t.Fatal(err)
}
}
}
return cleanup
}
func getPagesArgs(t *testing.T, listeners []ListenSpec, promPort string, extraArgs []string) (args, tempfiles []string) {
var hasHTTPS bool
args = append(args, "-log-verbose=true")
for _, spec := range listeners {
args = append(args, "-listen-"+spec.Type, spec.JoinHostPort())
if spec.Type == "https" {
hasHTTPS = true
}
}
if hasHTTPS {
key, cert := CreateHTTPSFixtureFiles(t)
tempfiles = []string{key, cert}
args = append(args, "-root-key", key, "-root-cert", cert)
}
if promPort != "" {
args = append(args, "-metrics-address", promPort)
}
args = append(args, getPagesDaemonArgs(t)...)
args = append(args, extraArgs...)
return
}
func getPagesDaemonArgs(t *testing.T) []string {
mode := os.Getenv("TEST_DAEMONIZE")
if mode == "" {
return nil
}
if os.Geteuid() != 0 {
t.Log("Privilege-dropping requested but not running as root!")
t.FailNow()
return nil
}
out := []string{}
switch mode {
case "tmpdir":
out = append(out, "-daemon-inplace-chroot=false")
case "inplace":
out = append(out, "-daemon-inplace-chroot=true")
default:
t.Log("Unknown daemonize mode", mode)
t.FailNow()
return nil
}
t.Log("Running pages as a daemon")
// This triggers the drop-privileges-and-chroot code in the pages daemon
out = append(out, "-daemon-uid", "0")
out = append(out, "-daemon-gid", "65534")
return out
}
// Does a HTTP(S) GET against the listener specified, setting a fake
// Host: and constructing the URL from the listener and the URL suffix.
func GetPageFromListener(t *testing.T, spec ListenSpec, host, urlsuffix string) (*http.Response, error) {
return GetPageFromListenerWithCookie(t, spec, host, urlsuffix, "")
}
func GetPageFromListenerWithCookie(t *testing.T, spec ListenSpec, host, urlsuffix string, cookie string) (*http.Response, error) {
url := spec.URL(urlsuffix)
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return nil, err
}
if cookie != "" {
req.Header.Set("Cookie", cookie)
}
req.Host = host
return DoPagesRequest(t, req)
}
func GetProxiedPageFromListener(t *testing.T, spec ListenSpec, host, xForwardedHost, urlsuffix string) (*http.Response, error) {
url := spec.URL(urlsuffix)
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return nil, err
}
req.Host = host
req.Header.Set("X-Forwarded-Host", xForwardedHost)
return DoPagesRequest(t, req)
}
func DoPagesRequest(t *testing.T, req *http.Request) (*http.Response, error) {
t.Logf("curl -X %s -H'Host: %s' %s", req.Method, req.Host, req.URL)
return TestHTTPSClient.Do(req)
}
func GetRedirectPage(t *testing.T, spec ListenSpec, host, urlsuffix string) (*http.Response, error) {
return GetRedirectPageWithCookie(t, spec, host, urlsuffix, "")
}
func GetRedirectPageWithCookie(t *testing.T, spec ListenSpec, host, urlsuffix string, cookie string) (*http.Response, error) {
url := spec.URL(urlsuffix)
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return nil, err
}
if cookie != "" {
req.Header.Set("Cookie", cookie)
}
req.Host = host
return TestHTTPSClient.Transport.RoundTrip(req)
}
func ClientWithCiphers(ciphers []uint16) (*http.Client, func()) {
tr := &http.Transport{
TLSClientConfig: &tls.Config{
RootCAs: TestCertPool,
CipherSuites: ciphers,
},
}
client := &http.Client{Transport: tr}
return client, tr.CloseIdleConnections
}
func waitForRoundtrips(t *testing.T, listeners []ListenSpec, timeout time.Duration) {
nListening := 0
start := time.Now()
for _, spec := range listeners {
for time.Since(start) < timeout {
req, err := http.NewRequest("GET", spec.URL("/"), nil)
if err != nil {
t.Fatal(err)
}
if response, err := QuickTimeoutHTTPSClient.Transport.RoundTrip(req); err == nil {
nListening++
response.Body.Close()
break
}
time.Sleep(100 * time.Millisecond)
}
}
require.Equal(t, len(listeners), nListening, "all listeners must be accepting TCP connections")
}
|