Unit test coverage (#89)

* Add unit tests for LeapAnalyzer

* Add test coverage reporting

* Add coverage badge to README

.github/workflows/gradle.yml → .github/workflows/test.yml

@@ -21,6 +21,8 @@ jobs:
           distribution: "temurin"
       - name: Test with Gradle
         run: ./gradlew --no-daemon --continue test
+      - name: Upload test coverage
+        uses: coverallsapp/github-action@3dfc5567390f6fa9267c0ee9c251e4c8c3f18949
 
   smoke_tests:
     name: Smoke tests

README.md

@@ -1,6 +1,6 @@
-# java-analyzer
+# Java Analyzer [![Coverage Status](https://coveralls.io/repos/github/exercism/java-analyzer/badge.svg?branch=main)](https://coveralls.io/github/exercism/java-analyzer?branch=main)
 
-The Java track project-auto-mentor analyzer using abstract syntax trees
+The Java track project-auto-mentor analyzer using abstract syntax trees.
 
 
 ## Running in docker

build.gradle

@@ -2,6 +2,7 @@ plugins {
     id "com.github.johnrengelman.shadow" version "8.1.1"
     id "java"
     id "application"
+    id "jacoco"
 }
 
 group = "org.exercism"
@@ -38,4 +39,13 @@ test {
         showStandardStreams = true
         events = ["passed", "failed", "skipped"]
     }
+
+    finalizedBy jacocoTestReport
+}
+
+jacocoTestReport {
+    dependsOn test
+    reports {
+        xml.required = true
+    }
 }

src/test/java/analyzer/exercises/leap/LeapAnalyzerTest.java

@@ -0,0 +1,45 @@
+package analyzer.exercises.leap;
+
+import analyzer.AnalyzerTest;
+import analyzer.Comment;
+import analyzer.comments.AvoidHardCodedTestCases;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.stream.Stream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class LeapAnalyzerTest extends AnalyzerTest<LeapAnalyzer> {
+    private static final String RESOURCE_LOCATION = "/analyzer/exercises/leap/";
+
+    public LeapAnalyzerTest() {
+        super(LeapAnalyzer.class);
+    }
+
+    @Test
+    public void optimalSolution() {
+        var analysis = analyzeResourceFile(RESOURCE_LOCATION + "OptimalSolution.java");
+        assertThat(analysis.getComments()).isEmpty();
+    }
+
+    private static Stream<Arguments> testCases() {
+        return Stream.of(
+                Arguments.of("HardCodedTestCases.java", new AvoidHardCodedTestCases()),
+                Arguments.of("UsingGregorianCalendar.java", new NoBuiltInMethods()),
+                Arguments.of("UsingIfStatements.java", new AvoidConditionalLogic()),
+                Arguments.of("UsingJavaTime.java", new NoBuiltInMethods()),
+                Arguments.of("UsingTernary.java", new AvoidConditionalLogic()),
+                Arguments.of("UsingTooManyChecks.java", new UseMinimumNumberOfChecks())
+        );
+    }
+
+    @ParameterizedTest(name = "{0}")
+    @MethodSource("testCases")
+    public void testCommentsOnSolution(String filename, Comment expectedComment) {
+        var analysis = analyzeResourceFile(RESOURCE_LOCATION + filename);
+        assertThat(analysis.getComments()).contains(expectedComment);
+    }
+}

src/test/resources/analyzer/exercises/leap/HardCodedTestCases.java

@@ -0,0 +1,5 @@
+class Leap {
+    boolean isLeapYear(int year) {
+        return year == 1960 || year == 2000 || year == 2400 || year == 1996;
+    }
+}

src/test/resources/analyzer/exercises/leap/OptimalSolution.java

@@ -0,0 +1,5 @@
+class Leap {
+    boolean isLeapYear(int year) {
+        return year % 400 == 0 || year % 100 != 0 && year % 4 == 0;
+    }
+}

src/test/resources/analyzer/exercises/leap/UsingJavaTime.java

@@ -0,0 +1,7 @@
+import java.time.Year;
+
+class Leap {
+    boolean isLeapYear(int year) {
+        return Year.isLeap(year);
+    }
+}