internal/desktop/proxy_test.go - main - githubmirror/compose

internal/desktop/proxy_test.go
177 строк6 KB
Domantas Petrauskas
fix(publish): bypass Docker Desktop proxy for loopback registries
15 июн 2026, 22:18
15 июн 2026, 22:180afb4c8
/*
   Copyright 2026 Docker Compose CLI authors

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package desktop

import (
	"net/http"
	"os"
	"path/filepath"
	"runtime"
	"testing"

	"gotest.tools/v3/assert"
)

func TestHTTPProxySocketEndpoint_UnixSocketExists(t *testing.T) {
	dir := t.TempDir()
	cliSock := filepath.Join(dir, "docker-cli.sock")
	proxySock := filepath.Join(dir, "httpproxy.sock")
	mustTouch(t, cliSock)
	mustTouch(t, proxySock)

	got := httpProxySocketEndpoint("unix://" + cliSock)
	assert.Equal(t, got, "unix://"+proxySock)
}

func TestHTTPProxySocketEndpoint_UnixSocketMissing(t *testing.T) {
	// httpproxy.sock deliberately not created — older DD or partial install.
	dir := t.TempDir()
	cliSock := filepath.Join(dir, "docker-cli.sock")
	mustTouch(t, cliSock)

	got := httpProxySocketEndpoint("unix://" + cliSock)
	assert.Equal(t, got, "", "stat miss must fall back so callers do not dial a non-existent socket")
}

func TestHTTPProxySocketEndpoint_WindowsNamedPipe(t *testing.T) {
	// The derived proxy endpoint must keep the engine endpoint's exact prefix
	// and only swap the trailing pipe name, so the result stays dialable by
	// winio (docker/compose#13824).
	cases := []struct {
		name     string
		endpoint string
		want     string
	}{
		{
			// The form Docker Desktop actually reports (observed on DD 29.5.2):
			// backslash `\\.\pipe\` namespace.
			name:     "backslash form (real Docker Desktop)",
			endpoint: `npipe://\\.\pipe\docker_cli`,
			want:     `npipe://\\.\pipe\dockerHttpProxy`,
		},
		{
			// Forward-slash form some tooling uses; must work too.
			name:     "forward-slash form",
			endpoint: "npipe:////./pipe/dockerDesktopLinuxEngine",
			want:     "npipe:////./pipe/dockerHttpProxy",
		},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			assert.Equal(t, httpProxySocketEndpoint(tc.endpoint), tc.want)
		})
	}
}

func TestHTTPProxySocketEndpoint_EmptyOrUnknown(t *testing.T) {
	assert.Equal(t, httpProxySocketEndpoint(""), "")
	assert.Equal(t, httpProxySocketEndpoint("tcp://localhost:1234"), "")
}

func TestProxyTransport_NilWhenNoDockerDesktop(t *testing.T) {
	assert.Assert(t, ProxyTransport("") == nil,
		"must return nil so callers fall back to their own (e.g. containerd's) default transport")
}

func TestProxyTransport_NilWhenSocketMissing(t *testing.T) {
	// no httpproxy.sock created
	dir := t.TempDir()
	cliSock := filepath.Join(dir, "docker-cli.sock")
	mustTouch(t, cliSock)

	assert.Assert(t, ProxyTransport("unix://"+cliSock) == nil,
		"must return nil when DD endpoint is set but proxy socket is missing, not a transport that would dial a dead socket")
}

func TestProxyTransport_RoutesThroughDockerDesktop(t *testing.T) {
	if runtime.GOOS == "windows" {
		t.Skip("unix sockets test path; Windows uses named pipes which os.Stat handles differently")
	}
	dir := t.TempDir()
	cliSock := filepath.Join(dir, "docker-cli.sock")
	proxySock := filepath.Join(dir, "httpproxy.sock")
	mustTouch(t, cliSock)
	mustTouch(t, proxySock)

	got := ProxyTransport("unix://" + cliSock)
	tr, ok := got.(*http.Transport)
	assert.Assert(t, ok, "expected *http.Transport when DD endpoint is set and socket exists")
	assert.Assert(t, tr != http.DefaultTransport, "must be a clone, not DefaultTransport itself")

	// Verify the clone preserved http.DefaultTransport's production
	// settings (timeouts, idle pool, HTTP/2). Compare to the source
	// fields rather than asserting fixed values so this test follows
	// stdlib changes.
	src := http.DefaultTransport.(*http.Transport)
	assert.Equal(t, tr.MaxIdleConns, src.MaxIdleConns)
	assert.Equal(t, tr.IdleConnTimeout, src.IdleConnTimeout)
	assert.Equal(t, tr.TLSHandshakeTimeout, src.TLSHandshakeTimeout)
	assert.Equal(t, tr.ExpectContinueTimeout, src.ExpectContinueTimeout)
	assert.Equal(t, tr.ForceAttemptHTTP2, src.ForceAttemptHTTP2)
}

// TestDDProxyFunc_BypassesLoopbackOnly exercises the proxy selection directly
// (rather than through ProxyTransport, which needs a live socket) so it runs on
// every platform, including Windows. This is the core of the
// docker/compose#13824 fix: loopback targets must connect directly instead of
// being forced through the Docker Desktop proxy. Everything else — including
// hosts a local NO_PROXY would match — must still route through Desktop's
// proxy, so Desktop keeps ownership of proxy decisions (docker/compose#13825
// review).
func TestDDProxyFunc_BypassesLoopbackOnly(t *testing.T) {
	// Set NO_PROXY to confirm it is deliberately NOT honored: registry.internal
	// must still be proxied.
	t.Setenv("NO_PROXY", "registry.internal")
	t.Setenv("no_proxy", "registry.internal")

	proxyFunc := ddProxyFunc()

	cases := []struct {
		name      string
		reqURL    string
		wantProxy bool
	}{
		{"loopback name", "http://localhost:5000/v2/", false},
		{"loopback IPv4", "http://127.0.0.1:5000/v2/", false},
		{"loopback IPv4 subnet", "http://127.5.6.7:5000/v2/", false},
		{"loopback IPv6", "http://[::1]:5000/v2/", false},
		{"NO_PROXY host is not honored", "https://registry.internal/v2/", true},
		{"external https", "https://registry-1.docker.io/v2/", true},
		{"external http", "http://example.com/v2/", true},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			req, err := http.NewRequest(http.MethodGet, tc.reqURL, http.NoBody)
			assert.NilError(t, err)
			proxyURL, err := proxyFunc(req)
			assert.NilError(t, err)
			if tc.wantProxy {
				assert.Assert(t, proxyURL != nil, "expected %s to route through the Docker Desktop proxy", tc.reqURL)
				assert.Equal(t, proxyURL.Host, ddProxyHost)
			} else {
				assert.Assert(t, proxyURL == nil, "expected %s to bypass the proxy and connect directly", tc.reqURL)
			}
		})
	}
}

func mustTouch(t *testing.T, path string) {
	t.Helper()
	f, err := os.Create(path)
	assert.NilError(t, err)
	assert.NilError(t, f.Close())
}