Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,27 @@ manifests, and `Vagrantfile`. The Maven parser includes parents, dependencies,
dependency management, plugins, plugin dependencies, plugin management, build
extensions, and their profile-scoped forms.

### Replacement

```go
type Replacement struct {
Name string // Package the directive targets
Version string // Targeted version; empty targets every version
ReplacementName string // Package used instead, when the replacement is a package
ReplacementVersion string // Version of ReplacementName, when given
Source Source // Replacement that is not a package, such as a local directory
Location string // Opaque parser-defined identity within the manifest
}
```

`Replacements` records directives that substitute the package or source used
for another package, in source order. `Parse` does not apply them, so
`Dependencies` still reports each requirement as written. A `go.mod` replace
only takes effect when that file is the main module, which `Parse` cannot know.
`go.mod` replace directives are recorded with a `path` source for a local
directory and a `ReplacementName` otherwise. `Declarations` omit modules named
on the left side of a replace directive.

### ParseResult

```go
Expand All @@ -449,6 +470,7 @@ type ParseResult struct {
Digest string // file-level verification value, when present
Dependencies []Dependency
Declarations []Declaration
Replacements []Replacement // Replace or override directives, not applied
Sources []Source // Ordered manifest-level source declarations
Scripts map[string][]string // Hook or task names with ordered commands or paths
Publication Publication // Package publication settings
Expand Down
150 changes: 150 additions & 0 deletions gomod_replace_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
package manifests

import (
"reflect"
"strings"
"testing"
"time"
)

func TestGoModReplacements(t *testing.T) {
content := []byte(`module example.com/app

go 1.26

require (
example.com/library v1.0.0
example.com/forked v1.2.0
example.com/local v0.1.0
"example.com/quoted" v2.0.0//note
example.com/kept v3.0.0 // indirect
)

replace example.com/library => example.com/library v1.1.0

replace (
example.com/forked v1.2.0 => github.com/me/forked v1.2.1 // fork
example.com/forked => github.com/me/forked v1.3.0
example.com/local => ../local
example.com/local v0.1.0 => "C:\\src\\local"
example.com/quoted => "../dir with spaces"
example.com/versionless => example.com/other
example.com/missing =>
)
`)
result, err := Parse("go.mod", content)
if err != nil {
t.Fatal(err)
}

wantDeps := map[string]string{
"example.com/library": "v1.0.0",
"example.com/forked": "v1.2.0",
"example.com/local": "v0.1.0",
"example.com/quoted": "v2.0.0",
"example.com/kept": "v3.0.0",
}
if len(result.Dependencies) != len(wantDeps) {
t.Fatalf("dependencies = %+v", result.Dependencies)
}
for _, dep := range result.Dependencies {
if wantDeps[dep.Name] != dep.Version {
t.Errorf("dependency %s %s, want version %q", dep.Name, dep.Version, wantDeps[dep.Name])
}
}

path := func(dir string) Source { return Source{Kind: SourcePath, Value: dir} }
want := []Replacement{
{Name: "example.com/library", ReplacementName: "example.com/library", ReplacementVersion: "v1.1.0", Location: "replace/example.com%2Flibrary"},
{Name: "example.com/forked", Version: "v1.2.0", ReplacementName: "github.com/me/forked", ReplacementVersion: "v1.2.1", Location: "replace/example.com%2Fforked"},
{Name: "example.com/forked", ReplacementName: "github.com/me/forked", ReplacementVersion: "v1.3.0", Location: "replace/example.com%2Fforked/2"},
{Name: "example.com/local", Source: path("../local"), Location: "replace/example.com%2Flocal"},
{Name: "example.com/local", Version: "v0.1.0", Source: path(`C:\src\local`), Location: "replace/example.com%2Flocal/2"},
{Name: "example.com/quoted", Source: path("../dir with spaces"), Location: "replace/example.com%2Fquoted"},
{Name: "example.com/versionless", ReplacementName: "example.com/other", Location: "replace/example.com%2Fversionless"},
}
if !reflect.DeepEqual(result.Replacements, want) {
t.Errorf("replacements =\n%+v\nwant\n%+v", result.Replacements, want)
}

// Declarations still omit replaced modules, so the quoted require must
// decode to match the unquoted replace.
if len(result.Declarations) != 1 || result.Declarations[0].Name != "example.com/kept" {
t.Errorf("declarations = %+v", result.Declarations)
}
}

func TestGoModWithoutReplacements(t *testing.T) {
result, err := Parse("go.mod", []byte("module example.com/app\n\nrequire example.com/a v1.0.0\n"))
if err != nil {
t.Fatal(err)
}
if result.Replacements != nil {
t.Errorf("replacements = %+v, want none", result.Replacements)
}
}

func TestGoModParenthesisTokens(t *testing.T) {
content := []byte(`module example.com/app

