[accumulo] branch main updated: Update test documentation to clarify purpose. (#2704)

[ct...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ctubbsii pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/main by this push:
     new 0642fb074c Update test documentation to clarify purpose. (#2704)
0642fb074c is described below

commit 0642fb074c9309fedd0e0f4ba4f3c43942c4b782
Author: EdColeman <de...@etcoleman.com>
AuthorDate: Sat May 14 19:09:38 2022 -0400

    Update test documentation to clarify purpose. (#2704)
---
 .../java/org/apache/accumulo/test/start/KeywordStartIT.java    | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/test/src/main/java/org/apache/accumulo/test/start/KeywordStartIT.java b/test/src/main/java/org/apache/accumulo/test/start/KeywordStartIT.java
index b58ef20e5c..ce0ce5bb61 100644
--- a/test/src/main/java/org/apache/accumulo/test/start/KeywordStartIT.java
+++ b/test/src/main/java/org/apache/accumulo/test/start/KeywordStartIT.java
@@ -102,8 +102,14 @@ public class KeywordStartIT {
     assertEquals(2, results.size());
   }
 
-  // Note: this test may fail in Eclipse, if the services files haven't been generated by the
-  // AutoService annotation processor
+  /**
+   * This test guards against accidental renaming or incorrect naming of the keyword used to
+   * identify the service. The keyword is used to access the commands via the command line, so
+   * changes are visible to users and should not be changed.
+   * <p>
+   * Note: this test may fail in Eclipse, if the services files haven't been generated by the
+   * AutoService annotation processor
+   */
   @Test
   @SuppressWarnings("deprecation")
   public void testExpectedClasses() {