](http://www.vml.com/poland)
+
[](https://coveralls.io/github/Cognifide/AEM-Rules-for-SonarQube?branch=master)
-[](https://sonarcloud.io/dashboard?id=AEM-Rules-for-SonarQube)
+[
](https://www.sonarlint.org/)
+[
](https://sonarcloud.io)
+[
](https://www.sonarqube.org/)
# About AEM Rules for SonarQube
## Purpose
-As we all know, SonarQube is a great tool that helps us increase quality of our codebase. However, it does apply mainly to general Java issues. As we know, we can hurt ourselves much more doing AEM. [Adobe Experience Manager](https://docs.adobe.com/docs/en/aem/6-2.html) is a comprehensive content management platform solution for building websites, mobile apps and forms. This tool is intended to find common bugs and bad smells specific for AEM development. Documentation of each rule is available from SonarQube interface after plugin installation.
+As we all know, SonarQube is a great tool that helps us increase quality of our codebase. However, it does apply mainly to general Java issues. As we know, we can hurt ourselves much more doing AEM. [Adobe Experience Manager](https://experienceleague.adobe.com/en/docs) is a comprehensive content management platform solution for building websites, mobile apps and forms. This tool is intended to find common bugs and bad smells specific for AEM development. Documentation of each rule is available from SonarQube interface after plugin installation.
## Prerequisites
@@ -17,25 +20,16 @@ Each release has its own prerequisites section, for more information please chec
## Installation
-**Custom Dockerfile**
+### Local docker image
-Following Dockerfile uses official Sonarqube 7.9 image and download AEM Rules 1.0-RC2 to plugin directory.
+Check the plugin locally with the prepared ```docker-compose.yml```. Just run these commands from the repo root to build the latest package and fire up a container.
```
-FROM sonarqube:7.9-community AS aemrulesqube79
-RUN curl -Lk -o $SONARQUBE_HOME/extensions/plugins/aemrules-1.0-RC2.jar https://github.com/wttech/AEM-Rules-for-SonarQube/releases/download/v1.0-RC2/aemrules-1.0-RC2.jar
+mvn clean package
+cd local-docker-image
+docker-compose up -d
```
-**Community image**
-
-This is already prepared solution thanks to @ahmed-musallam.
-
-`docker run --rm -p 9000:9000 ahmedmusallam/sonarqube-aem:latest`
-
-This solution is for those who would like to start testing theirs code within aem rules and sonarqube. It contains SonarQube v 7.7, aem rules v 0.11 and predefined quality gates.
-If you would like to participate in our Aem Rules development, please refer to [wiki page](https://github.com/wttech/AEM-Rules-for-SonarQube/wiki) to get into.
-
-
### Update Center
Go to your SonarQube instance administration console and open Update Center. Find AEM Rules for SonarQube plugin and click install!
@@ -52,7 +46,6 @@ Go to your SonarQube instance administration console and open Update Center. Fin
Use of the plugin does not differ much from regular SonarQube analysis. However, as rules are often tied to a certain AEM version and its components (Felix, Sling), we've introduced the `aemVersion` analysis property.
Each rule defines supported AEM version or version range. Most of the rules are universal.
-By providing the AEM version parameter, you can instruct the Sonar Runner to only use only a subset of rules applicable to a particular AEM version. When the parameter is not provided then a default AEM version is used (currently 6.4)
### Running analysis
@@ -60,14 +53,19 @@ When running analysis, pass `sonarRunner.aemVersion` property with your AEM vers
`sonarRunner.aemVersion=Compilation error
\ No newline at end of file diff --git a/src/main/resources/com/vml/rules/htl/HTL-0.json b/src/main/resources/com/vml/rules/htl/HTL-0.json new file mode 100644 index 00000000..19eb8c25 --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-0.json @@ -0,0 +1,14 @@ +{ + "title": "Compilation error", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "5min" + }, + "tags": [ + "aem" + ], + "defaultSeverity": "Minor", + "sqKey": "HTL-0" +} diff --git a/src/main/resources/com/vml/rules/htl/HTL-1.html b/src/main/resources/com/vml/rules/htl/HTL-1.html new file mode 100644 index 00000000..b9e7f714 --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-1.html @@ -0,0 +1,10 @@ +Always Place HTL Attributes After the Ones that are Part of the Markup
+It's easier to understand HTL code if the attributes processed server-side are visually separated from the ones used at the front-end.
+Noncompliant Code Example
+
+<div data-sly-test="${model.enabled}" class="decorated" data-sly-unwrap="${!model.decorated}"> // Bad - mixing HTL attributes with other ones
+
+Compliant Solution
+
+<div class="decorated" data-sly-test="${model.enabled}" data-sly-unwrap="${!model.decorated}"> // Good - HTL-specific attributes grouped at the end of the element
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-1.json b/src/main/resources/com/vml/rules/htl/HTL-1.json
new file mode 100644
index 00000000..370f44b1
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-1.json
@@ -0,0 +1,14 @@
+{
+ "title": "Always place HTL attributes at the end",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "HTL-1"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-10.html b/src/main/resources/com/vml/rules/htl/HTL-10.html
new file mode 100644
index 00000000..f863ea2b
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-10.html
@@ -0,0 +1,10 @@
+If it's not possible to use an existing element, prefer sly tags over introducing superfluous markup that renders on the page.
+Noncompliant Code Example
++<div data-sly-use.model="com.example.Model" data-sly-use.templates="templates.html"></div> +<div data-sly-use.model="com.example.Model" data-sly-use.templates="templates.html" data-sly-unwrap></div> ++
Compliant Solution
++<sly data-sly-use.model="com.example.Model" data-sly-use.templates="templates.html"></sly> +diff --git a/src/main/resources/com/vml/rules/htl/HTL-10.json b/src/main/resources/com/vml/rules/htl/HTL-10.json new file mode 100644 index 00000000..c9c31c99 --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-10.json @@ -0,0 +1,14 @@ +{ + "title": "Use sly tags over redundant markup", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "5min" + }, + "tags": [ + "aem" + ], + "defaultSeverity": "Minor", + "sqKey": "HTL-10" +} diff --git a/src/main/resources/com/vml/rules/htl/HTL-11.html b/src/main/resources/com/vml/rules/htl/HTL-11.html new file mode 100644 index 00000000..e68bce60 --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-11.html @@ -0,0 +1,19 @@ +
Use existing HTML elements instead of adding extra sly tags.
+Noncompliant Code Example
+
+<sly data-sly-test="${model.visible}" data-sly-use="com.example.HeroModel">
+ <div class="myComponent">
+ <h1>${model.headline}</h1>
+ <p>${model.text}</p>
+ </div>
+</sly>
+
+Compliant Solution
+
+<div class="myComponent"
+ data-sly-test="${model.visible}"
+ data-sly-use="com.example.HeroModel">
+ <h1>${model.headline}</h1>
+ <p>${model.text}</p>
+</div>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-11.json b/src/main/resources/com/vml/rules/htl/HTL-11.json
new file mode 100644
index 00000000..d6d17818
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-11.json
@@ -0,0 +1,14 @@
+{
+ "title": "Use existing HTML elements instead of adding extra sly tags",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "HTL-11"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-12.html b/src/main/resources/com/vml/rules/htl/HTL-12.html
new file mode 100644
index 00000000..979b3db1
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-12.html
@@ -0,0 +1,30 @@
+Use the most restrictive HTL context possible.
+Noncompliant Code Example
+
+<div data-index-number="${model.index}"></div>
+
+Compliant Solution
+
+<div data-index-number="${model.index @ context='number'}"></div>
+
+Available markup context:
+-
+
- html - Use this in case you want to output HTMLRemoves markup that may contain XSS risks +
- text - Use this for simple HTML contentEncodes all HTML +
- elementName - Allows only element names that are white-listed, outputs 'div' otherwise - +
- attributeName - Outputs nothing if the value doesn't correspond to the HTML attribute name syntaxdoesn't allow 'style' and 'on*' attributes +
- attribute - Applies HTML attribute escaping +
- uri - Outputs nothing if the value contains XSS risks +
- scriptToken - Outputs nothing if the value doesn't correspond to an Identifier, String literal or Numeric literal JavaScript token +
- scriptString - Applies JavaScript string escaping +
- scriptComment - Context for Javascript block comments. Outputs nothing if value is trying to break out of the comment context +
- scriptRegExp - Applies JavaScript regular expression escaping +
- styleToken - Outputs nothing if the value doesn't correspond to the CSS token syntax +
- styleString - Applies CSS string escaping +
- styleComment - Context for CSS comments. Outputs nothing if value is trying to break out of the comment context +
- comment - Applies HTML comment escaping +
- number - Outputs zero if the value is not a number +
- unsafe - Use this at your own risk, this disables XSS protection completely +
See
+Source diff --git a/src/main/resources/com/vml/rules/htl/HTL-12.json b/src/main/resources/com/vml/rules/htl/HTL-12.json new file mode 100644 index 00000000..1b3eebbf --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-12.json @@ -0,0 +1,14 @@ +{ + "title": "Use the most restrictive HTL context possible", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "5min" + }, + "tags": [ + "aem" + ], + "defaultSeverity": "Minor", + "sqKey": "HTL-12" +} diff --git a/src/main/resources/com/vml/rules/htl/HTL-13.html b/src/main/resources/com/vml/rules/htl/HTL-13.html new file mode 100644 index 00000000..bae826ef --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-13.html @@ -0,0 +1,13 @@ +Avoid using 'unsafe' display context, it disables XSS protection completely.
+Noncompliant Code Example
+
+<div class="my-component>
+ <p>${model.text @ context='unsafe'}</p>
+</div>
+
+Compliant Solution
+
+<div class="my-component>
+ <p>${model.text}</p>
+</div>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-13.json b/src/main/resources/com/vml/rules/htl/HTL-13.json
new file mode 100644
index 00000000..d38381b1
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-13.json
@@ -0,0 +1,14 @@
+{
+ "title": "Avoid using 'unsafe' display context, this disables XSS protection completely",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Critical",
+ "sqKey": "HTL-13"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-14.html b/src/main/resources/com/vml/rules/htl/HTL-14.html
new file mode 100644
index 00000000..bbdab176
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-14.html
@@ -0,0 +1,9 @@
+HTL expressions in HTML comments should have defined context.
+Noncompliant Code Example
+
+<!--[if IE]><link rel="shortcut icon" href="${site.root}/images/favicon/favicon.ico?v2"><![endif]-->
+
+Compliant Solution
+
+<!--[if IE]><link rel="shortcut icon" href="${site.root @ context='uri'}/images/favicon/favicon.ico?v2"><![endif]-->
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-14.json b/src/main/resources/com/vml/rules/htl/HTL-14.json
new file mode 100644
index 00000000..a153f495
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-14.json
@@ -0,0 +1,14 @@
+{
+ "title": "Please define markup context for HTML conditional comments otherwise automatically implied context will be 'comment'",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "HTL-14"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-15.html b/src/main/resources/com/vml/rules/htl/HTL-15.html
new file mode 100644
index 00000000..40b91fa2
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-15.html
@@ -0,0 +1,15 @@
+Use Camel Case in identifiers:
+-
+
- variable names +
- template names +
Noncompliant Code Example
++<sly data-sly-template.COMPONENT_VALIDATION> +<sly data-sly-use.GalleryModel="com.example.GalleryModel"> ++
Compliant Solution
++<sly data-sly-template.componentValidation> +<sly data-sly-use.galleryModel="com.example.GalleryModel"> +diff --git a/src/main/resources/com/vml/rules/htl/HTL-15.json b/src/main/resources/com/vml/rules/htl/HTL-15.json new file mode 100644 index 00000000..93b27549 --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-15.json @@ -0,0 +1,14 @@ +{ + "title": "Use Camel Case in identifiers", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "5min" + }, + "tags": [ + "aem" + ], + "defaultSeverity": "Minor", + "sqKey": "HTL-15" +} diff --git a/src/main/resources/com/vml/rules/htl/HTL-16.html b/src/main/resources/com/vml/rules/htl/HTL-16.html new file mode 100644 index 00000000..497dd095 --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-16.html @@ -0,0 +1,15 @@ +
HTL <sly> elements are automatically unwrapped.
-
+
- variable names +
- template names +
Noncompliant Code Example
+
+<sly data-sly-test="${myTest}" data-sly-unwrap>Caption</sly>
+
+Compliant Solution
+
+<sly data-sly-test="${myTest}">Caption</sly>
+
+<sly data-sly-test="${myTest}" data-sly-unwrap="${false}">Caption</sly>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-16.json b/src/main/resources/com/vml/rules/htl/HTL-16.json
new file mode 100644
index 00000000..1790987e
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-16.json
@@ -0,0 +1,14 @@
+{
+ "title": "HTL + HTL Templates should be placed in separate files. This helps to understand which code is meant to render a component and which code is re-used as a template. + Additionally, component-specific code can be safely removed. It should be immediately obvious whether or not some code is re-used across the codebase. +
+Noncompliant Code Example
+
+<template data-sly-template.image="${@ source, description}">
+ <img src="${source}" alt="${description}" title="${description}"/>
+</template>
+
+<div class="image-component" data-sly-use.model="com.example.Image">
+ <sly data-sly-call="${image @ source=model.src, description=model.altText}"
+</div>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-2.json b/src/main/resources/com/vml/rules/htl/HTL-2.json
new file mode 100644
index 00000000..f38f05cb
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-2.json
@@ -0,0 +1,14 @@
+{
+ "title": "HTL Templates should be placed in separate files",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "15min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "HTL-2"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-3.html b/src/main/resources/com/vml/rules/htl/HTL-3.html
new file mode 100644
index 00000000..0bbf6505
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-3.html
@@ -0,0 +1,18 @@
+HTL provides implicit variables in data-sly-list and data-sly-repeat blocks.
+Try to avoid them and use explicit names clarifying the role of the objects instead.
+Noncompliant Code Example
+
+<ul data-sly-list="${model.downloadableFiles}">
+ <li>
+ <a href="${item.url}">${item.name}</a>
+ </li>
+</ul>
+
+Compliant Solution
+
+<ul data-sly-list.file="${model.downloadableFiles}">
+ <li>
+ <a href="${file.url}">${file.name}</a>
+ </li>
+</ul>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-3.json b/src/main/resources/com/vml/rules/htl/HTL-3.json
new file mode 100644
index 00000000..9e746d33
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-3.json
@@ -0,0 +1,14 @@
+{
+ "title": "Explicit names in loops",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "10min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "HTL-3"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-4.html b/src/main/resources/com/vml/rules/htl/HTL-4.html
new file mode 100644
index 00000000..4e5144e7
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-4.html
@@ -0,0 +1,19 @@
+Always try to re-use existing conditions, so the code is more readable.
+Noncompliant Code Example
+
+<span class="uber-mode__top-bar" data-sly-test="${uberModeHelper.uberModeEnabled || forceUberMode}">
+ <div class="my-component">
+ Some text
+ </div>
+</span>
+<span class="uber-mode__bottom-bar" data-sly-test="${uberModeHelper.uberModeEnabled || forceUberMode}"></span>
+
+Compliant Solution
+
+<span class="uber-mode__top-bar" data-sly-test.uberMode="${uberModeHelper.uberModeEnabled || forceUberMode}">
+ <div class="my-component">
+ Some text
+ </div>
+</span>
+<span class="uber-mode__bottom-bar" data-sly-test="${uberMode}"></span>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-4.json b/src/main/resources/com/vml/rules/htl/HTL-4.json
new file mode 100644
index 00000000..99cbb90d
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-4.json
@@ -0,0 +1,14 @@
+{
+ "title": "Consider caching data-sly-test conditions",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "10min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Info",
+ "sqKey": "HTL-4"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-5.html b/src/main/resources/com/vml/rules/htl/HTL-5.html
new file mode 100644
index 00000000..dd5c1b53
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-5.html
@@ -0,0 +1,9 @@
+Always use HTL style of commenting
+Noncompliant Code Example
++ <!-- Potentially bad, plain HTML comments will be visible on the page --> ++
Compliant Solution
++ <!--/* Good, this comment will not be rendered */--> +diff --git a/src/main/resources/com/vml/rules/htl/HTL-5.json b/src/main/resources/com/vml/rules/htl/HTL-5.json new file mode 100644 index 00000000..1e127cf0 --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-5.json @@ -0,0 +1,14 @@ +{ + "title": "Always use HTL style of comments", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "10min" + }, + "tags": [ + "aem" + ], + "defaultSeverity": "Minor", + "sqKey": "HTL-5" +} diff --git a/src/main/resources/com/vml/rules/htl/HTL-6.html b/src/main/resources/com/vml/rules/htl/HTL-6.html new file mode 100644 index 00000000..3cb207d3 --- /dev/null +++ b/src/main/resources/com/vml/rules/htl/HTL-6.html @@ -0,0 +1,13 @@ +
HTL uses uri display context as default for src, poster, manifest, href, formaction, data, cite, action attributes. Explicit display context definition should be removed.
+Noncompliant Code Example
+
+<img alt="${model.imageAlt @ context='attribute'}" src="${model.imageUrl @ context='uri'}" />
+
+Compliant Solution
+
+<img alt="${model.imageAlt}" src="${model.imageUrl}" />
+
+<div data-service-url="${model.url @ context='uri'}">
+ ${'http://www.example.org/search?s=1&q=htl' @ context='uri'}
+</div>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-6.json b/src/main/resources/com/vml/rules/htl/HTL-6.json
new file mode 100644
index 00000000..011d3ce8
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-6.json
@@ -0,0 +1,14 @@
+{
+ "title": "HTL uses uri display context as default for src, poster, manifest, href, formaction, data, cite, action attributes",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "HTL-6"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-7.html b/src/main/resources/com/vml/rules/htl/HTL-7.html
new file mode 100644
index 00000000..99feefe3
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-7.html
@@ -0,0 +1,25 @@
+For style and script tags display context definition is mandatory.
+Noncompliant Code Example
+
+<script>
+ var bar='${someText}';
+</script>
+
+<style>
+ a {
+ font-family: '${fontFamily}', sans-serif;
+ }
+</style>
+
+Compliant Solution
+
+<script>
+ var bar='${someText @ context="scriptString"}';
+</script>
+
+<style>
+ a {
+ font-family: '${fontFamily @ context="styleToken"}', sans-serif;
+ }
+</style>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-7.json b/src/main/resources/com/vml/rules/htl/HTL-7.json
new file mode 100644
index 00000000..b4390236
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-7.json
@@ -0,0 +1,14 @@
+{
+ "title": "For style and script tags display context definition is mandatory",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Major",
+ "sqKey": "HTL-7"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-8.html b/src/main/resources/com/vml/rules/htl/HTL-8.html
new file mode 100644
index 00000000..086aca83
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-8.html
@@ -0,0 +1,9 @@
+In HTL event attributes must contain display context definition.
+Noncompliant Code Example
+
+<a href="#id" onclick="${myFunctionName}()">Link</a> <!--/* Non-Compliant */-->
+
+Compliant Solution
+
+<a href="#id" onclick="${myFunctionName @ context='scriptToken'}()">Link</a>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-8.json b/src/main/resources/com/vml/rules/htl/HTL-8.json
new file mode 100644
index 00000000..7e854097
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-8.json
@@ -0,0 +1,14 @@
+{
+ "title": "For event attributes display context is mandatory",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Major",
+ "sqKey": "HTL-8"
+}
diff --git a/src/main/resources/com/vml/rules/htl/HTL-9.html b/src/main/resources/com/vml/rules/htl/HTL-9.html
new file mode 100644
index 00000000..8f295bce
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-9.html
@@ -0,0 +1,9 @@
+For inline styles display context is mandatory.
+Noncompliant Code Example
+
+<a href="#id" style="color: ${colorName};">Link</a>
+
+Compliant Solution
+
+<a href="#id" style="color: ${colorName @ context='styleToken'};">Link</a>
+
diff --git a/src/main/resources/com/vml/rules/htl/HTL-9.json b/src/main/resources/com/vml/rules/htl/HTL-9.json
new file mode 100644
index 00000000..77467a69
--- /dev/null
+++ b/src/main/resources/com/vml/rules/htl/HTL-9.json
@@ -0,0 +1,14 @@
+{
+ "title": "For inline styles display context is mandatory",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Major",
+ "sqKey": "HTL-9"
+}
diff --git a/src/main/resources/metadata/AEM-19.json b/src/main/resources/metadata/AEM-19.json
deleted file mode 100644
index 2027a78a..00000000
--- a/src/main/resources/metadata/AEM-19.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "remediation": {
- "constantCost": "30min"
- }
-}
diff --git a/src/main/resources/rules/AEM-1.md b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-1.html
similarity index 69%
rename from src/main/resources/rules/AEM-1.md
rename to src/main/resources/org/sonar/l10n/java/rules/java/AEM-1.html
index f32de86d..a60e46bc 100644
--- a/src/main/resources/rules/AEM-1.md
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-1.html
@@ -1,13 +1,13 @@
-Use constants available in AEM instead of repeating inline literals.
-== Noncompliant Code Example
-``
+Use predefined constant in annotation instead of hardcoded value.
+Noncompliant Code Example
+public static final String JCR_CONTENT = "jcr:content"; // Noncompliant; Use predefined constant available in com.day.cq.commons.jcr.JcrConstants // ... Resource resource = resourceResolver.getResource(resourcePath + JCR_CONTENT); -`` -== Compliant Solution -`` ++
Compliant Solution
+import com.day.cq.commons.jcr.JcrConstants // ... Resource resource = resourceResolver.getResource(resourcePath + JcrConstants.JCR_CONTENT); -`` +diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-1.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-1.json new file mode 100644 index 00000000..09fe6aea --- /dev/null +++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-1.json @@ -0,0 +1,14 @@ +{ + "title": "Use predefined constant in annotation instead of hardcoded value.", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "5min" + }, + "tags": [ + "aem" + ], + "defaultSeverity": "Minor", + "sqKey": "AEM-1" +} diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-11.html b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-11.html new file mode 100644 index 00000000..ac666cfe --- /dev/null +++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-11.html @@ -0,0 +1,36 @@ +
+ Administrative access to the resource tree and JCR Repository by means of usage of ResourceResolverFactory.getAdministrativeResourceResolver
+ and SlingRepository.loginAdministrative has been deprecated.
+ Use ResourceResolverFactory.getServiceResourceResolver or SlingRepository.loginService
+ respectively.
+
Noncompliant Code Example
++ResourceResolver resourceResolver = resourceResolverFactory.getAdministrativeResourceResolver(credentials); ++
+
+Session session = slingRepository.loginAdministrative(workspace); ++
Compliant Solution
+
+try (ResourceResolver resourceResolver = resolverFactory.getServiceResourceResolver(null)) {
+ ...
+}
+
+or
+
+Map<String, Object> param = new HashMap<String, Object>();
+param.put(ResourceResolverFactory.SUBSERVICE, "sub service name");
+try (ResourceResolver resourceResolver = resolverFactory.getServiceResourceResolver(param)) {
+ ...
+}
+
+or
++Session session = slingRepository.loginService(subServiceName, workspace); ++
See
+ResourceResolverFactory Javadoc+Service Authentication diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-11.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-11.json new file mode 100644 index 00000000..57a721cf --- /dev/null +++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-11.json @@ -0,0 +1,14 @@ +{ + "title": "Do not use deprecated administrative access methods", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "30min" + }, + "tags": [ + "aem" + ], + "defaultSeverity": "Major", + "sqKey": "AEM-11" +} diff --git a/src/main/resources/rules/AEM-15.md b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-15.html similarity index 53% rename from src/main/resources/rules/AEM-15.md rename to src/main/resources/org/sonar/l10n/java/rules/java/AEM-15.html index 80c73940..3a70237d 100644 --- a/src/main/resources/rules/AEM-15.md +++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-15.html @@ -1,67 +1,67 @@ -Usage of ``synchronized`` keyword should be avoided if possible. Check if using ``synchronized`` can be replaced with more sophisticated solution. +
+ Usage of synchronized keyword should be avoided if possible. Check if using synchronized
+ can be replaced with more sophisticated solution.
+
Noncompliant Code Example
+import java.util.ArrayList; import java.util.List; (...) -private final List+list = new ArrayList<>(16); +private final List<String> list = new ArrayList<>(16); public synchronized void addElement(String s) { // Noncompliant list.add(s); } -`` -or -`` +
or
+import java.util.ArrayList; import java.util.List; (...) -private final List+list = new ArrayList<>(16); +private final List<String> list = new ArrayList<>(16); public void removeElement(String s) { synchronized(list) { // Noncompliant list.remove(s); } } -`` -or -`` +
or
+
private int counter = 0;
public synchronized void increment() { // Noncompliant
counter++;
}
-``
-
-== Compliant Solution
-
-``
+
+Compliant Solution
+import java.util.List; import java.util.concurrent.CopyOnWriteArrayList; (...) -private final List+list = new CopyOnWriteArrayList<>(16); +private final ListList<String> list = new CopyOnWriteArrayList<>(16); // use java.util.concurrent.ConcurrentHashMap for Map public void addElement(String s) { list.add(s); } -`` -or -`` +
or
+import java.util.ArrayList; import java.util.List; import java.util.Collections; (...) -private final List+list = Collections.synchronizedList(new ArrayList<>(16)); +private final List<String> list = Collections.synchronizedList(new ArrayList<>(16)); // Collections object contains also synchronizedMap function public void addElement(String s) { list.add(s); } -`` -or -`` +
or
+import java.util.concurrent.atomic.AtomicInteger java.util.concurrent.atomic.LongAdder // from java 8 (...) @@ -72,9 +72,8 @@ counter.addAndGet(1); meter.increment(); } -`` - -== See -More details: -[Java 7 java.util.concurrent javadoc](https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/package-summary.html) -[Java 8 java.util.concurrent javadoc](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/package-summary.html) \ No newline at end of file ++
See
+Java 7 java.util.concurrent javadoc ++Java 8 java.util.concurrent javadoc diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-15.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-15.json new file mode 100644 index 00000000..71fc3357 --- /dev/null +++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-15.json @@ -0,0 +1,15 @@ +{ + "title": "Check if using 'synchronized' can be replaced with more sophisticated solution.", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "30min" + }, + "tags": [ + "multi-threading", + "performance" + ], + "defaultSeverity": "Info", + "sqKey": "AEM-15" +} diff --git a/src/main/resources/rules/AEM-16.md b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-16.html similarity index 62% rename from src/main/resources/rules/AEM-16.md rename to src/main/resources/org/sonar/l10n/java/rules/java/AEM-16.html index e229a8b7..a202baa8 100644 --- a/src/main/resources/rules/AEM-16.md +++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-16.html @@ -1,8 +1,9 @@ -Usage of ``@Optional`` is redundant, ``defaultInjectionStrategy`` is defined as ``OPTIONAL`` +
+ Usage of @Optional is redundant, defaultInjectionStrategy is defined as OPTIONAL
+
Noncompliant Code Example
+
@Model(adaptables = Resource.class , defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL)
public class SampleModel {
@@ -10,14 +11,13 @@
@Optional //Noncompliant
private String str1;
(...)
-``
-== Compliant Solution
-
-``
+
+Compliant Solution
+
@Model(adaptables = Resource.class , defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL)
public class SampleModel {
@Inject // Compliant
private String str1;
(...)
-``
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-16.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-16.json
new file mode 100644
index 00000000..afc53f77
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-16.json
@@ -0,0 +1,15 @@
+{
+ "title": "Check if using 'synchronized' can be replaced with more sophisticated solution.",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem",
+ "sling-models"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "AEM-16"
+}
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-17.html b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-17.html
new file mode 100644
index 00000000..fc49a908
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-17.html
@@ -0,0 +1,29 @@
+
+ The ModifiableValueMap
+ is an extension of the ValueMap which allows to modify and persist properties.
+ It is checking user permissions and returns `null` if the user has no permission to write.
+
+ The modifiable value map is only changeable through any of the following methods:
+
-
+
put(String, Object)
+ putAll(java.util.Map)
+ remove(Object)
+
+If none of the above methods is called,
ValueMap should be used instead.
+
+
+Noncompliant Code Example
+
+public Object getProperty(Resource resource) {
+ ModifiableValueMap createdResourceProperties = resource.adaptTo(ModifiableValueMap.class); // Noncompliant ValueMap should be used
+ return createdResourceProperties.get("propertyName");
+}
+
+Compliant Solution
+
+public Object getProperty(Resource resource) {
+ ValueMap createdResourceProperties = resource.getValueMap();
+ return createdResourceProperties.get("propertyName");
+}
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-17.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-17.json
new file mode 100644
index 00000000..84f40d83
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-17.json
@@ -0,0 +1,14 @@
+{
+ "title": "No mutator methods invoked on ModifiableValueMap",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "10min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Critical",
+ "sqKey": "AEM-17"
+}
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-18.html b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-18.html
new file mode 100644
index 00000000..2b7fda0e
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-18.html
@@ -0,0 +1,37 @@
+
+ The page.getContentResource()
+ is a method of the Page class
+ which allows you to get a Resource from the page.
+
+ It is possible to get a null if a jcr:content node does not exist in the repository.
+
+ Lack of jrc:content is a quite common situation and occurs when one publishes a deeply nested page without publishing its parents first.
+ In that case parent pages will be published without jrc:content node.
+
+ Therefore, you should always null check the return value of getContentResource()
+
Noncompliant Code Example
+
+public ValueMap getProperty(Page page) {
+ return page.getContentResource().getValueMap();
+}
+
+Compliant Solution
+
+public ValueMap getProperty(Page page) {
+ if (page.getContentResource != null) {
+ return page.getContentResource.getValueMap();
+ }
+ return ValueMap.EMPTY;
+}
+
+or
+
+public ValueMap getProperty(Page page) {
+ Optional<Resource> contentResource = Optional.ofNullable(page.getContentResource());
+ return contentResource.map(Resource::getValueMap).orElse(ValueMap.EMPTY);
+}
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-18.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-18.json
new file mode 100644
index 00000000..d3ca0763
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-18.json
@@ -0,0 +1,14 @@
+{
+ "title": "Always null check the returned value of Page.getContentResource() method",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "AEM-18"
+}
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-19.html b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-19.html
new file mode 100644
index 00000000..24c1b379
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-19.html
@@ -0,0 +1,23 @@
+
+ The SlingQuery
+ is a Sling resource tree traversal tool inspired by the jQuery JavaScript API.
+
+ SearchStrategy can have negative performance impact if mismatched.
+ Therefore developer should always make informed decision and define strategy explicitly.
+
Noncompliant Code Example
+
+private void strategyNotDefined(Resource resource) {
+ SlingQuery sq = $(resource);
+ sq.find();
+ }
+
+Compliant Solution
+
+private void strategyDefined(Resource resource) {
+ SlingQuery sq = $(resource).searchStrategy(SearchStrategy.BFS);
+ sq.find();
+ }
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-19.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-19.json
new file mode 100644
index 00000000..5d8e19fd
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-19.json
@@ -0,0 +1,14 @@
+{
+ "title": "Implicit search strategy used in Sling Query",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "30min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "AEM-19"
+}
diff --git a/src/main/resources/rules/AEM-2.md b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-2.html
similarity index 80%
rename from src/main/resources/rules/AEM-2.md
rename to src/main/resources/org/sonar/l10n/java/rules/java/AEM-2.html
index 47b46fa8..ce768b66 100644
--- a/src/main/resources/rules/AEM-2.md
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-2.html
@@ -1,6 +1,6 @@
-Use constants available in AEM instead of repeating inline literals.
-== Noncompliant Code Example
-``
+Use constants available in AEM instead of repeating inline literals.
+Noncompliant Code Example
+
@SlingServlet(
resourceTypes = { "some/resource/path" },
selectors = { "inspect", "install" },
@@ -8,9 +8,9 @@
methods = { "POST" } // Noncompliant; Use predefined constant available in org.apache.sling.api.servlets.HttpConstants.METHOD_POST
)
public class ComponentServlet extends SlingAllMethodsServlet {
-``
-== Compliant Solution
-``
+
+Compliant Solution
+
import org.apache.sling.api.servlets.HttpConstants;
// ...
@SlingServlet(
@@ -20,4 +20,4 @@
methods = { HttpConstants.METHOD_POST }
)
public class ComponentServlet extends SlingAllMethodsServlet {
-``
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-2.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-2.json
new file mode 100644
index 00000000..5d35e53f
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-2.json
@@ -0,0 +1,14 @@
+{
+ "title": "Use predefined constant instead of hardcoded value.",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "AEM-2"
+}
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-20.html b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-20.html
new file mode 100644
index 00000000..45a337ef
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-20.html
@@ -0,0 +1,36 @@
+
+ The ResourceResolver
+ should be initialised in
+ try-with-resources block
+ which ensures that it will be automatically closed because of the
+ Autocloseable interface.
+
+ Therefore, you should always initialise ResourceResolver in try-with-resources block
+
Noncompliant Code Example
+
+protected void getResourceResolver() {
+ ResourceResolver resourceResolver = null;
+ try {
+ resourceResolver = resourceResolverFactory.getServiceResourceResolver(null); // Noncompliant
+ } catch (LoginException e) {
+ System.out.println("something went wrong");
+ } finally {
+ if (resourceResolver != null) {
+ //resourceResolver.close();
+ }
+ }
+}
+
+Compliant Solution
+
+private void getResourceResolver() {
+ try (ResourceResolver resourceResolver = resourceResolverFactory.getServiceResourceResolver(null)) {
+ resourceResolver.getResource("path/to/resource");
+ } catch (LoginException e) {
+ System.out.println("something went wrong");
+ }
+}
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-20.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-20.json
new file mode 100644
index 00000000..2f3272f0
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-20.json
@@ -0,0 +1,14 @@
+{
+ "title": "ResourceResolver can be closed using try-with-resources Java 7 feature.",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "10min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Info",
+ "sqKey": "AEM-20"
+}
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-3.html b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-3.html
new file mode 100644
index 00000000..409721a4
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-3.html
@@ -0,0 +1,30 @@
+
+ It is not safe to keep session based object as a field in Servlet, Filter, or EventHandler.
+ As well as any Declarative Services component. Rule checks for the occurrence of any instance or static fields of
+ following types:
+
-
+
- org.apache.sling.api.resource.ResourceResolver +
- javax.jcr.Session +
- com.day.cq.wcm.api.PageManager +
Noncompliant Code Example
+
+public class ComponentsServlet extends SlingSafeMethodsServlet {
+
+ public static final ResourceResolver staticResolver; // Noncompliant
+
+ private ResourceResolver resolver; // Noncompliant
+
+ public ResourceResolver publicResolver; // Noncompliant
+
+ private PageManager pageManager; // Noncompliant
+
+ private Session session; // Noncompliant
+
++
+public class ComponentsFilter implements Filter {
+
+ private PageManager pageManager; // Noncompliant
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-3.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-3.json
new file mode 100644
index 00000000..f1f9af9f
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-3.json
@@ -0,0 +1,15 @@
+{
+ "title": "Non-thread safe object used as a field of Servlet / Filter etc.",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "1h"
+ },
+ "tags": [
+ "bug",
+ "aem"
+ ],
+ "defaultSeverity": "Critical",
+ "sqKey": "AEM-3"
+}
diff --git a/src/main/resources/rules/AEM-6.md b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-6.html
similarity index 53%
rename from src/main/resources/rules/AEM-6.md
rename to src/main/resources/org/sonar/l10n/java/rules/java/AEM-6.html
index a1e33b9d..5720a379 100644
--- a/src/main/resources/rules/AEM-6.md
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-6.html
@@ -1,23 +1,29 @@
-Resource Resolver has a life cycle which begins with the creation of the Resource Resolver using any of the factory methods and ends with calling the ``close()`` method. It is very important to call the ``close()`` method once the resource resolver is not used any more to ensure any system resources are properly clean up.
-== Noncompliant Code Example
-``
+
+ Resource Resolver has a life cycle which begins with the creation of the Resource Resolver using any of the factory
+ methods and ends with calling the close() method. It is very important to call the close()
+ method once the resource resolver is not used any more to ensure any system resources are properly clean up.
+
Noncompliant Code Example
+
try {
ResourceResolver resolver = resourceResolverFactory.getResourceResolver(authenticationInfoMap); // Noncompliant; resourceResolver should be closed in finally block
// ...
} catch (Exception e) {
// ...
}
-``
-``
+
++
try {
ResourceResolver resolver = resourceResolverFactory.getResourceResolver(authenticationInfoMap); // Noncompliant; resourceResolver should be closed in finally block
resolver.close();
} catch (Exception e) {
// ...
}
-``
-== Compliant Solution
-``
+
+Compliant Solution
+
ResourceResolver resolver = null;
try {
resolver = resourceResolverFactory.getResourceResolver(authenticationInfoMap);
@@ -29,6 +35,6 @@
resolver.close();
}
}
-``
-== See
-[ResourceResolver Javadoc](https://sling.apache.org/apidocs/sling6/org/apache/sling/api/resource/ResourceResolver.html)
+
+See
+ResourceResolver Javadoc diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-6.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-6.json new file mode 100644 index 00000000..606a138b --- /dev/null +++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-6.json @@ -0,0 +1,14 @@ +{ + "title": "ResourceResolver should be closed in finally block.", + "type": "CODE_SMELL", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "15min" + }, + "tags": [ + "aem" + ], + "defaultSeverity": "Critical", + "sqKey": "AEM-6" +} diff --git a/src/main/resources/rules/AEM-7.md b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-7.html similarity index 55% rename from src/main/resources/rules/AEM-7.md rename to src/main/resources/org/sonar/l10n/java/rules/java/AEM-7.html index 355ca057..4b811a3d 100644 --- a/src/main/resources/rules/AEM-7.md +++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-7.html @@ -1,16 +1,19 @@ -Manually created ``Session`` should be logged out after it is no longer needed. The ``logout()`` method releases all resources associated with ``Session``. -== Noncompliant Code Example -`` +
+ Manually created Session should be logged out after it is no longer needed. The logout() method releases all resources associated with Session.
+
Noncompliant Code Example
+
Session session = null;
try {
session = repository.loginService("myService", null);
// ...
} catch (RepositoryException e) {
// ...
-}
-``
-== Compliant Solution
-``
+}
+
+Compliant Solution
+
Session session = null;
try {
session = repository.loginService("myService", null);
@@ -22,4 +25,4 @@
session.logout();
}
}
-``
\ No newline at end of file
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-7.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-7.json
new file mode 100644
index 00000000..5b6338fb
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-7.json
@@ -0,0 +1,14 @@
+{
+ "title": "Session should be logged out in finally block.",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "10min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Critical",
+ "sqKey": "AEM-7"
+}
diff --git a/src/main/resources/rules/AEM-8.md b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-8.html
similarity index 72%
rename from src/main/resources/rules/AEM-8.md
rename to src/main/resources/org/sonar/l10n/java/rules/java/AEM-8.html
index dc56fe1e..a7d9b044 100644
--- a/src/main/resources/rules/AEM-8.md
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-8.html
@@ -1,6 +1,7 @@
-Prefer cleaner ``@SlingServlet`` annotation over ``@Properties`` approach. Do not mix up both approaches.
-== Noncompliant Code Example
-``
+Prefer cleaner @SlingServlet annotation over @Properties approach. Do not mix up both approaches.
Noncompliant Code Example
+
@Component
@Service(value = javax.servlet.Servlet.class)
@Properties({
@@ -9,13 +10,13 @@
@Property(name = "sling.servlet.extensions", value = { "tab" }),
@Property(name = "sling.servlet.methods", value = { HttpConstants.METHOD_GET })
})
-``
-== Compliant Solution
-``
+
+Compliant Solution
+
@SlingServlet(
resourceTypes = "some/resource/path",
selectors = "selector",
extensions = "tab",
methods = HttpConstants.METHOD_GET
)
-``
\ No newline at end of file
+
diff --git a/src/main/resources/org/sonar/l10n/java/rules/java/AEM-8.json b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-8.json
new file mode 100644
index 00000000..27a2cc55
--- /dev/null
+++ b/src/main/resources/org/sonar/l10n/java/rules/java/AEM-8.json
@@ -0,0 +1,14 @@
+{
+ "title": "Prefer cleaner @SlingServlet annotation.",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "10min"
+ },
+ "tags": [
+ "aem"
+ ],
+ "defaultSeverity": "Minor",
+ "sqKey": "AEM-8"
+}
diff --git a/src/main/resources/rules/AEM-11.md b/src/main/resources/rules/AEM-11.md
deleted file mode 100644
index 16fa3448..00000000
--- a/src/main/resources/rules/AEM-11.md
+++ /dev/null
@@ -1,30 +0,0 @@
-Administrative access to the resource tree and JCR Repository by means of usage of ``ResourceResolverFactory.getAdministrativeResourceResolver`` and ``SlingRepository.loginAdministrative`` has been deprecated.
-Use ``ResourceResolverFactory.getServiceResourceResolver`` or ``SlingRepository.loginService`` respectively.
-== Noncompliant Code Example
-``
-ResourceResolver resourceResolver = resourceResolverFactory.getAdministrativeResourceResolver(credentials);
-``
-``
-Session session = slingRepository.loginAdministrative(workspace);
-``
-== Compliant Solution
-``
-try (ResourceResolver resourceResolver = resolverFactory.getServiceResourceResolver(null)) {
- ...
-}
-``
-or
-``
-Map // Bad - mixing HTL attributes with other ones
-``
-
-== Compliant Solution
-
-``
-
// Good - HTL-specific attributes grouped at the end of the element
-``
diff --git a/src/main/resources/rules/HTL-10.md b/src/main/resources/rules/HTL-10.md
deleted file mode 100644
index 6d0b7b48..00000000
--- a/src/main/resources/rules/HTL-10.md
+++ /dev/null
@@ -1,14 +0,0 @@
-If it's not possible to use an existing element, prefer sly tags over introducing superfluous markup that renders on the page.
-
-== Noncompliant Code Examples
-
-``
-
-
-``
-
-== Compliant Solution
-
-``
-
-
-``
-
-== Compliant Solution
-
-``
-
-
-``
-
-== Compliant Solution
-
-``
-
-
-``
\ No newline at end of file
diff --git a/src/main/resources/rules/HTL-16.md b/src/main/resources/rules/HTL-16.md
deleted file mode 100644
index 4c72bb9f..00000000
--- a/src/main/resources/rules/HTL-16.md
+++ /dev/null
@@ -1,12 +0,0 @@
-HTL elements are automatically unwrapped.
-
-== Noncompliant Code Example
-``
-Caption
-``
-== Compliant Solution
-``
-Caption
-
-Caption
-``
diff --git a/src/main/resources/rules/HTL-2.md b/src/main/resources/rules/HTL-2.md
deleted file mode 100644
index fe290c05..00000000
--- a/src/main/resources/rules/HTL-2.md
+++ /dev/null
@@ -1,13 +0,0 @@
-HTL Templates should be placed in separate files. This helps to understand which code is meant to render a component and which code is re-used as a template. Additionally, component-specific code can be safely removed. It should be immediately obvious whether or not some code is re-used across the codebase.
-
-== Noncompliant Code Example
-
-``
-
- 
-
-
-
-
-${model.headline}
-${model.text}
-
-
-``
diff --git a/src/main/resources/rules/HTL-12.md b/src/main/resources/rules/HTL-12.md
deleted file mode 100644
index 2f3c51c7..00000000
--- a/src/main/resources/rules/HTL-12.md
+++ /dev/null
@@ -1,26 +0,0 @@
-Use the most restrictive HTL context possible.
-
-== Noncompliant Code Example
-````
-
-== Compliant Solution
-````
-
-Available markup context:
-* html - Use this in case you want to output HTMLRemoves markup that may contain XSS risks
-* text - Use this for simple HTML contentEncodes all HTML
-* elementName - Allows only element names that are white-listed, outputs 'div' otherwise -
-* attributeName - Outputs nothing if the value doesn't correspond to the HTML attribute name syntaxdoesn't allow 'style' and 'on*' attributes
-* attribute - Applies HTML attribute escaping
-* uri - Outputs nothing if the value contains XSS risks
-* scriptToken - Outputs nothing if the value doesn't correspond to an Identifier, String literal or Numeric literal JavaScript token
-* scriptString - Applies JavaScript string escaping
-* scriptComment - Context for Javascript block comments. Outputs nothing if value is trying to break out of the comment context
-* scriptRegExp - Applies JavaScript regular expression escaping
-* styleToken - Outputs nothing if the value doesn't correspond to the CSS token syntax
-* styleString - Applies CSS string escaping
-* styleComment - Context for CSS comments. Outputs nothing if value is trying to break out of the comment context
-* comment - Applies HTML comment escaping
-* number - Outputs zero if the value is not a number
-* unsafe - Use this at your own risk, this disables XSS protection completely
-Source : https://github.com/adobe/htl-spec/blob/master/SPECIFICATION.md#121-display-context
diff --git a/src/main/resources/rules/HTL-13.md b/src/main/resources/rules/HTL-13.md
deleted file mode 100644
index 7dda5451..00000000
--- a/src/main/resources/rules/HTL-13.md
+++ /dev/null
@@ -1,16 +0,0 @@
-Avoid using 'unsafe' display context, it disables XSS protection completely.
-
-== Noncompliant Code Example
-``
-${model.headline}
-${model.text}
-
-
-``
diff --git a/src/main/resources/rules/HTL-14.md b/src/main/resources/rules/HTL-14.md
deleted file mode 100644
index 9d69f17c..00000000
--- a/src/main/resources/rules/HTL-14.md
+++ /dev/null
@@ -1,14 +0,0 @@
-HTL expressions in HTML comments should have defined context.
-
-== Noncompliant Code Example
-
-``
-
-``
-
-
-== Compliant Solution
-
-``
-
-``
diff --git a/src/main/resources/rules/HTL-15.md b/src/main/resources/rules/HTL-15.md
deleted file mode 100644
index 92a7a6ba..00000000
--- a/src/main/resources/rules/HTL-15.md
+++ /dev/null
@@ -1,17 +0,0 @@
-Use Camel Case in identifiers:
- * variable names
- * template names
-
-== Noncompliant Code Example
-
-``
-${model.text}
-
-
-``
diff --git a/src/main/resources/rules/HTL-3.md b/src/main/resources/rules/HTL-3.md
deleted file mode 100644
index abcdbea2..00000000
--- a/src/main/resources/rules/HTL-3.md
+++ /dev/null
@@ -1,22 +0,0 @@
-HTL provides implicit variables in data-sly-list and data-sly-repeat blocks.
-Try to avoid them and use explicit names clarifying the role of the objects instead.
-
- == Noncompliant Code Example
-
-``
-
-``
-
-== Compliant Solution
-
-``
-
-
- children = contentResourceA.getChildren(); // Noncompliant
- }
-
- private void notSafeUseOfResourceAfterIfWithNullCheck(Resource resource) {
- Page page = resource.adaptTo(Page.class);
- Resource contentResource = page.getContentResource("test");
- if (contentResource != null) {
- // do something
- }
- Iterable children = contentResource.getChildren(); // Noncompliant
- }
-
- private void nullCheckUsedOnDifferentResourceThanCheckedInIfStatement(Resource resource1,
- Resource resource2) {
- Page page1 = resource1.adaptTo(Page.class);
- Page page2 = resource2.adaptTo(Page.class);
- Resource contentResource1 = page1.getContentResource();
- Resource contentResource2 = page2.getContentResource("test");
- if (contentResource1 != null) {
- Iterable children = contentResource2.getChildren(); // Noncompliant
- }
- }
-
- private void correctlyNullCheckedContentResource(Resource resource1, Resource resource2) {
- Page page1 = resource1.adaptTo(Page.class);
- Page page2 = resource2.adaptTo(Page.class);
- Resource contentResource1 = page1.getContentResource();
- Resource contentResource2 = page2.getContentResource();
- Iterable children = null;
- if (contentResource1 != null) {
- children = contentResource1.getChildren();
- if (contentResource2 != null) {
- children = contentResource1.getChildren();
- }
- children = contentResource1.getChildren();
- } else if (contentResource2 != null) {
- children = contentResource2.getChildren();
- }
- }
-
- private void directlyCallMethodOnGetContentResourceReturn(Resource resource) {
- Page page = resource.adaptTo(Page.class);
- ValueMap map = page.getContentResource().getValueMap(); // Noncompliant
- ModifiableValueMap modifiableValueMap = page.getContentResource().adaptTo(ModifiableValueMap.class); // Noncompliant
- }
-
- private void useOfOptionalInCaseOfNullContentResource(Resource resource) {
- Page page = resource.adaptTo(Page.class);
- Optional contentResourceOptional = Optional.ofNullable(page.getContentResource());
- Iterable children = contentResourceOptional.get().getChildren();
- }
-
- private boolean contentResourceNullCheckWithImmediateReturn(Resource resource) {
- Page page = resource.adaptTo(Page.class);
- Resource contentResource = page.getContentResource();
- if (contentResource == null) {
- return false;
- }
- contentResource.getValueMap();
- return true;
- }
-
- private ValueMap checkForNullWithObjectsNonNull(Resource resource) {
- ValueMap result = new ValueMapDecorator(new HashMap<>());
- Page page = resource.adaptTo(Page.class);
- Resource pageResource = page.getContentResource("test");
- if (Objects.nonNull(pageResource)) {
- result = pageResource.getValueMap();
- }
- return result;
- }
-
- private ValueMap checkForNullWithObjectsIsNull(Resource resource) {
- ValueMap result = new ValueMapDecorator(new HashMap<>());
- Page page = resource.adaptTo(Page.class);
- Resource pageResource = page.getContentResource("test");
- if (Objects.isNull(pageResource)) {
- return result;
- } else {
- return pageResource.getValueMap();
- }
- }
-
- private ValueMap checkForNullWithCommonsObjectUtilsAllNotNull(Resource resource) {
- ValueMap result = new ValueMapDecorator(new HashMap<>());
- Page page = resource.adaptTo(Page.class);
- Resource pageResource = page.getContentResource("test");
- if (ObjectUtils.allNotNull(pageResource)) {
- result = pageResource.getValueMap();
- }
- return result;
- }
-
- private ValueMap checkForNonNullWithCommonsObjectUtilsAllNotNullMultipleResources(Resource resource) {
- ValueMap result = new ValueMapDecorator(new HashMap<>());
- Page page = resource.adaptTo(Page.class);
- Resource pageResource = page.getContentResource("test");
- Resource pageResource2 = page.getContentResource("test");
- Resource pageResource3 = page.getContentResource("test");
- if (ObjectUtils.allNotNull(pageResource, pageResource2)) {
- result = pageResource.getValueMap();
- result = pageResource2.getValueMap();
- result = pageResource3.getValueMap(); // Noncompliant
- }
- return result;
- }
-}
diff --git a/src/test/files/checks/htl/AvoidExtraSlyTagsCheck.html b/src/test/files/htl/AvoidExtraSlyTagsCheck.html
similarity index 96%
rename from src/test/files/checks/htl/AvoidExtraSlyTagsCheck.html
rename to src/test/files/htl/AvoidExtraSlyTagsCheck.html
index aa91f920..0cf240ec 100644
--- a/src/test/files/checks/htl/AvoidExtraSlyTagsCheck.html
+++ b/src/test/files/htl/AvoidExtraSlyTagsCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/AvoidUsingUnsafeDisplayContextCheck.html b/src/test/files/htl/AvoidUsingUnsafeDisplayContextCheck.html
similarity index 95%
rename from src/test/files/checks/htl/AvoidUsingUnsafeDisplayContextCheck.html
rename to src/test/files/htl/AvoidUsingUnsafeDisplayContextCheck.html
index 52d117df..fdce9c34 100644
--- a/src/test/files/checks/htl/AvoidUsingUnsafeDisplayContextCheck.html
+++ b/src/test/files/htl/AvoidUsingUnsafeDisplayContextCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/CamelCaseCheck.html b/src/test/files/htl/CamelCaseCheck.html
similarity index 96%
rename from src/test/files/checks/htl/CamelCaseCheck.html
rename to src/test/files/htl/CamelCaseCheck.html
index 68901b9e..f588f875 100644
--- a/src/test/files/checks/htl/CamelCaseCheck.html
+++ b/src/test/files/htl/CamelCaseCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/DefineDisplayContextInEventAttributes.html b/src/test/files/htl/DefineDisplayContextInEventAttributes.html
similarity index 94%
rename from src/test/files/checks/htl/DefineDisplayContextInEventAttributes.html
rename to src/test/files/htl/DefineDisplayContextInEventAttributes.html
index 0c3109df..00307988 100644
--- a/src/test/files/checks/htl/DefineDisplayContextInEventAttributes.html
+++ b/src/test/files/htl/DefineDisplayContextInEventAttributes.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/DefineDisplayContextInInlineStylesCheck.html b/src/test/files/htl/DefineDisplayContextInInlineStylesCheck.html
similarity index 93%
rename from src/test/files/checks/htl/DefineDisplayContextInInlineStylesCheck.html
rename to src/test/files/htl/DefineDisplayContextInInlineStylesCheck.html
index b3cc6df8..a71e761f 100644
--- a/src/test/files/checks/htl/DefineDisplayContextInInlineStylesCheck.html
+++ b/src/test/files/htl/DefineDisplayContextInInlineStylesCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/DefineDisplayContextInScriptsAndStylesCheck.html b/src/test/files/htl/DefineDisplayContextInScriptsAndStylesCheck.html
similarity index 94%
rename from src/test/files/checks/htl/DefineDisplayContextInScriptsAndStylesCheck.html
rename to src/test/files/htl/DefineDisplayContextInScriptsAndStylesCheck.html
index c924ee22..d005d5a5 100644
--- a/src/test/files/checks/htl/DefineDisplayContextInScriptsAndStylesCheck.html
+++ b/src/test/files/htl/DefineDisplayContextInScriptsAndStylesCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/DisplayContextInConditionalCommentsCheck.html b/src/test/files/htl/DisplayContextInConditionalCommentsCheck.html
similarity index 94%
rename from src/test/files/checks/htl/DisplayContextInConditionalCommentsCheck.html
rename to src/test/files/htl/DisplayContextInConditionalCommentsCheck.html
index 7fa0a6e9..7d944ce6 100644
--- a/src/test/files/checks/htl/DisplayContextInConditionalCommentsCheck.html
+++ b/src/test/files/htl/DisplayContextInConditionalCommentsCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/htl/Empty.html b/src/test/files/htl/Empty.html
new file mode 100644
index 00000000..fa0d417f
--- /dev/null
+++ b/src/test/files/htl/Empty.html
@@ -0,0 +1,21 @@
+
diff --git a/src/test/files/checks/htl/ExplicitNamesInLoopsCheck.html b/src/test/files/htl/ExplicitNamesInLoopsCheck.html
similarity index 96%
rename from src/test/files/checks/htl/ExplicitNamesInLoopsCheck.html
rename to src/test/files/htl/ExplicitNamesInLoopsCheck.html
index f2cf6b2b..f776be5f 100644
--- a/src/test/files/checks/htl/ExplicitNamesInLoopsCheck.html
+++ b/src/test/files/htl/ExplicitNamesInLoopsCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/HtlAttributesShouldBeAtTheEndCheck.html b/src/test/files/htl/HtlAttributesShouldBeAtTheEndCheck.html
similarity index 92%
rename from src/test/files/checks/htl/HtlAttributesShouldBeAtTheEndCheck.html
rename to src/test/files/htl/HtlAttributesShouldBeAtTheEndCheck.html
index 00765b87..678aa996 100644
--- a/src/test/files/checks/htl/HtlAttributesShouldBeAtTheEndCheck.html
+++ b/src/test/files/htl/HtlAttributesShouldBeAtTheEndCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/HtlCommentsCheck.html b/src/test/files/htl/HtlCommentsCheck.html
similarity index 100%
rename from src/test/files/checks/htl/HtlCommentsCheck.html
rename to src/test/files/htl/HtlCommentsCheck.html
diff --git a/src/test/files/checks/htl/NamingAndReusingConditionsCheck.html b/src/test/files/htl/NamingAndReusingConditionsCheck.html
similarity index 96%
rename from src/test/files/checks/htl/NamingAndReusingConditionsCheck.html
rename to src/test/files/htl/NamingAndReusingConditionsCheck.html
index c72bb748..bf32f1a8 100644
--- a/src/test/files/checks/htl/NamingAndReusingConditionsCheck.html
+++ b/src/test/files/htl/NamingAndReusingConditionsCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/PlaceTemplatesInSeparateFilesCheck.html b/src/test/files/htl/PlaceTemplatesInSeparateFilesCheck.html
similarity index 97%
rename from src/test/files/checks/htl/PlaceTemplatesInSeparateFilesCheck.html
rename to src/test/files/htl/PlaceTemplatesInSeparateFilesCheck.html
index 5971d646..6087c186 100644
--- a/src/test/files/checks/htl/PlaceTemplatesInSeparateFilesCheck.html
+++ b/src/test/files/htl/PlaceTemplatesInSeparateFilesCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/SlyElementsAreAutomaticallyUnwrappedCheck.html b/src/test/files/htl/SlyElementsAreAutomaticallyUnwrappedCheck.html
similarity index 93%
rename from src/test/files/checks/htl/SlyElementsAreAutomaticallyUnwrappedCheck.html
rename to src/test/files/htl/SlyElementsAreAutomaticallyUnwrappedCheck.html
index 15675f60..4b5e6b39 100644
--- a/src/test/files/checks/htl/SlyElementsAreAutomaticallyUnwrappedCheck.html
+++ b/src/test/files/htl/SlyElementsAreAutomaticallyUnwrappedCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/UseDefaultDisplayContextCheck.html b/src/test/files/htl/UseDefaultDisplayContextCheck.html
similarity index 94%
rename from src/test/files/checks/htl/UseDefaultDisplayContextCheck.html
rename to src/test/files/htl/UseDefaultDisplayContextCheck.html
index f57025a7..d98b8835 100644
--- a/src/test/files/checks/htl/UseDefaultDisplayContextCheck.html
+++ b/src/test/files/htl/UseDefaultDisplayContextCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/UseMostRestrictiveHtlContextCheck.html b/src/test/files/htl/UseMostRestrictiveHtlContextCheck.html
similarity index 92%
rename from src/test/files/checks/htl/UseMostRestrictiveHtlContextCheck.html
rename to src/test/files/htl/UseMostRestrictiveHtlContextCheck.html
index 739de14a..b8a5753b 100644
--- a/src/test/files/checks/htl/UseMostRestrictiveHtlContextCheck.html
+++ b/src/test/files/htl/UseMostRestrictiveHtlContextCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/htl/UseSlyTagsOverRedundantMarkupCheck.html b/src/test/files/htl/UseSlyTagsOverRedundantMarkupCheck.html
similarity index 96%
rename from src/test/files/checks/htl/UseSlyTagsOverRedundantMarkupCheck.html
rename to src/test/files/htl/UseSlyTagsOverRedundantMarkupCheck.html
index aabfc29a..e3e0e4c1 100644
--- a/src/test/files/checks/htl/UseSlyTagsOverRedundantMarkupCheck.html
+++ b/src/test/files/htl/UseSlyTagsOverRedundantMarkupCheck.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/java/AdministrativeAccessUsageCheck.java b/src/test/files/java/AdministrativeAccessUsageCheck.java
similarity index 97%
rename from src/test/files/checks/java/AdministrativeAccessUsageCheck.java
rename to src/test/files/java/AdministrativeAccessUsageCheck.java
index 4719aea2..058dad75 100644
--- a/src/test/files/checks/java/AdministrativeAccessUsageCheck.java
+++ b/src/test/files/java/AdministrativeAccessUsageCheck.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,9 +17,11 @@
* limitations under the License.
* #L%
*/
+
import java.util.Map;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
+
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.api.resource.LoginException;
import org.apache.sling.api.resource.ResourceResolver;
diff --git a/src/test/files/checks/java/AnnotationsConstantsCheck.java b/src/test/files/java/AnnotationsConstantsCheck.java
similarity index 65%
rename from src/test/files/checks/java/AnnotationsConstantsCheck.java
rename to src/test/files/java/AnnotationsConstantsCheck.java
index 08639c15..f7ef8462 100644
--- a/src/test/files/checks/java/AnnotationsConstantsCheck.java
+++ b/src/test/files/java/AnnotationsConstantsCheck.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
import java.io.IOException;
import javax.servlet.ServletException;
+
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.sling.SlingServlet;
@@ -29,14 +30,14 @@
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
@SlingServlet(
- resourceTypes = {"some/resource/path"},
- selectors = {"inspect", "install"},
- extensions = {"json"},
- methods = {"POST"} // Noncompliant {{Use constant METHOD_POST from class org.apache.sling.api.servlets.HttpConstants instead of hardcoded value.}}
+ resourceTypes = {"some/resource/path"},
+ selectors = {"inspect", "install"},
+ extensions = {"json"},
+ methods = {"POST"} // Noncompliant {{Use constant METHOD_POST from class org.apache.sling.api.servlets.HttpConstants instead of hardcoded value.}}
)
@Properties({
- @Property(name = "service.vendor", value = ZenGardenConstants.VENDOR_NAME), // Noncompliant {{Use constant SERVICE_VENDOR from interface org.osgi.framework.Constants instead of hardcoded value.}}
- @Property(name = "service.description", value = "Provides import process.") // Noncompliant {{Use constant SERVICE_DESCRIPTION from interface org.osgi.framework.Constants instead of hardcoded value.}}
+ @Property(name = "service.vendor", value = ZenGardenConstants.VENDOR_NAME), // Noncompliant {{Use constant SERVICE_VENDOR from interface org.osgi.framework.Constants instead of hardcoded value.}}
+ @Property(name = "service.description", value = "Provides import process.") // Noncompliant {{Use constant SERVICE_DESCRIPTION from interface org.osgi.framework.Constants instead of hardcoded value.}}
})
public class AnnotationsConstantsCheck extends SlingAllMethodsServlet {
@@ -44,12 +45,12 @@ public class AnnotationsConstantsCheck extends SlingAllMethodsServlet {
@Override("Test")
protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response)
- throws ServletException, IOException {
+ throws ServletException, IOException {
}
@Override("service.description") // Noncompliant {{Use constant SERVICE_DESCRIPTION from interface org.osgi.framework.Constants instead of hardcoded value.}}
protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response)
- throws ServletException, IOException {
+ throws ServletException, IOException {
}
}
diff --git a/src/test/files/checks/java/resourceresolver/AutoclosableResourceResolver.java b/src/test/files/java/AutoclosableResourceResolver.java
similarity index 97%
rename from src/test/files/checks/java/resourceresolver/AutoclosableResourceResolver.java
rename to src/test/files/java/AutoclosableResourceResolver.java
index c5162c9b..74fb5c39 100644
--- a/src/test/files/checks/java/resourceresolver/AutoclosableResourceResolver.java
+++ b/src/test/files/java/AutoclosableResourceResolver.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,7 +19,6 @@
*/
package com.example;
-import java.util.Map;
import java.util.List;
import java.awt.Event;
import jdk.nashorn.internal.ir.annotations.Reference;
diff --git a/src/test/files/checks/java/ConstantsCheck.java b/src/test/files/java/ConstantsCheck.java
similarity index 96%
rename from src/test/files/checks/java/ConstantsCheck.java
rename to src/test/files/java/ConstantsCheck.java
index a0b56d8d..ffee1e22 100644
--- a/src/test/files/checks/java/ConstantsCheck.java
+++ b/src/test/files/java/ConstantsCheck.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/src/test/files/java/ContentResourceShouldBeNullCheckedCheck.java b/src/test/files/java/ContentResourceShouldBeNullCheckedCheck.java
new file mode 100644
index 00000000..20de3cb0
--- /dev/null
+++ b/src/test/files/java/ContentResourceShouldBeNullCheckedCheck.java
@@ -0,0 +1,144 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.example;
+
+import com.adobe.cq.commerce.common.ValueMapDecorator;
+import com.day.cq.wcm.api.Page;
+import org.apache.commons.lang3.ObjectUtils;
+import org.apache.sling.api.resource.ModifiableValueMap;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ValueMap;
+
+import java.util.HashMap;
+import java.util.Objects;
+import java.util.Optional;
+
+public class ContentResourceShouldBeNullCheckedCheck {
+
+ private void contentResourceNotNullCheckedBeforeUsage(Resource resource) {
+ Page page = resource.adaptTo(Page.class);
+ Resource contentResourceA = page.getContentResource();
+ Iterable children = contentResourceA.getChildren(); // Noncompliant
+ }
+
+ private void notSafeUseOfResourceAfterIfWithNullCheck(Resource resource) {
+ Page page = resource.adaptTo(Page.class);
+ Resource contentResource = page.getContentResource("test");
+ if (contentResource != null) {
+ // do something
+ }
+ Iterable children = contentResource.getChildren(); // Noncompliant
+ }
+
+ private void nullCheckUsedOnDifferentResourceThanCheckedInIfStatement(Resource resource1,
+ Resource resource2) {
+ Page page1 = resource1.adaptTo(Page.class);
+ Page page2 = resource2.adaptTo(Page.class);
+ Resource contentResource1 = page1.getContentResource();
+ Resource contentResource2 = page2.getContentResource("test");
+ if (contentResource1 != null) {
+ Iterable children = contentResource2.getChildren(); // Noncompliant
+ }
+ }
+
+ private void correctlyNullCheckedContentResource(Resource resource1, Resource resource2) {
+ Page page1 = resource1.adaptTo(Page.class);
+ Page page2 = resource2.adaptTo(Page.class);
+ Resource contentResource1 = page1.getContentResource();
+ Resource contentResource2 = page2.getContentResource();
+ Iterable children = null;
+ if (contentResource1 != null) {
+ children = contentResource1.getChildren();
+ if (contentResource2 != null) {
+ children = contentResource1.getChildren();
+ }
+ children = contentResource1.getChildren();
+ } else if (contentResource2 != null) {
+ children = contentResource2.getChildren();
+ }
+ }
+
+ private void directlyCallMethodOnGetContentResourceReturn(Resource resource) {
+ Page page = resource.adaptTo(Page.class);
+ ValueMap map = page.getContentResource().getValueMap(); // Noncompliant
+ ModifiableValueMap modifiableValueMap = page.getContentResource().adaptTo(ModifiableValueMap.class); // Noncompliant
+ }
+
+ private void useOfOptionalInCaseOfNullContentResource(Resource resource) {
+ Page page = resource.adaptTo(Page.class);
+ Optional contentResourceOptional = Optional.ofNullable(page.getContentResource());
+ Iterable children = contentResourceOptional.get().getChildren();
+ }
+
+ private boolean contentResourceNullCheckWithImmediateReturn(Resource resource) {
+ Page page = resource.adaptTo(Page.class);
+ Resource contentResource = page.getContentResource();
+ if (contentResource == null) {
+ return false;
+ }
+ contentResource.getValueMap();
+ return true;
+ }
+
+ private ValueMap checkForNullWithObjectsNonNull(Resource resource) {
+ ValueMap result = new ValueMapDecorator(new HashMap<>());
+ Page page = resource.adaptTo(Page.class);
+ Resource pageResource = page.getContentResource("test");
+ if (Objects.nonNull(pageResource)) {
+ result = pageResource.getValueMap();
+ }
+ return result;
+ }
+
+ private ValueMap checkForNullWithObjectsIsNull(Resource resource) {
+ ValueMap result = new ValueMapDecorator(new HashMap<>());
+ Page page = resource.adaptTo(Page.class);
+ Resource pageResource = page.getContentResource("test");
+ if (Objects.isNull(pageResource)) {
+ return result;
+ } else {
+ return pageResource.getValueMap();
+ }
+ }
+
+ private ValueMap checkForNullWithCommonsObjectUtilsAllNotNull(Resource resource) {
+ ValueMap result = new ValueMapDecorator(new HashMap<>());
+ Page page = resource.adaptTo(Page.class);
+ Resource pageResource = page.getContentResource("test");
+ if (ObjectUtils.allNotNull(pageResource)) {
+ result = pageResource.getValueMap();
+ }
+ return result;
+ }
+
+ private ValueMap checkForNonNullWithCommonsObjectUtilsAllNotNullMultipleResources(Resource resource) {
+ ValueMap result = new ValueMapDecorator(new HashMap<>());
+ Page page = resource.adaptTo(Page.class);
+ Resource pageResource = page.getContentResource("test");
+ Resource pageResource2 = page.getContentResource("test");
+ Resource pageResource3 = page.getContentResource("test");
+ if (ObjectUtils.allNotNull(pageResource, pageResource2)) {
+ result = pageResource.getValueMap();
+ result = pageResource2.getValueMap();
+ result = pageResource3.getValueMap(); // Noncompliant
+ }
+ return result;
+ }
+}
diff --git a/src/test/files/checks/java/slingmodels/DefaultInjectionStrategyAnnotationCheck.java b/src/test/files/java/DefaultInjectionStrategyAnnotationCheck.java
similarity index 96%
rename from src/test/files/checks/java/slingmodels/DefaultInjectionStrategyAnnotationCheck.java
rename to src/test/files/java/DefaultInjectionStrategyAnnotationCheck.java
index 24bc03d0..eeeb310c 100644
--- a/src/test/files/checks/java/slingmodels/DefaultInjectionStrategyAnnotationCheck.java
+++ b/src/test/files/java/DefaultInjectionStrategyAnnotationCheck.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.inject.Inject;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.DefaultInjectionStrategy;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.Optional;
+import javax.inject.Inject;
+
@Model(adaptables = Resource.class, defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL)
public class DefaultInjectionStrategyAnnotationCheck {
diff --git a/src/test/files/checks/java/slingmodels/DefaultInjectionStrategyAnnotationCheckMultipleAdaptables.java b/src/test/files/java/DefaultInjectionStrategyAnnotationCheckMultipleAdaptables.java
similarity index 96%
rename from src/test/files/checks/java/slingmodels/DefaultInjectionStrategyAnnotationCheckMultipleAdaptables.java
rename to src/test/files/java/DefaultInjectionStrategyAnnotationCheckMultipleAdaptables.java
index 10839aaa..8981dadc 100644
--- a/src/test/files/checks/java/slingmodels/DefaultInjectionStrategyAnnotationCheckMultipleAdaptables.java
+++ b/src/test/files/java/DefaultInjectionStrategyAnnotationCheckMultipleAdaptables.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.inject.Inject;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.DefaultInjectionStrategy;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.Optional;
+import javax.inject.Inject;
+
@Model(adaptables = {Resource.class, SlingHttpServletRequest.class}, defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL)
public class DefaultInjectionStrategyAnnotationCheckMultipleAdaptables {
diff --git a/src/test/files/checks/java/LongResourceResolverEvenListenerError.java b/src/test/files/java/LongResourceResolverEvenListenerError.java
similarity index 97%
rename from src/test/files/checks/java/LongResourceResolverEvenListenerError.java
rename to src/test/files/java/LongResourceResolverEvenListenerError.java
index 1f1b31a8..5b6b61a8 100644
--- a/src/test/files/checks/java/LongResourceResolverEvenListenerError.java
+++ b/src/test/files/java/LongResourceResolverEvenListenerError.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,11 +19,6 @@
*/
package com.example;
-import java.util.Map;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
-import javax.jcr.observation.EventIterator;
-import javax.jcr.observation.EventListener;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
@@ -33,6 +28,12 @@
import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+import javax.jcr.observation.EventIterator;
+import javax.jcr.observation.EventListener;
+import java.util.Map;
+
@Component
public class LongResourceResolverEvenListenerError implements EventListener {
diff --git a/src/test/files/checks/java/LongSessionEventListener.java b/src/test/files/java/LongSessionEventListener.java
similarity index 97%
rename from src/test/files/checks/java/LongSessionEventListener.java
rename to src/test/files/java/LongSessionEventListener.java
index a231e0dc..68fb18f4 100644
--- a/src/test/files/checks/java/LongSessionEventListener.java
+++ b/src/test/files/java/LongSessionEventListener.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,6 @@
*/
package com.example;
-import java.util.Map;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
-import javax.jcr.observation.EventIterator;
-import javax.jcr.observation.EventListener;
-import javax.jcr.observation.ObservationManager;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
@@ -34,6 +28,13 @@
import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+import javax.jcr.observation.EventIterator;
+import javax.jcr.observation.EventListener;
+import javax.jcr.observation.ObservationManager;
+import java.util.Map;
+
@Component
public class LongSessionEventListener implements EventListener {
diff --git a/src/test/files/checks/java/LongSessionEventListenerError.java b/src/test/files/java/LongSessionEventListenerError.java
similarity index 97%
rename from src/test/files/checks/java/LongSessionEventListenerError.java
rename to src/test/files/java/LongSessionEventListenerError.java
index 2f4334a0..5a5f96e8 100644
--- a/src/test/files/checks/java/LongSessionEventListenerError.java
+++ b/src/test/files/java/LongSessionEventListenerError.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,18 +19,19 @@
*/
package com.example;
-import java.util.Map;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
-import javax.jcr.observation.EventIterator;
-import javax.jcr.observation.EventListener;
-import javax.jcr.observation.ObservationManager;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+import javax.jcr.observation.EventIterator;
+import javax.jcr.observation.EventListener;
+import javax.jcr.observation.ObservationManager;
+import java.util.Map;
+
@Component
public class LongSessionEventListenerError implements EventListener {
diff --git a/src/test/files/checks/java/LongSessionService.java b/src/test/files/java/LongSessionService.java
similarity index 98%
rename from src/test/files/checks/java/LongSessionService.java
rename to src/test/files/java/LongSessionService.java
index e0e2d7ee..89e6a4cd 100644
--- a/src/test/files/checks/java/LongSessionService.java
+++ b/src/test/files/java/LongSessionService.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,6 @@
*/
package com.example;
-import java.util.Map;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
-import javax.jcr.observation.EventIterator;
-import javax.jcr.observation.EventListener;
-import javax.servlet.http.HttpServletRequest;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
@@ -37,6 +31,13 @@
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceRegistration;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+import javax.jcr.observation.EventIterator;
+import javax.jcr.observation.EventListener;
+import javax.servlet.http.HttpServletRequest;
+import java.util.Map;
+
@Component
public class LongSessionService implements EventListener {
diff --git a/src/test/files/checks/java/ModifiableValueMapUsageCheck.java b/src/test/files/java/ModifiableValueMapUsageCheck.java
similarity index 91%
rename from src/test/files/checks/java/ModifiableValueMapUsageCheck.java
rename to src/test/files/java/ModifiableValueMapUsageCheck.java
index bb79ba3e..8fdfc95b 100644
--- a/src/test/files/checks/java/ModifiableValueMapUsageCheck.java
+++ b/src/test/files/java/ModifiableValueMapUsageCheck.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,10 +19,11 @@
*/
package com.example;
-import java.util.Map;
import org.apache.sling.api.resource.ModifiableValueMap;
import org.apache.sling.api.resource.Resource;
+import java.util.Map;
+
public class ModifiableValueMapUsageCheck {
public Resource setProperty(Resource resource) {
@@ -40,12 +41,12 @@ public Resource removeProperty(Resource resource) {
}
public Object getPropertyFromResource(Resource resource) {
- ModifiableValueMap createdResourceProperties = resource.adaptTo(ModifiableValueMap.class); // Noncompliant ValueMap should be used
+ ModifiableValueMap createdResourceProperties = resource.adaptTo(ModifiableValueMap.class); // Noncompliant
return createdResourceProperties.get("propName");
}
public Object getProperty(Resource resource) {
- ModifiableValueMap createdResourceProperties = resource.adaptTo(ModifiableValueMap.class); // Noncompliant ValueMap should be used
+ ModifiableValueMap createdResourceProperties = resource.adaptTo(ModifiableValueMap.class); // Noncompliant
return getPropertyFromValueMap("propName", createdResourceProperties);
}
diff --git a/src/test/files/checks/java/ResourceResolverConsumer.java b/src/test/files/java/ResourceResolverConsumer.java
similarity index 97%
rename from src/test/files/checks/java/ResourceResolverConsumer.java
rename to src/test/files/java/ResourceResolverConsumer.java
index 2b399259..9eb074cc 100644
--- a/src/test/files/checks/java/ResourceResolverConsumer.java
+++ b/src/test/files/java/ResourceResolverConsumer.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -27,9 +27,10 @@
import com.day.cq.workflow.WorkflowSession;
import com.day.cq.workflow.exec.WorkItem;
import com.day.cq.workflow.metadata.MetaDataMap;
-import javax.jcr.Session;
import org.apache.sling.api.resource.ResourceResolver;
+import javax.jcr.Session;
+
public class ResourceResolverConsumer extends AbstractAssetWorkflowProcess {
private final ResourceResolverProducer resourceResolverProducer;
diff --git a/src/test/files/checks/java/SampleServlet.java b/src/test/files/java/SampleServlet.java
similarity index 94%
rename from src/test/files/checks/java/SampleServlet.java
rename to src/test/files/java/SampleServlet.java
index 1383679b..55ad626e 100644
--- a/src/test/files/checks/java/SampleServlet.java
+++ b/src/test/files/java/SampleServlet.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,9 +19,6 @@
*/
package com.example;
-import java.io.IOException;
-import java.util.Map;
-import javax.servlet.ServletException;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.sling.SlingServlet;
import org.apache.sling.api.SlingHttpServletRequest;
@@ -34,6 +31,10 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import javax.servlet.ServletException;
+import java.io.IOException;
+import java.util.Map;
+
@SlingServlet(paths = "somePath", methods = {HttpConstants.METHOD_GET})
public class SampleServlet extends SlingAllMethodsServlet {
@@ -42,34 +43,11 @@ public class SampleServlet extends SlingAllMethodsServlet {
@Reference
private ResourceResolverFactory resourceResolverFactory;
- @Override
- protected void doGet(final SlingHttpServletRequest request, final SlingHttpServletResponse response)
- throws ServletException, IOException {
- ResourceResolver resourceResolver = null; // Noncompliant {{ResourceResolver should be closed in finally block.}}
- try {
- resourceResolver = resourceResolverFactory.getServiceResourceResolver(null);
- } catch (LoginException e) {
- LOGGER.error("Error during getting instance of ResourceResolver class", e);
- } finally {
- if (resourceResolver != null) {
- //resourceResolver.close();
- }
- }
- }
-
- @Override
- protected void doPost(final SlingHttpServletRequest request, final SlingHttpServletResponse response)
- throws ServletException, IOException {
- ResourceResolver resourceResolver = null;
- resourceResolver = request.getResourceResolver();
- // do sth
- }
-
/**
* Create a new session for specified user (impersonating).
*/
public static ResourceResolver getResourceResolverForUser(ResourceResolverFactory factory, String userId)
- throws LoginException {
+ throws LoginException {
ResourceResolver resolver;
if (userId != null) {
Map authenticationInfo = new HashMap<>();
@@ -82,24 +60,47 @@ public static ResourceResolver getResourceResolverForUser(ResourceResolverFactor
}
public static ResourceResolver getResourceResolverForUserNested(ResourceResolverFactory factory, String userId)
- throws LoginException {
+ throws LoginException {
ResourceResolver resolver;
resolver = getResourceResolverForUser(resourceResolverFactory, userId);
return resolver;
}
public static ResourceResolver getResourceResolverForUserInit(ResourceResolverFactory factory)
- throws LoginException {
+ throws LoginException {
ResourceResolver resolver = factory.getServiceResourceResolver(null);
return resolver;
}
public static ResourceResolver getResourceResolverForUserNestedInit(ResourceResolverFactory factory)
- throws LoginException {
+ throws LoginException {
ResourceResolver resolver = getResourceResolverForUserInit(resourceResolverFactory);
return resolver;
}
+ @Override
+ protected void doGet(final SlingHttpServletRequest request, final SlingHttpServletResponse response)
+ throws ServletException, IOException {
+ ResourceResolver resourceResolver = null; // Noncompliant {{ResourceResolver should be closed in finally block.}}
+ try {
+ resourceResolver = resourceResolverFactory.getServiceResourceResolver(null);
+ } catch (LoginException e) {
+ LOGGER.error("Error during getting instance of ResourceResolver class", e);
+ } finally {
+ if (resourceResolver != null) {
+ //resourceResolver.close();
+ }
+ }
+ }
+
+ @Override
+ protected void doPost(final SlingHttpServletRequest request, final SlingHttpServletResponse response)
+ throws ServletException, IOException {
+ ResourceResolver resourceResolver = null;
+ resourceResolver = request.getResourceResolver();
+ // do sth
+ }
+
public void checkCorrectJumpMethod() {
ResourceResolver resourceResolver = null;
try {
diff --git a/src/test/files/checks/java/SessionLogoutEight.java b/src/test/files/java/SessionLogoutEight.java
similarity index 95%
rename from src/test/files/checks/java/SessionLogoutEight.java
rename to src/test/files/java/SessionLogoutEight.java
index 53cd2a38..09cc4a7e 100644
--- a/src/test/files/checks/java/SessionLogoutEight.java
+++ b/src/test/files/java/SessionLogoutEight.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
@Component(immediate = true)
public class SessionLogout {
diff --git a/src/test/files/checks/java/SessionLogoutFive.java b/src/test/files/java/SessionLogoutFive.java
similarity index 95%
rename from src/test/files/checks/java/SessionLogoutFive.java
rename to src/test/files/java/SessionLogoutFive.java
index 2fba3ba3..9e2c4b1f 100644
--- a/src/test/files/checks/java/SessionLogoutFive.java
+++ b/src/test/files/java/SessionLogoutFive.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
@Component(immediate = true)
public class SessionLogout {
diff --git a/src/test/files/checks/java/SessionLogoutFour.java b/src/test/files/java/SessionLogoutFour.java
similarity index 96%
rename from src/test/files/checks/java/SessionLogoutFour.java
rename to src/test/files/java/SessionLogoutFour.java
index 03b53f92..b7a7f206 100644
--- a/src/test/files/checks/java/SessionLogoutFour.java
+++ b/src/test/files/java/SessionLogoutFour.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
@Component(immediate = true)
public class SessionLogout {
diff --git a/src/test/files/checks/java/SessionLogoutOne.java b/src/test/files/java/SessionLogoutOne.java
similarity index 96%
rename from src/test/files/checks/java/SessionLogoutOne.java
rename to src/test/files/java/SessionLogoutOne.java
index cc661303..72798db3 100644
--- a/src/test/files/checks/java/SessionLogoutOne.java
+++ b/src/test/files/java/SessionLogoutOne.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
@Component(immediate = true)
public class SessionLogout {
diff --git a/src/test/files/checks/java/SessionLogoutSeven.java b/src/test/files/java/SessionLogoutSeven.java
similarity index 96%
rename from src/test/files/checks/java/SessionLogoutSeven.java
rename to src/test/files/java/SessionLogoutSeven.java
index 5896c209..fa56046e 100644
--- a/src/test/files/checks/java/SessionLogoutSeven.java
+++ b/src/test/files/java/SessionLogoutSeven.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
@Component(immediate = true)
public class SessionLogout {
diff --git a/src/test/files/checks/java/SessionLogoutSix.java b/src/test/files/java/SessionLogoutSix.java
similarity index 96%
rename from src/test/files/checks/java/SessionLogoutSix.java
rename to src/test/files/java/SessionLogoutSix.java
index ce7ef077..95ac9484 100644
--- a/src/test/files/checks/java/SessionLogoutSix.java
+++ b/src/test/files/java/SessionLogoutSix.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,13 +19,14 @@
*/
package com.example;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
import org.apache.commons.lang3.StringUtils;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
@Component(immediate = true)
public class SessionLogout {
diff --git a/src/test/files/checks/java/SessionLogoutThree.java b/src/test/files/java/SessionLogoutThree.java
similarity index 95%
rename from src/test/files/checks/java/SessionLogoutThree.java
rename to src/test/files/java/SessionLogoutThree.java
index 8dadd251..6651e92e 100644
--- a/src/test/files/checks/java/SessionLogoutThree.java
+++ b/src/test/files/java/SessionLogoutThree.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
@Component(immediate = true)
public class SessionLogout {
diff --git a/src/test/files/checks/java/SessionLogoutTwo.java b/src/test/files/java/SessionLogoutTwo.java
similarity index 95%
rename from src/test/files/checks/java/SessionLogoutTwo.java
rename to src/test/files/java/SessionLogoutTwo.java
index 652cadf2..92133555 100644
--- a/src/test/files/checks/java/SessionLogoutTwo.java
+++ b/src/test/files/java/SessionLogoutTwo.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,13 @@
*/
package com.example;
-import javax.jcr.RepositoryException;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.sling.jcr.api.SlingRepository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
@Component(immediate = true)
public class SessionLogout {
diff --git a/src/test/files/checks/slingquery/SlingQueryImplicitStrategyCheck.java b/src/test/files/java/SlingQueryImplicitStrategyCheck.java
similarity index 72%
rename from src/test/files/checks/slingquery/SlingQueryImplicitStrategyCheck.java
rename to src/test/files/java/SlingQueryImplicitStrategyCheck.java
index 51f09008..c77b3667 100644
--- a/src/test/files/checks/slingquery/SlingQueryImplicitStrategyCheck.java
+++ b/src/test/files/java/SlingQueryImplicitStrategyCheck.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,13 +17,8 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.statistics.accelerator.foundation.datasource;
+package com.vml.statistics.accelerator.foundation.datasource;
-import static org.apache.sling.query.SlingQuery.$;
-
-import java.io.IOException;
-import java.util.Optional;
-import javax.servlet.ServletException;
import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
@@ -33,12 +28,18 @@
import org.apache.sling.query.api.SearchStrategy;
import org.apache.tools.ant.taskdefs.optional.Script;
+import javax.servlet.ServletException;
+import java.io.IOException;
+import java.util.Optional;
+
+import static org.apache.sling.query.SlingQuery.$;
+
public class SlingQueryImplicitStrategyCheck extends SlingAllMethodsServlet {
private static final String SOMETHING = "something";
protected void doGet(final SlingHttpServletRequest request, final SlingHttpServletResponse response)
- throws ServletException, IOException {
+ throws ServletException, IOException {
Resource resource = request.getResource();
strategyNotDefined(resource);
strategyDefined(resource);
@@ -70,7 +71,7 @@ private void strategyDefined(Resource resource) {
SlingQuery.$(resource).searchStrategy(SearchStrategy.BFS).find("").find();
$(resource).searchStrategy(SearchStrategy.QUERY).find("res_type").asList().stream()
- .map(r -> r.adaptTo(SlingQueryImplicitStrategyCheck.class).toString()).filter(StringUtils::isNotEmpty).iterator();
+ .map(r -> r.adaptTo(SlingQueryImplicitStrategyCheck.class).toString()).filter(StringUtils::isNotEmpty).iterator();
}
public void casesThatShouldBeIgnored() {
@@ -81,33 +82,33 @@ public void casesThatShouldBeIgnored() {
}
GroupPage groupPage = repository.find(queryModel.getSolrCore(),
- queryModel.getPreparedQuery(),
- queryModel.getGroupLimit(),
- queryModel.getSortType(),
- queryModel.getFiltersQueryModel().getFiltersCriteria());
+ queryModel.getPreparedQuery(),
+ queryModel.getGroupLimit(),
+ queryModel.getSortType(),
+ queryModel.getFiltersQueryModel().getFiltersCriteria());
}
public void testVer1() {
this.variable = Optional.of(resource.getResourceMetadata())
- .map(metadata -> metadata.get(ResourceMetadata.RESOLUTION_PATH))
- .filter(String.class::isInstance)
- .map(String::valueOf)
- .map(path -> resource.getResourceResolver().getResource(path))
- .map(r -> $(r).searchStrategy(SearchStrategy.QUERY).find(SOMETHING).asList())
- .map(list -> list.get(0));
+ .map(metadata -> metadata.get(ResourceMetadata.RESOLUTION_PATH))
+ .filter(String.class::isInstance)
+ .map(String::valueOf)
+ .map(path -> resource.getResourceResolver().getResource(path))
+ .map(r -> $(r).searchStrategy(SearchStrategy.QUERY).find(SOMETHING).asList())
+ .map(list -> list.get(0));
}
public void testVer2() {
this.variable = Optional.of(resource.getResourceMetadata())
- .map(metadata -> metadata.get(ResourceMetadata.RESOLUTION_PATH))
- .filter(String.class::isInstance)
- .map(String::valueOf)
- .map(path -> resource.getResourceResolver().getResource(path))
- .map(r -> $(r).find(SOMETHING).asList()) // Noncompliant
- .map(list -> list.get(0));
+ .map(metadata -> metadata.get(ResourceMetadata.RESOLUTION_PATH))
+ .filter(String.class::isInstance)
+ .map(String::valueOf)
+ .map(path -> resource.getResourceResolver().getResource(path))
+ .map(r -> $(r).find(SOMETHING).asList()) // Noncompliant
+ .map(list -> list.get(0));
}
private Resource test2() {
return resource = Iterables.getFirst($(configurationResource).find(MapConfigurationModel.RESOURCE_TYPE), null); // Noncompliant
}
-}
\ No newline at end of file
+}
diff --git a/src/test/files/checks/java/slingservlet/SlingServletOne.java b/src/test/files/java/SlingServletOne.java
similarity index 82%
rename from src/test/files/checks/java/slingservlet/SlingServletOne.java
rename to src/test/files/java/SlingServletOne.java
index 59a67002..5d07d2cc 100644
--- a/src/test/files/checks/java/slingservlet/SlingServletOne.java
+++ b/src/test/files/java/SlingServletOne.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,8 +19,6 @@
*/
package com.example;
-import java.io.IOException;
-import javax.servlet.ServletException;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
@@ -30,17 +28,20 @@
import org.apache.sling.api.servlets.HttpConstants;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
+import javax.servlet.ServletException;
+import java.io.IOException;
+
@Component // Noncompliant {{Prefer cleaner @SlingServlet annotation.}}
@Service(value = javax.servlet.Servlet.class)
@Properties({@Property(name = "sling.servlet.resourceTypes", value = {"sling/servlet/default"}),
- @Property(name = "sling.servlet.selectors", value = {"selector"}),
- @Property(name = "sling.servlet.extensions", value = {"tab"}),
- @Property(name = "sling.servlet.methods", value = {HttpConstants.METHOD_GET})})
+ @Property(name = "sling.servlet.selectors", value = {"selector"}),
+ @Property(name = "sling.servlet.extensions", value = {"tab"}),
+ @Property(name = "sling.servlet.methods", value = {HttpConstants.METHOD_GET})})
public class SlingTestOne extends SlingSafeMethodsServlet {
@Override
protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response)
- throws ServletException, IOException {
+ throws ServletException, IOException {
//do sth
}
}
diff --git a/src/test/files/checks/java/slingservlet/SlingServletThree.java b/src/test/files/java/SlingServletThree.java
similarity index 64%
rename from src/test/files/checks/java/slingservlet/SlingServletThree.java
rename to src/test/files/java/SlingServletThree.java
index b6cafcfa..06bc32ec 100644
--- a/src/test/files/checks/java/slingservlet/SlingServletThree.java
+++ b/src/test/files/java/SlingServletThree.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,10 +19,6 @@
*/
package com.example;
-import static org.apache.sling.servlets.resolver.internal.ServletResolverConstants.SLING_SERVLET_EXTENSIONS;
-
-import java.io.IOException;
-import javax.servlet.ServletException;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.sling.SlingServlet;
@@ -31,19 +27,24 @@
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.apache.sling.servlets.resolver.internal.ServletResolverConstants;
+import javax.servlet.ServletException;
+import java.io.IOException;
+
+import static org.apache.sling.servlets.resolver.internal.ServletResolverConstants.SLING_SERVLET_EXTENSIONS;
+
@SlingServlet(methods = "GET")
@Properties({
- @Property(name = Constants.SERVICE_VENDOR, value = "Cognifide"),
- @Property(name = Constants.SERVICE_DESCRIPTION, value = "Some description"),
- @Property(name = ServletResolverConstants.SLING_SERVLET_SELECTORS, value = "selector"), // Noncompliant {{Property SLING_SERVLET_SELECTORS can be handled by @SlingServlet annotation.}}
- @Property(name = SLING_SERVLET_EXTENSIONS, value = "json"), // Noncompliant {{Property SLING_SERVLET_EXTENSIONS can be handled by @SlingServlet annotation.}}
- @Property(name = "sling.servlet.resourceTypes", value = {"sling/servlet/default"}) // Noncompliant {{Property "sling.servlet.resourceTypes" can be handled by @SlingServlet annotation.}}
+ @Property(name = Constants.SERVICE_VENDOR, value = "Cognifide"),
+ @Property(name = Constants.SERVICE_DESCRIPTION, value = "Some description"),
+ @Property(name = ServletResolverConstants.SLING_SERVLET_SELECTORS, value = "selector"), // Noncompliant {{Property SLING_SERVLET_SELECTORS can be handled by @SlingServlet annotation.}}
+ @Property(name = SLING_SERVLET_EXTENSIONS, value = "json"), // Noncompliant {{Property SLING_SERVLET_EXTENSIONS can be handled by @SlingServlet annotation.}}
+ @Property(name = "sling.servlet.resourceTypes", value = {"sling/servlet/default"}) // Noncompliant {{Property "sling.servlet.resourceTypes" can be handled by @SlingServlet annotation.}}
})
public class SlingTestThree extends SlingSafeMethodsServlet {
@Override
protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response)
- throws ServletException, IOException {
+ throws ServletException, IOException {
//do sth
}
}
diff --git a/src/test/files/checks/java/slingservlet/SlingServletTwo.java b/src/test/files/java/SlingServletTwo.java
similarity index 85%
rename from src/test/files/checks/java/slingservlet/SlingServletTwo.java
rename to src/test/files/java/SlingServletTwo.java
index 8eae2661..20844279 100644
--- a/src/test/files/checks/java/slingservlet/SlingServletTwo.java
+++ b/src/test/files/java/SlingServletTwo.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,8 +19,6 @@
*/
package com.example;
-import java.io.IOException;
-import javax.servlet.ServletException;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
@@ -29,16 +27,19 @@
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
+import javax.servlet.ServletException;
+import java.io.IOException;
+
@Service // Noncompliant {{@Component nor @Service annotation is not needed when @SlingServlet is used.}}
@SlingServlet(resourceTypes = "sling/servlet/default", selectors = "someSelector", extensions = "json", methods = "GET")
@Properties({
- @Property(name = Constants.SERVICE_VENDOR, value = "Cognifide"),
- @Property(name = Constants.SERVICE_DESCRIPTION, value = "Some description")})
+ @Property(name = Constants.SERVICE_VENDOR, value = "Cognifide"),
+ @Property(name = Constants.SERVICE_DESCRIPTION, value = "Some description")})
public class SlingTestTwo extends SlingSafeMethodsServlet {
@Override
protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response)
- throws ServletException, IOException {
+ throws ServletException, IOException {
//do sth
}
}
diff --git a/src/test/files/checks/java/slingservlet/SlingServletWithStandardAnnotations.java b/src/test/files/java/SlingServletWithStandardAnnotations.java
similarity index 81%
rename from src/test/files/checks/java/slingservlet/SlingServletWithStandardAnnotations.java
rename to src/test/files/java/SlingServletWithStandardAnnotations.java
index 6f227fa3..0f10d3ab 100644
--- a/src/test/files/checks/java/slingservlet/SlingServletWithStandardAnnotations.java
+++ b/src/test/files/java/SlingServletWithStandardAnnotations.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,26 +19,27 @@
*/
package com.example;
-import java.io.IOException;
-import javax.servlet.Servlet;
-import javax.servlet.ServletException;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.HttpConstants;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.osgi.service.component.annotations.Component;
+import javax.servlet.Servlet;
+import javax.servlet.ServletException;
+import java.io.IOException;
+
@Component(property = { // Compliant {{ OSGi standard annotations are OK}}
- "sling.servlet.resourceTypes=sling/servlet/default",
- "sling.servlet.selectors=selector",
- "sling.servlet.extensions=tab",
- "sling.servlet.methods=" + HttpConstants.METHOD_GET
+ "sling.servlet.resourceTypes=sling/servlet/default",
+ "sling.servlet.selectors=selector",
+ "sling.servlet.extensions=tab",
+ "sling.servlet.methods=" + HttpConstants.METHOD_GET
}, service = Servlet.class)
public class SlingServletWithStandardAnnotations extends SlingSafeMethodsServlet {
@Override
protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response)
- throws ServletException, IOException {
+ throws ServletException, IOException {
//do sth
}
}
diff --git a/src/test/files/checks/java/SynchronizedKeywordUsageCheck.java b/src/test/files/java/SynchronizedKeywordUsageCheck.java
similarity index 96%
rename from src/test/files/checks/java/SynchronizedKeywordUsageCheck.java
rename to src/test/files/java/SynchronizedKeywordUsageCheck.java
index ab800086..a3ba0397 100644
--- a/src/test/files/checks/java/SynchronizedKeywordUsageCheck.java
+++ b/src/test/files/java/SynchronizedKeywordUsageCheck.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
public class SynchronizedKeywordUsageCheck {
private final List list = new ArrayList<>(16);
+ private int counter = 0;
public synchronized void addElement(String s) { // Noncompliant {{Usage of 'synchronized' keyword should be avoided if possible.}}
list.add(s);
@@ -36,8 +37,6 @@ public void removeElement(String s) {
}
}
- private int counter = 0;
-
public synchronized void increment() { // Noncompliant
counter++;
}
diff --git a/src/test/files/checks/java/ThreadSafeFieldCheckDsComponentAnnotation.java b/src/test/files/java/ThreadSafeFieldCheckDsComponentAnnotation.java
similarity index 94%
rename from src/test/files/checks/java/ThreadSafeFieldCheckDsComponentAnnotation.java
rename to src/test/files/java/ThreadSafeFieldCheckDsComponentAnnotation.java
index 8628b041..898d280a 100644
--- a/src/test/files/checks/java/ThreadSafeFieldCheckDsComponentAnnotation.java
+++ b/src/test/files/java/ThreadSafeFieldCheckDsComponentAnnotation.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,9 +19,10 @@
*/
package com.example;
-import javax.jcr.Session;
import org.osgi.service.component.annotations.Component;
+import javax.jcr.Session;
+
@Component
public class ThreadSafeFieldCheckDsComponentAnnotationExample {
diff --git a/src/test/files/checks/java/ThreadSafeFieldCheckEventHandler.java b/src/test/files/java/ThreadSafeFieldCheckEventHandler.java
similarity index 94%
rename from src/test/files/checks/java/ThreadSafeFieldCheckEventHandler.java
rename to src/test/files/java/ThreadSafeFieldCheckEventHandler.java
index 470827a9..20568033 100644
--- a/src/test/files/checks/java/ThreadSafeFieldCheckEventHandler.java
+++ b/src/test/files/java/ThreadSafeFieldCheckEventHandler.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,9 +19,10 @@
*/
package com.example;
-import javax.jcr.Session;
import org.osgi.service.event.EventHandler;
+import javax.jcr.Session;
+
public class ThreadSafeFieldCheckEventHandlerExample implements EventHandler {
diff --git a/src/test/files/checks/java/ThreadSafeFieldCheckFilter.java b/src/test/files/java/ThreadSafeFieldCheckFilter.java
similarity index 92%
rename from src/test/files/checks/java/ThreadSafeFieldCheckFilter.java
rename to src/test/files/java/ThreadSafeFieldCheckFilter.java
index 28d65824..75ebf878 100644
--- a/src/test/files/checks/java/ThreadSafeFieldCheckFilter.java
+++ b/src/test/files/java/ThreadSafeFieldCheckFilter.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,18 +21,19 @@
import com.day.cq.tagging.TagManager;
import com.day.cq.wcm.api.PageManager;
-import java.io.IOException;
+import org.apache.felix.scr.annotations.sling.SlingFilter;
+import org.apache.felix.scr.annotations.sling.SlingFilterScope;
+
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
-import org.apache.felix.scr.annotations.sling.SlingFilter;
-import org.apache.felix.scr.annotations.sling.SlingFilterScope;
+import java.io.IOException;
@SlingFilter(scope = SlingFilterScope.COMPONENT, order = Integer.MAX_VALUE, metatype = true, label =
- "label", description = "description")
+ "label", description = "description")
public class ThreadSafeFieldCheckFilterExample implements Filter {
private PageManager pageManager; // Noncompliant {{Usage of com.day.cq.wcm.api.PageManager as a field is not thread safe.}}
@@ -46,7 +47,7 @@ public void init(FilterConfig filterConfig) throws ServletException {
@Override
public void doFilter(final ServletRequest req, final ServletResponse res, final FilterChain chain)
- throws IOException, ServletException {
+ throws IOException, ServletException {
// filter
}
diff --git a/src/test/files/checks/java/ThreadSafeFieldCheckScrComponentAnnotation.java b/src/test/files/java/ThreadSafeFieldCheckScrComponentAnnotation.java
similarity index 93%
rename from src/test/files/checks/java/ThreadSafeFieldCheckScrComponentAnnotation.java
rename to src/test/files/java/ThreadSafeFieldCheckScrComponentAnnotation.java
index 010d152e..ae9a508a 100644
--- a/src/test/files/checks/java/ThreadSafeFieldCheckScrComponentAnnotation.java
+++ b/src/test/files/java/ThreadSafeFieldCheckScrComponentAnnotation.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,9 +19,10 @@
*/
package com.example;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.Component;
+import javax.jcr.Session;
+
@Component
public class ThreadSafeFieldCheckComponentAnnotationExample {
diff --git a/src/test/files/checks/java/ThreadSafeFieldCheckServlet.java b/src/test/files/java/ThreadSafeFieldCheckServlet.java
similarity index 97%
rename from src/test/files/checks/java/ThreadSafeFieldCheckServlet.java
rename to src/test/files/java/ThreadSafeFieldCheckServlet.java
index 2b2298af..f266bf23 100644
--- a/src/test/files/checks/java/ThreadSafeFieldCheckServlet.java
+++ b/src/test/files/java/ThreadSafeFieldCheckServlet.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/java/ThreadSafeFieldCheckSlingServletAnnotation.java b/src/test/files/java/ThreadSafeFieldCheckSlingServletAnnotation.java
similarity index 93%
rename from src/test/files/checks/java/ThreadSafeFieldCheckSlingServletAnnotation.java
rename to src/test/files/java/ThreadSafeFieldCheckSlingServletAnnotation.java
index b945ca24..a670b840 100644
--- a/src/test/files/checks/java/ThreadSafeFieldCheckSlingServletAnnotation.java
+++ b/src/test/files/java/ThreadSafeFieldCheckSlingServletAnnotation.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,9 +19,10 @@
*/
package com.example;
-import javax.jcr.Session;
import org.apache.felix.scr.annotations.sling.SlingServlet;
+import javax.jcr.Session;
+
@SlingServlet
public class ThreadSafeFieldCheckSlingServletExample {
diff --git a/src/test/java/com/cognifide/aemrules/extensions/RulesLoaderTest.java b/src/test/java/com/cognifide/aemrules/extensions/RulesLoaderTest.java
deleted file mode 100644
index 7c1db604..00000000
--- a/src/test/java/com/cognifide/aemrules/extensions/RulesLoaderTest.java
+++ /dev/null
@@ -1,336 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.extensions;
-
-import static org.hamcrest.CoreMatchers.is;
-import static org.hamcrest.CoreMatchers.nullValue;
-
-import com.cognifide.aemrules.java.rules.JavaCheckClasses;
-import com.cognifide.aemrules.metadata.Metadata;
-import com.cognifide.aemrules.tag.Tags;
-import com.cognifide.aemrules.version.AemVersion;
-
-import java.util.Arrays;
-import java.util.List;
-import org.junit.Assert;
-import org.junit.Before;
-import org.junit.Test;
-import org.sonar.api.server.rule.RulesDefinition;
-import org.sonar.api.server.rule.RulesDefinition.NewRepository;
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.check.RuleProperty;
-import org.sonar.plugins.java.api.JavaCheck;
-import org.sonar.plugins.java.api.JavaFileScanner;
-import org.sonar.plugins.java.api.JavaFileScannerContext;
-import org.sonar.plugins.java.api.tree.BaseTreeVisitor;
-
-public class RulesLoaderTest {
-
- private static final String RULE_KEY = "AEM-TEST";
-
- private static final String RULE_NAME = "test";
-
- private static final String TECHNICAL_DEBT = "10min";
-
- private static final String RULE_MARKDOWN_TEST_DESCRIPTION = "Test description.";
-
- private static final String RULE_PROPERTY_KEY = "testKey";
-
- private static final String RULE_PROPERTY_DESCRIPTION = "testDescription";
-
- private static final String RULES_PROPERTY_DEFAULT_VALUE = "testDefault";
-
- private static final String RULES_PROPERTY_TYPE = "testType";
-
- private NewRepository repo;
-
- private RulesDefinition.Context context;
-
- @Before
- public void setUp() {
- context = new RulesDefinition.Context();
- repo = context.createRepository(JavaCheckClasses.REPOSITORY_KEY, "java");
- repo.setName(JavaCheckClasses.REPOSITORY_KEY);
- }
-
- @Test
- public void shouldLoadRuleWithAllSettings() {
- givenRulesLoaded(Arrays.asList(RuleWithAllSettings.class));
-
- RulesDefinition.Repository repository = context.repository(JavaCheckClasses.REPOSITORY_KEY);
- RulesDefinition.Rule rule = repository.rule(RULE_KEY);
-
- Assert.assertThat(rule.markdownDescription(), is(RULE_MARKDOWN_TEST_DESCRIPTION));
- Assert.assertThat(rule.name(), is(RULE_NAME));
- Assert.assertThat(rule.severity(), is(Priority.MINOR.toString()));
- Assert.assertThat(rule.tags().contains(Tags.AEM), is(true));
- Assert.assertThat(rule.debtRemediationFunction().baseEffort(), is(TECHNICAL_DEBT));
- }
-
- @Test
- public void shouldNotSetTechnicalDebtWhenAnnotationNotPresent() {
- givenRulesLoaded(Arrays.asList(RuleWithoutMetadataAnnotation.class));
-
- RulesDefinition.Repository repository = context.repository(JavaCheckClasses.REPOSITORY_KEY);
- RulesDefinition.Rule rule = repository.rule(RULE_KEY);
-
- Assert.assertThat(rule.markdownDescription(), is(RULE_MARKDOWN_TEST_DESCRIPTION));
- Assert.assertThat(rule.name(), is(RULE_NAME));
- Assert.assertThat(rule.severity(), is(Priority.MINOR.toString()));
- Assert.assertThat(rule.tags().contains(Tags.AEM), is(true));
- Assert.assertThat(rule.debtRemediationFunction(), is(nullValue()));
- }
-
- @Test
- public void shouldNotSetTechnicalDebtWhenTechnicalDebtNotSetInMetadata() {
- givenRulesLoaded(Arrays.asList(RuleWithEmptyTechnicalDebt.class));
-
- RulesDefinition.Repository repository = context.repository(JavaCheckClasses.REPOSITORY_KEY);
- RulesDefinition.Rule rule = repository.rule(RULE_KEY);
-
- Assert.assertThat(rule.markdownDescription(), is(RULE_MARKDOWN_TEST_DESCRIPTION));
- Assert.assertThat(rule.name(), is(RULE_NAME));
- Assert.assertThat(rule.severity(), is(Priority.MINOR.toString()));
- Assert.assertThat(rule.tags().contains(Tags.AEM), is(true));
- Assert.assertThat(rule.debtRemediationFunction(), is(nullValue()));
- }
-
- @Test
- public void shouldNotLoadRuleWhenRuleAnnotationIsNotPresent() {
- givenRulesLoaded(Arrays.asList(RuleWithoutRuleAnnotation.class));
-
- RulesDefinition.Repository repository = context.repository(JavaCheckClasses.REPOSITORY_KEY);
- RulesDefinition.Rule rule = repository.rule(RULE_KEY);
-
- Assert.assertThat(rule, is(nullValue()));
- }
-
-
- @Test
- public void shouldSetDefaultValuesWhenRuleAttributeWithNameOnly() {
- givenRulesLoaded(Arrays.asList(RuleWithOnlyNameAttribute.class));
-
- RulesDefinition.Repository repository = context.repository(JavaCheckClasses.REPOSITORY_KEY);
- RulesDefinition.Rule rule = repository.rule("com.cognifide.aemrules.extensions.RulesLoaderTest.RuleWithOnlyNameAttribute");
-
- Assert.assertThat(rule.markdownDescription(), is("No description yet."));
- Assert.assertThat(rule.name(), is(RULE_NAME));
- Assert.assertThat(rule.severity(), is(Priority.MAJOR.toString()));
- Assert.assertThat(rule.tags().size(), is(0));
- Assert.assertThat(rule.debtRemediationFunction().baseEffort(), is(TECHNICAL_DEBT));
- }
-
- @Test(expected = IllegalStateException.class)
- public void shouldThrowExceptionWhenRuleNameNotProvide() {
- givenRulesLoaded(Arrays.asList(RuleWithoutNameAttributeSet.class));
- }
-
- @Test
- public void shouldLoadRuleWithProperty() {
- givenRulesLoaded(Arrays.asList(RuleWithRuleProperty.class));
-
- RulesDefinition.Repository repository = context.repository(JavaCheckClasses.REPOSITORY_KEY);
- RulesDefinition.Rule rule = repository.rule(RULE_KEY);
- RulesDefinition.Param param = rule.param(RULE_PROPERTY_KEY);
-
- Assert.assertThat(param.description(), is(RULE_PROPERTY_DESCRIPTION));
- Assert.assertThat(param.defaultValue(), is(RULES_PROPERTY_DEFAULT_VALUE));
- Assert.assertThat(param.type().type(), is(RULES_PROPERTY_TYPE));
- }
-
- @Test
- public void shouldLoadRuleWithPropertyWithoutAttributes() {
- givenRulesLoaded(Arrays.asList(RuleWithRulePropertyWithoutAttributes.class));
-
- RulesDefinition.Repository repository = context.repository(JavaCheckClasses.REPOSITORY_KEY);
- RulesDefinition.Rule rule = repository.rule(RULE_KEY);
- RulesDefinition.Param param = rule.param("testProperty");
-
- Assert.assertThat(param.description(), is(nullValue()));
- Assert.assertThat(param.defaultValue(), is(nullValue()));
- Assert.assertThat(param.type().type(), is("STRING"));
- }
-
- private void givenRulesLoaded(List> annotationClasses) {
- RulesLoader rulesLoader = new RulesLoader();
- rulesLoader.load(repo, annotationClasses);
- repo.done();
- }
-
- @Rule(
- key = RULE_KEY,
- name = RULE_NAME,
- priority = Priority.MINOR,
- tags = Tags.AEM
- )
- @AemVersion(
- all = true
- )
- @Metadata(
- technicalDebt = TECHNICAL_DEBT
- )
- private class RuleWithAllSettings extends BaseTreeVisitor implements JavaFileScanner {
-
- @Override
- public void scanFile(JavaFileScannerContext javaFileScannerContext) {
-
- }
- }
-
- @Rule(
- key = RULE_KEY,
- name = RULE_NAME,
- priority = Priority.MINOR,
- tags = Tags.AEM
- )
- @AemVersion(
- all = true
- )
- private class RuleWithoutMetadataAnnotation extends BaseTreeVisitor implements JavaFileScanner {
-
- @Override
- public void scanFile(JavaFileScannerContext javaFileScannerContext) {
-
- }
- }
-
- @Rule(
- key = RULE_KEY,
- name = RULE_NAME,
- priority = Priority.MINOR,
- tags = Tags.AEM
- )
- @AemVersion(
- all = true
- )
- @Metadata(
- technicalDebt = ""
- )
- private class RuleWithEmptyTechnicalDebt extends BaseTreeVisitor implements JavaFileScanner {
-
- @Override
- public void scanFile(JavaFileScannerContext javaFileScannerContext) {
-
- }
- }
-
- @AemVersion(
- all = true
- )
- @Metadata(
- technicalDebt = TECHNICAL_DEBT
- )
- private class RuleWithoutRuleAnnotation extends BaseTreeVisitor implements JavaFileScanner {
-
- @Override
- public void scanFile(JavaFileScannerContext javaFileScannerContext) {
-
- }
- }
-
- @Rule(
- name = RULE_NAME
- )
- @AemVersion(
- all = true
- )
- @Metadata(
- technicalDebt = TECHNICAL_DEBT
- )
- private class RuleWithOnlyNameAttribute extends BaseTreeVisitor implements JavaFileScanner {
-
- @Override
- public void scanFile(JavaFileScannerContext javaFileScannerContext) {
-
- }
- }
-
- @Rule(
- key = RULE_KEY,
- priority = Priority.MINOR,
- tags = Tags.AEM
- )
- @AemVersion(
- all = true
- )
- @Metadata(
- technicalDebt = TECHNICAL_DEBT
- )
- private class RuleWithoutNameAttributeSet extends BaseTreeVisitor implements JavaFileScanner {
-
- @Override
- public void scanFile(JavaFileScannerContext javaFileScannerContext) {
-
- }
- }
-
- @Rule(
- key = RULE_KEY,
- name = RULE_NAME,
- priority = Priority.MINOR,
- tags = Tags.AEM
- )
- @AemVersion(
- all = true
- )
- @Metadata(
- technicalDebt = TECHNICAL_DEBT
- )
- private class RuleWithRuleProperty extends BaseTreeVisitor implements JavaFileScanner {
-
- @RuleProperty(
- key = RULE_PROPERTY_KEY,
- description = RULE_PROPERTY_DESCRIPTION,
- defaultValue = RULES_PROPERTY_DEFAULT_VALUE,
- type = RULES_PROPERTY_TYPE
- )
- private String testProperty;
-
- @Override
- public void scanFile(JavaFileScannerContext javaFileScannerContext) {
-
- }
- }
-
- @Rule(
- key = RULE_KEY,
- name = RULE_NAME,
- priority = Priority.MINOR,
- tags = Tags.AEM
- )
- @AemVersion(
- all = true
- )
- @Metadata(
- technicalDebt = TECHNICAL_DEBT
- )
- private class RuleWithRulePropertyWithoutAttributes extends BaseTreeVisitor implements JavaFileScanner {
-
- @RuleProperty
- private String testProperty;
-
- @Override
- public void scanFile(JavaFileScannerContext javaFileScannerContext) {
-
- }
- }
-
-}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/AvoidUsingUnsafeDisplayContextCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/AvoidUsingUnsafeDisplayContextCheckTest.java
deleted file mode 100644
index f216d3bf..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/AvoidUsingUnsafeDisplayContextCheckTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class AvoidUsingUnsafeDisplayContextCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkAllDataAttributesContainsDisplayContext() {
- check = new AvoidUsingUnsafeDisplayContextCheck();
- filename = "src/test/files/checks/htl/AvoidUsingUnsafeDisplayContextCheck.html";
- verify();
- }
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryForInlineStylesCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryForInlineStylesCheckTest.java
deleted file mode 100644
index 74785993..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryForInlineStylesCheckTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class DisplayContextIsMandatoryForInlineStylesCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkInlineStyleDisplayContext() {
- check = new InlineStyleMandatoryDisplayContextCheck();
- filename = "src/test/files/checks/htl/DefineDisplayContextInInlineStylesCheck.html";
- verify();
- }
-}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryInEventAttributesTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryInEventAttributesTest.java
deleted file mode 100644
index baa923ce..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryInEventAttributesTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class DisplayContextIsMandatoryInEventAttributesTest extends AbstractBaseTest {
-
- @Test
- public void checkEventAttributeDisplayContext() {
- check = new EventMandatoryDisplayContextCheck();
- filename = "src/test/files/checks/htl/DefineDisplayContextInEventAttributes.html";
- verify();
- }
-}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryInScriptsAndStylesCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryInScriptsAndStylesCheckTest.java
deleted file mode 100644
index 42cd0b35..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextIsMandatoryInScriptsAndStylesCheckTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class DisplayContextIsMandatoryInScriptsAndStylesCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkScriptsAndStyleDisplayContext() {
- check = new ScriptsAndStyleMandatoryDisplayContextCheck();
- filename = "src/test/files/checks/htl/DefineDisplayContextInScriptsAndStylesCheck.html";
- verify();
- }
-}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/ExplicitNamesInLoopsCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/ExplicitNamesInLoopsCheckTest.java
deleted file mode 100644
index 2b457dfa..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/ExplicitNamesInLoopsCheckTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class ExplicitNamesInLoopsCheckTest extends AbstractBaseTest {
-
- @Test
- public void ExplicitNamesInLoopsCheck() {
- check = new ExplicitNamesInLoopsCheck();
- filename = "src/test/files/checks/htl/ExplicitNamesInLoopsCheck.html";
- verify();
- }
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/HtlAttributesShouldBeAtTheEndCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/HtlAttributesShouldBeAtTheEndCheckTest.java
deleted file mode 100644
index ab26cd7b..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/HtlAttributesShouldBeAtTheEndCheckTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class HtlAttributesShouldBeAtTheEndCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkHtlAttributesOrder() {
- check = new HtlAttributesShouldBeAtTheEndCheck();
- filename = "src/test/files/checks/htl/HtlAttributesShouldBeAtTheEndCheck.html";
- verify();
- }
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/HtlCommentsCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/HtlCommentsCheckTest.java
deleted file mode 100644
index c54b8923..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/HtlCommentsCheckTest.java
+++ /dev/null
@@ -1,34 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class HtlCommentsCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkHTLStyleOfCommenting() {
- check = new HtlCommentsCheck();
- filename = "src/test/files/checks/htl/HtlCommentsCheck.html";
- verify();
- }
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/NamingAndReusingConditionsCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/NamingAndReusingConditionsCheckTest.java
deleted file mode 100644
index 3cc1e444..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/NamingAndReusingConditionsCheckTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class NamingAndReusingConditionsCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkHtlAttributesOrder() {
- check = new NamingAndReusingConditionsCheck();
- filename = "src/test/files/checks/htl/NamingAndReusingConditionsCheck.html";
- verify();
- }
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/PlaceTemplatesInSeparateFilesCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/PlaceTemplatesInSeparateFilesCheckTest.java
deleted file mode 100644
index 6fb90fcf..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/PlaceTemplatesInSeparateFilesCheckTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class PlaceTemplatesInSeparateFilesCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkHtlAttributesOrder() {
- check = new PlaceTemplatesInSeparateFilesCheck();
- filename = "src/test/files/checks/htl/PlaceTemplatesInSeparateFilesCheck.html";
- verify();
- }
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/UseMostRestrictiveHtlContextCheckTest.java b/src/test/java/com/cognifide/aemrules/htl/checks/UseMostRestrictiveHtlContextCheckTest.java
deleted file mode 100644
index 283dc890..00000000
--- a/src/test/java/com/cognifide/aemrules/htl/checks/UseMostRestrictiveHtlContextCheckTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.htl.checks;
-
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
-
-public class UseMostRestrictiveHtlContextCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkAllDataAttributesContainsDisplayContext() {
- check = new UseMostRestrictiveHtlContextCheck();
- filename = "src/test/files/checks/htl/UseMostRestrictiveHtlContextCheck.html";
- verify();
- }
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/ContentResourceShouldBeNullCheckedCheckTest.java b/src/test/java/com/cognifide/aemrules/java/checks/ContentResourceShouldBeNullCheckedCheckTest.java
deleted file mode 100644
index 48416ff0..00000000
--- a/src/test/java/com/cognifide/aemrules/java/checks/ContentResourceShouldBeNullCheckedCheckTest.java
+++ /dev/null
@@ -1,32 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.java.checks;
-
-import org.junit.Test;
-
-public class ContentResourceShouldBeNullCheckedCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkIfContentResourceIsNotNull() {
- check = new ContentResourceShouldBeNullCheckedCheck();
- filename = "src/test/files/checks/java/ContentResourceShouldBeNullCheckedCheck.java";
- verify();
- }
-}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/DefaultInjectionStrategyAnnotationCheckTest.java b/src/test/java/com/cognifide/aemrules/java/checks/DefaultInjectionStrategyAnnotationCheckTest.java
deleted file mode 100644
index af66fc05..00000000
--- a/src/test/java/com/cognifide/aemrules/java/checks/DefaultInjectionStrategyAnnotationCheckTest.java
+++ /dev/null
@@ -1,41 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.java.checks;
-
-import com.cognifide.aemrules.java.checks.slingmodels.DefaultInjectionStrategyAnnotationCheck;
-import org.junit.Test;
-
-public class DefaultInjectionStrategyAnnotationCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkAnnotation() {
- check = new DefaultInjectionStrategyAnnotationCheck();
- filename = "src/test/files/checks/java/slingmodels/DefaultInjectionStrategyAnnotationCheck.java";
- verify();
- }
-
- @Test
- public void checkMultipleAdaptablesAnnotation() {
- check = new DefaultInjectionStrategyAnnotationCheck();
- filename = "src/test/files/checks/java/slingmodels/DefaultInjectionStrategyAnnotationCheckMultipleAdaptables.java";
- verify();
- }
-
-}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/PreferSlingServletAnnotationTest.java b/src/test/java/com/cognifide/aemrules/java/checks/PreferSlingServletAnnotationTest.java
deleted file mode 100644
index b0fdcb95..00000000
--- a/src/test/java/com/cognifide/aemrules/java/checks/PreferSlingServletAnnotationTest.java
+++ /dev/null
@@ -1,53 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.java.checks;
-
-import org.junit.Test;
-
-public class PreferSlingServletAnnotationTest extends AbstractBaseTest {
-
- @Test
- public void checkLackOfAnnotation() {
- check = new PreferSlingServletAnnotation();
- filename = "src/test/files/checks/java/slingservlet/SlingServletOne.java";
- verify();
- }
-
- @Test
- public void checkMixedAnnotations() {
- check = new PreferSlingServletAnnotation();
- filename = "src/test/files/checks/java/slingservlet/SlingServletTwo.java";
- verify();
- }
-
- @Test
- public void checkRedundantProperties() {
- check = new PreferSlingServletAnnotation();
- filename = "src/test/files/checks/java/slingservlet/SlingServletThree.java";
- verify();
- }
-
- @Test
- public void checkStandardAnnotations() {
- check = new PreferSlingServletAnnotation();
- filename = "src/test/files/checks/java/slingservlet/SlingServletWithStandardAnnotations.java";
- verifyNoIssues();
- }
-}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/ResourceResolverShouldBeClosedTest.java b/src/test/java/com/cognifide/aemrules/java/checks/ResourceResolverShouldBeClosedTest.java
deleted file mode 100644
index 171ddf94..00000000
--- a/src/test/java/com/cognifide/aemrules/java/checks/ResourceResolverShouldBeClosedTest.java
+++ /dev/null
@@ -1,63 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.java.checks;
-
-import org.junit.Test;
-
-import com.cognifide.aemrules.java.checks.resourceresolver.close.ResourceResolverShouldBeClosed;
-
-public class ResourceResolverShouldBeClosedTest extends AbstractBaseTest {
-
- @Test
- public void checkInjectorNotClosedInFinallyBlock() {
- check = new ResourceResolverShouldBeClosed();
- filename = "src/test/files/checks/java/SampleServlet.java";
- verify();
- }
-
- @Test
- public void checkResourceResolverNotClosedInFinallyBlockWhenResourceResolverComesFromDifferentClass() {
- check = new ResourceResolverShouldBeClosed();
- filename = "src/test/files/checks/java/ResourceResolverConsumer.java";
- verifyNoIssues();
- }
-
- @Test
- public void checkResourceResolverNotClosedWhenItIsOpenedInActivateAndClosedInDeactivate() {
- check = new ResourceResolverShouldBeClosed();
- filename = "src/test/files/checks/java/LongSessionService.java";
- verifyNoIssues();
- }
-
- @Test
- public void checkResourceResolverClosedInDeactivateMethod() {
- check = new ResourceResolverShouldBeClosed();
- filename = "src/test/files/checks/java/LongSessionEventListener.java";
- verifyNoIssues();
- }
-
- @Test
- public void checkResourceResolverClosedInDeactivateMethodError() {
- check = new ResourceResolverShouldBeClosed();
- filename = "src/test/files/checks/java/LongResourceResolverEvenListenerError.java";
- verify();
- }
-
-}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/ResourceResolverTryWithResourcesTest.java b/src/test/java/com/cognifide/aemrules/java/checks/ResourceResolverTryWithResourcesTest.java
deleted file mode 100644
index 57e9d722..00000000
--- a/src/test/java/com/cognifide/aemrules/java/checks/ResourceResolverTryWithResourcesTest.java
+++ /dev/null
@@ -1,34 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.java.checks;
-
-import com.cognifide.aemrules.java.checks.resourceresolver.close.ResourceResolverTryWithResourcesCheck;
-import org.junit.Test;
-
-public class ResourceResolverTryWithResourcesTest extends AbstractBaseTest {
-
- @Test
- public void checkResourceResolverUsesTryWithResourcesBlock() {
- check = new ResourceResolverTryWithResourcesCheck();
- filename = "src/test/files/checks/java/resourceresolver/AutoclosableResourceResolver.java";
- verify();
- }
-
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/SessionShouldBeLoggedOutTest.java b/src/test/java/com/cognifide/aemrules/java/checks/SessionShouldBeLoggedOutTest.java
deleted file mode 100644
index 68350c12..00000000
--- a/src/test/java/com/cognifide/aemrules/java/checks/SessionShouldBeLoggedOutTest.java
+++ /dev/null
@@ -1,66 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.java.checks;
-
-import java.util.Arrays;
-import java.util.Collection;
-
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.junit.runners.Parameterized;
-
-@RunWith(Parameterized.class)
-public class SessionShouldBeLoggedOutTest extends AbstractBaseTest {
-
- // format is filename, failure expected
- @Parameterized.Parameters
- public static Collection data() {
- return Arrays.asList(new Object[][]{
- {"src/test/files/checks/java/SessionLogoutOne.java", false},
- {"src/test/files/checks/java/SessionLogoutTwo.java", false},
- {"src/test/files/checks/java/SessionLogoutThree.java", false},
- {"src/test/files/checks/java/SessionLogoutFour.java", true},
- {"src/test/files/checks/java/SessionLogoutFive.java", true},
- {"src/test/files/checks/java/SessionLogoutSix.java", true},
- {"src/test/files/checks/java/SessionLogoutSeven.java", true},
- {"src/test/files/checks/java/SessionLogoutEight.java", false},
- {"src/test/files/checks/java/LongSessionEventListener.java", false},
- {"src/test/files/checks/java/LongSessionEventListenerError.java", true}
- });
- }
-
- private boolean expectFailure;
-
- public SessionShouldBeLoggedOutTest(Object fn, Object expectFailure) {
- filename = (String) fn;
- this.expectFailure = ((Boolean) expectFailure).booleanValue();
- }
-
- @Test
- public void checkInjectorNotClosedInFinallyBlock() {
- check = new SessionShouldBeLoggedOut();
- if (expectFailure) {
- verify();
- } else {
- verifyNoIssues();
- }
- }
-
-}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/SlingQueryImplicitStrategyCheckTest.java b/src/test/java/com/cognifide/aemrules/java/checks/SlingQueryImplicitStrategyCheckTest.java
deleted file mode 100644
index 0cd0c3c2..00000000
--- a/src/test/java/com/cognifide/aemrules/java/checks/SlingQueryImplicitStrategyCheckTest.java
+++ /dev/null
@@ -1,34 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.java.checks;
-
-import com.cognifide.aemrules.java.checks.slingquery.SlingQueryImplicitStrategyCheck;
-import org.junit.Test;
-
-public class SlingQueryImplicitStrategyCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkImplicitSearches() {
- check = new SlingQueryImplicitStrategyCheck();
- filename = "src/test/files/checks/slingquery/SlingQueryImplicitStrategyCheck.java";
- verify();
- }
-
-}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/ThreadSafeFieldCheckTest.java b/src/test/java/com/cognifide/aemrules/java/checks/ThreadSafeFieldCheckTest.java
deleted file mode 100644
index a95c23b8..00000000
--- a/src/test/java/com/cognifide/aemrules/java/checks/ThreadSafeFieldCheckTest.java
+++ /dev/null
@@ -1,67 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.java.checks;
-
-import org.junit.Test;
-
-public class ThreadSafeFieldCheckTest extends AbstractBaseTest {
-
- @Test
- public void checkThreadSafeFieldsInServlet() {
- check = new ThreadSafeFieldCheck();
- filename = "src/test/files/checks/java/ThreadSafeFieldCheckServlet.java";
- verify();
- }
-
- @Test
- public void checkThreadSafeFieldsInFilter() {
- check = new ThreadSafeFieldCheck();
- filename = "src/test/files/checks/java/ThreadSafeFieldCheckFilter.java";
- verify();
- }
-
- @Test
- public void checkThreadSafeFieldsInEventHandler() {
- check = new ThreadSafeFieldCheck();
- filename = "src/test/files/checks/java/ThreadSafeFieldCheckEventHandler.java";
- verify();
- }
-
- @Test
- public void checkThreadSafeFieldsInScrComponent() {
- check = new ThreadSafeFieldCheck();
- filename = "src/test/files/checks/java/ThreadSafeFieldCheckScrComponentAnnotation.java";
- verify();
- }
-
- @Test
- public void checkThreadSafeFieldsInDsComponent() {
- check = new ThreadSafeFieldCheck();
- filename = "src/test/files/checks/java/ThreadSafeFieldCheckDsComponentAnnotation.java";
- verify();
- }
-
- @Test
- public void checkThreadSafeFieldsInSlingServletAnnotated() {
- check = new ThreadSafeFieldCheck();
- filename = "src/test/files/checks/java/ThreadSafeFieldCheckSlingServletAnnotation.java";
- verify();
- }
-}
diff --git a/src/test/java/com/cognifide/aemrules/version/VersionSupportCheckerTest.java b/src/test/java/com/cognifide/aemrules/version/VersionSupportCheckerTest.java
deleted file mode 100644
index abf2b0b8..00000000
--- a/src/test/java/com/cognifide/aemrules/version/VersionSupportCheckerTest.java
+++ /dev/null
@@ -1,189 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.cognifide.aemrules.version;
-
-import static com.cognifide.aemrules.version.VersionSupportChecker.DEFAULT_AEM_VERSION;
-import static com.cognifide.aemrules.version.VersionSupportChecker.create;
-import static org.hamcrest.CoreMatchers.is;
-
-import org.junit.Assert;
-import org.junit.Test;
-
-public class VersionSupportCheckerTest {
-
- @Test
- public void shouldSupportAllVersionsWhenAllSet() {
- VersionSupportChecker versionSupportChecker = create(
- CheckSupportingAllVersions.class.getAnnotation(AemVersion.class));
- Assert.assertThat(versionSupportChecker.supports("6.3"), is(true));
- Assert.assertThat(versionSupportChecker.supports("2.1"), is(true));
- Assert.assertThat(versionSupportChecker.supports("2.0"), is(true));
- }
-
- @Test
- public void shouldSupportAllVersionsBetweenFromAndTo() {
- VersionSupportChecker versionSupportChecker = create(
- CheckSupportingVersionsFromTo.class.getAnnotation(AemVersion.class));
- Assert.assertThat(versionSupportChecker.supports("6.1"), is(true));
- Assert.assertThat(versionSupportChecker.supports("5.2"), is(true));
- Assert.assertThat(versionSupportChecker.supports("5.1"), is(true));
- Assert.assertThat(versionSupportChecker.supports("6.4"), is(true));
- Assert.assertThat(versionSupportChecker.supports("6.5"), is(false));
- Assert.assertThat(versionSupportChecker.supports("5.0"), is(false));
- }
-
- @Test
- public void shouldSupportAllVersionsFrom() {
- VersionSupportChecker versionSupportChecker = create(
- CheckSupportingVersionsFrom.class.getAnnotation(AemVersion.class));
- Assert.assertThat(versionSupportChecker.supports("100.1"), is(true));
- Assert.assertThat(versionSupportChecker.supports("10.1"), is(true));
- Assert.assertThat(versionSupportChecker.supports("17.2"), is(true));
- Assert.assertThat(versionSupportChecker.supports("10.0"), is(false));
- Assert.assertThat(versionSupportChecker.supports("5.9"), is(false));
- }
-
- @Test
- public void shouldSupportAllVersionsTo() {
- VersionSupportChecker supportedVersions = create(
- CheckSupportingVersionsTo.class.getAnnotation(AemVersion.class));
- Assert.assertThat(supportedVersions.supports("1.1"), is(true));
- Assert.assertThat(supportedVersions.supports("10.1"), is(true));
- Assert.assertThat(supportedVersions.supports("0.2"), is(true));
- Assert.assertThat(supportedVersions.supports("8.5"), is(true));
- Assert.assertThat(supportedVersions.supports("10.2"), is(false));
- Assert.assertThat(supportedVersions.supports("20.9"), is(false));
- }
-
- @Test
- public void shouldSupportAllProvidedVersions() {
- VersionSupportChecker supportedVersions = create(
- CheckSupportingVersionsIncluded.class.getAnnotation(AemVersion.class));
- Assert.assertThat(supportedVersions.supports("6.1"), is(true));
- Assert.assertThat(supportedVersions.supports("2.1"), is(true));
- Assert.assertThat(supportedVersions.supports("4.8"), is(true));
- Assert.assertThat(supportedVersions.supports("6.0"), is(false));
- Assert.assertThat(supportedVersions.supports("2.2"), is(false));
- }
-
- @Test
- public void shouldSupportAllVersionsExcludingProvided() {
- VersionSupportChecker supportedVersions = create(
- CheckSupportingVersionsExcluded.class.getAnnotation(AemVersion.class));
- Assert.assertThat(supportedVersions.supports("6.1"), is(false));
- Assert.assertThat(supportedVersions.supports("2.1"), is(false));
- Assert.assertThat(supportedVersions.supports("4.8"), is(false));
- Assert.assertThat(supportedVersions.supports("6.0"), is(true));
- Assert.assertThat(supportedVersions.supports("2.2"), is(true));
- }
-
- @Test
- public void shouldUseDefaultVersionWhenProvidedVersionIsEmptyOrNull() {
- VersionSupportChecker supportedVersions = create(
- CheckSupportingDefaultVersion.class.getAnnotation(AemVersion.class));
- Assert.assertThat(supportedVersions.supports(DEFAULT_AEM_VERSION), is(true));
- Assert.assertThat(supportedVersions.supports(""), is(true));
- Assert.assertThat(supportedVersions.supports(null), is(true));
- }
-
- @Test(expected = IllegalArgumentException.class)
- public void shouldThrowExceptionWhenVersionToSupportIsIncorrect() {
- VersionSupportChecker supportedVersions = create(
- CheckSupportingVersionsExcluded.class.getAnnotation(AemVersion.class));
- supportedVersions.supports("f.1");
- }
-
- @Test(expected = IllegalArgumentException.class)
- public void shouldThrowExceptionWhenVersionIncorrectProvided1() {
- create(CheckWithIncorrectVersion1.class.getAnnotation(AemVersion.class));
- }
-
- @Test(expected = IllegalArgumentException.class)
- public void shouldThrowExceptionWhenVersionIncorrectProvided2() {
- create(CheckWithIncorrectVersion2.class.getAnnotation(AemVersion.class));
- }
-
-
- @AemVersion(
- all = true
- )
- private class CheckSupportingAllVersions {
-
- }
-
- @AemVersion(
- from = "5.1",
- to = "6.4"
- )
- private class CheckSupportingVersionsFromTo {
-
- }
-
- @AemVersion(
- from = "10.1"
- )
- private class CheckSupportingVersionsFrom {
-
- }
-
- @AemVersion(
- to = "10.1"
- )
- private class CheckSupportingVersionsTo {
-
- }
-
- @AemVersion(
- included = {"6.1", "2.1", "4.8"}
- )
- private class CheckSupportingVersionsIncluded {
-
- }
-
- @AemVersion(
- all = true,
- excluded = {"6.1", "2.1", "4.8"}
- )
- private class CheckSupportingVersionsExcluded {
-
- }
-
- @AemVersion(
- from = "5.6.7"
- )
- private class CheckWithIncorrectVersion1 {
-
- }
-
- @AemVersion(
- included = "a.b"
- )
- private class CheckWithIncorrectVersion2 {
-
- }
-
- @AemVersion(
- included = {DEFAULT_AEM_VERSION}
- )
- private class CheckSupportingDefaultVersion {
-
- }
-
-}
\ No newline at end of file
diff --git a/src/test/java/com/cognifide/aemrules/AemRulesSonarPluginTest.java b/src/test/java/com/vml/aemrules/AemRulesSonarPluginTest.java
similarity index 77%
rename from src/test/java/com/cognifide/aemrules/AemRulesSonarPluginTest.java
rename to src/test/java/com/vml/aemrules/AemRulesSonarPluginTest.java
index 6118d6e7..fb89a800 100644
--- a/src/test/java/com/cognifide/aemrules/AemRulesSonarPluginTest.java
+++ b/src/test/java/com/vml/aemrules/AemRulesSonarPluginTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,25 +17,24 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules;
+package com.vml.aemrules;
-import static org.fest.assertions.Assertions.assertThat;
-
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
import org.sonar.api.Plugin;
import org.sonar.api.SonarEdition;
import org.sonar.api.SonarQubeSide;
import org.sonar.api.internal.SonarRuntimeImpl;
import org.sonar.api.utils.Version;
-public class AemRulesSonarPluginTest {
+import static org.assertj.core.api.Assertions.assertThat;
+
+class AemRulesSonarPluginTest {
@Test
- public void webPluginTester() {
+ void webPluginTester() {
Plugin.Context context = new Plugin.Context(SonarRuntimeImpl.forSonarQube(Version.create(6, 7), SonarQubeSide.SERVER, SonarEdition.COMMUNITY));
new AemRulesSonarPlugin().define(context);
- assertThat(context.getExtensions()).hasSize(7);
+ assertThat(context.getExtensions()).hasSize(8);
}
-
-}
\ No newline at end of file
+}
diff --git a/src/test/java/com/cognifide/aemrules/htl/AbstractBaseTest.java b/src/test/java/com/vml/aemrules/htl/AbstractBaseTest.java
similarity index 75%
rename from src/test/java/com/cognifide/aemrules/htl/AbstractBaseTest.java
rename to src/test/java/com/vml/aemrules/htl/AbstractBaseTest.java
index a2ac1aae..b76bdfc8 100644
--- a/src/test/java/com/cognifide/aemrules/htl/AbstractBaseTest.java
+++ b/src/test/java/com/vml/aemrules/htl/AbstractBaseTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,29 +17,30 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl;
+package com.vml.aemrules.htl;
-import com.cognifide.aemrules.htl.api.HtlCheck;
-import com.cognifide.aemrules.htl.checks.AbstractHtlCheck;
-import com.cognifide.aemrules.htl.lex.HtlLexer;
-import com.cognifide.aemrules.htl.rules.HtlCheckClasses;
-import com.cognifide.aemrules.htl.visitors.HtlScanner;
-import java.io.File;
-import java.io.FileReader;
-import java.io.IOException;
-import java.nio.charset.StandardCharsets;
-import java.util.List;
-
-import com.cognifide.aemrules.utils.Throwables;
+import com.vml.aemrules.htl.api.HtlCheck;
+import com.vml.aemrules.htl.checks.AbstractHtlCheck;
+import com.vml.aemrules.htl.lex.HtlLexer;
+import com.vml.aemrules.htl.rules.HtlRulesList;
+import com.vml.aemrules.htl.visitors.HtlScanner;
+import com.vml.aemrules.utils.Throwables;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
import org.sonar.api.rule.RuleKey;
import org.sonar.check.Rule;
-import org.sonar.plugins.html.api.HtmlConstants;
import org.sonar.plugins.html.checks.HtmlIssue;
import org.sonar.plugins.html.node.CommentNode;
import org.sonar.plugins.html.visitor.HtmlSourceCode;
+import java.io.File;
+import java.io.FileReader;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+
+import static com.vml.aemrules.htl.Constants.REPOSITORY_KEY;
+
public abstract class AbstractBaseTest {
protected AbstractHtlCheck check;
@@ -48,12 +49,12 @@ public abstract class AbstractBaseTest {
private static HtmlSourceCode createSourceCode(File file) {
return new HtmlSourceCode(
- new TestInputFileBuilder("key", file.getPath())
- .setLanguage(HtmlConstants.LANGUAGE_KEY)
- .setType(InputFile.Type.MAIN)
- .setModuleBaseDir(new File(".").toPath())
- .setCharset(StandardCharsets.UTF_8)
- .build()
+ new TestInputFileBuilder("key", file.getPath())
+ .setLanguage(Htl.LANGUAGE_KEY)
+ .setType(InputFile.Type.MAIN)
+ .setModuleBaseDir(new File(".").toPath())
+ .setCharset(StandardCharsets.UTF_8)
+ .build()
);
}
@@ -62,8 +63,8 @@ private static HtlScanner setupScanner(AbstractHtlCheck check, HtmlCheckVerifier
scanner.addVisitor(new ExpectedIssueCollector(htmlCheckVerifier));
if (check != null) {
Class htlCheck = check.getClass();
- Rule rule = HtlCheckClasses.getRule(htlCheck);
- RuleKey ruleKey = RuleKey.of(HtlCheckClasses.REPOSITORY_KEY, rule.key());
+ Rule rule = HtlRulesList.getRule(htlCheck);
+ RuleKey ruleKey = RuleKey.of(REPOSITORY_KEY, rule.key());
check.setRuleKey(ruleKey);
}
scanner.addVisitor(check);
diff --git a/src/test/java/com/cognifide/aemrules/htl/HtlProfileTest.java b/src/test/java/com/vml/aemrules/htl/HtlProfileTest.java
similarity index 71%
rename from src/test/java/com/cognifide/aemrules/htl/HtlProfileTest.java
rename to src/test/java/com/vml/aemrules/htl/HtlProfileTest.java
index 733fc0e5..2168802f 100644
--- a/src/test/java/com/cognifide/aemrules/htl/HtlProfileTest.java
+++ b/src/test/java/com/vml/aemrules/htl/HtlProfileTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,37 +17,37 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl;
+package com.vml.aemrules.htl;
-import static org.fest.assertions.Assertions.assertThat;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule;
+import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfile;
+import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.Context;
import java.util.Collection;
import java.util.Map;
import java.util.Map.Entry;
import java.util.function.Function;
import java.util.stream.Collectors;
-import org.junit.Before;
-import org.junit.Test;
-import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition;
-import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInActiveRule;
-import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.BuiltInQualityProfile;
-import org.sonar.api.server.profile.BuiltInQualityProfilesDefinition.Context;
-public class HtlProfileTest {
+import static org.assertj.core.api.Assertions.assertThat;
+
+class HtlProfileTest {
private HtlProfile profile;
private Context context;
- @Before
+ @BeforeEach
public void setUp() {
profile = new HtlProfile();
- this.context = new BuiltInQualityProfilesDefinition.Context();
+ this.context = new Context();
}
@Test
- public void sanity() {
+ void sanity() {
profile.define(context);
Map activeRules = getActiveRulesByRuleKey(context);
@@ -56,7 +56,7 @@ public void sanity() {
}
@Test
- public void rulesLoaded() {
+ void rulesLoaded() {
profile.define(context);
Map activeRules = getActiveRulesByRuleKey(context);
@@ -67,13 +67,13 @@ public void rulesLoaded() {
private Map getActiveRulesByRuleKey(Context context) {
return context.profilesByLanguageAndName().entrySet().stream()
- .map(Entry::getValue)
- .map(Map::entrySet)
- .flatMap(Collection::stream)
- .map(Entry::getValue)
- .map(BuiltInQualityProfile::rules)
- .flatMap(Collection::stream)
- .collect(Collectors.toMap(BuiltInActiveRule::ruleKey, Function.identity()));
+ .map(Entry::getValue)
+ .map(Map::entrySet)
+ .flatMap(Collection::stream)
+ .map(Entry::getValue)
+ .map(BuiltInQualityProfile::rules)
+ .flatMap(Collection::stream)
+ .collect(Collectors.toMap(BuiltInActiveRule::ruleKey, Function.identity()));
}
}
diff --git a/src/test/java/com/cognifide/aemrules/htl/HtlSensorTest.java b/src/test/java/com/vml/aemrules/htl/HtlSensorTest.java
similarity index 74%
rename from src/test/java/com/cognifide/aemrules/htl/HtlSensorTest.java
rename to src/test/java/com/vml/aemrules/htl/HtlSensorTest.java
index c12383d4..611fb7e4 100644
--- a/src/test/java/com/cognifide/aemrules/htl/HtlSensorTest.java
+++ b/src/test/java/com/vml/aemrules/htl/HtlSensorTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,25 +17,16 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl;
+package com.vml.aemrules.htl;
-import static org.fest.assertions.Assertions.assertThat;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
-
-import com.cognifide.aemrules.extensions.AemRulesRulesDefinition;
-import com.cognifide.aemrules.htl.checks.HtlAttributesShouldBeAtTheEndCheck;
-import com.cognifide.aemrules.htl.rules.HtlCheckClasses;
-import java.io.File;
-import java.io.IOException;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.Files;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.stream.Collectors;
-import org.junit.Before;
-import org.junit.Test;
+import com.vml.aemrules.htl.checks.HtlAttributesShouldBeAtTheEndCheck;
+import com.vml.aemrules.htl.rules.HtlRulesDefinition;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
+import org.sonar.api.SonarEdition;
+import org.sonar.api.SonarQubeSide;
+import org.sonar.api.SonarRuntime;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.fs.internal.DefaultInputFile;
import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
@@ -46,15 +37,29 @@
import org.sonar.api.batch.sensor.internal.SensorContextTester;
import org.sonar.api.batch.sensor.issue.Issue;
import org.sonar.api.config.Configuration;
+import org.sonar.api.internal.SonarRuntimeImpl;
import org.sonar.api.measures.FileLinesContext;
import org.sonar.api.measures.FileLinesContextFactory;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.server.rule.RulesDefinition;
import org.sonar.api.server.rule.RulesDefinition.Repository;
-import org.sonar.plugins.html.api.HtmlConstants;
+import org.sonar.api.utils.Version;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static com.vml.aemrules.htl.Constants.REPOSITORY_KEY;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
-public class HtlSensorTest {
+class HtlSensorTest {
private static final File TEST_DIR = new File("src/test/resources/sensor");
@@ -62,12 +67,13 @@ public class HtlSensorTest {
private SensorContextTester tester;
- @Before
- public void setUp() {
- RulesDefinition rulesDefinition = new AemRulesRulesDefinition();
+ @BeforeEach
+ void setUp() {
+ SonarRuntime sonarRuntime = SonarRuntimeImpl.forSonarQube(Version.create(8, 9), SonarQubeSide.SERVER, SonarEdition.COMMUNITY);
+ RulesDefinition rulesDefinition = new HtlRulesDefinition(sonarRuntime);
RulesDefinition.Context context = new RulesDefinition.Context();
rulesDefinition.define(context);
- RulesDefinition.Repository htlRepository = context.repository(HtlCheckClasses.REPOSITORY_KEY);
+ Repository htlRepository = context.repository(REPOSITORY_KEY);
FileLinesContextFactory fileLinesContextFactory = getMockedFileLinesContextFactory();
Configuration configuration = getMockedConfiguration();
@@ -80,7 +86,7 @@ public void setUp() {
private CheckFactory getCheckFactory(Repository htlRepository) {
List ar = new ArrayList<>();
for (RulesDefinition.Rule rule : htlRepository.rules()) {
- ar.add(new NewActiveRule.Builder().setRuleKey(RuleKey.of(HtlCheckClasses.REPOSITORY_KEY, rule.key())).build());
+ ar.add(new NewActiveRule.Builder().setRuleKey(RuleKey.of(REPOSITORY_KEY, rule.key())).build());
}
return new CheckFactory(new DefaultActiveRules(ar));
}
@@ -99,21 +105,21 @@ private FileLinesContextFactory getMockedFileLinesContextFactory() {
}
@Test
- public void checkIncorrectFile_issuesFound() throws Exception {
+ void checkIncorrectFile_issuesFound() throws Exception {
DefaultInputFile inputFile = createInputFile(TEST_DIR, "test.html");
tester.fileSystem().add(inputFile);
sensor.execute(tester);
assertThat(tester.allIssues()).isNotEmpty();
List issuesRules = tester.allIssues().stream()
- .map(Issue::ruleKey)
- .map(RuleKey::rule)
- .distinct()
- .collect(Collectors.toList());
+ .map(Issue::ruleKey)
+ .map(RuleKey::rule)
+ .distinct()
+ .collect(Collectors.toList());
assertThat(issuesRules).contains(HtlAttributesShouldBeAtTheEndCheck.RULE_KEY);
}
@Test
- public void checkCancellation_noIssueFound() throws Exception {
+ void checkCancellation_noIssueFound() throws Exception {
DefaultInputFile inputFile = createInputFile(TEST_DIR, "test.html");
tester.fileSystem().add(inputFile);
tester.setCancelled(true);
@@ -122,7 +128,7 @@ public void checkCancellation_noIssueFound() throws Exception {
}
@Test
- public void sonarlintCheck() throws Exception {
+ void sonarlintCheck() throws Exception {
DefaultInputFile inputFile = createInputFile(TEST_DIR, "test.html");
tester.fileSystem().add(inputFile);
sensor.execute(tester);
@@ -133,7 +139,7 @@ public void sonarlintCheck() throws Exception {
}
@Test
- public void checkFileWithError_analysisErrorFound() throws Exception {
+ void checkFileWithError_analysisErrorFound() throws Exception {
DefaultInputFile inputFile = createInputFile(TEST_DIR, "error.html");
tester.fileSystem().add(inputFile);
sensor.execute(tester);
@@ -141,7 +147,7 @@ public void checkFileWithError_analysisErrorFound() throws Exception {
}
@Test
- public void checkExpressionWithinHtmlComment_noErrorsFound() throws Exception {
+ void checkExpressionWithinHtmlComment_noErrorsFound() throws Exception {
DefaultInputFile inputFile = createInputFile(TEST_DIR, "comment.html");
tester.fileSystem().add(inputFile);
sensor.execute(tester);
@@ -149,7 +155,7 @@ public void checkExpressionWithinHtmlComment_noErrorsFound() throws Exception {
}
@Test
- public void checkNestedTags_noErrorsFound() throws IOException {
+ void checkNestedTags_noErrorsFound() throws IOException {
DefaultInputFile inputFile = createInputFile(TEST_DIR, "nestedTags.html");
tester.fileSystem().add(inputFile);
sensor.execute(tester);
@@ -157,7 +163,7 @@ public void checkNestedTags_noErrorsFound() throws IOException {
}
@Test
- public void checkDescriptorConfiguration() {
+ void checkDescriptorConfiguration() {
DefaultSensorDescriptor descriptor = new DefaultSensorDescriptor();
sensor.describe(descriptor);
assertThat(descriptor.name()).isEqualTo("HTL");
@@ -166,12 +172,12 @@ public void checkDescriptorConfiguration() {
private DefaultInputFile createInputFile(File dir, String fileName) throws IOException {
return new TestInputFileBuilder("key", fileName)
- .setModuleBaseDir(dir.toPath())
- .setLanguage(HtmlConstants.LANGUAGE_KEY)
- .setType(InputFile.Type.MAIN)
- .initMetadata(new String(Files.readAllBytes(new File(dir, fileName).toPath()), StandardCharsets.UTF_8))
- .setCharset(StandardCharsets.UTF_8)
- .build();
+ .setModuleBaseDir(dir.toPath())
+ .setLanguage(Htl.LANGUAGE_KEY)
+ .setType(InputFile.Type.MAIN)
+ .initMetadata(new String(Files.readAllBytes(new File(dir, fileName).toPath()), StandardCharsets.UTF_8))
+ .setCharset(StandardCharsets.UTF_8)
+ .build();
}
-}
\ No newline at end of file
+}
diff --git a/src/test/java/com/cognifide/aemrules/htl/HtlTest.java b/src/test/java/com/vml/aemrules/htl/HtlTest.java
similarity index 73%
rename from src/test/java/com/cognifide/aemrules/htl/HtlTest.java
rename to src/test/java/com/vml/aemrules/htl/HtlTest.java
index 146e3475..abb4c0ab 100644
--- a/src/test/java/com/cognifide/aemrules/htl/HtlTest.java
+++ b/src/test/java/com/vml/aemrules/htl/HtlTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,18 +17,18 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl;
+package com.vml.aemrules.htl;
+import org.junit.jupiter.api.Test;
-import static org.fest.assertions.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThat;
-import org.junit.Test;
-public class HtlTest {
+class HtlTest {
@Test
- public void shouldReturnEmptyArrayOfDefaultFileSuffixes() {
+ void shouldReturnEmptyArrayOfDefaultFileSuffixes() {
Htl htl = new Htl();
assertThat(htl.getFileSuffixes()).isEmpty();
}
-}
\ No newline at end of file
+}
diff --git a/src/test/java/com/cognifide/aemrules/htl/HtmlCheckVerifier.java b/src/test/java/com/vml/aemrules/htl/HtmlCheckVerifier.java
similarity index 85%
rename from src/test/java/com/cognifide/aemrules/htl/HtmlCheckVerifier.java
rename to src/test/java/com/vml/aemrules/htl/HtmlCheckVerifier.java
index 0354d166..78517e5a 100644
--- a/src/test/java/com/cognifide/aemrules/htl/HtmlCheckVerifier.java
+++ b/src/test/java/com/vml/aemrules/htl/HtmlCheckVerifier.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,23 +17,24 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl;
+package com.vml.aemrules.htl;
-
-import static org.junit.Assert.assertThat;
-import static org.junit.matchers.JUnitMatchers.hasItem;
+import org.apache.commons.lang3.StringUtils;
+import org.sonar.plugins.html.checks.HtmlIssue;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
-import org.apache.commons.lang3.StringUtils;
-import org.sonar.plugins.html.checks.HtmlIssue;
+
+import static org.hamcrest.CoreMatchers.hasItem;
+import static org.hamcrest.MatcherAssert.assertThat;
+
public class HtmlCheckVerifier {
public static final String ISSUE_MARKER = "";
- private Set expectedIssuesLines;
+ private final Set expectedIssuesLines;
public HtmlCheckVerifier() {
this.expectedIssuesLines = new HashSet<>();
@@ -48,8 +49,8 @@ public void collectExpectedIssues(String comment, int startLine) {
public void checkIssues(List issues) {
Set issuesLines = issues.stream()
- .map(HtmlIssue::line)
- .collect(Collectors.toSet());
+ .map(HtmlIssue::line)
+ .collect(Collectors.toSet());
for (HtmlIssue issue : issues) {
assertThat("No issues expected in line: " + issue.line() + ", but got: " + issue.ruleKey(), expectedIssuesLines, hasItem(issue.line()));
diff --git a/src/test/java/com/cognifide/aemrules/htl/HtmlCheckVerifierTest.java b/src/test/java/com/vml/aemrules/htl/HtmlCheckVerifierTest.java
similarity index 67%
rename from src/test/java/com/cognifide/aemrules/htl/HtmlCheckVerifierTest.java
rename to src/test/java/com/vml/aemrules/htl/HtmlCheckVerifierTest.java
index c2082bc4..5bc759b7 100644
--- a/src/test/java/com/cognifide/aemrules/htl/HtmlCheckVerifierTest.java
+++ b/src/test/java/com/vml/aemrules/htl/HtmlCheckVerifierTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,49 +17,53 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl;
+package com.vml.aemrules.htl;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.sonar.api.rule.RuleKey;
+import org.sonar.plugins.html.checks.HtmlIssue;
import java.util.ArrayList;
import java.util.List;
-import org.junit.Before;
-import org.junit.Test;
-import org.sonar.api.rule.RuleKey;
-import org.sonar.plugins.html.checks.HtmlIssue;
-public class HtmlCheckVerifierTest {
+import static org.junit.jupiter.api.Assertions.assertThrows;
- private HtmlCheckVerifier htmlCheckVerifier = new HtmlCheckVerifier();
+class HtmlCheckVerifierTest {
- @Before
+ private final HtmlCheckVerifier htmlCheckVerifier = new HtmlCheckVerifier();
+
+ @BeforeEach
public void setUp() {
htmlCheckVerifier.collectExpectedIssues(HtmlCheckVerifier.ISSUE_MARKER, 1);
}
- @Test(expected = AssertionError.class)
- public void checkUnexpectedError() {
+ @Test
+ void checkUnexpectedError() {
List htmlIssues = new ArrayList<>();
htmlIssues.add(createLineIssue(1));
htmlIssues.add(createLineIssue(2));
- htmlCheckVerifier.checkIssues(htmlIssues);
+ assertThrows(AssertionError.class, () -> {
+ htmlCheckVerifier.checkIssues(htmlIssues);
+ });
}
- @Test()
- public void checkMultipleExpectedIssuesInTheSameLine() {
+ @Test
+ void checkMultipleExpectedIssuesInTheSameLine() {
List htmlIssues = new ArrayList<>();
htmlIssues.add(createLineIssue(1));
htmlIssues.add(createLineIssue(1));
htmlCheckVerifier.checkIssues(htmlIssues);
}
- @Test(expected = AssertionError.class)
- public void checkExpectedIssueButNotReported() {
+ @Test
+ void checkExpectedIssueButNotReported() {
List htmlIssues = new ArrayList<>();
- htmlCheckVerifier.checkIssues(htmlIssues);
+ assertThrows(AssertionError.class, () -> htmlCheckVerifier.checkIssues(htmlIssues));
}
private HtmlIssue createLineIssue(Integer line) {
RuleKey rule = RuleKey.of("r", "r");
return new HtmlIssue(rule, line, "");
}
-}
\ No newline at end of file
+}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/AbstractHtlCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/AbstractHtlCheckTest.java
similarity index 50%
rename from src/test/java/com/cognifide/aemrules/htl/checks/AbstractHtlCheckTest.java
rename to src/test/java/com/vml/aemrules/htl/checks/AbstractHtlCheckTest.java
index 27b825e9..c24562f2 100644
--- a/src/test/java/com/cognifide/aemrules/htl/checks/AbstractHtlCheckTest.java
+++ b/src/test/java/com/vml/aemrules/htl/checks/AbstractHtlCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,41 +17,52 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.checks;
+package com.vml.aemrules.htl.checks;
-
-import static org.fest.assertions.Assertions.assertThat;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNull;
-
-import java.io.File;
-import java.util.List;
-import org.junit.Before;
-import org.junit.Test;
+import com.vml.aemrules.htl.AbstractBaseTest;
+import com.vml.aemrules.htl.Htl;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
import org.sonar.plugins.html.checks.HtmlIssue;
import org.sonar.plugins.html.visitor.HtmlSourceCode;
-public class AbstractHtlCheckTest {
+import java.io.File;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
- private AbstractHtlCheck check;
- private HtmlSourceCode htmlSourceCode;
+class AbstractHtlCheckTest extends AbstractBaseTest {
- private static HtmlSourceCode createHtmlSourceCode(String relativePath) {
- return new HtmlSourceCode(new TestInputFileBuilder("key", relativePath).setModuleBaseDir(new File(".").toPath()).build());
+ private AbstractHtlCheck check;
+
+ private static HtmlSourceCode createHtmlSourceCode(File file) {
+ return new HtmlSourceCode(
+ new TestInputFileBuilder("key", file.getPath())
+ .setLanguage(Htl.LANGUAGE_KEY)
+ .setType(InputFile.Type.MAIN)
+ .setModuleBaseDir(new File(".").toPath())
+ .setCharset(StandardCharsets.UTF_8)
+ .build()
+ );
}
- @Before
+ @BeforeEach
public void setUp() {
this.check = new AbstractHtlCheck();
- this.htmlSourceCode = createHtmlSourceCode("/");
- check.setSourceCode(htmlSourceCode);
+ File file = new File("src/test/files/htl/Empty.html");
+ HtmlSourceCode htmlSourceCode = createHtmlSourceCode(file);
+ this.check.setSourceCode(htmlSourceCode);
}
@Test
- public void creatingViolationWithoutCost() {
- check.createViolation(0, "Issue 0");
+ void creatingViolationWithoutCost() {
+ this.check.createViolation(0, "Issue 0");
List issues = check.getHtmlSourceCode().getIssues();
assertThat(issues).hasSize(1);
@@ -59,8 +70,8 @@ public void creatingViolationWithoutCost() {
}
@Test
- public void creatingViolationWithCost() {
- check.createViolation(1, "Issue 0", 1d);
+ void creatingViolationWithCost() {
+ this.check.createViolation(1, "Issue 0", 1d);
List issues = check.getHtmlSourceCode().getIssues();
assertThat(issues).hasSize(1);
@@ -68,9 +79,9 @@ public void creatingViolationWithCost() {
}
@Test
- public void creatingViolations() {
- check.createViolation(0, "Issue 0", 1d);
- check.createViolation(1, "Issue 1");
+ void creatingViolations() {
+ this.check.createViolation(0, "Issue 0", 1d);
+ this.check.createViolation(1, "Issue 1");
List issues = check.getHtmlSourceCode().getIssues();
assertThat(issues).hasSize(2);
@@ -78,5 +89,4 @@ public void creatingViolations() {
assertNull(issues.get(1).cost());
}
-
-}
\ No newline at end of file
+}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/AvoidExtraSlyTagsCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/AvoidExtraSlyTagsCheckTest.java
new file mode 100644
index 00000000..f4dbb6ad
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/AvoidExtraSlyTagsCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class AvoidExtraSlyTagsCheckTest extends AbstractBaseTest {
+
+ @Test
+ void avoidExtraSlyTags() {
+ this.check = new AvoidExtraSlyTagsCheck();
+ this.filename = "src/test/files/htl/AvoidExtraSlyTagsCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/AvoidUsingUnsafeDisplayContextCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/AvoidUsingUnsafeDisplayContextCheckTest.java
new file mode 100644
index 00000000..1940e8a6
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/AvoidUsingUnsafeDisplayContextCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class AvoidUsingUnsafeDisplayContextCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkAllDataAttributesContainsDisplayContext() {
+ this.check = new AvoidUsingUnsafeDisplayContextCheck();
+ this.filename = "src/test/files/htl/AvoidUsingUnsafeDisplayContextCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/CamelCaseCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/CamelCaseCheckTest.java
new file mode 100644
index 00000000..9b78d151
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/CamelCaseCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class CamelCaseCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkCapitalization() {
+ this.check = new CamelCaseCheck();
+ this.filename = "src/test/files/htl/CamelCaseCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/ModifiableValueMapUsageCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/DefaultDisplayContextCheckTest.java
similarity index 62%
rename from src/test/java/com/cognifide/aemrules/java/checks/ModifiableValueMapUsageCheckTest.java
rename to src/test/java/com/vml/aemrules/htl/checks/DefaultDisplayContextCheckTest.java
index 16298d6e..9fb6b390 100644
--- a/src/test/java/com/cognifide/aemrules/java/checks/ModifiableValueMapUsageCheckTest.java
+++ b/src/test/java/com/vml/aemrules/htl/checks/DefaultDisplayContextCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,16 +17,17 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.java.checks;
+package com.vml.aemrules.htl.checks;
-import org.junit.Test;
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
-public class ModifiableValueMapUsageCheckTest extends AbstractBaseTest {
+class DefaultDisplayContextCheckTest extends AbstractBaseTest {
@Test
- public void checkIfMVMIsUsedToRetrievePropertiesFromResource() {
- check = new ModifiableValueMapUsageCheck();
- filename = "src/test/files/checks/java/ModifiableValueMapUsageCheck.java";
+ void checkDefaultDisplayContext() {
+ this.check = new DefaultDisplayContextCheck();
+ this.filename = "src/test/files/htl/UseDefaultDisplayContextCheck.html";
verify();
}
}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/DisplayContextInConditionalCommentsCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/DisplayContextInConditionalCommentsCheckTest.java
new file mode 100644
index 00000000..fe0f9af3
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/DisplayContextInConditionalCommentsCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class DisplayContextInConditionalCommentsCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkContextInConditionalComments() {
+ this.check = new DisplayContextInConditionalCommentsCheck();
+ this.filename = "src/test/files/htl/DisplayContextInConditionalCommentsCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryForInlineStylesCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryForInlineStylesCheckTest.java
new file mode 100644
index 00000000..83cfe610
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryForInlineStylesCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class DisplayContextIsMandatoryForInlineStylesCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkInlineStyleDisplayContext() {
+ this.check = new InlineStyleMandatoryDisplayContextCheck();
+ this.filename = "src/test/files/htl/DefineDisplayContextInInlineStylesCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryInEventAttributesTest.java b/src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryInEventAttributesTest.java
new file mode 100644
index 00000000..03a63647
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryInEventAttributesTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class DisplayContextIsMandatoryInEventAttributesTest extends AbstractBaseTest {
+
+ @Test
+ void checkEventAttributeDisplayContext() {
+ this.check = new EventMandatoryDisplayContextCheck();
+ this.filename = "src/test/files/htl/DefineDisplayContextInEventAttributes.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/SlyElementsAreAutomaticallyUnwrappedCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryInScriptsAndStylesCheckTest.java
similarity index 60%
rename from src/test/java/com/cognifide/aemrules/htl/checks/SlyElementsAreAutomaticallyUnwrappedCheckTest.java
rename to src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryInScriptsAndStylesCheckTest.java
index eda5d43c..67e50c56 100644
--- a/src/test/java/com/cognifide/aemrules/htl/checks/SlyElementsAreAutomaticallyUnwrappedCheckTest.java
+++ b/src/test/java/com/vml/aemrules/htl/checks/DisplayContextIsMandatoryInScriptsAndStylesCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,17 +17,17 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.checks;
+package com.vml.aemrules.htl.checks;
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
-public class SlyElementsAreAutomaticallyUnwrappedCheckTest extends AbstractBaseTest {
+class DisplayContextIsMandatoryInScriptsAndStylesCheckTest extends AbstractBaseTest {
@Test
- public void checkRedundantUnwrapAttributes() {
- check = new SlyElementsAreAutomaticallyUnwrappedCheck();
- filename = "src/test/files/checks/htl/SlyElementsAreAutomaticallyUnwrappedCheck.html";
+ void checkScriptsAndStyleDisplayContext() {
+ this.check = new ScriptsAndStyleMandatoryDisplayContextCheck();
+ this.filename = "src/test/files/htl/DefineDisplayContextInScriptsAndStylesCheck.html";
verify();
}
}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/ExplicitNamesInLoopsCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/ExplicitNamesInLoopsCheckTest.java
new file mode 100644
index 00000000..84dbb9d3
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/ExplicitNamesInLoopsCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class ExplicitNamesInLoopsCheckTest extends AbstractBaseTest {
+
+ @Test
+ void ExplicitNamesInLoopsCheck() {
+ this.check = new ExplicitNamesInLoopsCheck();
+ this.filename = "src/test/files/htl/ExplicitNamesInLoopsCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/HtlAttributesShouldBeAtTheEndCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/HtlAttributesShouldBeAtTheEndCheckTest.java
new file mode 100644
index 00000000..3a0cdc0e
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/HtlAttributesShouldBeAtTheEndCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class HtlAttributesShouldBeAtTheEndCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkHtlAttributesOrder() {
+ this.check = new HtlAttributesShouldBeAtTheEndCheck();
+ this.filename = "src/test/files/htl/HtlAttributesShouldBeAtTheEndCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/CamelCaseCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/HtlCommentsCheckTest.java
similarity index 63%
rename from src/test/java/com/cognifide/aemrules/htl/checks/CamelCaseCheckTest.java
rename to src/test/java/com/vml/aemrules/htl/checks/HtlCommentsCheckTest.java
index 30068220..f05af07e 100644
--- a/src/test/java/com/cognifide/aemrules/htl/checks/CamelCaseCheckTest.java
+++ b/src/test/java/com/vml/aemrules/htl/checks/HtlCommentsCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,17 +17,18 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.checks;
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
+package com.vml.aemrules.htl.checks;
-public class CamelCaseCheckTest extends AbstractBaseTest {
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class HtlCommentsCheckTest extends AbstractBaseTest {
@Test
- public void checkCapitalization() {
- check = new CamelCaseCheck();
- filename = "src/test/files/checks/htl/CamelCaseCheck.html";
+ void checkHTLStyleOfCommenting() {
+ this.check = new HtlCommentsCheck();
+ this.filename = "src/test/files/htl/HtlCommentsCheck.html";
verify();
}
-}
\ No newline at end of file
+}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/NamingAndReusingConditionsCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/NamingAndReusingConditionsCheckTest.java
new file mode 100644
index 00000000..339011dc
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/NamingAndReusingConditionsCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class NamingAndReusingConditionsCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkHtlAttributesOrder() {
+ this.check = new NamingAndReusingConditionsCheck();
+ this.filename = "src/test/files/htl/NamingAndReusingConditionsCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/htl/checks/PlaceTemplatesInSeparateFilesCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/PlaceTemplatesInSeparateFilesCheckTest.java
new file mode 100644
index 00000000..a76a96da
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/htl/checks/PlaceTemplatesInSeparateFilesCheckTest.java
@@ -0,0 +1,33 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.htl.checks;
+
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
+
+class PlaceTemplatesInSeparateFilesCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkHtlAttributesOrder() {
+ this.check = new PlaceTemplatesInSeparateFilesCheck();
+ this.filename = "src/test/files/htl/PlaceTemplatesInSeparateFilesCheck.html";
+ verify();
+ }
+}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/UseSlyTagsOverRedundantMarkupCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/SlyElementsAreAutomaticallyUnwrappedCheckTest.java
similarity index 61%
rename from src/test/java/com/cognifide/aemrules/htl/checks/UseSlyTagsOverRedundantMarkupCheckTest.java
rename to src/test/java/com/vml/aemrules/htl/checks/SlyElementsAreAutomaticallyUnwrappedCheckTest.java
index 62fc2ace..397cd228 100644
--- a/src/test/java/com/cognifide/aemrules/htl/checks/UseSlyTagsOverRedundantMarkupCheckTest.java
+++ b/src/test/java/com/vml/aemrules/htl/checks/SlyElementsAreAutomaticallyUnwrappedCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,17 +17,17 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.checks;
+package com.vml.aemrules.htl.checks;
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
-public class UseSlyTagsOverRedundantMarkupCheckTest extends AbstractBaseTest {
+class SlyElementsAreAutomaticallyUnwrappedCheckTest extends AbstractBaseTest {
@Test
- public void checkRedundantSlyTags() {
- check = new UseSlyTagsOverRedundantMarkupCheck();
- filename = "src/test/files/checks/htl/UseSlyTagsOverRedundantMarkupCheck.html";
+ void checkRedundantUnwrapAttributes() {
+ this.check = new SlyElementsAreAutomaticallyUnwrappedCheck();
+ this.filename = "src/test/files/htl/SlyElementsAreAutomaticallyUnwrappedCheck.html";
verify();
}
}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/DefaultDisplayContextCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/UseMostRestrictiveHtlContextCheckTest.java
similarity index 61%
rename from src/test/java/com/cognifide/aemrules/htl/checks/DefaultDisplayContextCheckTest.java
rename to src/test/java/com/vml/aemrules/htl/checks/UseMostRestrictiveHtlContextCheckTest.java
index c5dd1d08..c38fdc58 100644
--- a/src/test/java/com/cognifide/aemrules/htl/checks/DefaultDisplayContextCheckTest.java
+++ b/src/test/java/com/vml/aemrules/htl/checks/UseMostRestrictiveHtlContextCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,17 +17,17 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.checks;
+package com.vml.aemrules.htl.checks;
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
-public class DefaultDisplayContextCheckTest extends AbstractBaseTest {
+class UseMostRestrictiveHtlContextCheckTest extends AbstractBaseTest {
@Test
- public void checkDefaultDisplayContext() {
- check = new DefaultDisplayContextCheck();
- filename = "src/test/files/checks/htl/UseDefaultDisplayContextCheck.html";
+ void checkAllDataAttributesContainsDisplayContext() {
+ this.check = new UseMostRestrictiveHtlContextCheck();
+ this.filename = "src/test/files/htl/UseMostRestrictiveHtlContextCheck.html";
verify();
}
}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/AvoidExtraSlyTagsCheckTest.java b/src/test/java/com/vml/aemrules/htl/checks/UseSlyTagsOverRedundantMarkupCheckTest.java
similarity index 61%
rename from src/test/java/com/cognifide/aemrules/htl/checks/AvoidExtraSlyTagsCheckTest.java
rename to src/test/java/com/vml/aemrules/htl/checks/UseSlyTagsOverRedundantMarkupCheckTest.java
index b4231a1f..f52cdc7a 100644
--- a/src/test/java/com/cognifide/aemrules/htl/checks/AvoidExtraSlyTagsCheckTest.java
+++ b/src/test/java/com/vml/aemrules/htl/checks/UseSlyTagsOverRedundantMarkupCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,17 +17,17 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.checks;
+package com.vml.aemrules.htl.checks;
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
+import com.vml.aemrules.htl.AbstractBaseTest;
+import org.junit.jupiter.api.Test;
-public class AvoidExtraSlyTagsCheckTest extends AbstractBaseTest {
+class UseSlyTagsOverRedundantMarkupCheckTest extends AbstractBaseTest {
@Test
- public void avoidExtraSlyTags() {
- check = new AvoidExtraSlyTagsCheck();
- filename = "src/test/files/checks/htl/AvoidExtraSlyTagsCheck.html";
+ void checkRedundantSlyTags() {
+ this.check = new UseSlyTagsOverRedundantMarkupCheck();
+ this.filename = "src/test/files/htl/UseSlyTagsOverRedundantMarkupCheck.html";
verify();
}
}
diff --git a/src/test/java/com/cognifide/aemrules/htl/visitors/HtlNodeCounterVisitor.java b/src/test/java/com/vml/aemrules/htl/visitors/HtlNodeCounterVisitor.java
similarity index 95%
rename from src/test/java/com/cognifide/aemrules/htl/visitors/HtlNodeCounterVisitor.java
rename to src/test/java/com/vml/aemrules/htl/visitors/HtlNodeCounterVisitor.java
index 94509b5e..05a0ef8e 100644
--- a/src/test/java/com/cognifide/aemrules/htl/visitors/HtlNodeCounterVisitor.java
+++ b/src/test/java/com/vml/aemrules/htl/visitors/HtlNodeCounterVisitor.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,11 +17,8 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.visitors;
+package com.vml.aemrules.htl.visitors;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
import org.apache.sling.scripting.sightly.compiler.expression.Expression;
import org.sonar.plugins.html.node.CommentNode;
import org.sonar.plugins.html.node.DirectiveNode;
@@ -31,11 +28,15 @@
import org.sonar.plugins.html.node.TextNode;
import org.sonar.plugins.html.visitor.HtmlSourceCode;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
public class HtlNodeCounterVisitor implements DefaultHtlVisitor {
private HtmlSourceCode sourceCode = null;
- private Map counterMap;
+ private final Map counterMap;
public HtlNodeCounterVisitor() {
counterMap = new HashMap<>();
diff --git a/src/test/java/com/cognifide/aemrules/htl/visitors/HtlScannerTest.java b/src/test/java/com/vml/aemrules/htl/visitors/HtlScannerTest.java
similarity index 80%
rename from src/test/java/com/cognifide/aemrules/htl/visitors/HtlScannerTest.java
rename to src/test/java/com/vml/aemrules/htl/visitors/HtlScannerTest.java
index 80e7a33b..01f51dfd 100644
--- a/src/test/java/com/cognifide/aemrules/htl/visitors/HtlScannerTest.java
+++ b/src/test/java/com/vml/aemrules/htl/visitors/HtlScannerTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,11 +17,21 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.visitors;
+package com.vml.aemrules.htl.visitors;
-import static org.junit.Assert.assertEquals;
+import com.google.common.io.Files;
+import com.vml.aemrules.htl.Htl;
+import com.vml.aemrules.htl.lex.HtlLexer;
+import com.vml.aemrules.utils.Throwables;
+import org.apache.sling.scripting.sightly.compiler.expression.Expression;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
+import org.sonar.plugins.html.node.CommentNode;
+import org.sonar.plugins.html.node.Node;
+import org.sonar.plugins.html.node.TagNode;
+import org.sonar.plugins.html.visitor.HtmlSourceCode;
-import com.cognifide.aemrules.htl.lex.HtlLexer;
import java.io.File;
import java.io.IOException;
import java.io.Reader;
@@ -29,19 +39,9 @@
import java.nio.charset.StandardCharsets;
import java.util.List;
-import com.cognifide.aemrules.utils.Throwables;
-import org.apache.sling.scripting.sightly.compiler.expression.Expression;
-import org.junit.Before;
-import org.junit.Test;
-import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
-import com.google.common.io.Files;
-import org.sonar.plugins.html.api.HtmlConstants;
-import org.sonar.plugins.html.node.CommentNode;
-import org.sonar.plugins.html.node.Node;
-import org.sonar.plugins.html.node.TagNode;
-import org.sonar.plugins.html.visitor.HtmlSourceCode;
+import static org.junit.jupiter.api.Assertions.assertEquals;
-public class HtlScannerTest {
+class HtlScannerTest {
private HtlNodeCounterVisitor counterVisitor;
@@ -49,7 +49,7 @@ public class HtlScannerTest {
private HtlLexer lexer;
- @Before
+ @BeforeEach
public void setUp() {
lexer = new HtlLexer();
htlScanner = new HtlScanner();
@@ -58,7 +58,7 @@ public void setUp() {
}
@Test
- public void checkVisitedNode() {
+ void checkVisitedNode() {
HtmlSourceCode htmlSourceCode = createHtmlSourceCode("scanner/testFile.html");
try (Reader reader = readFile("scanner/testFile.html")) {
List nodes = lexer.parse(reader);
@@ -73,9 +73,9 @@ public void checkVisitedNode() {
private HtmlSourceCode createHtmlSourceCode(String relativePath) {
return new HtmlSourceCode(new TestInputFileBuilder("key", relativePath)
- .setLanguage(HtmlConstants.LANGUAGE_KEY)
- .setModuleBaseDir(new File(".").toPath())
- .build()
+ .setLanguage(Htl.LANGUAGE_KEY)
+ .setModuleBaseDir(new File(".").toPath())
+ .build()
);
}
@@ -83,9 +83,9 @@ private Reader readFile(String fileName) {
File root = new File("src/test/resources");
File file = new File(root, fileName);
try {
- return new StringReader(Files.toString(file, StandardCharsets.UTF_8));
+ return new StringReader(Files.asCharSource(file, StandardCharsets.UTF_8).read());
} catch (IOException e) {
throw new IllegalArgumentException("Cannot read " + fileName, e);
}
}
-}
\ No newline at end of file
+}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/AbstractBaseTest.java b/src/test/java/com/vml/aemrules/java/checks/AbstractBaseTest.java
similarity index 96%
rename from src/test/java/com/cognifide/aemrules/java/checks/AbstractBaseTest.java
rename to src/test/java/com/vml/aemrules/java/checks/AbstractBaseTest.java
index 5f997fed..708426c6 100644
--- a/src/test/java/com/cognifide/aemrules/java/checks/AbstractBaseTest.java
+++ b/src/test/java/com/vml/aemrules/java/checks/AbstractBaseTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,16 +17,16 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.java.checks;
-
-import java.io.File;
-import java.util.ArrayList;
-import java.util.List;
+package com.vml.aemrules.java.checks;
import org.apache.commons.lang3.StringUtils;
import org.sonar.java.checks.verifier.CheckVerifier;
import org.sonar.plugins.java.api.JavaFileScanner;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
public abstract class AbstractBaseTest {
/**
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/AdministrativeAccessUsageCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/AdministrativeAccessUsageCheckTest.java
similarity index 62%
rename from src/test/java/com/cognifide/aemrules/java/checks/AdministrativeAccessUsageCheckTest.java
rename to src/test/java/com/vml/aemrules/java/checks/AdministrativeAccessUsageCheckTest.java
index 861a7304..3d65f8d4 100644
--- a/src/test/java/com/cognifide/aemrules/java/checks/AdministrativeAccessUsageCheckTest.java
+++ b/src/test/java/com/vml/aemrules/java/checks/AdministrativeAccessUsageCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,16 +17,16 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.java.checks;
+package com.vml.aemrules.java.checks;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
-public class AdministrativeAccessUsageCheckTest extends AbstractBaseTest {
+class AdministrativeAccessUsageCheckTest extends AbstractBaseTest {
@Test
- public void administrativeAccessUsageCheck() {
- check = new AdministrativeAccessUsageCheck();
- filename = "src/test/files/checks/java/AdministrativeAccessUsageCheck.java";
+ void administrativeAccessUsageCheck() {
+ this.check = new AdministrativeAccessUsageCheck();
+ this.filename = "src/test/files/java/AdministrativeAccessUsageCheck.java";
verify();
}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/AnnotationsConstantsCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/AnnotationsConstantsCheckTest.java
similarity index 64%
rename from src/test/java/com/cognifide/aemrules/java/checks/AnnotationsConstantsCheckTest.java
rename to src/test/java/com/vml/aemrules/java/checks/AnnotationsConstantsCheckTest.java
index 11086eb1..902f6524 100644
--- a/src/test/java/com/cognifide/aemrules/java/checks/AnnotationsConstantsCheckTest.java
+++ b/src/test/java/com/vml/aemrules/java/checks/AnnotationsConstantsCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,16 +17,16 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.java.checks;
+package com.vml.aemrules.java.checks;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
-public class AnnotationsConstantsCheckTest extends AbstractBaseTest {
+class AnnotationsConstantsCheckTest extends AbstractBaseTest {
@Test
- public void checkConstantsInAnnotations() {
- check = new AnnotationsConstantsCheck();
- filename = "src/test/files/checks/java/AnnotationsConstantsCheck.java";
+ void checkConstantsInAnnotations() {
+ this.check = new AnnotationsConstantsCheck();
+ this.filename = "src/test/files/java/AnnotationsConstantsCheck.java";
verify(false);
}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/ConstantsCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/ConstantsCheckTest.java
similarity index 67%
rename from src/test/java/com/cognifide/aemrules/java/checks/ConstantsCheckTest.java
rename to src/test/java/com/vml/aemrules/java/checks/ConstantsCheckTest.java
index 56b3725a..c81b55f1 100644
--- a/src/test/java/com/cognifide/aemrules/java/checks/ConstantsCheckTest.java
+++ b/src/test/java/com/vml/aemrules/java/checks/ConstantsCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,16 +17,16 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.java.checks;
+package com.vml.aemrules.java.checks;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
-public class ConstantsCheckTest extends AbstractBaseTest {
+class ConstantsCheckTest extends AbstractBaseTest {
@Test
- public void checkConstants() {
- check = new ConstantsCheck();
- filename = "src/test/files/checks/java/ConstantsCheck.java";
+ void checkConstants() {
+ this.check = new ConstantsCheck();
+ this.filename = "src/test/files/java/ConstantsCheck.java";
verify(false);
}
}
diff --git a/src/test/java/com/vml/aemrules/java/checks/ContentResourceShouldBeNullCheckedCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/ContentResourceShouldBeNullCheckedCheckTest.java
new file mode 100644
index 00000000..ff6cf966
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/java/checks/ContentResourceShouldBeNullCheckedCheckTest.java
@@ -0,0 +1,32 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.java.checks;
+
+import org.junit.jupiter.api.Test;
+
+class ContentResourceShouldBeNullCheckedCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkIfContentResourceIsNotNull() {
+ this.check = new ContentResourceShouldBeNullCheckedCheck();
+ this.filename = "src/test/files/java/ContentResourceShouldBeNullCheckedCheck.java";
+ verify();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/java/checks/DefaultInjectionStrategyAnnotationCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/DefaultInjectionStrategyAnnotationCheckTest.java
new file mode 100644
index 00000000..54ade811
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/java/checks/DefaultInjectionStrategyAnnotationCheckTest.java
@@ -0,0 +1,41 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.java.checks;
+
+import com.vml.aemrules.java.checks.slingmodels.DefaultInjectionStrategyAnnotationCheck;
+import org.junit.jupiter.api.Test;
+
+class DefaultInjectionStrategyAnnotationCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkAnnotation() {
+ this.check = new DefaultInjectionStrategyAnnotationCheck();
+ this.filename = "src/test/files/java/DefaultInjectionStrategyAnnotationCheck.java";
+ verify();
+ }
+
+ @Test
+ void checkMultipleAdaptablesAnnotation() {
+ this.check = new DefaultInjectionStrategyAnnotationCheck();
+ this.filename = "src/test/files/java/DefaultInjectionStrategyAnnotationCheckMultipleAdaptables.java";
+ verify();
+ }
+
+}
diff --git a/src/test/java/com/vml/aemrules/java/checks/ModifiableValueMapUsageCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/ModifiableValueMapUsageCheckTest.java
new file mode 100644
index 00000000..86bd53f4
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/java/checks/ModifiableValueMapUsageCheckTest.java
@@ -0,0 +1,32 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.java.checks;
+
+import org.junit.jupiter.api.Test;
+
+class ModifiableValueMapUsageCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkIfMVMIsUsedToRetrievePropertiesFromResource() {
+ this.check = new ModifiableValueMapUsageCheck();
+ this.filename = "src/test/files/java/ModifiableValueMapUsageCheck.java";
+ verify();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/java/checks/PreferSlingServletAnnotationTest.java b/src/test/java/com/vml/aemrules/java/checks/PreferSlingServletAnnotationTest.java
new file mode 100644
index 00000000..7a29f580
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/java/checks/PreferSlingServletAnnotationTest.java
@@ -0,0 +1,48 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.java.checks;
+
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+class PreferSlingServletAnnotationTest extends AbstractBaseTest {
+
+ @ParameterizedTest
+ @CsvSource({
+ "checkLackOfAnnotation,src/test/files/java/SlingServletOne.java",
+ "checkMixedAnnotations,src/test/files/java/SlingServletTwo.java",
+ "checkRedundantProperties,src/test/files/java/SlingServletThree.java"
+ })
+ void detect(String description, String fileName) {
+ System.out.println(description);
+ this.check = new PreferSlingServletAnnotation();
+ this.filename = fileName;
+ verify();
+ }
+
+ @Test
+ void checkStandardAnnotations() {
+ this.check = new PreferSlingServletAnnotation();
+ this.filename = "src/test/files/java/SlingServletWithStandardAnnotations.java";
+ verifyNoIssues();
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/java/checks/ResourceResolverShouldBeClosedTest.java b/src/test/java/com/vml/aemrules/java/checks/ResourceResolverShouldBeClosedTest.java
new file mode 100644
index 00000000..ae964962
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/java/checks/ResourceResolverShouldBeClosedTest.java
@@ -0,0 +1,53 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.java.checks;
+
+import com.vml.aemrules.java.checks.resourceresolver.close.ResourceResolverShouldBeClosed;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+class ResourceResolverShouldBeClosedTest extends AbstractBaseTest {
+
+ @ParameterizedTest
+ @CsvSource({
+ "checkInjectorNotClosedInFinallyBlock,src/test/files/java/SampleServlet.java",
+ "checkResourceResolverClosedInDeactivateMethodError,src/test/files/java/LongResourceResolverEvenListenerError.java"
+ })
+ void detect_1(String description, String fileName) {
+ System.out.println(description);
+ this.check = new ResourceResolverShouldBeClosed();
+ this.filename = fileName;
+ verify();
+ }
+
+ @ParameterizedTest
+ @CsvSource({
+ "checkResourceResolverNotClosedInFinallyBlockWhenResourceResolverComesFromDifferentClass,src/test/files/java/ResourceResolverConsumer.java",
+ "checkResourceResolverNotClosedWhenItIsOpenedInActivateAndClosedInDeactivate,src/test/files/java/LongSessionService.java",
+ "checkResourceResolverClosedInDeactivateMethod,src/test/files/java/LongSessionEventListener.java"
+ })
+ void detect_2(String description, String fileName) {
+ System.out.println(description);
+ this.check = new ResourceResolverShouldBeClosed();
+ this.filename = fileName;
+ verifyNoIssues();
+ }
+
+}
diff --git a/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextInConditionalCommentsCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/ResourceResolverTryWithResourcesTest.java
similarity index 57%
rename from src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextInConditionalCommentsCheckTest.java
rename to src/test/java/com/vml/aemrules/java/checks/ResourceResolverTryWithResourcesTest.java
index 461f3a47..b02d7849 100644
--- a/src/test/java/com/cognifide/aemrules/htl/checks/DisplayContextInConditionalCommentsCheckTest.java
+++ b/src/test/java/com/vml/aemrules/java/checks/ResourceResolverTryWithResourcesTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,17 +17,18 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.htl.checks;
+package com.vml.aemrules.java.checks;
-import com.cognifide.aemrules.htl.AbstractBaseTest;
-import org.junit.Test;
+import com.vml.aemrules.java.checks.resourceresolver.close.ResourceResolverTryWithResourcesCheck;
+import org.junit.jupiter.api.Test;
-public class DisplayContextInConditionalCommentsCheckTest extends AbstractBaseTest {
+class ResourceResolverTryWithResourcesTest extends AbstractBaseTest {
@Test
- public void checkContextInConditionalComments() {
- check = new DisplayContextInConditionalCommentsCheck();
- filename = "src/test/files/checks/htl/DisplayContextInConditionalCommentsCheck.html";
+ void checkResourceResolverUsesTryWithResourcesBlock() {
+ this.check = new ResourceResolverTryWithResourcesCheck();
+ this.filename = "src/test/files/java/AutoclosableResourceResolver.java";
verify();
}
+
}
diff --git a/src/test/java/com/vml/aemrules/java/checks/SessionShouldBeLoggedOutTest.java b/src/test/java/com/vml/aemrules/java/checks/SessionShouldBeLoggedOutTest.java
new file mode 100644
index 00000000..79ce8d64
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/java/checks/SessionShouldBeLoggedOutTest.java
@@ -0,0 +1,49 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.java.checks;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+class SessionShouldBeLoggedOutTest extends AbstractBaseTest {
+
+ @ParameterizedTest
+ @CsvSource({
+ "src/test/files/java/SessionLogoutOne.java,false",
+ "src/test/files/java/SessionLogoutTwo.java,false",
+ "src/test/files/java/SessionLogoutThree.java,false",
+ "src/test/files/java/SessionLogoutFour.java,true",
+ "src/test/files/java/SessionLogoutFive.java,true",
+ "src/test/files/java/SessionLogoutSix.java,true",
+ "src/test/files/java/SessionLogoutSeven.java,true",
+ "src/test/files/java/SessionLogoutEight.java,false",
+ "src/test/files/java/LongSessionEventListener.java,false",
+ "src/test/files/java/LongSessionEventListenerError.java,true"
+ })
+ void checkInjectorNotClosedInFinallyBlock(String fileName, boolean expectFailure) {
+ this.filename = fileName;
+ this.check = new SessionShouldBeLoggedOut();
+ if (expectFailure) {
+ verify();
+ } else {
+ verifyNoIssues();
+ }
+ }
+}
diff --git a/src/test/java/com/vml/aemrules/java/checks/SlingQueryImplicitStrategyCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/SlingQueryImplicitStrategyCheckTest.java
new file mode 100644
index 00000000..2876d0c7
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/java/checks/SlingQueryImplicitStrategyCheckTest.java
@@ -0,0 +1,34 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.java.checks;
+
+import com.vml.aemrules.java.checks.slingquery.SlingQueryImplicitStrategyCheck;
+import org.junit.jupiter.api.Test;
+
+class SlingQueryImplicitStrategyCheckTest extends AbstractBaseTest {
+
+ @Test
+ void checkImplicitSearches() {
+ this.check = new SlingQueryImplicitStrategyCheck();
+ this.filename = "src/test/files/java/SlingQueryImplicitStrategyCheck.java";
+ verify();
+ }
+
+}
diff --git a/src/test/java/com/cognifide/aemrules/java/checks/SynchronizedKeywordUsageCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/SynchronizedKeywordUsageCheckTest.java
similarity index 62%
rename from src/test/java/com/cognifide/aemrules/java/checks/SynchronizedKeywordUsageCheckTest.java
rename to src/test/java/com/vml/aemrules/java/checks/SynchronizedKeywordUsageCheckTest.java
index dddbecf9..1acb43d4 100644
--- a/src/test/java/com/cognifide/aemrules/java/checks/SynchronizedKeywordUsageCheckTest.java
+++ b/src/test/java/com/vml/aemrules/java/checks/SynchronizedKeywordUsageCheckTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,16 +17,16 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.java.checks;
+package com.vml.aemrules.java.checks;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
-public class SynchronizedKeywordUsageCheckTest extends AbstractBaseTest {
+class SynchronizedKeywordUsageCheckTest extends AbstractBaseTest {
@Test
- public void checkThreadSafeFieldsInServlet() {
- check = new SynchronizedKeywordUsageCheck();
- filename = "src/test/files/checks/java/SynchronizedKeywordUsageCheck.java";
+ void checkThreadSafeFieldsInServlet() {
+ this.check = new SynchronizedKeywordUsageCheck();
+ this.filename = "src/test/files/java/SynchronizedKeywordUsageCheck.java";
verify();
}
diff --git a/src/test/java/com/vml/aemrules/java/checks/ThreadSafeFieldCheckTest.java b/src/test/java/com/vml/aemrules/java/checks/ThreadSafeFieldCheckTest.java
new file mode 100644
index 00000000..bcdffe91
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/java/checks/ThreadSafeFieldCheckTest.java
@@ -0,0 +1,42 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.java.checks;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+class ThreadSafeFieldCheckTest extends AbstractBaseTest {
+
+ @ParameterizedTest
+ @CsvSource({
+ "checkThreadSafeFieldsInServlet,src/test/files/java/ThreadSafeFieldCheckServlet.java",
+ "checkThreadSafeFieldsInFilter,src/test/files/java/ThreadSafeFieldCheckFilter.java",
+ "checkThreadSafeFieldsInEventHandler,src/test/files/java/ThreadSafeFieldCheckEventHandler.java",
+ "checkThreadSafeFieldsInScrComponent,src/test/files/java/ThreadSafeFieldCheckScrComponentAnnotation.java",
+ "checkThreadSafeFieldsInDsComponent,src/test/files/java/ThreadSafeFieldCheckDsComponentAnnotation.java",
+ "checkThreadSafeFieldsInSlingServletAnnotated,src/test/files/java/ThreadSafeFieldCheckSlingServletAnnotation.java"
+ })
+ void detect(String description, String fileName) {
+ System.out.println(description);
+ this.check = new ThreadSafeFieldCheck();
+ this.filename = fileName;
+ verify();
+ }
+}
diff --git a/src/test/java/com/cognifide/aemrules/matcher/MethodMatcherTest.java b/src/test/java/com/vml/aemrules/matcher/MethodMatcherTest.java
similarity index 52%
rename from src/test/java/com/cognifide/aemrules/matcher/MethodMatcherTest.java
rename to src/test/java/com/vml/aemrules/matcher/MethodMatcherTest.java
index 53ff84f8..e6250071 100644
--- a/src/test/java/com/cognifide/aemrules/matcher/MethodMatcherTest.java
+++ b/src/test/java/com/vml/aemrules/matcher/MethodMatcherTest.java
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,12 +17,12 @@
* limitations under the License.
* #L%
*/
-package com.cognifide.aemrules.matcher;
+package com.vml.aemrules.matcher;
-import org.junit.Assert;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
import org.sonar.java.model.JParser;
import org.sonar.java.model.JParserConfig;
+import org.sonar.java.model.JavaVersionImpl;
import org.sonar.plugins.java.api.tree.ClassTree;
import org.sonar.plugins.java.api.tree.CompilationUnitTree;
import org.sonar.plugins.java.api.tree.ExpressionStatementTree;
@@ -35,122 +35,114 @@
import java.util.List;
import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
public class MethodMatcherTest {
- private static final String CODE_TO_PARSE_METHOD_SELECT_KIND_IDENTIFIER = "package com.cognifide.test; "
- + "class MyClass1 {}"
- + "class MyClass2 {}"
- + "class TestClass { "
- + "void test(MyClass1 m1, MyClass2 m2){}"
- + "void bar(){MyClass1 m1 = new MyClass1(); MyClass2 m2 = new MyClass2(); test(m1, m2);} "
- + "}";
-
- private static final String CODE_TO_PARSE_METHOD_SELECT_KIND_MEMBER_SELECT = "package com.cognifide.test; "
- + "class MyClass1 {}"
- + "class MyClass2 {}"
- + "class TestClass { "
- + "void test(MyClass1 m1, MyClass2 m2){}"
- + "void bar(){MyClass1 m1 = new MyClass1(); MyClass2 m2 = new MyClass2(); this.test(m1, m2);} "
- + "}";
-
- private static final int CLASS_INDEX = 2;
-
- private static final int CLASS_METHOD_INDEX = 1;
-
- private static final int METHOD_INVOCATION_INDEX = 2;
-
public static final String CLASSES_FILEPATH = "target/classes";
-
public static final String TEST_CLASSES_FILEPATH = "target/test-classes";
-
public static final String JAVA_VERSION = "1.8";
-
public static final String UNIT_NAME = "test";
-
+ private static final String CODE_TO_PARSE_METHOD_SELECT_KIND_IDENTIFIER = "package com.vml.test; "
+ + "class MyClass1 {}"
+ + "class MyClass2 {}"
+ + "class TestClass { "
+ + "void test(MyClass1 m1, MyClass2 m2){}"
+ + "void bar(){MyClass1 m1 = new MyClass1(); MyClass2 m2 = new MyClass2(); test(m1, m2);} "
+ + "}";
+ private static final String CODE_TO_PARSE_METHOD_SELECT_KIND_MEMBER_SELECT = "package com.vml.test; "
+ + "class MyClass1 {}"
+ + "class MyClass2 {}"
+ + "class TestClass { "
+ + "void test(MyClass1 m1, MyClass2 m2){}"
+ + "void bar(){MyClass1 m1 = new MyClass1(); MyClass2 m2 = new MyClass2(); this.test(m1, m2);} "
+ + "}";
+ private static final int CLASS_INDEX = 2;
+ private static final int CLASS_METHOD_INDEX = 1;
+ private static final int METHOD_INVOCATION_INDEX = 2;
private MethodInvocationTree methodInvocationTree;
@Test
- public void shouldMatchMethodWhenMethodNameAndOwnerClassAndMethodParametersMatch() {
+ void shouldMatchMethodWhenMethodNameAndOwnerClassAndMethodParametersMatch() {
givenMethodInvocationTree(CODE_TO_PARSE_METHOD_SELECT_KIND_IDENTIFIER);
MethodMatcher methodMatcher = MethodMatcher.create(
- MethodNamePredicate.is(UNIT_NAME),
- OwnerTypePredicate.is("com.cognifide.test.TestClass"),
- ParameterTypePredicate.is("com.cognifide.test.MyClass1"),
- ParameterTypePredicate.is("com.cognifide.test.MyClass2")
+ MethodNamePredicate.is(UNIT_NAME),
+ OwnerTypePredicate.is("com.vml.test.TestClass"),
+ ParameterTypePredicate.is("com.vml.test.MyClass1"),
+ ParameterTypePredicate.is("com.vml.test.MyClass2")
);
- Assert.assertThat(methodMatcher.matches(methodInvocationTree), is(true));
+ assertThat(methodMatcher.matches(methodInvocationTree), is(true));
}
@Test
- public void shouldMatchMethodWhenMethodNameAndOwnerClassAndOnlySecondParameterMatch() {
+ void shouldMatchMethodWhenMethodNameAndOwnerClassAndOnlySecondParameterMatch() {
givenMethodInvocationTree(CODE_TO_PARSE_METHOD_SELECT_KIND_MEMBER_SELECT);
MethodMatcher methodMatcher = MethodMatcher.create(
- MethodNamePredicate.is(UNIT_NAME),
- OwnerTypePredicate.is("com.cognifide.test.TestClass"),
- ParameterTypePredicate.anyParameterType(),
- ParameterTypePredicate.is("com.cognifide.test.MyClass2")
+ MethodNamePredicate.is(UNIT_NAME),
+ OwnerTypePredicate.is("com.vml.test.TestClass"),
+ ParameterTypePredicate.anyParameterType(),
+ ParameterTypePredicate.is("com.vml.test.MyClass2")
);
- Assert.assertThat(methodMatcher.matches(methodInvocationTree), is(true));
+ assertThat(methodMatcher.matches(methodInvocationTree), is(true));
}
@Test
- public void shouldNotMatchMethodWhenMethodNameDoesNotMatch() {
+ void shouldNotMatchMethodWhenMethodNameDoesNotMatch() {
givenMethodInvocationTree(CODE_TO_PARSE_METHOD_SELECT_KIND_IDENTIFIER);
MethodMatcher methodMatcher = MethodMatcher.create(
- MethodNamePredicate.is("different"),
- OwnerTypePredicate.is("com.cognifide.test.TestClass"),
- ParameterTypePredicate.is("com.cognifide.test.MyClass1"),
- ParameterTypePredicate.is("com.cognifide.test.MyClass2")
+ MethodNamePredicate.is("different"),
+ OwnerTypePredicate.is("com.vml.test.TestClass"),
+ ParameterTypePredicate.is("com.vml.test.MyClass1"),
+ ParameterTypePredicate.is("com.vml.test.MyClass2")
);
- Assert.assertThat(methodMatcher.matches(methodInvocationTree), is(false));
+ assertThat(methodMatcher.matches(methodInvocationTree), is(false));
}
@Test
- public void shouldNotMatchMethodWhenNumberOfMethodParametersDoesNotMatch() {
+ void shouldNotMatchMethodWhenNumberOfMethodParametersDoesNotMatch() {
givenMethodInvocationTree(CODE_TO_PARSE_METHOD_SELECT_KIND_MEMBER_SELECT);
MethodMatcher methodMatcher = MethodMatcher.create(
- MethodNamePredicate.is(UNIT_NAME),
- OwnerTypePredicate.is("com.cognifide.test.TestClass"),
- ParameterTypePredicate.is("com.cognifide.test.MyClass1")
+ MethodNamePredicate.is(UNIT_NAME),
+ OwnerTypePredicate.is("com.vml.test.TestClass"),
+ ParameterTypePredicate.is("com.vml.test.MyClass1")
);
- Assert.assertThat(methodMatcher.matches(methodInvocationTree), is(false));
+ assertThat(methodMatcher.matches(methodInvocationTree), is(false));
}
@Test
- public void shouldNotMatchMethodWhenMethodOwnerClassDoesNotMatch() {
+ void shouldNotMatchMethodWhenMethodOwnerClassDoesNotMatch() {
givenMethodInvocationTree(CODE_TO_PARSE_METHOD_SELECT_KIND_IDENTIFIER);
MethodMatcher methodMatcher = MethodMatcher.create(
- MethodNamePredicate.is(UNIT_NAME),
- OwnerTypePredicate.is("com.cognifide.test.Different"),
- ParameterTypePredicate.is("com.cognifide.test.MyClass1"),
- ParameterTypePredicate.is("com.cognifide.test.MyClass2")
+ MethodNamePredicate.is(UNIT_NAME),
+ OwnerTypePredicate.is("com.vml.test.Different"),
+ ParameterTypePredicate.is("com.vml.test.MyClass1"),
+ ParameterTypePredicate.is("com.vml.test.MyClass2")
);
- Assert.assertThat(methodMatcher.matches(methodInvocationTree), is(false));
+ assertThat(methodMatcher.matches(methodInvocationTree), is(false));
}
@Test
- public void shouldNotMatchMethodWhenMethodParameterTypesDoNotMatch() {
+ void shouldNotMatchMethodWhenMethodParameterTypesDoNotMatch() {
givenMethodInvocationTree(CODE_TO_PARSE_METHOD_SELECT_KIND_MEMBER_SELECT);
MethodMatcher methodMatcher = MethodMatcher.create(
- MethodNamePredicate.is(UNIT_NAME),
- OwnerTypePredicate.is("com.cognifide.test.TestClass"),
- ParameterTypePredicate.is("com.cognifide.test.Different1"),
- ParameterTypePredicate.is("com.cognifide.test.MyClass2")
+ MethodNamePredicate.is(UNIT_NAME),
+ OwnerTypePredicate.is("com.vml.test.TestClass"),
+ ParameterTypePredicate.is("com.vml.test.Different1"),
+ ParameterTypePredicate.is("com.vml.test.MyClass2")
);
- Assert.assertThat(methodMatcher.matches(methodInvocationTree), is(false));
+ assertThat(methodMatcher.matches(methodInvocationTree), is(false));
}
private void givenMethodInvocationTree(String codeToParse) {
@@ -162,8 +154,7 @@ private void givenMethodInvocationTree(String codeToParse) {
private CompilationUnitTree parse(String source) {
List classpath = Arrays.asList(new File(TEST_CLASSES_FILEPATH), new File(CLASSES_FILEPATH));
- return JParser.parse(JParserConfig.Mode.FILE_BY_FILE.create(JAVA_VERSION, classpath).astParser(), JAVA_VERSION, UNIT_NAME, source);
+ return JParser.parse(JParserConfig.Mode.FILE_BY_FILE.create(new JavaVersionImpl(11), classpath).astParser(), JAVA_VERSION, UNIT_NAME, source);
}
}
-
diff --git a/src/test/java/com/vml/aemrules/version/VersionSupportCheckerTest.java b/src/test/java/com/vml/aemrules/version/VersionSupportCheckerTest.java
new file mode 100644
index 00000000..5c709283
--- /dev/null
+++ b/src/test/java/com/vml/aemrules/version/VersionSupportCheckerTest.java
@@ -0,0 +1,190 @@
+/*-
+ * #%L
+ * AEM Rules for SonarQube
+ * %%
+ * Copyright (C) 2015-2024 VML
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.vml.aemrules.version;
+
+import org.junit.jupiter.api.Test;
+
+import static com.vml.aemrules.version.VersionSupportChecker.DEFAULT_AEM_VERSION;
+import static com.vml.aemrules.version.VersionSupportChecker.create;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+class VersionSupportCheckerTest {
+
+ @Test
+ void shouldSupportAllVersionsWhenAllSet() {
+ VersionSupportChecker versionSupportChecker = create(
+ CheckSupportingAllVersions.class.getAnnotation(AemVersion.class));
+ assertThat(versionSupportChecker.supports("6.3"), is(true));
+ assertThat(versionSupportChecker.supports("2.1"), is(true));
+ assertThat(versionSupportChecker.supports("2.0"), is(true));
+ }
+
+ @Test
+ void shouldSupportAllVersionsBetweenFromAndTo() {
+ VersionSupportChecker versionSupportChecker = create(
+ CheckSupportingVersionsFromTo.class.getAnnotation(AemVersion.class));
+ assertThat(versionSupportChecker.supports("6.1"), is(true));
+ assertThat(versionSupportChecker.supports("5.2"), is(true));
+ assertThat(versionSupportChecker.supports("5.1"), is(true));
+ assertThat(versionSupportChecker.supports("6.4"), is(true));
+ assertThat(versionSupportChecker.supports("6.5"), is(false));
+ assertThat(versionSupportChecker.supports("5.0"), is(false));
+ }
+
+ @Test
+ void shouldSupportAllVersionsFrom() {
+ VersionSupportChecker versionSupportChecker = create(
+ CheckSupportingVersionsFrom.class.getAnnotation(AemVersion.class));
+ assertThat(versionSupportChecker.supports("100.1"), is(true));
+ assertThat(versionSupportChecker.supports("10.1"), is(true));
+ assertThat(versionSupportChecker.supports("17.2"), is(true));
+ assertThat(versionSupportChecker.supports("10.0"), is(false));
+ assertThat(versionSupportChecker.supports("5.9"), is(false));
+ }
+
+ @Test
+ void shouldSupportAllVersionsTo() {
+ VersionSupportChecker supportedVersions = create(
+ CheckSupportingVersionsTo.class.getAnnotation(AemVersion.class));
+ assertThat(supportedVersions.supports("1.1"), is(true));
+ assertThat(supportedVersions.supports("10.1"), is(true));
+ assertThat(supportedVersions.supports("0.2"), is(true));
+ assertThat(supportedVersions.supports("8.5"), is(true));
+ assertThat(supportedVersions.supports("10.2"), is(false));
+ assertThat(supportedVersions.supports("20.9"), is(false));
+ }
+
+ @Test
+ void shouldSupportAllProvidedVersions() {
+ VersionSupportChecker supportedVersions = create(
+ CheckSupportingVersionsIncluded.class.getAnnotation(AemVersion.class));
+ assertThat(supportedVersions.supports("6.1"), is(true));
+ assertThat(supportedVersions.supports("2.1"), is(true));
+ assertThat(supportedVersions.supports("4.8"), is(true));
+ assertThat(supportedVersions.supports("6.0"), is(false));
+ assertThat(supportedVersions.supports("2.2"), is(false));
+ }
+
+ @Test
+ void shouldSupportAllVersionsExcludingProvided() {
+ VersionSupportChecker supportedVersions = create(
+ CheckSupportingVersionsExcluded.class.getAnnotation(AemVersion.class));
+ assertThat(supportedVersions.supports("6.1"), is(false));
+ assertThat(supportedVersions.supports("2.1"), is(false));
+ assertThat(supportedVersions.supports("4.8"), is(false));
+ assertThat(supportedVersions.supports("6.0"), is(true));
+ assertThat(supportedVersions.supports("2.2"), is(true));
+ }
+
+ @Test
+ void shouldUseDefaultVersionWhenProvidedVersionIsEmptyOrNull() {
+ VersionSupportChecker supportedVersions = create(
+ CheckSupportingDefaultVersion.class.getAnnotation(AemVersion.class));
+ assertThat(supportedVersions.supports(DEFAULT_AEM_VERSION), is(true));
+ assertThat(supportedVersions.supports(""), is(true));
+ assertThat(supportedVersions.supports(null), is(true));
+ }
+
+ @Test
+ void shouldThrowExceptionWhenVersionToSupportIsIncorrect() {
+ VersionSupportChecker supportedVersions = create(
+ CheckSupportingVersionsExcluded.class.getAnnotation(AemVersion.class));
+ assertThrows(IllegalArgumentException.class, () -> supportedVersions.supports("f.1"));
+ }
+
+ @Test
+ void shouldThrowExceptionWhenVersionIncorrectProvided1() {
+ assertThrows(IllegalArgumentException.class, () -> create(CheckWithIncorrectVersion1.class.getAnnotation(AemVersion.class)));
+ }
+
+ @Test
+ void shouldThrowExceptionWhenVersionIncorrectProvided2() {
+ assertThrows(IllegalArgumentException.class, () -> create(CheckWithIncorrectVersion2.class.getAnnotation(AemVersion.class)));
+ }
+
+
+ @AemVersion(
+ all = true
+ )
+ private class CheckSupportingAllVersions {
+
+ }
+
+ @AemVersion(
+ from = "5.1",
+ to = "6.4"
+ )
+ private class CheckSupportingVersionsFromTo {
+
+ }
+
+ @AemVersion(
+ from = "10.1"
+ )
+ private class CheckSupportingVersionsFrom {
+
+ }
+
+ @AemVersion(
+ to = "10.1"
+ )
+ private class CheckSupportingVersionsTo {
+
+ }
+
+ @AemVersion(
+ included = {"6.1", "2.1", "4.8"}
+ )
+ private class CheckSupportingVersionsIncluded {
+
+ }
+
+ @AemVersion(
+ all = true,
+ excluded = {"6.1", "2.1", "4.8"}
+ )
+ private class CheckSupportingVersionsExcluded {
+
+ }
+
+ @AemVersion(
+ from = "5.6.7"
+ )
+ private class CheckWithIncorrectVersion1 {
+
+ }
+
+ @AemVersion(
+ included = "a.b"
+ )
+ private class CheckWithIncorrectVersion2 {
+
+ }
+
+ @AemVersion(
+ included = {DEFAULT_AEM_VERSION}
+ )
+ private class CheckSupportingDefaultVersion {
+
+ }
+
+}
diff --git a/src/test/resources/rules/AEM-TEST.md b/src/test/resources/rules/AEM-TEST.md
deleted file mode 100644
index 4a55210b..00000000
--- a/src/test/resources/rules/AEM-TEST.md
+++ /dev/null
@@ -1 +0,0 @@
-Test description.
\ No newline at end of file
diff --git a/src/test/resources/rules/com.cognifide.aemrules.extensions.RulesLoaderTest.RuleWithOnlyNameAttribute.md b/src/test/resources/rules/com.cognifide.aemrules.extensions.RulesLoaderTest.RuleWithOnlyNameAttribute.md
deleted file mode 100644
index e69de29b..00000000
diff --git a/src/test/resources/scanner/testFile.html b/src/test/resources/scanner/testFile.html
index ec8f57c8..aca99c8a 100644
--- a/src/test/resources/scanner/testFile.html
+++ b/src/test/resources/scanner/testFile.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/resources/sensor/comment.html b/src/test/resources/sensor/comment.html
index d7b5feef..3ab34150 100644
--- a/src/test/resources/sensor/comment.html
+++ b/src/test/resources/sensor/comment.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/resources/sensor/error.html b/src/test/resources/sensor/error.html
index 8973e548..29d61280 100644
--- a/src/test/resources/sensor/error.html
+++ b/src/test/resources/sensor/error.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/resources/sensor/nestedTags.html b/src/test/resources/sensor/nestedTags.html
index b0a435cd..4e3f33d0 100644
--- a/src/test/resources/sensor/nestedTags.html
+++ b/src/test/resources/sensor/nestedTags.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/src/test/resources/sensor/test.html b/src/test/resources/sensor/test.html
index ef26da5c..b99e99d5 100644
--- a/src/test/resources/sensor/test.html
+++ b/src/test/resources/sensor/test.html
@@ -3,7 +3,7 @@
#%L
AEM Rules for SonarQube
%%
- Copyright (C) 2015-2019 Wunderman Thompson Technology
+ Copyright (C) 2015-2024 VML
%%
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
-
-
- - ${item.name} - -
-
-
- - ${file.name} - -
- ${'http://www.example.org/search?s=1&q=htl' @ context='uri'}
-
-``
diff --git a/src/main/resources/rules/HTL-7.md b/src/main/resources/rules/HTL-7.md
deleted file mode 100644
index d9f58593..00000000
--- a/src/main/resources/rules/HTL-7.md
+++ /dev/null
@@ -1,29 +0,0 @@
-For style and script tags display context definition is mandatory.
-
-== Noncompliant Code Example
-
-``
-
-
-
-``
-
-== Compliant Solution
-
-``
-
-
-
-``
diff --git a/src/main/resources/rules/HTL-8.md b/src/main/resources/rules/HTL-8.md
deleted file mode 100644
index 863ea054..00000000
--- a/src/main/resources/rules/HTL-8.md
+++ /dev/null
@@ -1,13 +0,0 @@
-In HTL event attributes must contain display context definition";
-
-== Noncompliant Code Example
-
-``
-Link
-``
-
-== Compliant Solution
-
-``
-Link
-``
diff --git a/src/main/resources/rules/HTL-9.md b/src/main/resources/rules/HTL-9.md
deleted file mode 100644
index 9a9e3044..00000000
--- a/src/main/resources/rules/HTL-9.md
+++ /dev/null
@@ -1,13 +0,0 @@
-For inline styles display context is mandatory
-
-== Noncompliant Code Example
-
-``
-Link
-``
-
-== Compliant Solution
-
-``
-Link
-``
diff --git a/src/main/script/prepareResources.groovy b/src/main/script/prepareResources.groovy
index f91a92f2..bceca8f6 100644
--- a/src/main/script/prepareResources.groovy
+++ b/src/main/script/prepareResources.groovy
@@ -2,7 +2,7 @@
* #%L
* AEM Rules for SonarQube
* %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
+ * Copyright (C) 2015-2024 VML
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/src/test/files/checks/java/ContentResourceShouldBeNullCheckedCheck.java b/src/test/files/checks/java/ContentResourceShouldBeNullCheckedCheck.java
deleted file mode 100644
index e1477451..00000000
--- a/src/test/files/checks/java/ContentResourceShouldBeNullCheckedCheck.java
+++ /dev/null
@@ -1,143 +0,0 @@
-/*-
- * #%L
- * AEM Rules for SonarQube
- * %%
- * Copyright (C) 2015-2019 Wunderman Thompson Technology
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package com.example;
-
-import com.adobe.cq.commerce.common.ValueMapDecorator;
-import com.day.cq.wcm.api.Page;
-import java.util.HashMap;
-import java.util.Objects;
-import java.util.Optional;
-import org.apache.commons.lang3.ObjectUtils;
-import org.apache.sling.api.resource.ModifiableValueMap;
-import org.apache.sling.api.resource.Resource;
-import org.apache.sling.api.resource.ValueMap;
-
-public class ContentResourceShouldBeNullCheckedCheck {
-
- private void contentResourceNotNullCheckedBeforeUsage(Resource resource) {
- Page page = resource.adaptTo(Page.class);
- Resource contentResourceA = page.getContentResource();
- Iterable