require(
example.com/a v1.0.0
)

require ( )

require()

replace(
example.com/a => ../a
)

replace ( )

replace()
`)
result, err := Parse("go.mod", content)
if err != nil {
t.Fatal(err)
}
if len(result.Dependencies) != 1 || result.Dependencies[0].Name != "example.com/a" || result.Dependencies[0].Version != "v1.0.0" {
t.Errorf("dependencies = %+v", result.Dependencies)
}
want := []Replacement{{Name: "example.com/a", Source: Source{Kind: SourcePath, Value: "../a"}, Location: "replace/example.com%2Fa"}}
if !reflect.DeepEqual(result.Replacements, want) {
t.Errorf("replacements = %+v, want %+v", result.Replacements, want)
}
if len(result.Declarations) != 0 {
t.Errorf("declarations = %+v, want none", result.Declarations)
}
}

func TestGoModEmptyOneLineBlockKeepsLaterDirectives(t *testing.T) {
content := []byte("module example.com/app\n\nrequire ( )\nrequire example.com/b v2.0.0\n\nreplace ( )\nreplace example.com/b => ../b\n")
result, err := Parse("go.mod", content)
if err != nil {
t.Fatal(err)
}
if len(result.Dependencies) != 1 || result.Dependencies[0].Name != "example.com/b" {
t.Errorf("dependencies = %+v", result.Dependencies)
}
if len(result.Replacements) != 1 || result.Replacements[0].Name != "example.com/b" {
t.Errorf("replacements = %+v", result.Replacements)
}
}

func TestGoModLongLine(t *testing.T) {
const tokens = 1 << 20
content := []byte("module example.com/app\n\nrequire example.com/a v1.0.0" + strings.Repeat(" a", tokens) + "\n")
started := time.Now()
result, err := Parse("go.mod", content)
if err != nil {
t.Fatal(err)
}
if elapsed := time.Since(started); elapsed > 5*time.Second {
t.Errorf("parsing a %d-token line took %v", tokens, elapsed)
}
if len(result.Dependencies) != 1 || result.Dependencies[0].Version != "v1.0.0" {
t.Errorf("dependencies = %+v", result.Dependencies)
}
}
14 changes: 14 additions & 0 deletions internal/core/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,18 @@ type ArtifactIntegrity struct {
Digest string
}

// Replacement records a directive that substitutes the package or source used
// for another package, without applying it. Location is ecosystem-specific and
// should be treated as an opaque identity.
type Replacement struct {
Name string
Version string
ReplacementName string
ReplacementVersion string
Source Source
Location string
}

// Declaration is a dependency-like reference at a stable logical location
// in a manifest. Version is the requirement as written in that location,
// before effective-model resolution or inheritance. Location is
Expand Down Expand Up @@ -145,6 +157,8 @@ type Result struct {
Digest string
Dependencies []Dependency
Declarations []Declaration
// Replacements holds replace or override directives in source order.
Replacements []Replacement
// Sources preserves manifest-level source declarations in source order.
// These entries are configuration, not evidence that any dependency was
// resolved from a particular source.
Expand Down
Loading
Loading