Skip to main content
Open source

Dependency resolution diagnostic

Recipe IDorg.openrewrite.java.dependencies.DependencyResolutionDiagnostic
Artifactorg.openrewrite.recipe:rewrite-java-dependencies

Recipes which manipulate dependencies must be able to successfully access the artifact repositories and resolve dependencies from them. This recipe produces two data tables used to understand the state of dependency resolution. The Repository accessibility report lists all the artifact repositories known to the project and whether respond to network access. The network access is attempted while the recipe is run and so is representative of current conditions. The Gradle dependency configuration errors lists all the dependency configurations that failed to resolve one or more dependencies when the project was parsed. This is representative of conditions at the time the LST was parsed.

Single recipeJavaApache License Version 2.0
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

3 parameters
3 optional
ParameterExampleTypeRequired
artifactIdjackson-coreStringOptional
The artifact ID of a dependency to attempt to download from the repository. Default value is "jackson-core". If this dependency is not found in the repository the error will be noted in the report. There is no need to specify an alternate value for this parameter unless the repository is known not to contain jackson-core.
groupIdcom.fasterxml.jackson.coreStringOptional
The group ID of a dependency to attempt to download from the repository. Default value is "com.fasterxml.jackson.core". If this dependency is not found in the repository the error will be noted in the report. There is no need to specify an alternate value for this parameter unless the repository is known not to contain jackson-core.
version2.16.0StringOptional
The version of a dependency to attempt to download from the repository. Default value is "2.16.0". If this dependency is not found in the repository the error will be noted in the report. There is no need to specify an alternate value for this parameter unless the repository is known not to contain jackson-core.

Examples

groovy
ParameterValue
groupIdnull
artifactIdnull
versionnull
Before
plugins {
id("java")
}
After
/*~~(build.gradle is a Gradle build file, but it is missing a GradleProject marker.)~~>*/plugins {
id("java")
}

Usage

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe DependencyResolutionDiagnostic

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-java-dependencies:1.56.0

Data tables

Repository accessibility report
org.openrewrite.java.dependencies.table.RepositoryAccessibilityReport

Listing of all dependency repositories and whether they are accessible.

ColumnDescription
Repository URIThe URI of the repository
Ping exception typeEmpty if the repository responded to a ping. Otherwise, the type of exception encountered when attempting to access the repository.
Ping error messageEmpty if the repository was accessible. Otherwise, the error message encountered when attempting to access the repository.
Ping HTTP codeThe HTTP response code returned by the repository. May be empty for non-HTTP repositories.
Dependency resolution exception typeEmpty if ping failed, or if the repository successfully downloaded the specified dependency. Otherwise, the type of exception encountered when attempting to access the repository.
Dependency resolution error messageEmpty if ping failed, or if the repository successfully downloaded the specified dependency. Otherwise, the error message encountered when attempting to access the repository.
Gradle dependency configuration errors
org.openrewrite.java.dependencies.table.GradleDependencyConfigurationErrors

Records Gradle dependency configurations which failed to resolve during parsing. Partial success/failure is common, a failure in this list does not mean that every dependency failed to resolve.

ColumnDescription
Project pathThe path of the project which contains the dependency configuration.
Configuration nameThe name of the dependency configuration which failed to resolve.
Exception typeThe type of exception encountered when attempting to resolve the dependency configuration.
Error messageThe error message encountered when attempting to resolve the dependency configuration.
Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

ColumnDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe specific recipe that added the Search marker.
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)The total time spent across the scanning phase of this recipe.
Max scanning time (ns)The max time scanning any one source file.
Cumulative edit time (ns)The total time spent across the editing phase of this recipe.
Max edit time (ns)The max time editing any one source file.