Mirrors/xcaddy
1
0
Fork 0
mirror of https://github.com/caddyserver/xcaddy.git synced 2025-02-02 06:07:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Prevent main Caddy module from upgrading from adding a plugin (#93)

Browse source 
* Prevent main Caddy module from upgrading from adding a plugin

Fixes #54

* Better comment
This commit is contained in:
Francis Lavoie 2022-04-07 19:07:11 -04:00 committed by GitHub
parent 7d6084b6d7
commit 71ce25d1a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
environment.go
View file

@ -128,7 +128,7 @@ func (b Builder) newEnvironment(ctx context.Context) (*environment, error) {
// pin versions by populating go.mod, first for Caddy itself and then plugins // pin versions by populating go.mod, first for Caddy itself and then plugins
log.Println("[INFO] Pinning versions") log.Println("[INFO] Pinning versions")
err = env.execGoGet(ctx, caddyModulePath, env.caddyVersion) err = env.execGoGet(ctx, caddyModulePath, env.caddyVersion, "", "")
if err != nil { if err != nil {
return nil, err return nil, err
} }
@ -143,7 +143,8 @@ nextPlugin:
continue nextPlugin continue nextPlugin
} }
} }
err = env.execGoGet(ctx, p.PackagePath, p.Version) // also pass the Caddy version to prevent it from being upgraded
err = env.execGoGet(ctx, p.PackagePath, p.Version, caddyModulePath, env.caddyVersion)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@ -154,12 +155,16 @@ nextPlugin:
default: default:
} }
} }
err = env.execGoGet(ctx, "", "")
// doing an empty "go get -d" can potentially resolve some
// ambiguities introduced by one of the plugins;
// see https://github.com/caddyserver/xcaddy/pull/92
err = env.execGoGet(ctx, "", "", "", "")
if err != nil { if err != nil {
return nil, err return nil, err
} }
log.Println("[INFO] Build environment ready")
log.Println("[INFO] Build environment ready")
return env, nil return env, nil
} }
@ -237,12 +242,32 @@ func (env environment) runCommand(ctx context.Context, cmd *exec.Cmd, timeout ti
} }
} }
func (env environment) execGoGet(ctx context.Context, modulePath, moduleVersion string) error { // execGoGet runs "go get -d -v" with the given module/version as an argument.
// Also allows passing in a second module/version pair, meant to be the main
// Caddy module/version we're building against; this will prevent the
// plugin module from causing the Caddy version to upgrade, if the plugin
// version requires a newer version of Caddy.
// See https://github.com/caddyserver/xcaddy/issues/54
func (env environment) execGoGet(ctx context.Context, modulePath, moduleVersion, caddyModulePath, caddyVersion string) error {
mod := modulePath mod := modulePath
if moduleVersion != "" { if moduleVersion != "" {
mod += "@" + moduleVersion mod += "@" + moduleVersion
} }
cmd := env.newCommand("go", "get", "-d", "-v", mod) caddy := caddyModulePath
if caddyVersion != "" {
caddy += "@" + caddyVersion
}
// using an empty string as an additional argument to "go get"
// breaks the command since it treats the empty string as a
// distinct argument, so we're using an if statement to avoid it.
var cmd *exec.Cmd
if caddy != "" {
cmd = env.newCommand("go", "get", "-d", "-v", mod, caddy)
} else {
cmd = env.newCommand("go", "get", "-d", "-v", mod)
}
return env.runCommand(ctx, cmd, env.timeoutGoGet) return env.runCommand(ctx, cmd, env.timeoutGoGet)
} }