add lazy loading to some modules

Author: nahsra

framework/codemodder-base/src/main/java/io/codemodder/LazyCodemodLoadingAbstractModule.java

@@ -0,0 +1,29 @@
+package io.codemodder;
+
+import com.google.inject.AbstractModule;
+import java.util.List;
+
+/** A module that only loads if it is responsible for a codemod that's being loaded. */
+public abstract class LazyCodemodLoadingAbstractModule extends AbstractModule {
+
+  private final boolean shouldActivate;
+
+  /** Returns true if this module is responsible for any of the given codemods, so it doesn't . */
+  protected LazyCodemodLoadingAbstractModule(
+      final List<Class<? extends CodeChanger>> codemodTypes) {
+    this.shouldActivate = codemodTypes.stream().anyMatch(this::isResponsibleFor);
+  }
+
+  /** Returns true if this module is responsible for any of the given codemods, so it doesn't . */
+  protected abstract boolean isResponsibleFor(Class<? extends CodeChanger> codemod);
+
+  @Override
+  protected final void configure() {
+    if (shouldActivate) {
+      doConfigure();
+    }
+  }
+
+  /** Do the configuration that you would normally do in the configure method. */
+  protected abstract void doConfigure();
+}

plugins/codemodder-plugin-appscan/src/main/java/io/codemodder/providers/sarif/appscan/AppScanModule.java

@@ -1,7 +1,8 @@
 package io.codemodder.providers.sarif.appscan;
 
-import com.google.inject.AbstractModule;
 import io.codemodder.CodeChanger;
+import io.codemodder.Codemod;
+import io.codemodder.LazyCodemodLoadingAbstractModule;
 import io.codemodder.RuleSarif;
 import java.lang.reflect.Constructor;
 import java.util.List;
@@ -12,19 +13,25 @@
 import java.util.stream.Stream;
 
 /** Responsible for distributing the SARIFS to AppScan based codemods based on rules. */
