JavaDoc. Tidy.

Signed-off-by: Alin Dreghiciu <adreghiciu@gmail.com>
mcculls · Aug 24, 2012 · 7b8e1fb · 7b8e1fb
1 parent df2f4c3
commit 7b8e1fb
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/...te-support/src/main/java/org/sonatype/nexus/testsuite/support/hamcrest/NexusMatchers.java b/...te-support/src/main/java/org/sonatype/nexus/testsuite/support/hamcrest/NexusMatchers.java
@@ -29,6 +29,12 @@
 public abstract class NexusMatchers
 {
 
+    /**
+     * Log file should not contain any of the common unwanted exceptions: NullPointerException, ClassNotFoundException,
+     * ClassCastException.
+     *
+     * @return matcher. Never null.
+     */
     @Factory
     public static Matcher<File> logHasNoCommonExceptions()
     {
@@ -39,12 +45,22 @@ public static Matcher<File> logHasNoCommonExceptions()
         );
     }
 
+    /**
+     * Log file has no reference to plugins that failed to activate (all plugins were activated successfully).
+     *
+     * @return matcher. Never null.
+     */
     @Factory
     public static Matcher<File> logHasNoFailingPlugins()
     {
         return InversionMatcher.not( logHasFailingPlugins() );
     }
 
+    /**
+     * Log file has a reference to an arbitrary plugin that failed to activate.
+     *
+     * @return matcher. Never null.
+     */
     @Factory
     public static LogFileMatcher logHasFailingPlugins()
     {
@@ -53,6 +69,12 @@ public static LogFileMatcher logHasFailingPlugins()
         ) );
     }
 
+    /**
+     * Log file has a reference to a specified plugin that failed to activate.
+     *
+     * @param pluginId id of plugin that is supposed to fail to activate in format {@code <groupId>:<artifactId>}
+     * @return matcher. Never null.
+     */
     @Factory
     public static LogFileMatcher logHasFailingPlugin( final String pluginId )
     {

diff --git a/...support/src/test/java/org/sonatype/nexus/testsuite/support/hamcrest/NexusMatcherTest.java b/...support/src/test/java/org/sonatype/nexus/testsuite/support/hamcrest/NexusMatcherTest.java
@@ -37,9 +37,11 @@ public class NexusMatcherTest
     @Rule
     public TestInfoRule testInfo = new TestInfoRule();
 
+    /**
+     * Verify that if log file to be matched does not exist an {@link AssertionError} is thrown with a proper message.
+     */
     @Test
     public void inexistentLogFile()
-        throws Exception
     {
         thrown.expect( AssertionError.class );
         thrown.expectMessage( "java.io.FileNotFoundException: File 'nexus.log' does not exist" );
@@ -49,16 +51,21 @@ public void inexistentLogFile()
         );
     }
 
+    /**
+     * Verify that a log file that does not contain NPE,CNF,CCE matches.
+     */
     @Test
     public void logFileHasNoCommonExceptions()
-        throws Exception
     {
         assertThat(
             resolveLogFile(),
             NexusMatchers.logHasNoCommonExceptions()
         );
     }
 
+    /**
+     * Verify that a log file that has all plugins activated successfully matches.
+     */
     @Test
     public void logFileHasNoFailingPlugins()
         throws Exception
@@ -69,6 +76,9 @@ public void logFileHasNoFailingPlugins()
         );
     }
 
+    /**
+     * Verify that a log file that has failing plugins matches.
+     */
     @Test
     public void logFileHasFailingPlugins()
         throws Exception
@@ -79,6 +89,9 @@ public void logFileHasFailingPlugins()
         );
     }
 
+    /**
+     * Verify that a log file that has a failing "com.sonatype.nexus.plugin:nexus-outreach-plugin" plugin matches.
+     */
     @Test
     public void logFileHasFailingPlugin()
         throws Exception