Merge pull request #672 from exercism/exception-testing-info

Clean up exception-related hints

exercises/all-your-base/src/test/java/BaseConverterTest.java

@@ -12,10 +12,6 @@ import static org.junit.Assert.assertArrayEquals;
  */
 public class BaseConverterTest {
 
-    /*
-     * See https://github.com/junit-team/junit4/wiki/Rules for information on JUnit Rules in general and
-     * ExpectedExceptions in particular.
-     */
     @Rule
     public ExpectedException expectedException = ExpectedException.none();
 

exercises/change/src/test/java/ChangeCalculatorTest.java

@@ -10,10 +10,6 @@ import static org.junit.Assert.assertEquals;
 
 public class ChangeCalculatorTest {
 
-    /*
-     * See https://github.com/junit-team/junit4/wiki/Rules for information on JUnit Rules in general and
-     * ExpectedExceptions in particular.
-     */
     @Rule
     public ExpectedException expectedException = ExpectedException.none();
 

exercises/hamming/HINTS.md

@@ -0,0 +1,12 @@
+## Hints
+
+This is the first exercise with tests that require you to throw an
+[`Exception`](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html). `Exception`s are typically thrown to
+indicate that a program has encountered an unexpected input or state.
+
+We use JUnit's [`ExpectedException`](http://junit.org/junit4/javadoc/4.12/org/junit/rules/ExpectedException.html)
+[rule](https://github.com/junit-team/junit4/wiki/rules) throughout the track to verify that the exceptions you throw
+are:
+
+1. instances of a specified Java type;
+2. (optionally) initialized with a specified message.

exercises/largest-series-product/src/test/java/LargestSeriesProductCalculatorTest.java

@@ -7,10 +7,6 @@ import static org.junit.Assert.assertEquals;
 
 public class LargestSeriesProductCalculatorTest {
 
-    /*
-     * See https://github.com/junit-team/junit4/wiki/Rules for information on JUnit Rules in general and
-     * ExpectedExceptions in particular.
-     */
     @Rule
     public ExpectedException expectedException = ExpectedException.none();
 

exercises/nth-prime/src/test/java/PrimeCalculatorTest.java

@@ -10,14 +10,14 @@ import static org.junit.Assert.*;
 public class PrimeCalculatorTest {
     private PrimeCalculator primeCalculator;
 
+    @Rule
+    public ExpectedException expectedException = ExpectedException.none();
+
     @Before
     public void setup() {
         primeCalculator = new PrimeCalculator();
     }
 
-    @Rule
-    public ExpectedException thrown = ExpectedException.none();
-
     @Test
     public void testFirstPrime() {
         assertThat(primeCalculator.nth(1), is(2));
@@ -44,7 +44,7 @@ public class PrimeCalculatorTest {
     @Ignore("Remove to run test")
     @Test
     public void testUndefinedPrime() {
-        thrown.expect(IllegalArgumentException.class);
+        expectedException.expect(IllegalArgumentException.class);
         primeCalculator.nth(0);
     }
 

exercises/nucleotide-count/src/test/java/NucleotideTest.java

@@ -11,8 +11,8 @@ import static org.junit.Assert.*;
 public class NucleotideTest {
 
     @Rule
-    public ExpectedException thrown = ExpectedException.none();
-    
+    public ExpectedException expectedException = ExpectedException.none();
+
     @Test
     public void testEmptyDnaStringHasNoAdenine() {
         DNA dna = new DNA("");
@@ -87,7 +87,7 @@ public class NucleotideTest {
     @Ignore("Remove to run test")
     @Test
     public void testValidatesNucleotides() {
-        thrown.expect(IllegalArgumentException.class);
+        expectedException.expect(IllegalArgumentException.class);
         DNA dna = new DNA("GACT");
         dna.count('X');
     }

exercises/ocr-numbers/src/test/java/OpticalCharacterReaderTest.java

@@ -9,10 +9,6 @@ import static org.junit.Assert.assertEquals;
 
 public class OpticalCharacterReaderTest {
 
-    /*
-     * See https://github.com/junit-team/junit4/wiki/Rules for information on JUnit Rules in general and
-     * ExpectedExceptions in particular.
-     */
     @Rule
     public ExpectedException expectedException = ExpectedException.none();
 

exercises/pascals-triangle/src/test/java/PascalsTriangleGeneratorTest.java

@@ -21,7 +21,7 @@ public class PascalsTriangleGeneratorTest {
     }
 
     @Rule
-    public ExpectedException thrown = ExpectedException.none();
+    public ExpectedException expectedException = ExpectedException.none();
 
     @Test
     public void testTriangleWithZeroRows() {
@@ -79,7 +79,7 @@ public class PascalsTriangleGeneratorTest {
     @Ignore("Remove to run test")
     @Test
     public void testValidatesNotNegativeRows() {
-        thrown.expect(IllegalArgumentException.class);
+        expectedException.expect(IllegalArgumentException.class);
         pascalsTriangleGenerator.generateTriangle(-1);
     }
 

exercises/perfect-numbers/src/test/java/NaturalNumberTest.java

@@ -10,10 +10,6 @@ import static org.junit.Assert.assertEquals;
  */
 public class NaturalNumberTest {
 
-    /*
-     * See https://github.com/junit-team/junit4/wiki/Rules for information on JUnit Rules in general and
-     * ExpectedExceptions in particular.
-     */
     @Rule
     public ExpectedException expectedException = ExpectedException.none();
 

exercises/queen-attack/src/test/java/QueenAttackCalculatorTest.java

@@ -8,10 +8,6 @@ import static org.junit.Assert.assertTrue;
 
 public class QueenAttackCalculatorTest {
 
-    /*
-     * See https://github.com/junit-team/junit4/wiki/Rules for information on JUnit Rules in general and
-     * ExpectedExceptions in particular.
-     */
     @Rule
     public ExpectedException expectedException = ExpectedException.none();
 

exercises/series/src/test/java/SeriesTest.java

@@ -11,10 +11,10 @@ import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 
 public class SeriesTest {
-    
+
     @Rule
-    public ExpectedException thrown = ExpectedException.none();
-    
+    public ExpectedException expectedException = ExpectedException.none();
+
     @Test
     public void hasDigitsShort() {
         Series series = new Series("01234");
@@ -154,7 +154,7 @@ public class SeriesTest {
     @Test
     @Ignore("Remove to run test")
     public void throwsAnErrorIfNotEnoughDigitsToSlice() {
-        thrown.expect(IllegalArgumentException.class);
+        expectedException.expect(IllegalArgumentException.class);
         new Series("01032987583").slices(12);
     }
 }

exercises/simple-linked-list/src/test/java/SimpleLinkedListTest.java

@@ -11,7 +11,7 @@ import static org.junit.Assert.*;
 public class SimpleLinkedListTest {
 
     @Rule
-    public ExpectedException thrown = ExpectedException.none();
+    public ExpectedException expectedException = ExpectedException.none();
 
     @Test
     public void aNewListIsEmpty() {
@@ -30,7 +30,7 @@ public class SimpleLinkedListTest {
     @Ignore("Remove to run test")
     @Test
     public void popOnEmptyListWillThrow() {
-        thrown.expect(NoSuchElementException.class);
+        expectedException.expect(NoSuchElementException.class);
         SimpleLinkedList list = new SimpleLinkedList();
         list.pop();
     }

exercises/triangle/src/test/java/TriangleTest.java

@@ -8,7 +8,7 @@ import static org.junit.Assert.assertEquals;
 public class TriangleTest {
 
     @Rule
-    public final ExpectedException thrown = ExpectedException.none();
+    public ExpectedException expectedException = ExpectedException.none();
 
     @Test
     public void equilateralTrianglesHaveEqualSides() throws TriangleException {
@@ -92,35 +92,35 @@ public class TriangleTest {
     @Ignore("Remove to run test")
     @Test
     public void trianglesWithNoSizeAreIllegal() throws TriangleException {
-        thrown.expect(TriangleException.class);
+        expectedException.expect(TriangleException.class);
         new Triangle(0, 0, 0);
     }
 
     @Ignore("Remove to run test")
     @Test
     public void trianglesWithNegativeSidesAreIllegal() throws TriangleException {
-        thrown.expect(TriangleException.class);
+        expectedException.expect(TriangleException.class);
         new Triangle(3, 4, -5);
     }
 
     @Ignore("Remove to run test")
     @Test
     public void trianglesViolatingTriangleInequalityAreIllegal() throws TriangleException {
-        thrown.expect(TriangleException.class);
+        expectedException.expect(TriangleException.class);
         new Triangle(1, 1, 3);
     }
 
     @Ignore("Remove to run test")
     @Test
     public void trianglesViolatingTriangleInequalityAreIllegal2() throws TriangleException {
-        thrown.expect(TriangleException.class);
+        expectedException.expect(TriangleException.class);
         new Triangle(2, 4, 2);
     }
 
     @Ignore("Remove to run test")
     @Test
     public void trianglesViolatingTriangleInequalityAreIllegal3() throws TriangleException {
-        thrown.expect(TriangleException.class);
+        expectedException.expect(TriangleException.class);
         new Triangle(7, 3, 2);
     }
 }

exercises/wordy/src/test/java/WordProblemSolverTest.java

@@ -8,10 +8,6 @@ import static org.junit.Assert.assertEquals;
 
 public class WordProblemSolverTest {
 
-    /*
-     * See https://github.com/junit-team/junit4/wiki/Rules for information on JUnit Rules in general and
-     * ExpectedExceptions in particular.
-     */
     @Rule
     public ExpectedException expectedException = ExpectedException.none();