Skip to main content

Dependency resolution diagnostic

org.openrewrite.java.dependencies.DependencyResolutionDiagnostic

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.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringgroupIdOptional. 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.com.fasterxml.jackson.core
StringartifactIdOptional. 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.jackson-core
StringversionOptional. 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.2.16.0

Example​

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

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-java-dependencies in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.5.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.dependencies.DependencyResolutionDiagnostic")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.33.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Repository accessibility report​

org.openrewrite.java.dependencies.table.RepositoryAccessibilityReport

Listing of all dependency repositories and whether they are accessible.

Column NameDescription
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.