Merge pull request moby#3427 from JordanGoasdoue/chore-allow-mirror-path

feat: handle mirror url with path

Author: tonistiigi

docs/buildkitd.toml.md

@@ -95,7 +95,8 @@ insecure-entitlements = [ "network.host", "security.insecure" ]
 
 # registry configures a new Docker register used for cache import or output.
 [registry."docker.io"]
-  mirrors = ["yourmirror.local:5000"]
+  # mirror configuration to handle path in case a mirror registry requires a /project path rather than just a host:port
+  mirrors = ["yourmirror.local:5000", "core.harbor.domain/proxy.docker.io"]
   http = true
   insecure = true
   ca=["/etc/config/myca.pem"]

util/resolver/resolver.go

@@ -6,6 +6,7 @@ import (
 	"net"
 	"net/http"
 	"os"
+	"path"
 	"path/filepath"
 	"runtime"
 	"strings"
@@ -17,6 +18,10 @@ import (
 	"github.com/pkg/errors"
 )
 
+const (
+	defaultPath = "/v2"
+)
+
 func fillInsecureOpts(host string, c config.RegistryConfig, h docker.RegistryHost) ([]docker.RegistryHost, error) {
 	var hosts []docker.RegistryHost
 
@@ -126,14 +131,7 @@ func NewRegistryConfig(m map[string]config.RegistryConfig) docker.RegistryHosts
 			var out []docker.RegistryHost
 
 			for _, mirror := range c.Mirrors {
-				h := docker.RegistryHost{
-					Scheme:       "https",
-					Client:       newDefaultClient(),
-					Host:         mirror,
-					Path:         "/v2",
-					Capabilities: docker.HostCapabilityPull | docker.HostCapabilityResolve,
-				}
-
+				h := newMirrorRegistryHost(mirror)
 				hosts, err := fillInsecureOpts(mirror, m[mirror], h)
 				if err != nil {
 					return nil, err
@@ -169,6 +167,20 @@ func NewRegistryConfig(m map[string]config.RegistryConfig) docker.RegistryHosts
 	)
 }
 
+func newMirrorRegistryHost(mirror string) docker.RegistryHost {
+	mirrorHost, mirrorPath := extractMirrorHostAndPath(mirror)
+	path := path.Join(defaultPath, mirrorPath)
+	h := docker.RegistryHost{
+		Scheme:       "https",
+		Client:       newDefaultClient(),
+		Host:         mirrorHost,
+		Path:         path,
+		Capabilities: docker.HostCapabilityPull | docker.HostCapabilityResolve,
+	}
+
+	return h
+}
+
 func newDefaultClient() *http.Client {
 	return &http.Client{
 		Transport: tracing.NewTransport(newDefaultTransport()),

util/resolver/resolver_test.go

@@ -0,0 +1,68 @@
+package resolver
+
+import (
+	"bytes"
+	"path"
+	"testing"
+
+	"github.com/moby/buildkit/cmd/buildkitd/config"
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewMirrorRegistryHost(t *testing.T) {
+	const testConfig = `
+[registry."docker.io"]
+mirrors = ["hub.docker.io", "yourmirror.local:5000/proxy.docker.io"]
+[registry."quay.io"]
+mirrors = ["yourmirror.local:5000/proxy.quay.io"]
+[registry."fake.io"]
+mirrors = ["https://url/", "https://url/path/"]
+`
+
+	tests := map[string]struct {
+		description string
+		host        string
+		path        string
+	}{
+		"hub.docker.io": {
+			description: "docker_io_mirror_without_path",
+			host:        "hub.docker.io",
+			path:        defaultPath,
+		},
+		"yourmirror.local:5000/proxy.docker.io": {
+			description: "docker_io_mirror_with_path",
+			host:        "yourmirror.local:5000",
+			path:        path.Join(defaultPath, "proxy.docker.io"),
+		},
+		"yourmirror.local:5000/proxy.quay.io": {
+			description: "docker_quay_mirror_with_path",
+			host:        "yourmirror.local:5000",
+			path:        path.Join(defaultPath, "proxy.quay.io"),
+		},
+		"https://url/": {
+			description: "docker_fake_mirror_scheme_without_path",
+			host:        "url",
+			path:        defaultPath,
+		},
+		"https://url/path/": {
+			description: "docker_fake_mirror_scheme_with_path",
+			host:        "url",
+			path:        path.Join(defaultPath, "path"),
+		},
+	}
+
+	cfg, err := config.Load(bytes.NewBuffer([]byte(testConfig)))
+	require.NoError(t, err)
+
+	require.NotEqual(t, len(cfg.Registries), 0)
+	for _, registry := range cfg.Registries {
+		require.NotEqual(t, len(registry.Mirrors), 0)
+		for _, m := range registry.Mirrors {
+			test := tests[m]
+			h := newMirrorRegistryHost(m)
+			require.NotEqual(t, h, nil)
+			require.Equal(t, h.Host, test.host)
+			require.Equal(t, h.Path, test.path)
+		}
+	}
+}

util/resolver/utils.go

@@ -0,0 +1,22 @@
+package resolver
+
+import (
+	"fmt"
+	"net/url"
+	"strings"
+)
+
+func extractMirrorHostAndPath(mirror string) (string, string) {
+	var path string
+	host := mirror
+
+	u, err := url.Parse(mirror)
+	if err != nil || u.Host == "" {
+		u, err = url.Parse(fmt.Sprintf("//%s", mirror))
+	}
+	if err != nil || u.Host == "" {
+		return host, path
+	}
+
+	return u.Host, strings.TrimRight(u.Path, "/")
+}