Skip to content

refactor: use guidedremediation from osv-scalibr for version updates #2719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cuixq wants to merge 3 commits into
base: main
Choose a base branch
from
+44 −68
Open

refactor: use guidedremediation from osv-scalibr for version updates #2719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33e2d7c
refactor: use guidedremediation from osv-scalibr for version updates
cuixq Apr 13, 2026
fb2f2ce
lint
cuixq Apr 13, 2026
3de67e3
depsdev
cuixq Apr 13, 2026
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
16 changes: 10 additions & 6 deletions cmd/osv-scanner/update/__snapshots__/command_test.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ unsupported data-source "github" - must be one of: deps.dev, native
---

[TestCommand/file_does_not_exist - 1]
Version updates (the update command) can be risky when run on untrusted projects. It may trigger the package manager to execute scripts or follow external registries specified in the project. Please ensure you trust the source code and artifacts before proceeding.

---

Expand All @@ -81,6 +82,7 @@ file not found: ./testdata/does_not_exist.xml
---

[TestCommand/update_pom.xml_with_in-place_changes - 1]
Version updates (the update command) can be risky when run on untrusted projects. It may trigger the package manager to execute scripts or follow external registries specified in the project. Please ensure you trust the source code and artifacts before proceeding.

---

Expand Down Expand Up @@ -129,7 +131,7 @@ file not found: ./testdata/does_not_exist.xml
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-migrator</artifactId>
<version>2.1.0-alpha1</version>
<version>2.0.17</version>
</dependency>
</dependencies>
</dependencyManagement>
Expand All @@ -141,7 +143,7 @@ file not found: ./testdata/does_not_exist.xml
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>3.0.0-beta2</version>
<version>2.25.4</version>
</dependency>
</dependencies>
</profile>
Expand All @@ -152,6 +154,7 @@ file not found: ./testdata/does_not_exist.xml
---

[TestCommand/update_pom_with_in_place_changes_using_deps_dev_data_source - 1]
Version updates (the update command) can be risky when run on untrusted projects. It may trigger the package manager to execute scripts or follow external registries specified in the project. Please ensure you trust the source code and artifacts before proceeding.

---

Expand Down Expand Up @@ -200,7 +203,7 @@ file not found: ./testdata/does_not_exist.xml
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-migrator</artifactId>
<version>2.1.0-alpha1</version>
<version>2.0.17</version>
</dependency>
</dependencies>
</dependencyManagement>
Expand All @@ -212,7 +215,7 @@ file not found: ./testdata/does_not_exist.xml
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>3.0.0-beta2</version>
<version>2.25.4</version>
</dependency>
</dependencies>
</profile>
Expand All @@ -223,6 +226,7 @@ file not found: ./testdata/does_not_exist.xml
---

[TestCommand/update_pom_with_in_place_changes_using_native_data_source - 1]
Version updates (the update command) can be risky when run on untrusted projects. It may trigger the package manager to execute scripts or follow external registries specified in the project. Please ensure you trust the source code and artifacts before proceeding.

---

Expand Down Expand Up @@ -271,7 +275,7 @@ file not found: ./testdata/does_not_exist.xml
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-migrator</artifactId>
<version>2.1.0-alpha1</version>
<version>2.0.17</version>
</dependency>
</dependencies>
</dependencyManagement>
Expand All @@ -283,7 +287,7 @@ file not found: ./testdata/does_not_exist.xml
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>3.0.0-beta2</version>
<version>2.25.4</version>
</dependency>
</dependencies>
</profile>
Expand Down
96 changes: 34 additions & 62 deletions cmd/osv-scanner/update/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@ import (
"io"
"net/http"
"os"
"path/filepath"

"deps.dev/util/resolve"
"github.com/google/osv-scanner/v2/internal/depsdev"
"github.com/google/osv-scanner/v2/internal/remediation/suggest"
"github.com/google/osv-scanner/v2/internal/remediation/upgrade"
"github.com/google/osv-scanner/v2/internal/resolution/client"
"github.com/google/osv-scanner/v2/internal/resolution/depfile"
"github.com/google/osv-scanner/v2/internal/resolution/manifest"
"github.com/google/osv-scalibr/clients/datasource"
"github.com/google/osv-scalibr/clients/resolution"
"github.com/google/osv-scalibr/depsdev"
"github.com/google/osv-scalibr/guidedremediation"
"github.com/google/osv-scalibr/guidedremediation/options"
"github.com/google/osv-scalibr/guidedremediation/upgrade"
"github.com/google/osv-scanner/v2/internal/cmdlogger"
"github.com/google/osv-scanner/v2/internal/version"
"github.com/urfave/cli/v3"
)
Expand Down Expand Up @@ -59,80 +60,51 @@ func Command(_, _ io.Writer, _ *http.Client) *cli.Command {
}
}

