Merge pull request #184 from h1alexbel/144

feat(#144): Each Lint timings in benchmark

.github/workflows/benchmark.yml

@@ -50,6 +50,17 @@ jobs:
             printf "\`\`\`text\n"
             cat target/lint-summary.txt
             printf "\n\n"
+            header=true
+            while IFS=, read -r id ms; do
+              if [[ "$id" != "id" ]]; then
+                if $header; then
+                  header=false
+                  continue
+                fi
+                printf "%s (%s ms)\n" "$(echo "$id" | tr -d '"')" "$(echo "$ms" | tr -d '"')"
+              fi
+            done < target/timings.csv
+            printf "\n\n"
             printf "\`\`\`\n\n"
             echo "The results were calculated in [this GHA job][benchmark-gha]"
             echo "on $(date +'%Y-%m-%d') at $(date +'%H:%M'),"

pom.xml

@@ -152,6 +152,18 @@ SOFTWARE.
       <version>0.50.0</version>
       <scope>compile</scope>
     </dependency>
+    <dependency>
+      <groupId>com.yegor256</groupId>
+      <artifactId>tojos</artifactId>
+      <version>0.18.4</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.opencsv</groupId>
+      <artifactId>opencsv</artifactId>
+      <version>5.9</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>com.yegor256</groupId>
       <artifactId>mktmp</artifactId>

src/main/java/org/eolang/lints/Lint.java

@@ -34,6 +34,12 @@
  */
 public interface Lint<T> {
 
+    /**
+     * Name of the lint.
+     * @return Lint name
+     */
+    String name();
+
     /**
      * Find and return defects.
      * @param entity The entity to analyze (could be {@link com.jcabi.xml.XML}

src/main/java/org/eolang/lints/LtByXsl.java

@@ -92,6 +92,11 @@ final class LtByXsl implements Lint<XML> {
         this.doc = motive;
     }
 
+    @Override
+    public String name() {
+        return this.rule;
+    }
+
     @Override
     public Collection<Defect> defects(final XML xmir) {
         final XML report = this.sheet.transform(xmir);

src/main/java/org/eolang/lints/Program.java

@@ -92,7 +92,7 @@ public Program(final XML xml) {
     }
 
     /**
-     * Find defects possible defects in the XM§IR file.
+     * Find defects possible defects in the XMIR file.
      * @return All defects found
      */
     public Collection<Defect> defects() {

src/main/java/org/eolang/lints/comments/LtAsciiOnly.java

@@ -80,6 +80,11 @@ public Collection<Defect> defects(final XML xmir) throws IOException {
         return defects;
     }
 
+    @Override
+    public String name() {
+        return "ascii-only";
+    }
+
     @Override
     public String motive() throws Exception {
         return new TextOf(

src/main/java/org/eolang/lints/misc/LtTestNotVerb.java

@@ -140,6 +140,11 @@ public String motive() throws Exception {
         ).asString();
     }
 
+    @Override
+    public String name() {
+        return "unit-test-is-not-verb";
+    }
+
     /**
      * Prestructor for default properties.
      * @return Properties.

src/main/java/org/eolang/lints/units/LtUnitTestMissing.java

@@ -62,6 +62,11 @@ public Collection<Defect> defects(final Map<String, XML> pkg) throws IOException
         return defects;
     }
 
+    @Override
+    public String name() {
+        return "unit-test-missing";
+    }
+
     @Override
     public String motive() throws Exception {
         return "";

src/test/java/org/eolang/lints/ProgramTest.java

@@ -31,15 +31,22 @@
 import com.yegor256.MktmpResolver;
 import com.yegor256.Together;
 import com.yegor256.farea.Farea;
+import com.yegor256.tojos.MnCsv;
+import com.yegor256.tojos.TjCached;
+import com.yegor256.tojos.TjDefault;
+import com.yegor256.tojos.Tojos;
 import com.yegor256.xsline.Xsline;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.ArrayList;
 import java.util.Collection;
 import org.cactoos.io.InputOf;
 import org.cactoos.io.ResourceOf;
+import org.cactoos.iterable.Sticky;
+import org.cactoos.iterable.Synced;
 import org.cactoos.set.SetOf;
 import org.eolang.parser.EoSyntax;
 import org.eolang.parser.TrParsing;
@@ -60,12 +67,6 @@
  *  other classes in size too, for instance smaller classes (standard program),
  *  large class (JNA pointer), x-large class, and xxl class. Don't forget to
  *  adjust lint-summary.txt file to capture all the measurements.
- * @todo #134:90min Capture all the lint timings in timings.csv.
- *  Currently, we just capture total time - amount of milliseconds was required
- *  to lint some XMIR. Would be helpful to get extended statistics - timings of
- *  each lint. Don't forget to include this information into lint-summary.txt.
- *  You can check how it was implemented in HONE:
- *  <a href="https://github.com/objectionary/hone-maven-plugin/blob/master/src/main/java/org/eolang/hone/Timings.java">Timings.java</a>.
  */
 @ExtendWith(MktmpResolver.class)
 final class ProgramTest {
@@ -231,7 +232,7 @@ void lintsLargeJnaClass(@Mktmp final Path home) throws Exception {
                 ).path();
                 final XML xmir = new XMLDocument(pre);
                 final long start = System.currentTimeMillis();
-                final Collection<Defect> defects = new Program(xmir).defects();
+                final Collection<Defect> defects = new ProgramTest.BcProgram(xmir).defects();
                 final long msec = System.currentTimeMillis() - start;
                 final Path target = Paths.get("target");
                 Files.write(
@@ -262,4 +263,81 @@ void lintsLargeJnaClass(@Mktmp final Path home) throws Exception {
             }
         );
     }
+
+    /**
+     * Benchmarked program.
+     * @since 0.0.29
+     */
+    private static final class BcProgram {
+
+        /**
+         * XMIR.
+         */
+        private final XML xmir;
+
+        /**
+         * Lints to apply.
+         */
+        private final Iterable<Lint<XML>> lints;
+
+        /**
+         * Timings.
+         */
+        private final Tojos timings;
+
+        /**
+         * Ctor.
+         * @param program XMIR program to lint
+         */
+        BcProgram(final XML program) {
+            this(
+                program,
+                new Synced<>(new Sticky<>(new PkMono())),
+                new TjCached(
+                    new TjDefault(
+                        new MnCsv("target/timings.csv")
+                    )
+                )
+            );
+        }
+
+        /**
+         * Ctor.
+         * @param program XMIR program to lint
+         * @param lnts Lints to apply
+         * @param tmngs Timings
+         */
+        BcProgram(final XML program, final Iterable<Lint<XML>> lnts, final Tojos tmngs) {
+            this.xmir = program;
+            this.lints = lnts;
+            this.timings = tmngs;
+        }
+
+        /**
+         * Defects.
+         * @return Defects
+         * @todo #144:35min Resolve code duplication with Program.java class.
+         *  Currently, BcProgram.java is duplication of Program.java. Let's make
+         *  it use the original Program.java, so they will stay synced. Don't forget
+         *  to remove this puzzle.
+         */
+        public Collection<Defect> defects() {
+            try {
+                final Collection<Defect> messages = new ArrayList<>(0);
+                for (final Lint<XML> lint : this.lints) {
+                    final long start = System.currentTimeMillis();
+                    final Collection<Defect> defects = lint.defects(this.xmir);
+                    final long done = System.currentTimeMillis() - start;
+                    this.timings.add(lint.name()).set("ms", done);
+                    messages.addAll(defects);
+                }
+                return messages;
+            } catch (final IOException ex) {
+                throw new IllegalStateException(
+                    "Failed to find defects in the XMIR file",
+                    ex
+                );
+            }
+        }
+    }
 }