Merge pull request #754 from kusumotolab/refactor-output

Exporter周りのリファクタリング

Author: ty-v1

build.gradle

@@ -70,6 +70,7 @@ dependencies {
 
     testImplementation 'org.assertj:assertj-core:3.10.0'
     testImplementation 'org.mockito:mockito-core:2.+'
+    testImplementation 'com.google.jimfs:jimfs:1.1'
 
     // Declare by "runtimeOnly" cuz hamcrest is necessary to execute junit-test dynamically,
     // but it doesn't seem to be loaded on compile task.

src/main/java/jp/kusumotolab/kgenprog/CUILauncher.java

@@ -20,8 +20,7 @@
 import jp.kusumotolab.kgenprog.ga.validation.DefaultCodeValidation;
 import jp.kusumotolab.kgenprog.ga.validation.SourceCodeValidation;
 import jp.kusumotolab.kgenprog.ga.variant.Variant;
-import jp.kusumotolab.kgenprog.output.Exporter;
-import jp.kusumotolab.kgenprog.output.ExporterFactory;
+import jp.kusumotolab.kgenprog.output.Exporters;
 import jp.kusumotolab.kgenprog.project.test.LocalTestExecutor;
 import jp.kusumotolab.kgenprog.project.test.TestExecutor;
 
@@ -61,10 +60,10 @@ public List<Variant> launch(final Configuration config) {
     final VariantSelection variantSelection = new DefaultVariantSelection(config.getHeadcount(),
         random);
     final TestExecutor testExecutor = new LocalTestExecutor(config);
-    final Exporter exporter = ExporterFactory.create(config);
+    final Exporters exporters = new Exporters(config);
     final KGenProgMain kGenProgMain =
         new KGenProgMain(config, faultLocalization, mutation, crossover, sourceCodeGeneration,
-            sourceCodeValidation, variantSelection, testExecutor, exporter);
+            sourceCodeValidation, variantSelection, testExecutor, exporters);
 
     return kGenProgMain.run();
   }

src/main/java/jp/kusumotolab/kgenprog/Configuration.java

@@ -188,7 +188,7 @@ public SecondVariantSelectionStrategy.Strategy getSecondVariantSelectionStrategy
     return secondVariantSelectionStrategy;
   }
 
