Open source

Finds flow between two methods

Recipe IDorg.openrewrite.analysis.search.FindFlowBetweenMethodsArtifactorg.openrewrite.meta:rewrite-analysis

Takes two patterns for the start/end methods to find flow between.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.analysis.search.FindFlowBetweenMethods")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.meta:rewrite-analysis:2.38.1")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.analysis.search.FindFlowBetweenMethods --recipe-option "startMethodPattern=java.util.List add(..)" --recipe-option "endMethodPattern=java.util.List add(..)" --recipe-option "target=<target>" --recipe-option "flow=<flow>"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.meta:rewrite-analysis:RELEASE

Options

Name	Type	Description
`startMethodPattern`required	`String`	A method pattern that is used to find matching the start point's method invocations. e.g. `java.util.List add(..)`
`startMatchOverrides`	`Boolean`	When enabled, find methods that are overrides of the method pattern.
`endMethodPattern`required	`String`	A method pattern that is used to find matching the end point's method invocations. e.g. `java.util.List add(..)`
`endMatchOverrides`	`Boolean`	When enabled, find methods that are overrides of the method pattern.
`target`required	`String`	The part of the method flow should traverse to
`flow`required	`String`	When enabled, show the data or taint flow of the method invocation.

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats