Merge pull request #2639 from antarus/feature/add-sonar-doc

Add sonar documentation
jhipster · Jul 17, 2022 · b291c4a · b291c4a
2 parents b8fc25f + 9883e9e
commit b291c4a
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 2 deletions.
diff --git a/src/main/java/tech/jhipster/lite/generator/server/sonar/domain/SonarModulesFactory.java b/src/main/java/tech/jhipster/lite/generator/server/sonar/domain/SonarModulesFactory.java
@@ -43,7 +43,9 @@ private JHipsterModuleBuilder commonModuleFiles(JHipsterModuleProperties propert
     return moduleBuilder(properties)
       .context()
       .put("sonarqubeDockerImage", dockerImages.get("sonarqube").fullName())
+      .put("srcMainDocker", "src/main/docker")
       .and()
+      .documentation(documentationTitle("sonar"), SOURCE.template("sonar.md"))
       .javaBuildPlugins()
       .plugin(propertiesPlugin())
       .pluginManagement(sonarPlugin())

diff --git a/src/main/resources/generator/server/sonar/sonar.md.mustache b/src/main/resources/generator/server/sonar/sonar.md.mustache
@@ -0,0 +1,22 @@
+# Usage
+
+Before you can analyse your project, you must launch sonar with the following command
+
+**with docker-compose**
+```bash
+docker-compose -f {{srcMainDocker}}/sonar.yml up -d
+```
+
+**with docker compose plugin**
+```bash
+docker compose -f {{srcMainDocker}}/sonar.yml up -d
+```
+
+After that you can launch the analysis of your project with
+```bash
+./mvnw clean verify sonar:sonar
+```
+
+You can see the result at [http://localhost:9001/](http://localhost:9001/)
+
+[official documentation](https://www.sonarqube.org/)
diff --git a/src/test/features/sonar.feature b/src/test/features/sonar.feature
@@ -6,10 +6,14 @@ Feature: Sonar modules
       | baseName    | jhipster            |
     Then I should have files in "."
       | sonar-project.properties |
+    Then I should have files in "documentation"
+      | sonar.md |
 
   Scenario: Should apply frontend and backend sonar module
     When I apply "sonar-java-backend-and-frontend" module to default project with maven file
       | packageName | tech.jhipster.chips |
       | baseName    | jhipster            |
     Then I should have files in "."
       | sonar-project.properties |
+    Then I should have files in "documentation"
+      | sonar.md |
diff --git a/src/test/java/tech/jhipster/lite/generator/server/sonar/domain/SonarModulesFactoryTest.java b/src/test/java/tech/jhipster/lite/generator/server/sonar/domain/SonarModulesFactoryTest.java
@@ -37,7 +37,10 @@ void shouldBuildBackendModule() {
       .containing(
         "sonar.exclusions=src/main/webapp/main.ts, src/main/webapp/app/main.ts, src/main/webapp/content/**/*.*, src/main/webapp/i18n/*.js, target/classes/static/**/*.*, src/main/webapp/app/index.tsx"
       )
-      .notContaining("sonar.testExecutionReportPaths=target/test-results/jest/TESTS-results-sonar.xml");
+      .notContaining("sonar.testExecutionReportPaths=target/test-results/jest/TESTS-results-sonar.xml")
+      .and()
+      .createFile("documentation/sonar.md")
+      .containing("docker compose -f src/main/docker/sonar.yml up -d");
   }
 
   @Test
@@ -51,7 +54,10 @@ void shouldBuildBackendFrontendModule() {
       .containing(
         "sonar.exclusions=src/main/webapp/main.ts, src/main/webapp/app/main.ts, src/main/webapp/content/**/*.*, src/main/webapp/i18n/*.js, target/classes/static/**/*.*, src/main/webapp/app/index.tsx, src/main/webapp/routes/index.svelte"
       )
-      .containing("sonar.testExecutionReportPaths=target/test-results/jest/TESTS-results-sonar.xml");
+      .containing("sonar.testExecutionReportPaths=target/test-results/jest/TESTS-results-sonar.xml")
+      .and()
+      .createFile("documentation/sonar.md")
+      .containing("docker-compose -f src/main/docker/sonar.yml up -d");
   }
 
   private void mockSonarqubeImage() {