Compile starter source with tests (exercism#2347)

sanderploegsma · web-flow · commit 3120f4f5d829 · 2023-09-02T06:58:25.000+02:00
* Add Gradle task to compile tests against the starter source * Check compilation of tests + starter source in CI * Fix stub implementation for `need-for-speed` * Fix stub implementation for `binary-search` * Fix stub implementation for `custom-set` * Fix stub implementation for `perfect-numbers` * Add missing import for @ignore in `pov` * Fix stub implementation for `prime-factors` * Fix stub implementation for `pythagorean-triplet` * Fix stub implementation for `rail-fence-cipher` * Fix stub implementation for `rational-numbers` * Fix stub implementation for `robot-simulator` * Fix stub implementation for `roman-numerals` * Fix stub implementation for `zipper`
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -18,8 +18,12 @@ jobs:
           distribution: "temurin"
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
-      - name: Compile and checkstyle with Gradle
-        run: cd exercises && ../gradlew check compileStarterSourceJava --exclude-task test --continue
+      - name: Check if tests compile cleanly with starter sources
+        working-directory: exercises
+        run: ../gradlew compileStarterTestJava --continue
+      - name: Run checkstyle
+        working-directory: exercises
+        run: ../gradlew check --exclude-task test --continue
 
   test:
     runs-on: ubuntu-latest
@@ -33,5 +37,6 @@ jobs:
           distribution: "temurin"
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
-      - name: Test all exercises with Gradle
-        run: cd exercises && ../gradlew test --continue
+      - name: Test all reference implementations with Gradle
+        working-directory: exercises
+        run: ../gradlew test --continue
diff --git a/exercises/build.gradle b/exercises/build.gradle
@@ -31,7 +31,7 @@ subprojects {
     // skip project named 'concept' or 'practice'
     // they are only folders containing exercises
     if(project.name == 'concept' || project.name == 'practice')
-      return;
+      return
 
     sourceSets {
       // Set the directory containing the reference solution as the default source set. Default
@@ -40,27 +40,37 @@ subprojects {
         java.srcDirs = [".meta/src/reference/java"]
       }
 
+      // Set the directory containing the @Ignore-stripped tests as the default test source set.
+      // Default test tasks will now run against this source set.
+      test {
+        java.srcDirs = [generatedTestSourceDir]
+      }
+
       // Define a custom source set named "starterSource" that points to the starter implementations
       // delivered to users. We can then use the generated "compileStarterSourceJava" task to verify
       // that the starter source compiles as-is.
       starterSource {
         java.srcDirs = ["src/main/java"]
       }
 
-      // Set the directory containing the @Ignore-stripped tests as the default test source set.
-      // Default test tasks will now run against this source set.
-      test {
-        java.srcDirs = [generatedTestSourceDir]
+      // Define a custom source set named "starterTest" that points to the tests delivered to users.
+      // We can then use the generated "compileStarterTestJava" task to verify that the tests compile
+      // cleanly against the starter source.
+      starterTest {
+        java.srcDirs = ["src/test/java"]
+        compileClasspath += starterSource.runtimeClasspath
       }
 
       // Log the source paths associated with each source set to verify they are what we expect.
-      logCompileTaskSourcePath(project, "compileJava") // Corresponds to the "main" source set.
-      logCompileTaskSourcePath(project, "compileStarterSourceJava")
+      logCompileTaskSourcePath(project, "compileJava")
       logCompileTaskSourcePath(project, "compileTestJava")
+      logCompileTaskSourcePath(project, "compileStarterSourceJava")
+      logCompileTaskSourcePath(project, "compileStarterTestJava")
     }
 
     configurations {
       starterSourceImplementation.extendsFrom implementation
+      starterTestImplementation.extendsFrom testImplementation
     }
 
     // configuration of the linter
diff --git a/exercises/concept/need-for-speed/src/main/java/NeedForSpeed.java b/exercises/concept/need-for-speed/src/main/java/NeedForSpeed.java
@@ -1,5 +1,7 @@
 class NeedForSpeed {
-    // TODO: define the constructor for the 'NeedForSpeed' class
+    NeedForSpeed(int speed, int batteryDrain) {
+        throw new UnsupportedOperationException("Please implement the NeedForSpeed constructor");
+    }
 
     public boolean batteryDrained() {
         throw new UnsupportedOperationException("Please implement the NeedForSpeed.batteryDrained() method");
@@ -19,7 +21,9 @@ public static NeedForSpeed nitro() {
 }
 
 class RaceTrack {
-    // TODO: define the constructor for the 'RaceTrack' class
+    RaceTrack(int distance) {
+        throw new UnsupportedOperationException("Please implement the RaceTrack constructor");
+    }
 
     public boolean tryFinishTrack(NeedForSpeed car) {
         throw new UnsupportedOperationException("Please implement the RaceTrack.tryFinishTrack() method");
diff --git a/exercises/practice/binary-search/src/main/java/BinarySearch.java b/exercises/practice/binary-search/src/main/java/BinarySearch.java
@@ -1,20 +1,11 @@
+import java.util.List;
 
 class BinarySearch {
-
-    int search(int a, int [] arr){
-        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
-    }
-
-    int search(float a, float [] arr){
-        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    BinarySearch(List<Integer> items) {
+        throw new UnsupportedOperationException("Please implement the BinarySearch constructor");
     }
 
-    int search(double a, double [] arr){
-        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    int indexOf(int item) throws ValueNotFoundException {
+        throw new UnsupportedOperationException("Please implement the indexOf method");
     }
-
-    int search(long a,long [] arr){
-        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
-    }
-
 }
diff --git a/exercises/practice/binary-search/src/main/java/ValueNotFoundException.java b/exercises/practice/binary-search/src/main/java/ValueNotFoundException.java
@@ -1,4 +1,4 @@
-class ValueNotFoundException extends Exception {
+public class ValueNotFoundException extends Exception {
 
     ValueNotFoundException(String message) {
         super(message);
diff --git a/exercises/practice/custom-set/src/main/java/CustomSet.java b/exercises/practice/custom-set/src/main/java/CustomSet.java
@@ -1,7 +1,6 @@
 import java.util.Collection;
 
 class CustomSet<T> {
-
     CustomSet() {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
@@ -43,4 +42,7 @@ CustomSet<T> getDifference(CustomSet<T> other) {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
+    boolean isSubset(CustomSet<T> other) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
 }
diff --git a/exercises/practice/perfect-numbers/src/main/java/NaturalNumber.java b/exercises/practice/perfect-numbers/src/main/java/NaturalNumber.java
@@ -1,6 +1,9 @@
-public class NaturalNumber {
+class NaturalNumber {
+    NaturalNumber(int number) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation");
+    }
 
-    public Classification getClassification() {
+    Classification getClassification() {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 }
diff --git a/exercises/practice/pov/src/test/java/PovTest.java b/exercises/practice/pov/src/test/java/PovTest.java
@@ -3,6 +3,7 @@
 
 import java.util.List;
 
+import org.junit.Ignore;
 import org.junit.Test;
 
 public class PovTest {
diff --git a/exercises/practice/prime-factors/src/main/java/PrimeFactorsCalculator.java b/exercises/practice/prime-factors/src/main/java/PrimeFactorsCalculator.java
@@ -2,7 +2,7 @@
 
 class PrimeFactorsCalculator {
 
-    List<Integer> calculatePrimeFactorsOf(int number) {
+    List<Long> calculatePrimeFactorsOf(long number) {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
diff --git a/exercises/practice/pythagorean-triplet/src/main/java/PythagoreanTriplet.java b/exercises/practice/pythagorean-triplet/src/main/java/PythagoreanTriplet.java
@@ -6,11 +6,11 @@ class PythagoreanTriplet {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
-    TripletListBuilder makeTripletsList() {
+    static TripletListBuilder makeTripletsList() {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
-    class TripletListBuilder {
+    static class TripletListBuilder {
 
         TripletListBuilder thatSumTo(int sum) {
             throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
diff --git a/exercises/practice/rail-fence-cipher/src/main/java/RailFenceCipher.java b/exercises/practice/rail-fence-cipher/src/main/java/RailFenceCipher.java
@@ -8,4 +8,8 @@ String getEncryptedData(String message) {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
+    String getDecryptedData(String message) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+
 }
diff --git a/exercises/practice/rational-numbers/src/main/java/Rational.java b/exercises/practice/rational-numbers/src/main/java/Rational.java
@@ -1,3 +1,5 @@
+import java.util.Objects;
+
 class Rational {
 
     Rational(int numerator, int denominator) {
@@ -12,29 +14,51 @@ int getDenominator() {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
+    Rational add(Rational other) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+
+    Rational subtract(Rational other) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+
+    Rational multiply(Rational other) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+
+    Rational divide(Rational other) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+
+    Rational abs() {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+
+    Rational pow(int power) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+
+    double exp(double exponent) {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+
     @Override
     public String toString() {
         return String.format("%d/%d", this.getNumerator(), this.getDenominator());
     }
 
     @Override
     public boolean equals(Object obj) {
-        if (obj == null || !this.getClass().isAssignableFrom(obj.getClass())) {
-            return false;
+        if (obj instanceof Rational other) {
+            return this.getNumerator() == other.getNumerator()
+                    && this.getDenominator() == other.getDenominator();
         }
 
-        Rational other = (Rational) obj;
-        return this.getNumerator() == other.getNumerator()
-            && this.getDenominator() == other.getDenominator();
+        return false;
     }
 
     @Override
     public int hashCode() {
-        int prime = 31;
-        int result = 1;
-        result = prime * result + this.getNumerator();
-        result = prime * result + this.getDenominator();
-
-        return result;
+        return Objects.hash(this.getDenominator(), this.getDenominator());
     }
 }
diff --git a/exercises/practice/robot-simulator/src/main/java/Robot.java b/exercises/practice/robot-simulator/src/main/java/Robot.java
@@ -24,7 +24,7 @@ void turnRight() {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
-    void simulate() {
+    void simulate(String instructions) {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
diff --git a/exercises/practice/roman-numerals/src/main/java/RomanNumerals.java b/exercises/practice/roman-numerals/src/main/java/RomanNumerals.java
@@ -1,7 +1,9 @@
 class RomanNumerals {
-
     RomanNumerals(int number) {
         throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
     }
 
-}
+    String getRomanNumeral() {
+        throw new UnsupportedOperationException("Delete this statement and write your own implementation.");
+    }
+}
diff --git a/exercises/practice/zipper/src/main/java/Zipper.java b/exercises/practice/zipper/src/main/java/Zipper.java
@@ -1,4 +1,8 @@
 class Zipper {
+    Zipper up;
+    Zipper left;
+    Zipper right;
+
     Zipper(int val) {
         throw new UnsupportedOperationException("Please implement the Zipper(int) constructor.");
     }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-class ValueNotFoundException extends Exception {`
	`1`	`+public class ValueNotFoundException extends Exception {`
`2`	`2`
`3`	`3`	`ValueNotFoundException(String message) {`
`4`	`4`	`super(message);`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`import java.util.Collection;`
`2`	`2`
`3`	`3`	`class CustomSet<T> {`
`4`		`-`
`5`	`4`	`CustomSet() {`
`6`	`5`	`throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`
`7`	`6`	`}`
`@@ -43,4 +42,7 @@ CustomSet<T> getDifference(CustomSet<T> other) {`
`43`	`42`	`throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`
`44`	`43`	`}`
`45`	`44`
	`45`	`+ boolean isSubset(CustomSet<T> other) {`
	`46`	`+ throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`
	`47`	`+ }`
`46`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`		`-public class NaturalNumber {`
	`1`	`+class NaturalNumber {`
	`2`	`+ NaturalNumber(int number) {`
	`3`	`+ throw new UnsupportedOperationException("Delete this statement and write your own implementation");`
	`4`	`+ }`
`2`	`5`
`3`		`- public Classification getClassification() {`
	`6`	`+ Classification getClassification() {`
`4`	`7`	`throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`
`5`	`8`	`}`
`6`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`class PrimeFactorsCalculator {`
`4`	`4`
`5`		`- List<Integer> calculatePrimeFactorsOf(int number) {`
	`5`	`+ List<Long> calculatePrimeFactorsOf(long number) {`
`6`	`6`	`throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`
`7`	`7`	`}`
`8`	`8`
Original file line number	Diff line number	Diff line change
`@@ -6,11 +6,11 @@ class PythagoreanTriplet {`
`6`	`6`	`throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`
`7`	`7`	`}`
`8`	`8`
`9`		`- TripletListBuilder makeTripletsList() {`
	`9`	`+ static TripletListBuilder makeTripletsList() {`
`10`	`10`	`throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`
`11`	`11`	`}`
`12`	`12`
`13`		`- class TripletListBuilder {`
	`13`	`+ static class TripletListBuilder {`
`14`	`14`
`15`	`15`	`TripletListBuilder thatSumTo(int sum) {`
`16`	`16`	`throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`