diff --git a/README.adoc b/README.adoc index 7a549cf..09c44e0 100644 --- a/README.adoc +++ b/README.adoc @@ -3,10 +3,20 @@ This is the Java Testing Plugin for https://jqassistant.org[jQAssistant]. For more information on jQAssistant see https://jqassistant.org[^]. -== Usage +It provides concepts for several Java frameworks that provide testing APIs, e.g. + +* AssertJ +* Camunda BPMN +* Mockito +* Project Reactor +* XMLUnit -To be able to use the plug-in, it must be specified as a plug-in to jQAssistant. +The concepts identify assertion methods and provide to the concept `java:AssertMethod`. +They are activated automatically if the latter concept is used, e.g. by a constraint. + +== Usage +To be able to use the plugin, it must be declared in the jQAssistant configuration; [source,yaml] ..jqassistant.yml @@ -15,5 +25,5 @@ jqassistant: plugins: - group-id: org.jqassistant.plugin artifact-id: jqassistant-java-testing-plugin - version: 1.0.0-SNAPSHOT + version: 1.0.0 ---- diff --git a/pom.xml b/pom.xml index 663830b..38930eb 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.jqassistant.plugin parent - 2.8.0 + 2.9.0-M3 diff --git a/src/main/resources/META-INF/jqassistant-rules/assertj.xml b/src/main/resources/META-INF/jqassistant-rules/assertj.xml index 97a1e27..e2e047c 100644 --- a/src/main/resources/META-INF/jqassistant-rules/assertj.xml +++ b/src/main/resources/META-INF/jqassistant-rules/assertj.xml @@ -2,7 +2,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> - + Sets labels :Assert and :AssertJ for AssertJ assert methods. diff --git a/src/main/resources/META-INF/jqassistant-rules/camunda-bpmn.xml b/src/main/resources/META-INF/jqassistant-rules/camunda-bpmn.xml index 7846b68..7e31f0d 100644 --- a/src/main/resources/META-INF/jqassistant-rules/camunda-bpmn.xml +++ b/src/main/resources/META-INF/jqassistant-rules/camunda-bpmn.xml @@ -2,7 +2,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> - + Sets labels :Assert and :Camunda for Camunda BPMN assert methods. diff --git a/src/main/resources/META-INF/jqassistant-rules/mockito.xml b/src/main/resources/META-INF/jqassistant-rules/mockito.xml index b06fd39..54b3100 100644 --- a/src/main/resources/META-INF/jqassistant-rules/mockito.xml +++ b/src/main/resources/META-INF/jqassistant-rules/mockito.xml @@ -2,7 +2,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> - + Sets labels :Assert and :Mockito for Mockito verify methods. @@ -22,7 +22,7 @@ ]]> - + Sets labels :Assert and :Mockito for BDDMockito then-should methods. diff --git a/src/main/resources/META-INF/jqassistant-rules/projectreactor.xml b/src/main/resources/META-INF/jqassistant-rules/projectreactor.xml index 1524e4e..37112c6 100644 --- a/src/main/resources/META-INF/jqassistant-rules/projectreactor.xml +++ b/src/main/resources/META-INF/jqassistant-rules/projectreactor.xml @@ -2,7 +2,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> - + Sets labels :Assert and :ProjectReactor for Project Reactor assert methods. diff --git a/src/main/resources/META-INF/jqassistant-rules/xmlunit-assertj.xml b/src/main/resources/META-INF/jqassistant-rules/xmlunit-assertj.xml index f3a2965..d19a994 100644 --- a/src/main/resources/META-INF/jqassistant-rules/xmlunit-assertj.xml +++ b/src/main/resources/META-INF/jqassistant-rules/xmlunit-assertj.xml @@ -2,7 +2,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> - + Sets labels :Assert and :AssertJ for xmlunit-assertj assert methods. diff --git a/src/test/java/org/jqassistant/plugin/java_testing/concept/AssertJIT.java b/src/test/java/org/jqassistant/plugin/java_testing/concept/AssertJIT.java index 7695457..49d7342 100644 --- a/src/test/java/org/jqassistant/plugin/java_testing/concept/AssertJIT.java +++ b/src/test/java/org/jqassistant/plugin/java_testing/concept/AssertJIT.java @@ -26,7 +26,7 @@ class AssertJIT extends AbstractJavaPluginIT { void assertjAssertMethod() throws Exception { scanClasses(AssertExample.class); - final Result conceptResult = applyConcept("assertj:AssertMethod"); + final Result conceptResult = applyConcept("java-testing-assertj:AssertMethod"); assertThat(conceptResult.getStatus()).isEqualTo(SUCCESS); store.beginTransaction(); diff --git a/src/test/java/org/jqassistant/plugin/java_testing/concept/CamundaIT.java b/src/test/java/org/jqassistant/plugin/java_testing/concept/CamundaIT.java index b9e4bc7..83224a3 100644 --- a/src/test/java/org/jqassistant/plugin/java_testing/concept/CamundaIT.java +++ b/src/test/java/org/jqassistant/plugin/java_testing/concept/CamundaIT.java @@ -27,7 +27,7 @@ public class CamundaIT extends AbstractJavaPluginIT { void camundaAssertMethodTest() throws Exception { scanClasses(AssertExample.class); - final Result conceptResult = applyConcept("camunda-bpmn:AssertMethod"); + final Result conceptResult = applyConcept("java-testing-camunda-bpmn:AssertMethod"); assertThat(conceptResult.getStatus()).isEqualTo(SUCCESS); store.beginTransaction(); diff --git a/src/test/java/org/jqassistant/plugin/java_testing/concept/MockitoIT.java b/src/test/java/org/jqassistant/plugin/java_testing/concept/MockitoIT.java index 3b99c12..af37bcb 100644 --- a/src/test/java/org/jqassistant/plugin/java_testing/concept/MockitoIT.java +++ b/src/test/java/org/jqassistant/plugin/java_testing/concept/MockitoIT.java @@ -28,7 +28,7 @@ class MockitoIT extends AbstractJavaPluginIT { void mockitoVerifyMethod() throws Exception { scanClasses(AssertExample.class); - final Result conceptResult = applyConcept("mockito:VerifyMethod"); + final Result conceptResult = applyConcept("java-testing-mockito:VerifyMethod"); assertThat(conceptResult.getStatus()).isEqualTo(SUCCESS); store.beginTransaction(); @@ -59,7 +59,7 @@ void mockitoVerifyMethod() throws Exception { void bddMockitoThenShouldMethod() throws Exception { scanClasses(AssertExample.class); - final Result conceptResult = applyConcept("mockito:BddThenShouldMethod"); + final Result conceptResult = applyConcept("java-testing-mockito:BddThenShouldMethod"); assertThat(conceptResult.getStatus()).isEqualTo(SUCCESS); store.beginTransaction(); diff --git a/src/test/java/org/jqassistant/plugin/java_testing/concept/ProjectReactorIT.java b/src/test/java/org/jqassistant/plugin/java_testing/concept/ProjectReactorIT.java index e185278..3d3cbc2 100644 --- a/src/test/java/org/jqassistant/plugin/java_testing/concept/ProjectReactorIT.java +++ b/src/test/java/org/jqassistant/plugin/java_testing/concept/ProjectReactorIT.java @@ -19,7 +19,7 @@ class ProjectReactorIT extends AbstractJavaPluginIT { void projectReactorAssertMethod() throws Exception { scanClasses(AssertExample.class); - final Result conceptResult = applyConcept("projectreactor:AssertMethod"); + final Result conceptResult = applyConcept("java-testing-projectreactor:AssertMethod"); assertThat(conceptResult.getStatus()).isEqualTo(SUCCESS); store.beginTransaction(); diff --git a/src/test/java/org/jqassistant/plugin/java_testing/concept/XmlUnitAssertIT.java b/src/test/java/org/jqassistant/plugin/java_testing/concept/XmlUnitAssertIT.java index 74b7670..3233626 100644 --- a/src/test/java/org/jqassistant/plugin/java_testing/concept/XmlUnitAssertIT.java +++ b/src/test/java/org/jqassistant/plugin/java_testing/concept/XmlUnitAssertIT.java @@ -26,7 +26,7 @@ class XmlUnitAssertIT extends AbstractJavaPluginIT { void xmlAssertMethod() throws Exception { scanClasses(AssertExample.class); - final Result conceptResult = applyConcept("xmlunit-assertj:AssertMethod"); + final Result conceptResult = applyConcept("java-testing-xmlunit-assertj:AssertMethod"); assertThat(conceptResult.getStatus()).isEqualTo(SUCCESS); store.beginTransaction();