type updateOptions struct {
Manifest string
IgnoreDev bool
UpgradeConfig upgrade.Config // Allowed upgrade levels per package.

Client client.DependencyClient
ManifestRW manifest.ReadWriter
}

func action(ctx context.Context, cmd *cli.Command) error {
options := updateOptions{
cmdlogger.Warnf("Version updates (the update command) can be risky when run on untrusted projects. It may trigger the package manager to execute scripts or follow external registries specified in the project. Please ensure you trust the source code and artifacts before proceeding.")

opts := options.UpdateOptions{
Manifest: cmd.String("manifest"),
IgnoreDev: cmd.Bool("ignore-dev"),
UpgradeConfig: upgrade.ParseUpgradeConfig(cmd.StringSlice("upgrade-config")),
UpgradeConfig: upgrade.NewConfigFromStrings(cmd.StringSlice("upgrade-config")),
}

if _, err := os.Stat(options.Manifest); errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("file not found: %s", options.Manifest)
if _, err := os.Stat(opts.Manifest); errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("file not found: %s", opts.Manifest)
} else if err != nil {
return err
}

system := resolve.UnknownSystem
if options.Manifest != "" {
rw, err := manifest.GetReadWriter(options.Manifest, cmd.String("maven-registry"))
if err != nil {
return err
}
options.ManifestRW = rw
system = rw.System()
// MavenClient is required for Maven projects
mc, err := datasource.NewMavenRegistryAPIClient(ctx, datasource.MavenRegistry{
URL: cmd.String("maven-registry"),
ReleasesEnabled: true,
}, "", false)
if err != nil {
return err
}
opts.MavenClient = mc

var err error
userAgent := "osv-scanner_update/" + version.OSVVersion
switch cmd.String("data-source") {
case "deps.dev":
options.Client, err = client.NewDepsDevClient(depsdev.DepsdevAPI, "osv-scanner_update/"+version.OSVVersion)
cl, err := resolution.NewDepsDevClient(depsdev.DepsdevAPI, userAgent)
if err != nil {
return err
}
opts.ResolveClient = cl
case "native":
switch system {
case resolve.Maven:
options.Client, err = client.NewMavenRegistryClient(cmd.String("maven-registry"))
if err != nil {
return err
}
case resolve.NPM, resolve.UnknownSystem:
fallthrough
default:
return fmt.Errorf("native data-source currently unsupported for %s ecosystem", system.String())
cl, err := resolution.NewCombinedNativeClient(resolution.CombinedNativeClientOptions{
ProjectDir: filepath.Dir(opts.Manifest),
MavenClient: mc,
})
if err != nil {
return err
}
opts.ResolveClient = cl
}

df, err := depfile.OpenLocalDepFile(options.Manifest)
if err != nil {
return err
}
mf, err := options.ManifestRW.Read(df)
df.Close() // Close the dep file and we may re-open it for writing
if err != nil {
return err
}

suggester, err := suggest.GetSuggester(mf.System())
if err != nil {
return err
}
patch, err := suggester.Suggest(ctx, options.Client, mf, suggest.Options{
IgnoreDev: options.IgnoreDev,
UpgradeConfig: options.UpgradeConfig,
})
if err != nil {
return err
}
_, err = guidedremediation.Update(opts)

return manifest.Overwrite(options.ManifestRW, options.Manifest, patch)
return err
}
Loading