internal/mod/zip: adapt to CUE semantics

Note: experimental feature.

Summary of changes from Go version:

- The canonical version of a module path always includes a major version
(even at v0 and v1).
- we don't encode the module version in a top level directory. Instead,
the contents of the module are exactly those in the zip file.
- finding the module.cue file becomes a little more awkward because it's
inside a subdirectory.
- we return the contents of the module.cue file so that it can be checked
by logic external to this package, which avoids having the zip package
depend on the entire CUE interpreter.
- `CreateFromVCS` is not needed, at least for now.

For #2330.

Signed-off-by: Roger Peppe <[email protected]>
Change-Id: I0e29102031f6e95a28b456beec3bdab144792083
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1168706
Reviewed-by: Paul Jolly <[email protected]>
Unity-Result: CUE porcuepine <[email protected]>
TryBot-Result: CUEcueckoo <[email protected]>

Author: rogpeppe

internal/mod/zip/testdata/check_dir/empty.txt

@@ -1,3 +1,4 @@
+wantErr=no cue.mod/module.cue file found
 -- want --
 valid:
 

internal/mod/zip/testdata/check_dir/various.txt

@@ -1,20 +1,20 @@
 -- want --
 valid:
-$work/valid.go
+$work/valid.cue
+$work/vendor/x/y
 
 omitted:
 $work/.hg_archival.txt: file is inserted by 'hg archive' and is always omitted
+$work/sub/cue.mod/module.cue: file is in another module
 $work/.git: directory is a version control repository
-$work/sub: directory is in another module
-$work/vendor/x/y: file is in vendor directory
 
 invalid:
-$work/GO.MOD: go.mod files must have lowercase names
-$work/invalid.go': malformed file path "invalid.go'": invalid char '\''
--- valid.go --
--- GO.MOD --
--- invalid.go' --
+$work/CUE.MOD: cue.mod directories must have lowercase names
+$work/invalid.cue': malformed file path "invalid.cue'": invalid char '\''
+-- valid.cue --
+-- CUE.MOD --
+-- invalid.cue' --
 -- vendor/x/y --
--- sub/go.mod --
+-- sub/cue.mod/module.cue --
 -- .hg_archival.txt --
 -- .git/x --

internal/mod/zip/testdata/check_files/empty.txt

@@ -1,3 +1,4 @@
+wantErr=no cue.mod/module.cue file found
 -- want --
 valid:
 

internal/mod/zip/testdata/check_files/various.txt

@@ -1,23 +1,44 @@
 -- want --
 valid:
+valid.cue
+other/valid.cue
+cue.mod/module.cue
+cue.mod/pkg_other/x
+cue.mod/pkg/x
+cue.mod/usr/x
+cue.mod/gen/x
+GO.MOD
+vendor/x/y
 valid.go
 
 omitted:
-vendor/x/y: file is in vendor directory
-sub/go.mod: file is in another module
+sub1/cue.mod/module.cue: file is in another module
+sub1/something.cue: file is in another module
+sub2/CUE.MOD/module.cue: file is in another module
 .hg_archival.txt: file is inserted by 'hg archive' and is always omitted
 
 invalid:
+cue.mod/Module.cue: cue.mod/module.cue files must have lowercase names
 not/../clean: file path is not clean
-GO.MOD: go.mod files must have lowercase names
+CUE.MOD/module.cue: cue.mod directories must have lowercase names
 invalid.go': malformed file path "invalid.go'": invalid char '\''
 valid.go: multiple entries for file "valid.go"
--- valid.go --
+-- valid.cue --
+-- other/valid.cue --
+-- cue.mod/module.cue --
+-- cue.mod/Module.cue --
+-- cue.mod/pkg_other/x --
+-- cue.mod/pkg/x --
+-- cue.mod/usr/x --
+-- cue.mod/gen/x --
 -- not/../clean --
 -- GO.MOD --
+-- CUE.MOD/module.cue --
 -- invalid.go' --
 -- vendor/x/y --
--- sub/go.mod --
+-- sub1/cue.mod/module.cue --
+-- sub1/something.cue --
+-- sub2/CUE.MOD/module.cue --
 -- .hg_archival.txt --
 -- valid.go --
 duplicate

internal/mod/zip/testdata/check_zip/empty.txt

