add comments

vladak · Sep 11, 2024 · 6dcc050 · 6dcc050
1 parent 5c241e6
commit 6dcc050
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/opengrok-indexer/src/test/java/org/opengrok/indexer/history/MercurialRepositoryTest.java b/opengrok-indexer/src/test/java/org/opengrok/indexer/history/MercurialRepositoryTest.java
@@ -449,6 +449,9 @@ void testAnnotationPositive(Pair<String, List<String>> pair) throws Exception {
         assertEquals(pair.getValue(), revisions);
     }
 
+    /**
+     * Test special case of repository with no tags, in this case empty repository.
+     */
     @Test
     void testBuildTagListEmpty() throws Exception {
         Path repositoryRootPath = Files.createDirectory(Path.of(RuntimeEnvironment.getInstance().getSourceRootPath(),
@@ -463,6 +466,9 @@ void testBuildTagListEmpty() throws Exception {
         IOUtils.removeRecursive(repositoryRootPath);
     }
 
+    /**
+     * Extract the tags from the original repository. It already contains one tag.
+     */
     @Test
     void testBuildTagListInitial() throws Exception {
         MercurialRepository hgRepo = (MercurialRepository) RepositoryFactory.getRepository(repositoryRoot);
@@ -476,6 +482,10 @@ void testBuildTagListInitial() throws Exception {
         assertEquals(expectedTags, tags);
     }
 
+    /**
+     * Clone the original repository, add new tag, check that the extracted tags contain the pre-existing
+     * and new one.
+     */
     @Test
     void testBuildTagListOneMore() throws Exception {
         Path repositoryRootPath = Files.createDirectory(Path.of(RuntimeEnvironment.getInstance().getSourceRootPath(),