cuelang.org/go@v0.10.1/internal/mod/modresolve/resolve_test.go

package modresolve

import (
	"crypto/sha256"
	"fmt"
	"strings"
	"testing"

	"cuelang.org/go/cue"
	"cuelang.org/go/cue/cuecontext"
	"github.com/go-quicktest/qt"
)

func TestRegistryConfigSchema(t *testing.T) {
	schema := RegistryConfigSchema()
	// Sanity check that it parses OK as CUE and can
	// validate a legitimate schema.
	ctx := cuecontext.New()
	v := ctx.CompileString(schema)
	fileSchema := v.LookupPath(cue.MakePath(cue.Def("#file")))
	qt.Assert(t, qt.IsNil(fileSchema.Err()))
	cfgVal := ctx.CompileString(`defaultRegistry: registry: "something.example"`)
	qt.Assert(t, qt.IsNil(cfgVal.Err()))
	cfgVal = cfgVal.Unify(fileSchema)
	qt.Assert(t, qt.IsNil(cfgVal.Err()))
}

func TestParseCUERegistry(t *testing.T) {
	testCases := []struct {
		testName        string
		in              string
		catchAllDefault string
		err             string
		wantAllHosts    []Host
		lookups         map[string]*Location
	}{{
		testName: "MultipleFallbacks",
		in:       "registry.somewhere,registry.other",
		err:      "duplicate catch-all registry",
	}, {
		testName:        "NoRegistryOrDefault",
		catchAllDefault: "",
		err:             "no catch-all registry or default",
	}, {
		testName: "InvalidRegistry",
		in:       "$#foo",
		err:      `invalid registry "\$#foo": invalid host name "\$#foo" in registry`,
	}, {
		testName: "InvalidSecuritySuffix",
		in:       "foo.com+bogus",
		err:      `invalid registry "foo.com\+bogus": unknown suffix \("\+bogus"\), need \+insecure, \+secure or no suffix\)`,
	}, {
		testName: "IPV6AddrWithoutBrackets",
		in:       "::1",
		err:      `invalid registry "::1": invalid host name "::1" in registry`,
	}, {
		testName: "EmptyElement",
		in:       "foo.com,",
		err:      `empty registry part`,
	}, {
		testName: "MissingPrefix",
		in:       "=foo.com",
		err:      `empty module prefix`,
	}, {
		testName: "MissingRegistry",
		in:       "x.com=",
		err:      `empty registry reference`,
	}, {
		testName: "InvalidModulePrefix",
		in:       "foo#=foo.com",
		err:      `invalid module path "foo#": invalid char '#'`,
	}, {
		testName: "DuplicateModulePrefix",
		in:       "x.com=r.org,x.com=q.org",
		err:      `duplicate module prefix "x.com"`,
	}, {
		testName: "NoDefaultCatchAll",
		in:       "x.com=r.org",
		err:      `no default catch-all registry provided`,
	}, {
		testName:        "InvalidCatchAll",
		in:              "x.com=r.org",
		catchAllDefault: "bogus",
		err:             `invalid catch-all registry "bogus": invalid host name "bogus" in registry`,
	}, {
		testName: "InvalidRegistryRef",
		in:       "foo.com//bar",
		err:      `invalid registry "foo.com//bar": invalid reference syntax \("foo.com//bar"\)`,
	}, {
		testName: "RegistryRefWithDigest",
		in:       "foo.com/bar@sha256:f3c16f525a1b7c204fc953d6d7db7168d84ebf4902f83c3a37d113b18c28981f",
		err:      `invalid registry "foo.com/bar@sha256:f3c16f525a1b7c204fc953d6d7db7168d84ebf4902f83c3a37d113b18c28981f": cannot have an associated tag or digest`,
	}, {
		testName: "RegistryRefWithTag",
		in:       "foo.com/bar:sometag",
		err:      `invalid registry "foo.com/bar:sometag": cannot have an associated tag or digest`,
	}, {
		testName: "MismatchedSecurity",
		in:       "foo.com/bar+secure,other.example=foo.com/bar+insecure",
		err:      `registry host "foo.com" is specified both as secure and insecure`,
	}, {
		testName:        "SingleCatchAll",
		catchAllDefault: "registry.somewhere",
		wantAllHosts:    []Host{{"registry.somewhere", false}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "registry.somewhere",
				Repository: "fruit.com/apple",
			},
		},
	}, {
		testName:     "CatchAllWithNoDefault",
		in:           "registry.somewhere",
		wantAllHosts: []Host{{"registry.somewhere", false}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "registry.somewhere",
				Repository: "fruit.com/apple",
			},
		},
	}, {
		testName:        "CatchAllWithDefault",
		in:              "registry.somewhere",
		catchAllDefault: "other.cue.somewhere",
		wantAllHosts:    []Host{{"registry.somewhere", false}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "registry.somewhere",
				Repository: "fruit.com/apple",
			},
			"": nil,
		},
	}, {
		testName:     "PrefixWithCatchAllNoDefault",
		in:           "example.com=registry.example.com/offset,registry.somewhere",
		wantAllHosts: []Host{{"registry.example.com", false}, {"registry.somewhere", false}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "registry.somewhere",
				Repository: "fruit.com/apple",
			},
			"example.com/blah": {
				Host:       "registry.example.com",
				Repository: "offset/example.com/blah",
			},
			"example.com": {
				Host:       "registry.example.com",
				Repository: "offset/example.com",
			},
		},
	}, {
		testName:        "PrefixWithCatchAllDefault",
		in:              "example.com=registry.example.com/offset",
		catchAllDefault: "registry.somewhere",
		wantAllHosts:    []Host{{"registry.example.com", false}, {"registry.somewhere", false}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "registry.somewhere",
				Repository: "fruit.com/apple",
			},
			"example.com/blah": {
				Host:       "registry.example.com",
				Repository: "offset/example.com/blah",
			},
		},
	}, {
		testName:        "PrefixWithCatchAllDefaultAndExplicitNoneFallback",
		in:              "example.com=registry.example.com/offset,none",
		catchAllDefault: "registry.somewhere",
		wantAllHosts:    []Host{{"registry.example.com", false}},
		lookups: map[string]*Location{
			"fruit.com/apple": nil,
			"example.com/blah": {
				Host:       "registry.example.com",
				Repository: "offset/example.com/blah",
			},
		},
	}, {
		testName:        "PrefixWithExplicitNone",
		in:              "example.com=none",
		catchAllDefault: "registry.somewhere",
		wantAllHosts:    []Host{{"registry.somewhere", false}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "registry.somewhere",
				Repository: "fruit.com/apple",
			},
			"example.com/blah": nil,
		},
	}, {
		testName:     "LocalhostIsInsecure",
		in:           "localhost:5000",
		wantAllHosts: []Host{{"localhost:5000", true}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "localhost:5000",
				Insecure:   true,
				Repository: "fruit.com/apple",
			},
		},
	}, {
		testName:     "SecureLocalhost",
		in:           "localhost:1234+secure",
		wantAllHosts: []Host{{"localhost:1234", false}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "localhost:1234",
				Repository: "fruit.com/apple",
			},
		},
	}, {
		testName:     "127.0.0.1IsInsecure",
		in:           "127.0.0.1",
		wantAllHosts: []Host{{"127.0.0.1", true}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "127.0.0.1",
				Insecure:   true,
				Repository: "fruit.com/apple",
			},
		},
	}, {
		testName:     "[::1]IsInsecure",
		in:           "[::1]",
		wantAllHosts: []Host{{"[::1]", true}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "[::1]",
				Insecure:   true,
				Repository: "fruit.com/apple",
			},
		},
	}, {
		testName:     "[0:0::1]IsInsecure",
		in:           "[0:0::1]",
		wantAllHosts: []Host{{"[0:0::1]", true}},
		lookups: map[string]*Location{
			"fruit.com/apple": {
				Host:       "[0:0::1]",
				Insecure:   true,
				Repository: "fruit.com/apple",
			},
		},
	}}

	for _, tc := range testCases {
		t.Run(tc.testName, func(t *testing.T) {
			r, err := ParseCUERegistry(tc.in, tc.catchAllDefault)
			if tc.err != "" {
				qt.Assert(t, qt.ErrorMatches(err, tc.err))
				return
			}
			qt.Assert(t, qt.IsNil(err))
			qt.Check(t, qt.DeepEquals(r.AllHosts(), tc.wantAllHosts))
			testLookups(t, r, tc.lookups)
		})
	}
}

