golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee: module.ModuleError

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify golang.org/x/mod/module.ModuleError in pkg:golang/golang.org/x/mod@v0.1.1-0.20191105210325-c90efee705ee
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/golang.org/x/mod@v0.1.1-0.20191105210325-c90efee705ee
Demonstrate these symbols/APIs:
  - golang.org/x/mod/module.ModuleError

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:7ad7da0364f266699190ce863bfbe2edf7b956276ea20e08ecb7a36ac960296c","contract":["module.VersionError returns *ModuleError containing Path, Version, and wrapped Err","module.Check returns *ModuleError when version does not match module path major","module.ModuleError Error() formats error with Path and Version when Version is present","module.ModuleError Error() formats error with module prefix when Version is empty","module.ModuleError Unwrap() returns the underlying wrapped error"],"goal":"verify golang.org/x/mod/module.ModuleError in pkg:golang/golang.org/x/mod@v0.1.1-0.20191105210325-c90efee705ee","kind":"HOW","packages":["pkg:golang/golang.org/x/mod@v0.1.1-0.20191105210325-c90efee705ee"],"schemaVersion":1,"symbols":["golang.org/x/mod/module.ModuleError"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/golang.org/x/mod@v0.1.1-0.20191105210325-c90efee705ee"],"schemaVersion":1,"subject":"pkg:golang/golang.org/x/mod@v0.1.1-0.20191105210325-c90efee705ee","symbols":["golang.org/x/mod/module.ModuleError"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.23

require golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee

require golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898 // indirect

golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee h1:WG0RUwxtNT4qqaXX3DPA8zHFNm/D9xaBpxzHt1WcA/E=
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898 h1:/atklqdjdhuosWIl6AIbOeHJjicWYPqR9bpxqxYG2pA=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

package main

import (
	"errors"
	"fmt"

	"golang.org/x/mod/module"
)

func main() {
	v := module.Version{Path: "example.com/mod", Version: "v1.0.0"}
	err := module.VersionError(v, errors.New("example failure"))
	if err != nil {
		var modErr *module.ModuleError
		if errors.As(err, &modErr) {
			fmt.Printf("Module error: %s@%s: %v\n", modErr.Path, modErr.Version, modErr.Err)
			fmt.Printf("Formatted message: %s\n", modErr.Error())
			return
		}
		fmt.Printf("Unexpected error: %v\n", err)
		return
	}
	fmt.Println("No module error.")
}

{
  "schemaVersion": 1,
  "goal": "verify golang.org/x/mod/module.ModuleError in pkg:golang/golang.org/x/mod@v0.1.1-0.20191105210325-c90efee705ee",
  "kind": "HOW",
  "packages": [
    "pkg:golang/golang.org/x/mod@v0.1.1-0.20191105210325-c90efee705ee"
  ],
  "symbols": [
    "golang.org/x/mod/module.ModuleError"
  ]
}

package main

import (
	"errors"
	"fmt"
	"os"
	"strings"

	"golang.org/x/mod/module"
)

func main() {
	// 1. module.VersionError returns *ModuleError containing Path, Version, and wrapped Err
	{
		v := module.Version{
			Path:    "example.com/foo/bar",
			Version: "v1.2.3",
		}
		cause := errors.New("resolution failed")
		err := module.VersionError(v, cause)
		if err == nil {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: expected error from VersionError\n")
			os.Exit(1)
		}
		var me *module.ModuleError
		if !errors.As(err, &me) {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: expected *module.ModuleError, got %T\n", err)
			os.Exit(1)
		}
		if me.Path != "example.com/foo/bar" {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: expected Path 'example.com/foo/bar', got %q\n", me.Path)
			os.Exit(1)
		}
		if me.Version != "v1.2.3" {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: expected Version 'v1.2.3', got %q\n", me.Version)
			os.Exit(1)
		}
		if me.Err != cause {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: expected wrapped Err to match cause\n")
			os.Exit(1)
		}
	}

	// 2. module.Check returns *ModuleError when version does not match module path major
	{
		err := module.Check("example.com/foo/v2", "v1.0.0")
		if err == nil {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: expected error from Check for version mismatch\n")
			os.Exit(1)
		}
		var me *module.ModuleError
		if !errors.As(err, &me) {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: expected *module.ModuleError, got %T\n", err)
			os.Exit(1)
		}
		if me.Path != "example.com/foo/v2" {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: expected Path 'example.com/foo/v2', got %q\n", me.Path)
			os.Exit(1)
		}
		if me.Err == nil {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: expected non-nil Err\n")
			os.Exit(1)
		}
	}

	// 3. module.ModuleError Error() formats error with Path and Version when Version is present
	{
		me := &module.ModuleError{
			Path:    "example.com/pkg",
			Version: "v2.1.0",
			Err:     errors.New("checksum mismatch"),
		}
		msg := me.Error()
		if !strings.Contains(msg, "example.com/pkg@v2.1.0") || !strings.Contains(msg, "checksum mismatch") {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: unexpected Error() output: %q\n", msg)
			os.Exit(1)
		}
	}

	// 4. module.ModuleError Error() formats error with module prefix when Version is empty
	{
		me := &module.ModuleError{
			Path:    "example.com/pkg",
			Version: "",
			Err:     errors.New("invalid path"),
		}
		msg := me.Error()
		if !strings.Contains(msg, "module example.com/pkg") || !strings.Contains(msg, "invalid path") {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: unexpected Error() output: %q\n", msg)
			os.Exit(1)
		}
	}

	// 5. module.ModuleError Unwrap() returns the underlying wrapped error
	{
		cause := errors.New("root cause error")
		me := &module.ModuleError{
			Path:    "example.com/target",
			Version: "v1.0.0",
			Err:     cause,
		}
		if me.Unwrap() != cause {
			fmt.Fprintf(os.Stderr, "assertion 5 failed: Unwrap() did not return cause\n")
			os.Exit(1)
		}
		if !errors.Is(me, cause) {
			fmt.Fprintf(os.Stderr, "assertion 5 failed: errors.Is did not match cause\n")
			os.Exit(1)
		}
	}

	fmt.Println("All contract assertions passed.")
}