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
|
package testdata
import (
"fmt"
"os"
"path/filepath"
"strings"
"testing"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitlab-pages/internal/source/gitlab/api"
)
type responseFn func(*testing.T, string) api.VirtualDomain
// DomainResponses holds the predefined API responses for certain domains
// that can be used with the GitLab API stub in acceptance tests
// Assume the working dir is inside shared/pages/
var DomainResponses = map[string]responseFn{
"zip-from-disk.gitlab.io": customDomain(projectConfig{
projectID: 123,
pathOnDisk: "@hashed/zip-from-disk.gitlab.io",
}),
"zip-from-disk-not-found.gitlab.io": customDomain(projectConfig{}),
// outside of working dir
"zip-not-allowed-path.gitlab.io": customDomain(projectConfig{pathOnDisk: "../../../../"}),
"group.gitlab-example.com": generateVirtualDomainFromDir("group", "group.gitlab-example.com", nil),
"CapitalGroup.gitlab-example.com": generateVirtualDomainFromDir("CapitalGroup", "CapitalGroup.gitlab-example.com", nil),
"group.404.gitlab-example.com": generateVirtualDomainFromDir("group.404", "group.404.gitlab-example.com", nil),
"group.https-only.gitlab-example.com": generateVirtualDomainFromDir("group.https-only", "group.https-only.gitlab-example.com", map[string]projectConfig{
"/project1": {
projectID: 1000,
https: true,
},
"/project2": {
projectID: 1100,
https: false,
},
}),
"domain.404.com": customDomain(projectConfig{
projectID: 1000,
pathOnDisk: "group.404/domain.404",
}),
"withacmechallenge.domain.com": customDomain(projectConfig{
projectID: 1234,
pathOnDisk: "group.acme/with.acme.challenge",
}),
// NOTE: before adding more domains here, generate the zip archive by running (per project)
// make zip PROJECT_SUBDIR=group/serving
// make zip PROJECT_SUBDIR=group/project2
}
// generateVirtualDomainFromDir walks the subdirectory inside of shared/pages/ to find any zip archives.
// It works for subdomains of pages-domain but not for custom domains (yet)
func generateVirtualDomainFromDir(dir, rootDomain string, perPrefixConfig map[string]projectConfig) responseFn {
return func(t *testing.T, wd string) api.VirtualDomain {
t.Helper()
var foundZips []string
// walk over dir and save any paths containing a `.zip` file
// $(GITLAB_PAGES_DIR)/shared/pages + "/" + group
cleanDir := filepath.Join(wd, dir)
// make sure resolved path inside dir is under wd to avoid https://securego.io/docs/rules/g304.html
require.Truef(t, strings.HasPrefix(cleanDir, wd), "path %q outside of wd %q", cleanDir, wd)
filepath.Walk(cleanDir, func(path string, info os.FileInfo, err error) error {
require.NoError(t, err)
if strings.HasSuffix(info.Name(), ".zip") {
project := strings.TrimPrefix(path, wd+"/"+dir)
foundZips = append(foundZips, project)
}
return nil
})
lookupPaths := make([]api.LookupPath, 0, len(foundZips))
// generate lookup paths
for _, project := range foundZips {
// if project = "group/subgroup/project/public.zip
// trim prefix group and suffix /public.zip
// so prefix = "/subgroup/project"
prefix := strings.TrimPrefix(project, dir)
prefix = strings.TrimSuffix(prefix, "/"+filepath.Base(project))
// use / as prefix when the current prefix matches the rootDomain, e.g.
// if request is group.gitlab-example.com/ and group/group.gitlab-example.com/public.zip exists
if prefix == "/"+rootDomain {
prefix = "/"
}
cfg, ok := perPrefixConfig[prefix]
if !ok {
cfg = projectConfig{}
}
lookupPath := api.LookupPath{
ProjectID: cfg.projectID,
AccessControl: cfg.accessControl,
HTTPSOnly: cfg.https,
Prefix: prefix,
Source: api.Source{
Type: "zip",
Path: fmt.Sprintf("file://%s", wd+"/"+dir+project),
},
}
lookupPaths = append(lookupPaths, lookupPath)
}
return api.VirtualDomain{
LookupPaths: lookupPaths,
}
}
}
type projectConfig struct {
// refer to makeGitLabPagesAccessStub for custom HTTP responses per projectID
projectID int
accessControl bool
https bool
pathOnDisk string
}
// customDomain with per project config
func customDomain(config projectConfig) responseFn {
return func(t *testing.T, wd string) api.VirtualDomain {
t.Helper()
return api.VirtualDomain{
Certificate: "",
Key: "",
LookupPaths: []api.LookupPath{
{
ProjectID: config.projectID,
AccessControl: config.accessControl,
HTTPSOnly: config.https,
// prefix should always be `/` for custom domains, otherwise `resolvePath` will try
// to look for files under public/prefix/ when serving content instead of just public/
// see internal/serving/disk/ for details
Prefix: "/",
Source: api.Source{
Type: "zip",
Path: fmt.Sprintf("file://%s/%s/public.zip", wd, config.pathOnDisk),
},
},
},
}
}
}
|
