added artefact filtering in variant generation

Author: pmbittner

src/main/java/de/variantsync/evolution/variability/SPLCommit.java

@@ -35,6 +35,7 @@ public class SPLCommit extends Commit {
 
     /**
      * Constructor for commits that should only contain information about the commit id.
+     * TODO: Document params.
      *
      * @param commitId The id of the commit
      */

src/main/java/de/variantsync/evolution/variability/pc/Artefact.java

@@ -1,9 +1,10 @@
 package de.variantsync.evolution.variability.pc;
 
 import de.variantsync.evolution.feature.Variant;
-import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.util.functional.Result;
+import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.variability.pc.groundtruth.GroundTruth;
+import de.variantsync.evolution.variability.pc.options.VariantGenerationOptions;
 import de.variantsync.evolution.variability.pc.visitor.ArtefactVisitor;
 import de.variantsync.evolution.variability.pc.visitor.ArtefactVisitorFocus;
 import de.variantsync.evolution.variability.pc.visitor.common.FilePCQuery;

src/main/java/de/variantsync/evolution/variability/pc/LineBasedAnnotation.java

@@ -1,11 +1,12 @@
 package de.variantsync.evolution.variability.pc;
 
 import de.variantsync.evolution.feature.Variant;
-import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.util.functional.Result;
+import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.variability.pc.groundtruth.AnnotationGroundTruth;
 import de.variantsync.evolution.variability.pc.groundtruth.BlockMatching;
 import de.variantsync.evolution.variability.pc.groundtruth.GroundTruth;
+import de.variantsync.evolution.variability.pc.options.VariantGenerationOptions;
 import de.variantsync.evolution.variability.pc.visitor.LineBasedAnnotationVisitorFocus;
 import org.prop4j.Node;
 

src/main/java/de/variantsync/evolution/variability/pc/SourceCodeFile.java

@@ -2,16 +2,17 @@
 
 import de.variantsync.evolution.feature.Variant;
 import de.variantsync.evolution.io.TextIO;
-import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.util.Logger;
-import de.variantsync.evolution.util.io.PathUtils;
 import de.variantsync.evolution.util.fide.bugfix.FixTrueFalse;
 import de.variantsync.evolution.util.functional.Functional;
 import de.variantsync.evolution.util.functional.Result;
 import de.variantsync.evolution.util.functional.Traversable;
+import de.variantsync.evolution.util.io.CaseSensitivePath;
+import de.variantsync.evolution.util.io.PathUtils;
 import de.variantsync.evolution.variability.pc.groundtruth.AnnotationGroundTruth;
 import de.variantsync.evolution.variability.pc.groundtruth.BlockMatching;
 import de.variantsync.evolution.variability.pc.groundtruth.GroundTruth;
+import de.variantsync.evolution.variability.pc.options.VariantGenerationOptions;
 import de.variantsync.evolution.variability.pc.visitor.SourceCodeFileVisitorFocus;
 import org.prop4j.Node;
 

src/main/java/de/variantsync/evolution/variability/pc/SyntheticArtefactTreeNode.java

@@ -1,12 +1,13 @@
 package de.variantsync.evolution.variability.pc;
 
 import de.variantsync.evolution.feature.Variant;
-import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.util.Logger;
 import de.variantsync.evolution.util.fide.bugfix.FixTrueFalse;
 import de.variantsync.evolution.util.functional.Functional;
 import de.variantsync.evolution.util.functional.Result;
+import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.variability.pc.groundtruth.GroundTruth;
+import de.variantsync.evolution.variability.pc.options.VariantGenerationOptions;
 import de.variantsync.evolution.variability.pc.visitor.ArtefactVisitorFocus;
 import de.variantsync.evolution.variability.pc.visitor.SyntheticArtefactTreeNodeVisitorFocus;
 
@@ -59,6 +60,12 @@ public Result<GroundTruth, Exception> generateVariant(final Variant variant, fin
             }
         } else {
             for (final Child subtree : subtrees) {
+                if (subtree instanceof SourceCodeFile sourceCodeFile) {
+                    if (!strategy.filter().shouldKeep(sourceCodeFile)) {
+                        continue;
+                    }
+                }
+
                 if (variant.isImplementing(subtree.getPresenceCondition())) {
                     final Result<GroundTruth, Exception> result = subtree
                             .generateVariant(variant, sourceDir, targetDir, strategy);

src/main/java/de/variantsync/evolution/variability/pc/VariantGenerationOptions.java

@@ -0,0 +1,57 @@
+package de.variantsync.evolution.variability.pc.options;
+
+import de.variantsync.evolution.variability.pc.Artefact;
+
+import java.util.Arrays;
+import java.util.Collection;
+
+/**
+ * Predicate to filter artefacts upon certain operations.
+ * @param <A> The type of artefact that should be filtered.
+ */
+@FunctionalInterface
+public interface ArtefactFilter<A extends Artefact> {
+    /**
+     * Determines whether a given artefact should be considered in or dropped from subsequent computations.
+     * @param a The artefact that should be filtered.
+     * @return True iff the given artefact should be kept and used in further computations.
+     */
+    boolean shouldKeep(final A a);
+
+    /**
+     * @return A filter that accepts all artifacts. Formally, its value is `a -> true`.
+     */
+    static <A extends Artefact> ArtefactFilter<A> KeepAll() {
+        return a -> true;
+    }
+
+    /**
+     * Folds all given filters into a single filter.
+     * The returned filter will run all filters in the order they are returned by the given collection.
+     * The returned filter returns false and stops computation as soon as one of the given filters
+     * rejects the input artefact to test.
+     * @param filters A collection of filters to collapse.
+     * @param <A> The type of artefacts to filter.
+     * @return A single filter that returns true for a given artifact iff all of the given filters return true for it.
+     *         Formally, if `f` is the output filter `f.shouldKeep(a) iff (forall fi in filters: fi.shouldKeep(a))`.
+     */
+    static <A extends Artefact> ArtefactFilter<A> Fold(final Collection<ArtefactFilter<A>> filters) {
+        return a -> {
+            for (final ArtefactFilter<A> filter : filters) {
+                if (!filter.shouldKeep(a)) {
+                    return false;
+                }
+            }
+
+            return true;
+        };
+    }
+
+    /**
+     * @see #Fold(Collection)
+     */
+    @SafeVarargs
+    static <A extends Artefact> ArtefactFilter<A> Fold(final ArtefactFilter<A>... filters) {
+        return Fold(Arrays.asList(filters));
+    }
+}

src/main/java/de/variantsync/evolution/variability/pc/options/ArtefactFilter.java

@@ -0,0 +1,22 @@
+package de.variantsync.evolution.variability.pc.options;
+
+import de.variantsync.evolution.variability.pc.SourceCodeFile;
+
+public record VariantGenerationOptions(
+        boolean exitOnError,
+        boolean ignoreNonExistentSPLFiles,
+        ArtefactFilter<SourceCodeFile> filter
+)
+{
+    public static VariantGenerationOptions ExitOnError(final ArtefactFilter<SourceCodeFile> filter) {
+        return new VariantGenerationOptions(true, false, filter);
+    }
+
+    public static VariantGenerationOptions IgnoreErrors(final ArtefactFilter<SourceCodeFile> filter) {
+        return new VariantGenerationOptions(false, true, filter);
+    }
+
+    public static VariantGenerationOptions ExitOnErrorButAllowNonExistentFiles(final ArtefactFilter<SourceCodeFile> filter) {
+        return new VariantGenerationOptions(true, true, filter);
+    }
+}

src/main/java/de/variantsync/evolution/variability/pc/options/VariantGenerationOptions.java

@@ -1,18 +1,19 @@
 package de.variantsync.evolution.variants.blueprints;
 
-import de.variantsync.evolution.feature.sampling.Sample;
 import de.variantsync.evolution.feature.Variant;
+import de.variantsync.evolution.feature.sampling.Sample;
 import de.variantsync.evolution.repository.AbstractSPLRepository;
 import de.variantsync.evolution.repository.AbstractVariantsRepository;
 import de.variantsync.evolution.repository.Branch;
-import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.util.Logger;
 import de.variantsync.evolution.util.functional.Lazy;
 import de.variantsync.evolution.util.functional.Result;
+import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.variability.SPLCommit;
 import de.variantsync.evolution.variability.pc.Artefact;
-import de.variantsync.evolution.variability.pc.VariantGenerationOptions;
 import de.variantsync.evolution.variability.pc.groundtruth.GroundTruth;
+import de.variantsync.evolution.variability.pc.options.ArtefactFilter;
+import de.variantsync.evolution.variability.pc.options.VariantGenerationOptions;
 import de.variantsync.evolution.variants.VariantCommit;
 import de.variantsync.evolution.variants.VariantsRevision;
 import de.variantsync.evolution.variants.sampling.SamplingStrategy;
@@ -86,7 +87,7 @@ public Lazy<VariantsRevision.Branches> generateArtefactsFor(final VariantsRevisi
                         variant,
                         new CaseSensitivePath(splRepo.getPath()),
                         new CaseSensitivePath(variantsRepo.getPath()),
-                        VariantGenerationOptions.ExitOnErrorButAllowNonExistentFiles);
+                        VariantGenerationOptions.ExitOnErrorButAllowNonExistentFiles(ArtefactFilter.KeepAll()));
                 Logger.log(result.map(u -> "Generating variant " + variant + " was successful!"));
 
                 // Commit the generated variant with the corresponding spl commit has as message.

src/main/java/de/variantsync/evolution/variants/blueprints/VariantsRevisionFromVariabilityBlueprint.java

@@ -2,24 +2,26 @@
 
 import de.ovgu.featureide.fm.core.analysis.cnf.formula.FeatureModelFormula;
 import de.ovgu.featureide.fm.core.base.IFeatureModel;
-import de.variantsync.evolution.feature.sampling.Sampler;
 import de.variantsync.evolution.feature.Variant;
+import de.variantsync.evolution.feature.config.FeatureIDEConfiguration;
 import de.variantsync.evolution.feature.config.IConfiguration;
+import de.variantsync.evolution.feature.config.SayYesToAllConfiguration;
 import de.variantsync.evolution.feature.sampling.FeatureIDESampler;
+import de.variantsync.evolution.feature.sampling.Sampler;
 import de.variantsync.evolution.io.ResourceLoader;
 import de.variantsync.evolution.io.Resources;
 import de.variantsync.evolution.io.TextIO;
 import de.variantsync.evolution.io.kernelhaven.KernelHavenSPLPCIO;
 import de.variantsync.evolution.sat.SAT;
-import de.variantsync.evolution.util.io.CaseSensitivePath;
 import de.variantsync.evolution.util.Logger;
-import de.variantsync.evolution.util.io.PathUtils;
 import de.variantsync.evolution.util.fide.FeatureModelUtils;
 import de.variantsync.evolution.util.fide.bugfix.FixTrueFalse;
 import de.variantsync.evolution.util.functional.Result;
-import de.variantsync.evolution.feature.config.FeatureIDEConfiguration;
-import de.variantsync.evolution.feature.config.SayYesToAllConfiguration;
+import de.variantsync.evolution.util.io.CaseSensitivePath;
+import de.variantsync.evolution.util.io.PathUtils;
 import de.variantsync.evolution.variability.pc.*;
+import de.variantsync.evolution.variability.pc.options.ArtefactFilter;
+import de.variantsync.evolution.variability.pc.options.VariantGenerationOptions;
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.prop4j.And;
@@ -69,7 +71,9 @@ public boolean generate(final List<Variant> variantsToTest, final boolean writeC
 
             for (final Variant v : variantsToTest) {
                 traceToTest
-                        .generateVariant(v, splDir, variantsDir.resolve(v.getName()), VariantGenerationOptions.ExitOnErrorButAllowNonExistentFiles)
+                        .generateVariant(v, splDir,
+                                variantsDir.resolve(v.getName()),
+                                VariantGenerationOptions.ExitOnErrorButAllowNonExistentFiles(ArtefactFilter.KeepAll()))
                         // Write ground truth
                         .bind(groundTruth -> Result.Try(() -> Resources.Instance().write(
                                 Artefact.class,