Apache Lucene open-source search software
Add support for running ast-grep rules (#14808)
Dawid Weisse61ff556e231
diff --git a/.github/workflows/run-checks-all.yml b/.github/workflows/run-checks-all.ymlindex 809c15b6efc..9cb7c0f4723 100644--- a/.github/workflows/run-checks-all.yml+++ b/.github/workflows/run-checks-all.yml@@ -40,6 +40,12 @@ jobs:- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2- uses: ./.github/actions/prepare-for-build+ - name: Install ast-grep+ if: ${{ ! startsWith(matrix.os, 'windows') }}+ run: |+ npm -g i @ast-grep/cli+ echo "lucene.tool.ast-grep=ast-grep" >> build-options.local.properties+- name: Run gradle check (without tests)run: ./gradlew check -x test "-Ptask.times=true" --max-workers 2diff --git a/.gitignore b/.gitignoreindex 3f769674c28..741b42ae0ae 100644--- a/.gitignore+++ b/.gitignore@@ -1,6 +1,7 @@# Gradle.# Ignore the generated local settings file./gradle.properties+/build-options.local.properties.gradle/build/diff --git a/build-tools/build-infra/src/main/groovy/lucene.root-project.setup.gradle b/build-tools/build-infra/src/main/groovy/lucene.root-project.setup.gradleindex b03836f0da2..c0e769525c5 100644--- a/build-tools/build-infra/src/main/groovy/lucene.root-project.setup.gradle+++ b/build-tools/build-infra/src/main/groovy/lucene.root-project.setup.gradle@@ -18,6 +18,7 @@import com.carrotsearch.gradle.buildinfra.buildoptions.BuildOptionValueSourceimport com.carrotsearch.gradle.buildinfra.buildoptions.BuildOptionsPluginimport org.apache.lucene.gradle.plugins.gitinfo.GitInfoPlugin+import org.apache.lucene.gradle.plugins.astgrep.AstGrepPluginimport com.carrotsearch.randomizedtesting.SeedUtilsimport java.time.ZonedDateTime@@ -32,11 +33,14 @@ if (project != project.rootProject) {//// Register these plugins early.//-plugins.apply(GitInfoPlugin)allprojects {plugins.apply(BuildOptionsPlugin)}+plugins.apply(BasePlugin)+plugins.apply(GitInfoPlugin)+plugins.apply(AstGrepPlugin)+//// Figure out project version based on the base version and, suffix (or overrides of these options).//@@ -159,7 +163,11 @@ buildOptions.addOption("lucene.tool.perl", "External perl executable (path or nabuildOptions.addOption("lucene.tool.git", "External git executable (path or name)", "git")ext.externalTool = { String name ->- if (name in ["python3", "perl", "git"]) {+ if (name in [+ "python3",+ "perl",+ "git"+ ]) {return buildOptions.getOption("lucene.tool." + name).asStringProvider().get()}throw new GradleException("External tool named '${name}' is not defined.")diff --git a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/astgrep/AstGrepPlugin.java b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/astgrep/AstGrepPlugin.javanew file mode 100644index 00000000000..62c5eccce46--- /dev/null+++ b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/astgrep/AstGrepPlugin.java@@ -0,0 +1,81 @@+package org.apache.lucene.gradle.plugins.astgrep;++import com.carrotsearch.gradle.buildinfra.buildoptions.BuildOptionsExtension;+import java.util.List;+import org.gradle.api.GradleException;+import org.gradle.api.Plugin;+import org.gradle.api.Project;+import org.gradle.api.tasks.Exec;++public class AstGrepPlugin implements Plugin<Project> {+ @Override+ public void apply(Project project) {+ if (project != project.getRootProject()) {+ throw new GradleException("This plugin can be applied to the root project only.");+ }++ var optionName = "lucene.tool.ast-grep";+ var tasks = project.getTasks();++ var astToolOption =+ project+ .getExtensions()+ .getByType(BuildOptionsExtension.class)+ .addOption(optionName, "External ast-grep executable (path or name)");++ var testAstGrepRules =+ tasks.register(+ "testAstGrepRules",+ Exec.class,+ (task) -> {+ task.setArgs(+ List.of(+ "test",+ "--skip-snapshot-tests",+ "-c",+ "gradle/validation/ast-grep/sgconfig.yml"));+ });++ var applyAstGrepRulesTask =+ tasks.register(+ "applyAstGrepRules",+ Exec.class,+ task -> {+ task.dependsOn(testAstGrepRules);++ if (!astToolOption.isPresent()) {+ task.getLogger()+ .warn(+ "The ast-grep tool location is not set ('{}' option), will not apply ast-grep rules.",+ optionName);+ }++ task.setArgs(List.of("scan", "-c", "gradle/validation/ast-grep/sgconfig.yml"));+ });++ // Common configuration.+ List.of(testAstGrepRules, applyAstGrepRulesTask)+ .forEach(+ taskProv -> {+ taskProv.configure(+ task -> {+ if (!astToolOption.isPresent()) {+ task.setEnabled(false);+ }++ task.setIgnoreExitValue(false);+ if (astToolOption.isPresent()) {+ task.setExecutable(astToolOption.get());+ }+ task.setWorkingDir(project.getLayout().getProjectDirectory());+ });+ });++ tasks+ .matching(task -> task.getName().equals("check") || task.getName().equals("tidy"))+ .configureEach(+ task -> {+ task.dependsOn(applyAstGrepRulesTask);+ });+ }+}diff --git a/gradle/validation/ast-grep/rules/.gitignore b/gradle/validation/ast-grep/rules/.gitignorenew file mode 100644index 00000000000..e69de29bb2ddiff --git a/gradle/validation/ast-grep/sgconfig.yml b/gradle/validation/ast-grep/sgconfig.ymlnew file mode 100644index 00000000000..7f5543fe565--- /dev/null+++ b/gradle/validation/ast-grep/sgconfig.yml@@ -0,0 +1,5 @@+ruleDirs:+ - ./rules++testConfigs:+ - testDir: ./testsdiff --git a/gradle/validation/ast-grep/tests/.gitignore b/gradle/validation/ast-grep/tests/.gitignorenew file mode 100644index 00000000000..e69de29bb2ddiff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txtindex 8444a52ed9a..df2b4737a09 100644--- a/lucene/CHANGES.txt+++ b/lucene/CHANGES.txt@@ -61,6 +61,11 @@ Changes in Runtime Behavior---------------------* GITHUB#14187: The query cache is now disabled by default. (Adrien Grand)+Build+---------------------+* GITHUB#14808: Add support for validating sources using ast-grep tool rules #14808+ (Robert Muir, Dawid Weiss)+Other---------------------