From ddb3546f6cd59be9c61a1eb00132ce5094a4712d Mon Sep 17 00:00:00 2001
From: Amit Kumar Deohoria
Date: Mon, 4 Nov 2024 03:04:05 +0530
Subject: [PATCH] Issue #13345: Enable examples tests for MissingCtorCheck
---
.../checks/coding/MissingCtorCheckExamplesTest.java | 6 ++----
.../missingctor/{Example1.txt => Example1.java} | 13 +++++++------
src/xdocs/checks/coding/missingctor.xml | 12 ++++++------
src/xdocs/checks/coding/missingctor.xml.template | 4 ++--
4 files changed, 17 insertions(+), 18 deletions(-)
rename src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/{Example1.txt => Example1.java} (52%)
diff --git a/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingCtorCheckExamplesTest.java b/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingCtorCheckExamplesTest.java
index 4b16c87b5fb..8a1fbefa497 100644
--- a/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingCtorCheckExamplesTest.java
+++ b/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingCtorCheckExamplesTest.java
@@ -19,12 +19,10 @@
package com.puppycrawl.tools.checkstyle.checks.coding;
-import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
-@Disabled("until https://github.com/checkstyle/checkstyle/issues/13345")
public class MissingCtorCheckExamplesTest extends AbstractExamplesModuleTestSupport {
@Override
protected String getPackageLocation() {
@@ -34,9 +32,9 @@ protected String getPackageLocation() {
@Test
public void testExample1() throws Exception {
final String[] expected = {
-
+ "23:1: " + getCheckMessage(MissingCtorCheck.MSG_KEY),
};
- verifyWithInlineConfigParser(getPath("Example1.txt"), expected);
+ verifyWithInlineConfigParser(getPath("Example1.java"), expected);
}
}
diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/Example1.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/Example1.java
similarity index 52%
rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/Example1.txt
rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/Example1.java
index 12a3abddc65..dbf00580a54 100644
--- a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/Example1.txt
+++ b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/Example1.java
@@ -5,24 +5,25 @@
*/
+package com.puppycrawl.tools.checkstyle.checks.coding.missingctor;
// xdoc section -- start
-class ExampleOk { // OK
+public class Example1 {
private int a;
- ExampleOk(int a) {
+ Example1(int a) {
this.a = a;
}
}
-class ExampleDefaultCtor { // OK
+class ExampleDefaultCtor {
private String s;
ExampleDefaultCtor() {
s = "foobar";
}
}
-class InvalidExample { // violation, class must have a constructor.
+class InvalidExample { // violation, 'Class should define a constructor'
public void test() {}
}
-abstract class AbstractExample { // OK
- public abstract void test() {}
+abstract class AbstractExample {
+ public abstract void test();
}
// xdoc section -- end
diff --git a/src/xdocs/checks/coding/missingctor.xml b/src/xdocs/checks/coding/missingctor.xml
index b250c6c35d1..10966efa386 100644
--- a/src/xdocs/checks/coding/missingctor.xml
+++ b/src/xdocs/checks/coding/missingctor.xml
@@ -28,23 +28,23 @@
Example:
-class ExampleOk { // OK
+public class Example1 {
private int a;
- ExampleOk(int a) {
+ Example1(int a) {
this.a = a;
}
}
-class ExampleDefaultCtor { // OK
+class ExampleDefaultCtor {
private String s;
ExampleDefaultCtor() {
s = "foobar";
}
}
-class InvalidExample { // violation, class must have a constructor.
+class InvalidExample { // violation, 'Class should define a constructor'
public void test() {}
}
-abstract class AbstractExample { // OK
- public abstract void test() {}
+abstract class AbstractExample {
+ public abstract void test();
}
diff --git a/src/xdocs/checks/coding/missingctor.xml.template b/src/xdocs/checks/coding/missingctor.xml.template
index 3c4545b4489..86291be6d1a 100644
--- a/src/xdocs/checks/coding/missingctor.xml.template
+++ b/src/xdocs/checks/coding/missingctor.xml.template
@@ -21,13 +21,13 @@
+ value="resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/Example1.java"/>
Example:
+ value="resources/com/puppycrawl/tools/checkstyle/checks/coding/missingctor/Example1.java"/>