Hotfix 1.0.3, update the api document detection process and allow refs inopenapi response headers

Author: adrian-palanques-cloudappi

its/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.apiaddicts.apitools.dosonarapi</groupId>
         <artifactId>dosonarapi</artifactId>
-        <version>1.0.2</version>
+        <version>1.0.3</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

openapi-checks/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>org.apiaddicts.apitools.dosonarapi</groupId>
     <artifactId>dosonarapi</artifactId>
-    <version>1.0.2</version>
+    <version>1.0.3</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

openapi-front-end/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>org.apiaddicts.apitools.dosonarapi</groupId>
     <artifactId>dosonarapi</artifactId>
-    <version>1.0.2</version>
+    <version>1.0.3</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

openapi-front-end/src/main/java/org/apiaddicts/apitools/dosonarapi/api/v3/OpenApi3Grammar.java

@@ -200,7 +200,7 @@ private static void buildResponses(YamlGrammarBuilder b) {
     b.rule(RESPONSE).is(b.object(
       b.mandatoryProperty("description", DESCRIPTION),
       b.property("headers", b.object(
-        b.patternProperty(".*", HEADER))),
+        b.patternProperty(".*", b.firstOf(REF, HEADER)))),
       b.property("content", b.object(
         b.patternProperty(".*", MEDIA_TYPE))),
       b.property("links", b.object(

openapi-test-tools/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>org.apiaddicts.apitools.dosonarapi</groupId>
     <artifactId>dosonarapi</artifactId>
-    <version>1.0.2</version>
+    <version>1.0.3</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

pom.xml

@@ -9,7 +9,7 @@
 
   <groupId>org.apiaddicts.apitools.dosonarapi</groupId>
   <artifactId>dosonarapi</artifactId>
-  <version>1.0.2</version>
+  <version>1.0.3</version>
   <packaging>pom</packaging>
 
   <name>SonarOpenAPI</name>

sonar-openapi-plugin/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>org.apiaddicts.apitools.dosonarapi</groupId>
     <artifactId>dosonarapi</artifactId>
-    <version>1.0.2</version>
+    <version>1.0.3</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

sonar-openapi-plugin/src/main/java/org/apiaddicts/apitools/dosonarapi/plugin/OpenApiAnalyzer.java

@@ -113,7 +113,7 @@ private void scanFile(InputFile inputFile) {
     OpenApiVisitorContext visitorContext;
     try {
       String content = getContent(inputFile);
-
+      if (!content.contains("swagger") && !content.contains("openapi")) return;
       JsonNode rootNode = genericParser.parse(content);
       boolean isV2 = !rootNode.at("/swagger").isMissing();
       boolean isV3 = !rootNode.at("/openapi").isMissing();
@@ -156,13 +156,16 @@ private void scanFile(InputFile inputFile) {
    */
   private String getContent(InputFile inputFile) throws IOException {
     String [] lines = inputFile.contents().split("\n");
-    for (int i = 1; i < lines.length; i++) {
-      lines[i] = lines[i].replace("\t", "    ");
-      lines[i] = lines[i].replace("\\/", "/");
+    for (int i = 0; i < lines.length; i++) {
+      lines[i] = lines[i].replace("\t", " ");
+      lines[i] = lines[i].replace("\\/", "//");
+      lines[i] = lines[i].replace("!!", "  ");
       if (!lines[i].trim().isEmpty()) continue;
-      int n = lines[i-1].indexOf(lines[i-1].trim());
-      if (n < 0) n = 0;
-      lines[i] = String.join("", Collections.nCopies(n, " ")) + "#";
+      if (i > 0) {
+        int n = lines[i - 1].indexOf(lines[i - 1].trim());
+        if (n < 0) n = 0;
+        lines[i] = String.join("", Collections.nCopies(n, " ")) + "#";
+      }
     }
     return String.join("\n", lines);
   }

sonar-openapi-plugin/src/test/java/org/apiaddicts/apitools/dosonarapi/plugin/OpenApiScannerSensorTest.java

@@ -24,6 +24,9 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.LinkedList;
+import java.util.List;
 
 import org.junit.Before;
 import org.junit.Test;
@@ -129,6 +132,16 @@ public void parse_error() {
         );
   }
 
+  @Test
+  public void parse_openapi3_headers_ref() {
+    inputFile("headers_ref.yaml");
+    activeRules = (new ActiveRulesBuilder())
+            .create(RuleKey.of(CheckList.REPOSITORY_KEY, ParsingErrorCheck.CHECK_KEY))
+            .activate()
+            .build();
+    sensor().execute(context);
+  }
+
   @Test
   public void parse_yaml_break_comment_ok() {
     inputFile("parse-yaml.yaml");
@@ -165,6 +178,21 @@ public void parse_yaml_tabs_ok() {
     assertThat(context.allAnalysisErrors()).hasSize(0);
   }
 
+  //@Test
+  public void test_folder() {
+    List<String> files = listFiles("files");
+    List<String> errorFiles = new LinkedList<>();
+    for (String file: files) {
+      context = SensorContextTester.create(baseDir);
+      inputFile(file);
+      activeRules = (new ActiveRulesBuilder()).create(RuleKey.of(CheckList.REPOSITORY_KEY, ParsingErrorCheck.CHECK_KEY))
+              .activate().build();
+      sensor().execute(context);
+      if (!context.allIssues().isEmpty() || !context.allAnalysisErrors().isEmpty()) errorFiles.add(file);
+    }
+    System.out.println(errorFiles);
+  }
+
   @Test
   public void cancelled_analysis() {
     InputFile inputFile = inputFile("file1.yaml");
@@ -193,4 +221,22 @@ private InputFile inputFile(String name) {
     context.fileSystem().add(inputFile);
     return inputFile;
   }
+
+  private List<String> listFiles(String folderName) {
+    File folder = baseDir.resolve(folderName).toAbsolutePath().toFile();
+    return listFilesInFolder(folder, baseDir.toFile());
+  }
+  private static List<String> listFilesInFolder(File folder, File baseFolder) {
+    File[] files = folder.listFiles();
+    List<String> allPaths = new ArrayList<>();
+    for (File file : files) {
+      if (file.isFile()) {
+        String relativePath = baseFolder.toURI().relativize(file.toURI()).getPath();
+        allPaths.add(relativePath);
+      } else if (file.isDirectory()) {
+        allPaths.addAll(listFilesInFolder(file, baseFolder));
+      }
+    }
+    return allPaths;
+  }
 }