-public final class AppScanModule extends AbstractModule {
+public final class AppScanModule extends LazyCodemodLoadingAbstractModule {
 
   private final List<Class<? extends CodeChanger>> codemodTypes;
   private final List<RuleSarif> allAppScanRuleSarifs;
 
   public AppScanModule(
       final List<Class<? extends CodeChanger>> codemodTypes, final List<RuleSarif> sarifs) {
+    super(codemodTypes);
     this.codemodTypes = Objects.requireNonNull(codemodTypes);
     this.allAppScanRuleSarifs = sarifs;
   }
 
   @Override
-  protected void configure() {
+  protected boolean isResponsibleFor(final Class<? extends CodeChanger> codemod) {
+    return codemod.getAnnotation(Codemod.class).id().startsWith("appscan:");
+  }
+
+  @Override
+  protected void doConfigure() {
     final Map<String, RuleSarif> map =
         allAppScanRuleSarifs.stream()
             .collect(Collectors.toUnmodifiableMap(RuleSarif::getRule, rs -> rs));

plugins/codemodder-plugin-codeql/src/main/java/io/codemodder/providers/sarif/codeql/CodeQLModule.java

@@ -1,7 +1,8 @@
 package io.codemodder.providers.sarif.codeql;
 
-import com.google.inject.AbstractModule;
 import io.codemodder.CodeChanger;
+import io.codemodder.Codemod;
+import io.codemodder.LazyCodemodLoadingAbstractModule;
 import io.codemodder.RuleSarif;
 import java.lang.reflect.Constructor;
 import java.util.List;
@@ -12,19 +13,25 @@
 import java.util.stream.Stream;
 
 /** Responsible for distributing the SARIFS to CodeQL based codemods based on rules. */
-public final class CodeQLModule extends AbstractModule {
+public final class CodeQLModule extends LazyCodemodLoadingAbstractModule {
 
   private final List<Class<? extends CodeChanger>> codemodTypes;
   private final List<RuleSarif> allCodeqlRuleSarifs;
 
   CodeQLModule(
       final List<Class<? extends CodeChanger>> codemodTypes, final List<RuleSarif> sarifs) {
+    super(codemodTypes);
     this.codemodTypes = Objects.requireNonNull(codemodTypes);
     this.allCodeqlRuleSarifs = sarifs;
   }
 
   @Override
-  protected void configure() {
+  protected boolean isResponsibleFor(final Class<? extends CodeChanger> codemod) {
+    return codemod.getAnnotation(Codemod.class).id().startsWith("codeql:");
+  }
+
+  @Override
+  protected void doConfigure() {
     // What if there are multiple sarif files with a given rule?
     // We can safely ignore this case for now.
     final Map<String, RuleSarif> map =

plugins/codemodder-plugin-pmd/src/main/java/io/codemodder/providers/sarif/pmd/PmdModule.java

@@ -2,10 +2,7 @@
 
 import com.contrastsecurity.sarif.Result;
 import com.contrastsecurity.sarif.SarifSchema210;
-import com.google.inject.AbstractModule;
-import io.codemodder.CodeChanger;
-import io.codemodder.LazyLoadingRuleSarif;
-import io.codemodder.RuleSarif;
+import io.codemodder.*;
 import io.github.classgraph.*;
 import java.lang.reflect.Executable;
 import java.lang.reflect.Parameter;
@@ -16,7 +13,7 @@
 import org.slf4j.LoggerFactory;
 
 /** Responsible for binding PMD-related things. */
-public final class PmdModule extends AbstractModule {
+public final class PmdModule extends LazyCodemodLoadingAbstractModule {
 
   private final List<Class<? extends CodeChanger>> codemodTypes;
   private final Path codeDirectory;
@@ -27,14 +24,22 @@ public PmdModule(
       final Path codeDirectory,
       final List<Path> includedFiles,
       final List<Class<? extends CodeChanger>> codemodTypes) {
+    super(codemodTypes);
     this.codemodTypes = Objects.requireNonNull(codemodTypes);
     this.codeDirectory = Objects.requireNonNull(codeDirectory);
     this.includedFiles = Objects.requireNonNull(includedFiles);
     this.pmdRunner = PmdRunner.createDefault();
   }
 
   @Override
-  protected void configure() {
+  protected boolean isResponsibleFor(final Class<? extends CodeChanger> codemod) {
+    Codemod annotation = codemod.getAnnotation(Codemod.class);
+    String id = annotation.id();
+    return id.startsWith("semgrep:") || id.startsWith("pixee:");
+  }
+
+  @Override
+  protected void doConfigure() {
     Set<String> packagesScanned = new HashSet<>();
 
     List<PmdScanTarget> scanTargets = new ArrayList<>();

plugins/codemodder-plugin-semgrep/src/main/java/io/codemodder/providers/sarif/semgrep/SemgrepModule.java

@@ -2,10 +2,7 @@
 
 import com.contrastsecurity.sarif.Result;
 import com.contrastsecurity.sarif.SarifSchema210;
-import com.google.inject.AbstractModule;
-import io.codemodder.CodeChanger;
-import io.codemodder.LazyLoadingRuleSarif;
-import io.codemodder.RuleSarif;
+import io.codemodder.*;
 import io.github.classgraph.*;
 import java.io.IOException;
 import java.io.UncheckedIOException;
@@ -20,7 +17,7 @@
 import org.slf4j.LoggerFactory;
 
 /** Responsible for binding Semgrep-related things. */
-public final class SemgrepModule extends AbstractModule {
+public final class SemgrepModule extends LazyCodemodLoadingAbstractModule {
 
   private final List<Class<? extends CodeChanger>> codemodTypes;
   private final Path codeDirectory;
@@ -44,13 +41,14 @@ public SemgrepModule(
         new DefaultSemgrepRuleFactory());
   }
 
-  public SemgrepModule(
+  SemgrepModule(
       final Path codeDirectory,
       final List<String> includePatterns,
       final List<String> excludePatterns,
       final List<Class<? extends CodeChanger>> codemodTypes,
       final List<RuleSarif> sarifs,
       final SemgrepRuleFactory semgrepRuleFactory) {
+    super(codemodTypes);
     this.codemodTypes = Objects.requireNonNull(codemodTypes);
     this.codeDirectory = Objects.requireNonNull(codeDirectory);
     this.includePatterns = Objects.requireNonNull(includePatterns);
@@ -61,7 +59,14 @@ public SemgrepModule(
   }
 
   @Override
-  protected void configure() {
+  protected boolean isResponsibleFor(final Class<? extends CodeChanger> codemod) {
+    Codemod annotation = codemod.getAnnotation(Codemod.class);
+    String id = annotation.id();
+    return id.startsWith("semgrep:") || id.startsWith("pixee:");
+  }
+
+  @Override
+  protected void doConfigure() {
 
     // find all the @ProvidedSemgrepScan annotations and bind them as is
     Set<String> packagesScanned = new HashSet<>();

plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/SonarModule.java

@@ -1,7 +1,8 @@
 package io.codemodder.providers.sonar;
 
-import com.google.inject.AbstractModule;
 import io.codemodder.CodeChanger;
+import io.codemodder.Codemod;
+import io.codemodder.LazyCodemodLoadingAbstractModule;
 import io.codemodder.sonar.model.Hotspot;
 import io.codemodder.sonar.model.Issue;
 import io.codemodder.sonar.model.SonarFinding;
@@ -14,7 +15,7 @@
 import java.util.*;
 import javax.inject.Inject;
 
-final class SonarModule<T extends SonarFinding> extends AbstractModule {
+final class SonarModule<T extends SonarFinding> extends LazyCodemodLoadingAbstractModule {
 
   private final List<Class<? extends CodeChanger>> codemodTypes;
   private final Path repository;
@@ -27,14 +28,20 @@ final class SonarModule<T extends SonarFinding> extends AbstractModule {
       final Path repository,
       final List<T> findings,
       final Class<? extends RuleFinding<T>> ruleFindingClass) {
+    super(codemodTypes);
     this.codemodTypes = Objects.requireNonNull(codemodTypes);
     this.repository = Objects.requireNonNull(repository);
     this.sonarFindings = findings;
     this.ruleFindingClass = ruleFindingClass;
   }
 
   @Override
-  protected void configure() {
+  protected boolean isResponsibleFor(final Class<? extends CodeChanger> codemod) {
+    return codemod.getAnnotation(Codemod.class).id().startsWith("sonar:");
+  }
+
+  @Override
+  protected void doConfigure() {
 
     Map<String, List<T>> findingsByRuleMap = groupFindingsByRule(sonarFindings);