diff options
Diffstat (limited to 'workhorse/internal/api')
-rw-r--r-- | workhorse/internal/api/api.go | 23 | ||||
-rw-r--r-- | workhorse/internal/api/api_test.go | 47 |
2 files changed, 47 insertions, 23 deletions
diff --git a/workhorse/internal/api/api.go b/workhorse/internal/api/api.go index 7f696f70c7a..896f59a322a 100644 --- a/workhorse/internal/api/api.go +++ b/workhorse/internal/api/api.go @@ -64,7 +64,13 @@ func NewAPI(myURL *url.URL, version string, roundTripper http.RoundTripper) *API } type GeoProxyEndpointResponse struct { - GeoProxyURL string `json:"geo_proxy_url"` + GeoProxyURL string `json:"geo_proxy_url"` + GeoProxyExtraData string `json:"geo_proxy_extra_data"` +} + +type GeoProxyData struct { + GeoProxyURL *url.URL + GeoProxyExtraData string } type HandleFunc func(http.ResponseWriter, *http.Request, *Response) @@ -394,7 +400,7 @@ func validResponseContentType(resp *http.Response) bool { return helper.IsContentType(ResponseContentType, resp.Header.Get("Content-Type")) } -func (api *API) GetGeoProxyURL() (*url.URL, error) { +func (api *API) GetGeoProxyData() (*GeoProxyData, error) { geoProxyApiUrl := *api.URL geoProxyApiUrl.Path, geoProxyApiUrl.RawPath = joinURLPath(api.URL, geoProxyEndpointPath) geoProxyApiReq := &http.Request{ @@ -405,23 +411,26 @@ func (api *API) GetGeoProxyURL() (*url.URL, error) { httpResponse, err := api.doRequestWithoutRedirects(geoProxyApiReq) if err != nil { - return nil, fmt.Errorf("GetGeoProxyURL: do request: %v", err) + return nil, fmt.Errorf("GetGeoProxyData: do request: %v", err) } defer httpResponse.Body.Close() if httpResponse.StatusCode != http.StatusOK { - return nil, fmt.Errorf("GetGeoProxyURL: Received HTTP status code: %v", httpResponse.StatusCode) + return nil, fmt.Errorf("GetGeoProxyData: Received HTTP status code: %v", httpResponse.StatusCode) } response := &GeoProxyEndpointResponse{} if err := json.NewDecoder(httpResponse.Body).Decode(response); err != nil { - return nil, fmt.Errorf("GetGeoProxyURL: decode response: %v", err) + return nil, fmt.Errorf("GetGeoProxyData: decode response: %v", err) } geoProxyURL, err := url.Parse(response.GeoProxyURL) if err != nil { - return nil, fmt.Errorf("GetGeoProxyURL: Could not parse Geo proxy URL: %v, err: %v", response.GeoProxyURL, err) + return nil, fmt.Errorf("GetGeoProxyData: Could not parse Geo proxy URL: %v, err: %v", response.GeoProxyURL, err) } - return geoProxyURL, nil + return &GeoProxyData{ + GeoProxyURL: geoProxyURL, + GeoProxyExtraData: response.GeoProxyExtraData, + }, nil } diff --git a/workhorse/internal/api/api_test.go b/workhorse/internal/api/api_test.go index b82bb55fb85..346f32b4a36 100644 --- a/workhorse/internal/api/api_test.go +++ b/workhorse/internal/api/api_test.go @@ -4,7 +4,6 @@ import ( "fmt" "net/http" "net/http/httptest" - "net/url" "regexp" "testing" @@ -18,21 +17,37 @@ import ( "gitlab.com/gitlab-org/gitlab/workhorse/internal/upstream/roundtripper" ) -func TestGetGeoProxyURLWhenGeoSecondary(t *testing.T) { - geoProxyURL, err := getGeoProxyURLGivenResponse(t, `{"geo_proxy_url":"http://primary"}`) - - require.NoError(t, err) - require.Equal(t, "http://primary", geoProxyURL.String()) -} - -func TestGetGeoProxyURLWhenGeoPrimaryOrNonGeo(t *testing.T) { - geoProxyURL, err := getGeoProxyURLGivenResponse(t, "{}") - - require.NoError(t, err) - require.Equal(t, "", geoProxyURL.String()) +func TestGetGeoProxyDataForResponses(t *testing.T) { + testCases := []struct { + desc string + json string + expectedError bool + expectedURL string + expectedExtraData string + }{ + {"when Geo secondary", `{"geo_proxy_url":"http://primary","geo_proxy_extra_data":"geo-data"}`, false, "http://primary", "geo-data"}, + {"when Geo secondary with explicit null data", `{"geo_proxy_url":"http://primary","geo_proxy_extra_data":null}`, false, "http://primary", ""}, + {"when Geo secondary without extra data", `{"geo_proxy_url":"http://primary"}`, false, "http://primary", ""}, + {"when Geo primary or no node", `{}`, false, "", ""}, + {"for malformed request", `non-json`, true, "", ""}, + } + + for _, tc := range testCases { + t.Run(tc.desc, func(t *testing.T) { + geoProxyData, err := getGeoProxyDataGivenResponse(t, tc.json) + + if tc.expectedError { + require.Error(t, err) + } else { + require.NoError(t, err) + require.Equal(t, tc.expectedURL, geoProxyData.GeoProxyURL.String()) + require.Equal(t, tc.expectedExtraData, geoProxyData.GeoProxyExtraData) + } + }) + } } -func getGeoProxyURLGivenResponse(t *testing.T, givenInternalApiResponse string) (*url.URL, error) { +func getGeoProxyDataGivenResponse(t *testing.T, givenInternalApiResponse string) (*GeoProxyData, error) { t.Helper() ts := testRailsServer(regexp.MustCompile(`/api/v4/geo/proxy`), 200, givenInternalApiResponse) defer ts.Close() @@ -43,9 +58,9 @@ func getGeoProxyURLGivenResponse(t *testing.T, givenInternalApiResponse string) apiClient := NewAPI(backend, version, rt) - geoProxyURL, err := apiClient.GetGeoProxyURL() + geoProxyData, err := apiClient.GetGeoProxyData() - return geoProxyURL, err + return geoProxyData, err } func testRailsServer(url *regexp.Regexp, code int, body string) *httptest.Server { |