@@ -1,4 +1,5 @@
-path=example.com/empty
+path=example.com/empty@v1
+wantErr=no cue.mod/module.cue file found
 version=v1.0.0
 -- want --
 valid:

internal/mod/zip/testdata/check_zip/various.txt

@@ -1,21 +1,19 @@
-path=example.com/various
+path=example.com/various@v1
 version=v1.0.0
 -- want --
 valid:
-example.com/[email protected]/valid.go
+valid.go
 
 omitted:
 
 invalid:
-noprefix: path does not have prefix "example.com/[email protected]/"
-example.com/[email protected]/not/../clean: file path is not clean
-example.com/[email protected]/invalid.go': malformed file path "invalid.go'": invalid char '\''
-example.com/[email protected]/GO.MOD: go.mod files must have lowercase names
-example.com/[email protected]/valid.go: multiple entries for file "valid.go"
--- noprefix --
--- example.com/[email protected]/valid.go --
--- example.com/[email protected]/not/../clean --
--- example.com/[email protected]/invalid.go' --
--- example.com/[email protected]/GO.MOD --
--- example.com/[email protected]/valid.go --
+not/../clean: file path is not clean
+invalid.go': malformed file path "invalid.go'": invalid char '\''
+CUE.MOD: cue.mod is not a directory
+valid.go: multiple entries for file "valid.go"
+-- valid.go --
+-- not/../clean --
+-- invalid.go' --
+-- CUE.MOD --
+-- valid.go --
 duplicate

internal/mod/zip/testdata/create/bad_file_path.txt

@@ -1,4 +1,4 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
 wantErr=malformed file path "bad.go'": invalid char '\''
 -- bad.go' --

internal/mod/zip/testdata/create/bad_gomod_case.txt

@@ -1,5 +1,5 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-wantErr=GO.MOD: go.mod files must have lowercase names
--- GO.MOD --
-module example.com/m
+wantErr=create zip: CUE.MOD/MODULE.CUE: cue.mod directories must have lowercase names
+-- CUE.MOD/MODULE.CUE --
+module: "example.com/m"

internal/mod/zip/testdata/create/bad_mod_path.txt

@@ -1,4 +1,4 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
 wantErr=multiple entries for file "dup.go"
 -- dup.go --

internal/mod/zip/testdata/create/bad_mod_path_version_suffix.txt

@@ -1,4 +1,4 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
 wantErr=entry "a.go" is both a file and a directory
 -- a.go --

internal/mod/zip/testdata/create/bad_version.txt

@@ -1,3 +1,4 @@
-path=example.com/empty
+path=example.com/empty@v1
 version=v1.0.0
 hash=h1:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
+wantErr=no cue.mod/module.cue file found

internal/mod/zip/testdata/create/dup_file.txt

@@ -1,9 +1,11 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-hash=h1:xctQQey8/y7IcBjFZDP/onWLSXhlqcsC3i1fgSdpMHk=
+hash=h1:kfXam9weeIGbXPqzuILvA7E/rit+44dEMb1xuXLpJwE=
 -- a.go --
 package a
--- b/GO.MOD --
+-- cue.mod/module.cue --
+module: "example.com/m"
+-- b/CUE.MOD/foo --
 MODULE EXAMPLE.COM/M/B
 -- b/b.go --
 package b

internal/mod/zip/testdata/create/dup_file_and_dir.txt

@@ -1,11 +1,10 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-hash=h1:XduFAgX/GaspZa8Jv4pfzoGEzNaU/r88PiCunijw5ok=
--- go.mod --
-module example.com/m
+hash=h1:W4OVf+GhuR8uGVPxUsw60LKchTUbx+6hPgZygdB2reM=
+-- cue.mod/module.cue --
+module: "example.com/m"
 
-go 1.13
--- sub/go.mod --
-module example.com/m/sub
+-- sub/cue.mod/module.cue --
+module: "example.com/m/sub"
 -- sub/x.go' --
 invalid name, but this shouldn't be read

internal/mod/zip/testdata/create/empty.txt

@@ -1,14 +1,10 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-hash=h1:5u93LDLN0Me+NGfZtRpA5mHxY8svfykHpq4CMSaBZyc=
--- go.mod --
-module example.com/m
+hash=h1:RGlDmT/EEpEYgcga7aIizwsyIh7qqsWvgHL1aZk1aJo=
+-- cue.mod/module.cue --
+module: "example.com/m"
 