-  public boolean getHistoryRecord() {
+  public boolean isHistoryRecord() {
     return historyRecord;
   }
 

src/main/java/jp/kusumotolab/kgenprog/KGenProgMain.java

@@ -16,7 +16,7 @@
 import jp.kusumotolab.kgenprog.ga.validation.SourceCodeValidation;
 import jp.kusumotolab.kgenprog.ga.variant.Variant;
 import jp.kusumotolab.kgenprog.ga.variant.VariantStore;
-import jp.kusumotolab.kgenprog.output.Exporter;
+import jp.kusumotolab.kgenprog.output.Exporters;
 import jp.kusumotolab.kgenprog.project.jdt.JDTASTConstruction;
 import jp.kusumotolab.kgenprog.project.test.TestExecutor;
 import jp.kusumotolab.kgenprog.project.test.TestResult;
@@ -41,7 +41,7 @@ public class KGenProgMain {
   private final SourceCodeValidation sourceCodeValidation;
   private final VariantSelection variantSelection;
   private final TestExecutor testExecutor;
-  private final Exporter exporter;
+  private final Exporters exporters;
   private final JDTASTConstruction astConstruction;
 
   /**
@@ -55,13 +55,13 @@ public class KGenProgMain {
    * @param sourceCodeValidation コード評価を行うインスタンス
    * @param variantSelection 個体の選択を行うインスタンス
    * @param testExecutor テスト実行を行うインスタンス
-   * @param exporter 出力処理を行うインスタンス
+   * @param exporters 出力処理を行うインスタンス
    */
   public KGenProgMain(final Configuration config, final FaultLocalization faultLocalization,
       final Mutation mutation, final Crossover crossover,
       final SourceCodeGeneration sourceCodeGeneration,
       final SourceCodeValidation sourceCodeValidation, final VariantSelection variantSelection,
-      final TestExecutor testExecutor, final Exporter exporter) {
+      final TestExecutor testExecutor, final Exporters exporters) {
 
     this.config = config;
     this.faultLocalization = faultLocalization;
@@ -72,7 +72,7 @@ public KGenProgMain(final Configuration config, final FaultLocalization faultLoc
     this.variantSelection = variantSelection;
     this.testExecutor = testExecutor;
     this.astConstruction = new JDTASTConstruction();
-    this.exporter = exporter;
+    this.exporters = exporters;
   }
 
   /**
@@ -84,8 +84,6 @@ public KGenProgMain(final Configuration config, final FaultLocalization faultLoc
   public List<Variant> run() throws RuntimeException {
     logConfig();
 
-    // outDirを空にする
-    exporter.clearPreviousResults();
     testExecutor.initialize();
 
     final Strategies strategies = new Strategies(faultLocalization, astConstruction,
@@ -143,7 +141,7 @@ public List<Variant> run() throws RuntimeException {
     }
 
     // 出力処理を行う
-    exporter.export(variantStore);
+    exporters.exportAll(variantStore);
 
     stopwatch.unsplit();
     strategies.finish();

src/main/java/jp/kusumotolab/kgenprog/ga/variant/VariantStore.java

@@ -47,11 +47,11 @@ public VariantStore(final Configuration config, final Strategies strategies) {
 
     variantCounter = new AtomicLong();
     generation = new OrdinalNumber(0);
-    elementReplacer = newElementReplacer(config.getHistoryRecord());
+    elementReplacer = newElementReplacer(config.isHistoryRecord());
     initialVariant = createInitialVariant();
     currentVariants = Collections.singletonList(initialVariant);
     allVariants = new LinkedList<>();
-    variantRecorder = newVariantRecorder(config.getHistoryRecord());
+    variantRecorder = newVariantRecorder(config.isHistoryRecord());
     variantRecorder.accept(initialVariant);
     generatedVariants = new ArrayList<>();
     foundSolutions = new ArrayList<>();
@@ -230,4 +230,7 @@ private Consumer<Variant> newVariantRecorder(final boolean historyRecord) {
     };
   }
 
+  public Configuration getConfiguration() {
+    return config;
+  }
 }

src/main/java/jp/kusumotolab/kgenprog/output/Exporter.java

@@ -1,55 +1,28 @@
 package jp.kusumotolab.kgenprog.output;
 
 import java.io.IOException;
-import java.nio.file.FileVisitOption;
+import java.io.UncheckedIOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.Comparator;
-import java.util.List;
-import java.util.stream.Collectors;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import jp.kusumotolab.kgenprog.Configuration;
 import jp.kusumotolab.kgenprog.ga.variant.VariantStore;
 
 /**
- * ログや外部ファイルへの出力処理を行うクラス．
+ * ログや外部ファイルへの出力処理を行うインタフェース．
  */
-public abstract class Exporter {
-
-  private static final Logger log = LoggerFactory.getLogger(Exporter.class);
-  protected final Configuration config;
-
-  public Exporter(final Configuration config) {
-    this.config = config;
-  }
+interface Exporter {
 
   /**
    * ログや外部ファイルへの出力を行う
    */
-  public abstract void export(final VariantStore variantStore);
-
-  /**
-   * 以前の出力結果を削除する．
-   */
-  public final void clearPreviousResults() throws RuntimeException {
-    if (Files.notExists(config.getOutDir())) {
-      return;
-    }
-
-    try {
-      final List<Path> subFiles = Files.walk(config.getOutDir(), FileVisitOption.FOLLOW_LINKS)
-          .filter(e -> !e.equals(config.getOutDir()))
-          .sorted(Comparator.reverseOrder())
-          .collect(Collectors.toList());
-
-      for (final Path subFile : subFiles) {
-        Files.deleteIfExists(subFile);
+  void export(final VariantStore variantStore);
+
+  default void createDir(final Path outdir) {
+    if (Files.notExists(outdir)) {
+      try {
+        Files.createDirectories(outdir);
+      } catch (IOException e) {
+        throw new UncheckedIOException(e); // couldn't handle this exception
       }
-    } catch (final IOException e) {
-      final String message = String.format("Cannot clear directory (%s)", config.getOutDir());
-      log.error(message);
-      throw new RuntimeException(message);
     }
   }
 }

src/main/java/jp/kusumotolab/kgenprog/output/ExporterFactory.java

@@ -1,20 +1,64 @@
 package jp.kusumotolab.kgenprog.output;
 
-import java.util.List;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.Set;
+import java.util.stream.Stream;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import jp.kusumotolab.kgenprog.Configuration;
 import jp.kusumotolab.kgenprog.ga.variant.VariantStore;
 
-public class Exporters extends Exporter {
+public class Exporters {
 
-  private List<Exporter> exporters;
+  private static final Logger log = LoggerFactory.getLogger(Exporters.class);
+  private final Path outdir;
+  private final Set<Exporter> exporterSet;
 
-  public Exporters(final Configuration config, final List<Exporter> exporters) {
-    super(config);
-    this.exporters = exporters;
+  public Exporters(final Configuration config) {
+    outdir = config.getOutDir();
+    exporterSet = createExporterSet(config);
+    clearPreviousResults();
   }
 
-  @Override
-  public void export(final VariantStore variantStore) {
-    exporters.forEach(e -> e.export(variantStore));
+  private Set<Exporter> createExporterSet(final Configuration config) {
+    if (config.needNotOutput()) {
+      return Collections.emptySet();
+    }
+    if (config.isHistoryRecord()) {
+      return Set.of(new PatchExporter(outdir), new JSONExporter(outdir));
+    }
+    return Set.of(new PatchExporter(outdir));
+  }
+
+  public void exportAll(final VariantStore variantStore) {
+    if (exporterSet.isEmpty()) {
+      return; // do nothing when exporters are empty
+    }
+    this.exporterSet.forEach(e -> e.export(variantStore));
+  }
+
+  private void clearPreviousResults() {
+    if (Files.notExists(outdir)) {
+      return;
+    }
+
+    // delete outdir recursively
+    try (final Stream<Path> walk = Files.walk(outdir)) {
+      walk.sorted(Comparator.reverseOrder())
+          .forEach(path -> {
+            try {
+              Files.delete(path);
+            } catch (final IOException e) {
+              log.warn(String.format("warn: cannot clear outdir %s", path));
+            }
+          });
+    } catch (final IOException e) {
+      throw new UncheckedIOException(e);
+    }
   }
 }

src/main/java/jp/kusumotolab/kgenprog/output/Exporters.java

@@ -1,34 +1,34 @@
 package jp.kusumotolab.kgenprog.output;
 
-import java.io.IOException;
-import java.nio.file.Files;
-import java.nio.file.Path;
 import java.util.List;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import java.util.stream.Collectors;
 
 /***
  * 1ファイルの変更内容．
+ * 単一ファイルの差分情報．
+ *
  * @author k-naitou
  *
  */
 public class FileDiff {
 
-  private static final Logger log = LoggerFactory.getLogger(FileDiff.class);
-
   private final List<String> diff;
-  public final String fileName;
+  private final String fileName;
   private final List<String> originalSourceCodeLines;
   private final List<String> modifiedSourceCodeLines;
 
-  public FileDiff(final List<String> diff, final String fileName,
+  public FileDiff(final String fileName, final List<String> diff,
       final List<String> originalSourceCodeLines, final List<String> modifiedSourceCodeLines) {
     this.diff = diff;
     this.fileName = fileName;
     this.originalSourceCodeLines = originalSourceCodeLines;
     this.modifiedSourceCodeLines = modifiedSourceCodeLines;
   }
 
+  public String getFileName() {
+    return fileName;
+  }
+
   public List<String> getOriginalSourceCodeLines() {
     return originalSourceCodeLines;
   }
@@ -37,16 +37,13 @@ public List<String> getModifiedSourceCodeLines() {
     return modifiedSourceCodeLines;
   }
 
-  public String getDiff() {
-    return String.join(System.lineSeparator(), diff);
+  public List<String> getDiff() {
+    return diff;
   }
 
-  public void write(final Path outDir) {
-    try {
-      Files.write(outDir.resolve(fileName + ".java"), modifiedSourceCodeLines);
-      Files.write(outDir.resolve(fileName + ".diff"), diff);
-    } catch (final IOException e) {
-      log.error(e.getMessage(), e);
-    }
+  @Override
+  public String toString() {
+    return diff.stream()
+        .collect(Collectors.joining(System.lineSeparator()));
   }
 }

src/main/java/jp/kusumotolab/kgenprog/output/FileDiff.java

@@ -47,8 +47,8 @@ public JsonElement serialize(final FileDiff fileDiff, final Type type,
       final JsonSerializationContext context) {
 
     final JsonObject serializedFileDiff = new JsonObject();
-    serializedFileDiff.addProperty("fileName", fileDiff.fileName);
-    serializedFileDiff.addProperty("diff", fileDiff.getDiff());
+    serializedFileDiff.addProperty("fileName", fileDiff.getFileName());
+    serializedFileDiff.addProperty("diff", fileDiff.getDiff().toString());
 
     return serializedFileDiff;
   }