func TestParseConfig(t *testing.T) {
	testCases := []struct {
		testName        string
		in              string
		catchAllDefault string
		err             string
		wantAllHosts    []Host
		lookups         map[string]*Location
	}{{
		testName:        "NoRegistryOrDefault",
		catchAllDefault: "",
		err:             "no default catch-all registry provided",
	}, {
		testName: "InvalidRegistry",
		in: `
defaultRegistry: registry: "$#foo"
`,
		err: `invalid default registry configuration: invalid host name "\$#foo" in registry`,
	}, {
		testName: "EncHashAsRepo",
		in: `
defaultRegistry: {
	registry: "registry.somewhere/hello"
	pathEncoding: "hashAsRepo"
	prefixForTags: "mod-"
}
`,
		wantAllHosts: []Host{{"registry.somewhere", false}},
		lookups: map[string]*Location{
			"foo.com/bar v1.2.3": {
				Host:       "registry.somewhere",
				Repository: "hello/" + hashOf("foo.com/bar"),
				Tag:        "mod-v1.2.3",
			},
		},
	}, {
		testName: "EncHashAsTag",
		in: `
defaultRegistry: {
	registry: "registry.somewhere/hello"
	pathEncoding: "hashAsTag"
	prefixForTags: "mod-"
}
`,
		wantAllHosts: []Host{{"registry.somewhere", false}},
		lookups: map[string]*Location{
			"foo.com/bar v1.2.3": {
				Host:       "registry.somewhere",
				Repository: "hello",
				Tag:        "mod-" + hashOf("foo.com/bar") + "-v1.2.3",
			},
		},
	}, {
		testName: "DefaultRegistryWithModuleRegistries",
		in: `
defaultRegistry: {
	registry: "registry.somewhere"
}
moduleRegistries: {
	"a.com": {
		registry: "registry.otherwhere"
	}
}
`,
		wantAllHosts: []Host{{"registry.otherwhere", false}, {"registry.somewhere", false}},
		lookups: map[string]*Location{
			"a.com v0.0.1": {
				Host:       "registry.otherwhere",
				Repository: "a.com",
				Tag:        "v0.0.1",
			},
			"b.com v0.0.1": {
				Host:       "registry.somewhere",
				Repository: "b.com",
				Tag:        "v0.0.1",
			},
		},
	}, {
		testName:        "DiverseRegistries",
		catchAllDefault: "default.example/foo",
		in: `
moduleRegistries: {
	"a.com": {
		registry: "r1.example/a/b+insecure"
	}
	"a.com/foo/bar": {
		registry: "r2.example/xxx"
		pathEncoding: "hashAsRepo"
		prefixForTags: "cue-"
	}
	"a.com/foo": {
		registry: "r1.example/hello+insecure"
	}
	"stripped.org/bar": {
		registry: "r3.example/repo"
		stripPrefix: true
	}
	"badmodules.org": {
		registry: "none"
	}
}
`,
		wantAllHosts: []Host{{
			Name: "default.example",
		}, {
			Name:     "r1.example",
			Insecure: true,
		}, {
			Name: "r2.example",
		}, {
			Name: "r3.example",
		}},
		lookups: map[string]*Location{
			"a.com/other/bar/baz v0.0.1": {
				Host:       "r1.example",
				Insecure:   true,
				Repository: "a/b/a.com/other/bar/baz",
				Tag:        "v0.0.1",
			},
			"a.com/foo/bar v0.0.1": {
				Host:       "r2.example",
				Repository: "xxx/" + hashOf("a.com/foo/bar"),
				Tag:        "cue-v0.0.1",
			},
			"a.com/foo/bar": {
				Host:       "r2.example",
				Repository: "xxx/" + hashOf("a.com/foo/bar"),
				Tag:        "cue-",
			},
			"a.com/foo/baz v0.0.1": {
				Host:       "r1.example",
				Insecure:   true,
				Repository: "hello/a.com/foo/baz",
				Tag:        "v0.0.1",
			},
			"a.com/food v0.0.1": {
				Host:       "r1.example",
				Insecure:   true,
				Repository: "a/b/a.com/food",
				Tag:        "v0.0.1",
			},
			"b.com v0.0.1": {
				Host:       "default.example",
				Repository: "foo/b.com",
				Tag:        "v0.0.1",
			},
			"stripped.org/bar/one/two/three v0.0.1": {
				Host:       "r3.example",
				Repository: "repo/one/two/three",
				Tag:        "v0.0.1",
			},
			"stripped.org/bar v0.0.1": {
				Host:       "r3.example",
				Repository: "repo",
				Tag:        "v0.0.1",
			},
			"badmodules.org/something v1.2.3": nil,
			"badmodules.org v1.2.3":           nil,
		},
	}, {
		testName: "InvalidModulePath",
		in: `
moduleRegistries: "bad+module": {
	registry: "foo.com"
}
`,
		err: `invalid module path "bad\+module": invalid char '\+'`,
	}, {
		testName: "InvalidHost",
		in: `
moduleRegistries: "foo.example": {
		registry: "badhost:"
}
`,
		err: `invalid registry configuration in "foo.example": invalid host name "badhost:" in registry`,
	}, {
		testName: "InvalidRepository",
		in: `
moduleRegistries: "foo.example": {
		registry: "ok.com/A"
}
`,
		err: `invalid registry configuration in "foo.example": invalid reference syntax \("ok.com/A"\)`,
	}, {
		testName: "UnknownField",
		in: `
registiries: "foo.example": {
		registry: "ok.com/A",
}
`,
		err: `invalid configuration file: registiries: field not allowed`,
	}, {
		testName:        "MismatchedSecurity",
		catchAllDefault: "c.example",
		in: `
moduleRegistries: {
	"a.example": {
		registry: "ok.com+insecure"
	}
	"b.example": {
		registry: "ok.com"
	}
}
`,
		err: `registry host "ok.com" is specified both as secure and insecure`,
	}, {
		testName:        "StripPrefixWithNoRepo",
		catchAllDefault: "c.example",
		in: `
moduleRegistries: {
	"a.example/foo": {
		registry: "foo.example"
		stripPrefix: true
	}
}
`,
		err: `invalid registry configuration in "a.example/foo": use of stripPrefix requires a non-empty repository within the registry`,
	}}

	for _, tc := range testCases {
		t.Run(tc.testName, func(t *testing.T) {
			r, err := ParseConfig([]byte(tc.in), "somefile.cue", tc.catchAllDefault)
			if tc.err != "" {
				qt.Assert(t, qt.ErrorMatches(err, tc.err))
				return
			}
			qt.Assert(t, qt.IsNil(err))
			qt.Check(t, qt.DeepEquals(r.AllHosts(), tc.wantAllHosts))
			testLookups(t, r, tc.lookups)
		})
	}
}

func testLookups(t *testing.T, r LocationResolver, lookups map[string]*Location) {
	for key, want := range lookups {
		t.Run(key, func(t *testing.T) {
			m, v, _ := strings.Cut(key, " ")
			got, ok := r.ResolveToLocation(m, v)
			if want == nil {
				qt.Assert(t, qt.IsFalse(ok))
			} else {
				qt.Assert(t, qt.DeepEquals(&got, want))
			}
		})
	}
}

func hashOf(s string) string {
	return fmt.Sprintf("%x", sha256.Sum256([]byte(s)))
}