gitlabhq/gitlab-shell

View on GitHub
client/httpclient_test.go

Summary

Maintainability
A
0 mins
Test Coverage
package client

import (
    "context"
    "encoding/base64"
    "fmt"
    "io"
    "net/http"
    "strings"
    "testing"
    "time"

    "github.com/stretchr/testify/assert"
    "github.com/stretchr/testify/require"
    "gitlab.com/gitlab-org/gitlab-shell/v14/client/testserver"
)

func TestReadTimeout(t *testing.T) {
    expectedSeconds := uint64(300)

    client, err := NewHTTPClientWithOpts("http://localhost:3000", "", "", "", expectedSeconds, nil)
    require.NoError(t, err)

    require.NotNil(t, client)
    require.Equal(t, time.Duration(expectedSeconds)*time.Second, client.RetryableHTTP.HTTPClient.Timeout)
}

const (
    username = "basic_auth_user"
    password = "basic_auth_password"
)

func TestBasicAuthSettings(t *testing.T) {
    requests := []testserver.TestRequestHandler{
        {
            Path: "/api/v4/internal/get_endpoint",
            Handler: func(w http.ResponseWriter, r *http.Request) {
                assert.Equal(t, http.MethodGet, r.Method)

                fmt.Fprint(w, r.Header.Get("Authorization"))
            },
        },
        {
            Path: "/api/v4/internal/post_endpoint",
            Handler: func(w http.ResponseWriter, r *http.Request) {
                assert.Equal(t, http.MethodPost, r.Method)

                fmt.Fprint(w, r.Header.Get("Authorization"))
            },
        },
    }

    client := setup(t, username, password, requests)

    response, err := client.Get(context.Background(), "/get_endpoint")
    require.NoError(t, err)
    testBasicAuthHeaders(t, response)

    response, err = client.Post(context.Background(), "/post_endpoint", nil)
    require.NoError(t, err)
    testBasicAuthHeaders(t, response)
}

func testBasicAuthHeaders(t *testing.T, response *http.Response) {
    defer response.Body.Close()

    require.NotNil(t, response)
    responseBody, err := io.ReadAll(response.Body)
    require.NoError(t, err)

    headerParts := strings.Split(string(responseBody), " ")
    require.NotNil(t, headerParts)
    require.Equal(t, "Basic", headerParts[0])

    credentials, err := base64.StdEncoding.DecodeString(headerParts[1])
    require.NoError(t, err)

    require.Equal(t, username+":"+password, string(credentials))
}

func TestEmptyBasicAuthSettings(t *testing.T) {
    requests := []testserver.TestRequestHandler{
        {
            Path: "/api/v4/internal/empty_basic_auth",
            Handler: func(_ http.ResponseWriter, r *http.Request) {
                assert.Equal(t, "", r.Header.Get("Authorization"))
            },
        },
    }

    client := setup(t, "", "", requests)

    resp, err := client.Get(context.Background(), "/empty_basic_auth")
    require.NoError(t, err)
    resp.Body.Close()
}

func TestRequestWithUserAgent(t *testing.T) {
    const gitalyUserAgent = "gitaly/13.5.0"
    requests := []testserver.TestRequestHandler{
        {
            Path: "/api/v4/internal/default_user_agent",
            Handler: func(_ http.ResponseWriter, r *http.Request) {
                assert.Equal(t, defaultUserAgent, r.UserAgent())
            },
        },
        {
            Path: "/api/v4/internal/override_user_agent",
            Handler: func(_ http.ResponseWriter, r *http.Request) {
                assert.Equal(t, gitalyUserAgent, r.UserAgent())
            },
        },
    }

    client := setup(t, "", "", requests)

    defaultUserAgentResp, err := client.Get(context.Background(), "/default_user_agent")
    require.NoError(t, err)

    client.SetUserAgent(gitalyUserAgent)
    overriddenUserAgentResp, err := client.Get(context.Background(), "/override_user_agent")
    require.NoError(t, err)

    defaultUserAgentResp.Body.Close()
    overriddenUserAgentResp.Body.Close()
}

func setup(t *testing.T, username, password string, requests []testserver.TestRequestHandler) *GitlabNetClient {
    url := testserver.StartHTTPServer(t, requests)

    httpClient, err := NewHTTPClientWithOpts(url, "", "", "", 1, nil)
    require.NoError(t, err)

    client, err := NewGitlabNetClient(username, password, "", httpClient)
    require.NoError(t, err)

    return client
}