-
Notifications
You must be signed in to change notification settings - Fork 5
/
gitlab.go
236 lines (197 loc) · 7.12 KB
/
gitlab.go
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
// Copyright © 2017-2020 Olivier Robardet
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package main
import (
"encoding/json"
"errors"
"fmt"
"gitlab.com/orobardet/gitlab-ci-linter/config"
"io/ioutil"
"net"
"net/http"
"os"
"path"
"path/filepath"
"strings"
"time"
)
// Filename of a gitlab-ci file. Used to find the gitlab-ci file if no path are given at calls
const gitlabCiFileName = ".gitlab-ci.yml"
// Default Gitlab instance URL to use
const defaultGitlabRootURL = "https://gitlab.com"
// Path of the Gitlab CI lint API, to be used on the root url
const gitlabAPICiLintPath = "/api/v4/ci/lint"
// GitlabAPILintRequest struct represents the JSON body of a request sent to the Gitlab API /ci/lint
type GitlabAPILintRequest struct {
Content string `json:"content"`
}
// GitlabAPILintResponse struct represents the JSON body of a response from the Gitlab API /ci/lint
type GitlabAPILintResponse struct {
Status string `json:"status,omitempty"`
Error string `json:"error,omitempty"`
Errors []string `json:"errors,omitempty"`
MergedYaml string `json:"merged_yaml,omitempty"`
}
// Search in the given directory a git repository directory
// It goes up in the filesystem hierarchy until a repository is found, or the root is reach
func findGitlabCiFile(directory string) (string, error) {
candidate := path.Join(directory, gitlabCiFileName)
fileInfo, err := os.Stat(candidate)
if !os.IsNotExist(err) && !fileInfo.IsDir() {
return candidate, nil
}
// If we are at the root of the filesystem, it means we did not find any gitlab-ci file
if directory[len(directory)-1] == filepath.Separator {
return "", errors.New("not found")
}
return findGitlabCiFile(filepath.Dir(directory))
}
func initGitlabHTTPClientRequest(method string, url string, content string) (*http.Client, *http.Request, error) {
var httpClient *http.Client
var req *http.Request
httpClient = &http.Client{
Transport: &http.Transport{
Proxy: http.ProxyFromEnvironment,
DialContext: (&net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
}).DialContext,
ForceAttemptHTTP2: false,
MaxIdleConns: 100,
IdleConnTimeout: 90 * time.Second,
TLSHandshakeTimeout: 10 * time.Second,
ExpectContinueTimeout: 1 * time.Second,
},
Timeout: time.Second * time.Duration(httpRequestTimeout),
}
req, err := http.NewRequest(method, url, strings.NewReader(content))
req.Header.Add("Accept", "*/*")
req.Header.Add("Content-Type", "application/json")
req.Header.Add("User-Agent", fmt.Sprintf("%s/%s", config.APPNAME, config.VERSION))
if personalAccessToken != "" {
req.Header.Add("PRIVATE-TOKEN", personalAccessToken)
}
return httpClient, req, err
}
// Check if we can get a response with the rootUrl on the API CI Lint endpoint, and if a redirection occurs
// If a redirection is detected, return the redirected root URL.
// This is needed as redirection response only occurs when the API is call using en HTTP GET, but in the en the API
// has to be called in POST
func checkGitlabAPIUrl(rootURL string) (string, error) {
newRootURL := rootURL
lintURL := rootURL + gitlabAPICiLintPath
if verboseMode {
fmt.Printf("Checking '%s' (using '%s')...\n", rootURL, lintURL)
}
httpClient, req, err := initGitlabHTTPClientRequest("GET", lintURL, "")
if err != nil {
return newRootURL, fmt.Errorf("Unable to create an HTTP client: %w", err)
}
resp, err := httpClient.Do(req)
if err != nil {
fmt.Printf("%+v\n", req.Header)
return newRootURL, fmt.Errorf("HTTP request error: %w", err)
}
defer resp.Body.Close()
// Getting the full URL used for the last query, after following potential redirection
lastURL := resp.Request.URL.String()
// Let's try to get the redirected root URL by removing the gitlab API path from the last use URL
lastRootURL := strings.TrimSuffix(lastURL, gitlabAPICiLintPath)
// If the result is not empty or unchanged, it means
if lastRootURL != "" && lastRootURL != lastURL {
newRootURL = lastRootURL
}
if verboseMode {
fmt.Printf("Url '%s' validated\n", newRootURL)
}
return newRootURL, nil
}
// Send the content of a gitlab-ci file to a Gitlab instance lint API to check its validity
// In case of invalid, lint error messages are returned in `msgs`
func lintGitlabCIUsingAPI(rootURL string, ciFileContent string) (status bool, msgs []string, err error) {
msgs = []string{}
status = false
// Prepare the JSON content of the POST request:
// {
// "content": "<ESCAPED CONTENT OF THE GITLAB-CI FILE>"
// }
var reqParams = GitlabAPILintRequest{Content: ciFileContent}
reqBody, _ := json.Marshal(reqParams)
// Prepare requesting the API
lintURL := fmt.Sprintf("%s%s?include_merged_yaml=%t", rootURL, gitlabAPICiLintPath, includeMergedYaml)
if verboseMode {
fmt.Printf("Querying %s...\n", lintURL)
}
httpClient, req, err := initGitlabHTTPClientRequest("POST", lintURL, string(reqBody))
if err != nil {
err = fmt.Errorf("Unable to create an HTTP client: %w", err)
return
}
// Make the request to the API
resp, err := httpClient.Do(req)
if err != nil {
err = fmt.Errorf("HTTP request error: %w", err)
return
}
defer resp.Body.Close()
// Get the results
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
err = fmt.Errorf("Unable to parse response: %w", err)
return
}
var result GitlabAPILintResponse
err = json.Unmarshal([]byte(body), &result)
if err != nil {
err = fmt.Errorf("Unable to parse JSON response: %w", err)
return
}
if result.MergedYaml != "" {
fmt.Printf("Merged yaml: %s\n", result.MergedYaml)
}
// Analyse the results
if result.Status == "valid" {
status = true
err = nil
return
}
if result.Status == "invalid" {
msgs = result.Errors
}
if result.Error != "" {
err = fmt.Errorf("API respond %s", result.Error)
}
return
}
func guessGitlabAPIFromGitRemoteURL(remoteURL string) (apiRootURL string, err error) {
httpRemoteURL, err := checkGitlabAPIUrl(httpiseRemoteURL(remoteURL))
if err != nil {
return "", err
}
if httpRemoteURL != "" {
apiRootURL = httpRemoteURL
if verboseMode {
fmt.Printf("API url found: %s\n", httpRemoteURL)
}
} else {
return "", errors.New("Unknown error occurs")
}
return
}