Added lint for fix of comments in test code duplicate test names

src/main/java/org/eolang/lints/LtTestComment.java

@@ -0,0 +1,57 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
+ * SPDX-License-Identifier: MIT
+ */
+package org.eolang.lints;
+
+import com.github.lombrozo.xnav.Xnav;
+import com.jcabi.xml.XML;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
+import org.eolang.parser.OnDefault;
+
+/**
+ * Lint that warns if a comment is present at a test object.
+ * @since 0.0.59
+ */
+final class LtTestComment implements Lint<XML> {
+    @Override
+    public Collection<Defect> defects(final XML xmir) throws IOException {
+        final Collection<Defect> defects = new ArrayList<>(0);
+        final Xnav xml = new Xnav(xmir.inner());
+        final List<Xnav> objects = xml
+            .path("//o[@name and starts-with(@name, '+')]")
+            .collect(Collectors.toList());
+        for (final Xnav object : objects) {
+            final List<Xnav> comments = object
+                .path(".//meta[@key='comment']")
+                .collect(Collectors.toList());
+            if (!comments.isEmpty()) {
+                defects.add(
+                    new Defect.Default(
+                        "test-has-comment",
+                        Severity.WARNING,
+                        new OnDefault(xmir).get(),
+                        Integer.parseInt(object.attribute("line").text().orElse("0")),
+                        "Test object contains a comment. Prefer short, self-explanatory test names instead of documenting them."
+                    )
+                );
+            }
+        }
+        return defects;
+    }
+
+    @Override
+    public String motive() throws IOException {
+        return "Comments in test objects are discouraged as they often duplicate the test name. Prefer short, clear test names.";
+    }
+
+    @Override
+    public String name() {
+        return "test-has-comment";
+    }
+}
+

src/test/java/org/eolang/lints/LtTestCommentTest.java

@@ -0,0 +1,98 @@
+/*
+
+SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
+SPDX-License-Identifier: MIT
+*/
+package org.eolang.lints;
+
+import com.github.lombrozo.xnav.Xnav;
+import com.jcabi.xml.XML;
+import com.jcabi.xml.XMLDocument;
+import org.hamcrest.MatcherAssert;
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.util.Collection;
+
+final class LtTestCommentTest {
+
+    @Test
+    void reportsNoDefectsWhenTestObjectHasNoComment() throws IOException {
+        XML xml = new XMLDocument(
+                "<program>" +
+                        "<object name='foo' line='10'>" +
+                        "<o name='+test' line='12'>" +
+                        "</o>" +
+                        "</object>" +
+                        "</program>"
+        );
+        LtTestComment lint = new LtTestComment();
+        Collection<Defect> defects = lint.defects(xml);
+        MatcherAssert.assertThat(
+            "Should not report defects when test object has no comment",
+            defects,
+            Matchers.empty()
+        );
+    }
+
+    @Test
+    void reportsNoDefectsWhenNoTestObjectPresent() throws IOException {
+        XML xml = new XMLDocument(
+                "<program>" +
+                        "<object name='foo' line='10'>" +
+                        "<o name='bar' line='12'>" +
+                        "</o>" +
+                        "</object>" +
+                        "</program>"
+        );
+        LtTestComment lint = new LtTestComment();
+        Collection<Defect> defects = lint.defects(xml);
+        MatcherAssert.assertThat(
+            "Should not report defects when no test object is present",
+            defects,
+            Matchers.empty()
+        );
+    }
+
+    @Test
+    void motiveContainsGuidance() throws IOException {
+        LtTestComment lint = new LtTestComment();
+        MatcherAssert.assertThat(
+                "Motive must discourage comments in test objects",
+                lint.motive(),
+                Matchers.containsString("Comments in test objects are discouraged")
+        );
+    }
+
+    @Test
+    void nameIsStableId() {
+        LtTestComment lint = new LtTestComment();
+        MatcherAssert.assertThat(
+                "Rule id must be 'test-has-comment'",
+                lint.name(),
+                Matchers.equalTo("test-has-comment")
+        );
+    }
+
+    @Test
+    void reportsDefectWhenTestObjectHasComment() throws IOException {
+        final XML xml = new XMLDocument(
+            "<program>" +
+                "<object name='foo' line='10'>" +
+                "<o name='+test' line='12'>" +
+                "<meta key='comment' line='13'/>" +
+                "</o>" +
+                "</object>" +
+            "</program>"
+        );
+        final LtTestComment lint = new LtTestComment();
+        final Collection<Defect> defects = lint.defects(xml);
+        MatcherAssert.assertThat(
+            "Should report exactly one defect when a test object has a comment",
+            defects,
+            Matchers.hasSize(1)
+        );
+    }
+
+}