-go 1.13
--- vendor/modules.txt --
-included
-see comment in isVendoredPackage and golang.org/issue/31562.
--- vendor/example.com/x/x.go --
+-- cue.mod/vendor/example.com/x/x.go --
 excluded
 -- sub/vendor/sub.txt --
-excluded
+included

internal/mod/zip/testdata/create/exclude_cap_go_mod_submodule.txt

@@ -1,4 +1,4 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
 wantErr=case-insensitive file name collision: "m.go" and "M.GO"
 -- m.go --

internal/mod/zip/testdata/create/exclude_submodule.txt

@@ -1,22 +1,11 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-hash=h1:tpqYOOmuilagXzyqoJ3roUjp8gneQeTv5YVpL6BG7/k=
--- go.mod --
-module example.com/m
-
-go 1.13
--- m.go --
+hash=h1:pMP6w+M7uoGv0NdCdaJk4KX++ZpbTibPMuqnvDngD48=
+-- cue.mod/module.cue --
+module: "example.com/m"
+-- m.cue --
 package m
-
-func Foo() int { return 42 }
--- cmd/hello/hello.go --
+-- foo/bar/hello.cue --
 package main
 
-import (
-  "fmt"
-  "example.com/m"
-)
-
-func main() {
-  fmt.Println(m.Foo())
-}
+x: "hello"

internal/mod/zip/testdata/create/exclude_vendor.txt

@@ -1,4 +1,4 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
 wantErr=malformed file path "bad.go'": invalid char '\''
 -- bad.go' --

internal/mod/zip/testdata/create/file_case_conflict.txt

@@ -1,5 +1,5 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-wantErr=GO.MOD: go.mod files must have lowercase names
--- GO.MOD --
-module example.com/m
+wantErr=cue.mod/MODULE.CUE: cue.mod/module.cue files must have lowercase names
+-- cue.mod/MODULE.CUE --
+module: "example.com/m"

internal/mod/zip/testdata/create/go_mod_dir.txt

@@ -1,3 +1,4 @@
-path=example.com/empty
+path=example.com/empty@v1
 version=v1.0.0
 hash=h1:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
+wantErr=no cue.mod/module.cue file found

internal/mod/zip/testdata/create/invalid_utf8_mod_path.txt

@@ -1,11 +1,9 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-hash=h1:XduFAgX/GaspZa8Jv4pfzoGEzNaU/r88PiCunijw5ok=
--- go.mod --
-module example.com/m
-
-go 1.13
--- sub/go.mod --
-module example.com/m/sub
+hash=h1:js1etTKx6RMP5ZMV2GIUC2hUhREIdF7sb4aiWzQLkOU=
+-- cue.mod/module.cue --
+module: "example.com/m"
+-- sub/cue.mod/module.cue --
+module: "example.com/m/sub"
 -- sub/x.go' --
 invalid name, but this shouldn't be read

internal/mod/zip/testdata/create/simple.txt

@@ -1,6 +1,6 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-hash=h1:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
+hash=h1:js1etTKx6RMP5ZMV2GIUC2hUhREIdF7sb4aiWzQLkOU=
 -- .bzr/exclude --
 exclude
 -- .git/exclude --
@@ -9,3 +9,5 @@ exclude
 exclude
 -- .svn/exclude --
 exclude
+-- cue.mod/module.cue --
+module: "example.com/m"

internal/mod/zip/testdata/create_from_dir/bad_file_path.txt

@@ -1,14 +1,10 @@
-path=example.com/m
+path=example.com/m@v1
 version=v1.0.0
-hash=h1:5u93LDLN0Me+NGfZtRpA5mHxY8svfykHpq4CMSaBZyc=
--- go.mod --
-module example.com/m
+hash=h1:RGlDmT/EEpEYgcga7aIizwsyIh7qqsWvgHL1aZk1aJo=
+-- cue.mod/module.cue --
+module: "example.com/m"
 
-go 1.13
--- vendor/modules.txt --
-included
-see comment in isVendoredPackage and golang.org/issue/31562.
--- vendor/example.com/x/x.go --
+-- cue.mod/vendor/example.com/x/x.go --
 excluded
 -- sub/vendor/sub.txt --
-excluded
+included