Function TestWithoutFollowingRedirects

api/client_test.go:366–412

TestWithoutFollowingRedirects verifies that WithoutFollowingRedirects stops the request at the redirect and surfaces an HTTPError rather than following through. It also proves the redirect is not followed by recording every method the transport sees: without the option the transport would receive a

(t *testing.T)

// the correct behaviour for repo delete: the caller learns the operation failed rather than
// receiving a misleading success.
func TestWithoutFollowingRedirects(t *testing.T) {
	newCountingTransport := func(methods *[]string) http.RoundTripper {
		return roundTripFunc(func(req *http.Request) (*http.Response, error) {
			*methods = append(*methods, req.Method)
			resp := &http.Response{
				StatusCode: http.StatusMovedPermanently,
				Header:     http.Header{"Location": []string{"https://api.github.com/repos/OWNER/RENAMED"}},
				Body:       io.NopCloser(bytes.NewBufferString("")),
				Request:    req,
			}
			return resp, nil
		})
	}

	t.Run("without option: redirect is followed, DELETE becomes GET", func(t *testing.T) {
		var methods []string
		transport := newCountingTransport(&methods)
		// Second request (the followed redirect) must also be handled by the transport.
		redirectTransport := redirectFollowingTransport{
			inner:   transport,
			methods: &methods,
		}
		client := NewClientFromHTTP(&http.Client{Transport: redirectTransport})

		_, _ = client.Request("github.com", http.MethodDelete, "repos/OWNER/REPO", nil)

		// The transport sees DELETE then GET because Go's default policy demotes DELETE to GET.
		require.GreaterOrEqual(t, len(methods), 2)
		assert.Equal(t, http.MethodDelete, methods[0])
		assert.Equal(t, http.MethodGet, methods[1])
	})

	t.Run("with option: redirect is not followed, HTTPError carries redirect status", func(t *testing.T) {
		var methods []string
		client := NewClientFromHTTP(&http.Client{Transport: newCountingTransport(&methods)})

		_, err := client.Request("github.com", http.MethodDelete, "repos/OWNER/REPO", nil, WithoutFollowingRedirects())
		require.Error(t, err)

		var httpErr HTTPError
		require.ErrorAs(t, err, &httpErr)
		assert.Equal(t, http.StatusMovedPermanently, httpErr.StatusCode)

		// Transport is only asked for the original DELETE; the redirect is never followed.
		assert.Equal(t, []string{http.MethodDelete}, methods)
	})
}

// roundTripFunc lets a plain function satisfy http.RoundTripper.
type roundTripFunc func(*http.Request) (*http.Response, error)