Feature/add external configuration (#18)

* Fix comments regex.

Signed-off-by: Nikolay Chakarov <[email protected]>

* Add support for external configuration.
Signed-off-by: Nikolay Chakarov <[email protected]>

---------

Signed-off-by: Nikolay Chakarov <[email protected]>
Co-authored-by: Nikolay Chakarov <[email protected]>

Author: nchakarovvmw

.its-sonar-config.json

@@ -0,0 +1,4 @@
+[{
+  "filepath": "src/main/java/org/sonar/plugins/its/java/SourceComment.java",
+  "terms": "master"
+}]

build.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright 2022 VMware, Inc.
+# Copyright 2023 VMware, Inc.
 # SPDX-License-Identifier: BSD-2
 pwd
 mkdir plugins

pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    Copyright 2022 VMware, Inc.
+    Copyright 2023 VMware, Inc.
     SPDX-License-Identifier: BSD-2
 -->
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -102,6 +102,16 @@
 			<version>1.2.0</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.json</groupId>
+			<artifactId>json</artifactId>
+			<version>20230227</version>
+		</dependency>
+		<dependency>
+			<groupId>com.vaadin.external.google</groupId>
+			<artifactId>android-json</artifactId>
+			<version>0.0.20131108.vaadin1</version>
+		</dependency>
 	</dependencies>
 
 	<build>

src/main/java/org/sonar/plugins/its/java/SourceComment.java

@@ -1,9 +1,13 @@
 /***********************************************************
- * Copyright 2022 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  * SPDX-License-Identifier: BSD-2
  ***********************************************************/
 package org.sonar.plugins.its.java;
 
+/**
+ * Class describing the start and the end of a comment.
+ * The term master shouldn't be detected here because of the external configuration.
+ */
 public class SourceComment {
     private long start;
     private long end;

src/main/java/org/sonar/plugins/its/java/checks/ITSCommentsRule.java

@@ -1,5 +1,5 @@
 /***********************************************************
- * Copyright 2022 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  * SPDX-License-Identifier: BSD-2
  ***********************************************************/
 package org.sonar.plugins.its.java.checks;
@@ -17,7 +17,7 @@
  * It should detect master, slave, kill, etc
  */
 @Rule(key = ITSCommentsRule.KEY, name = "Inclusive Terminology Comments Scanner",
-        description = "Scan text/source files comments for presense of offensive terms",
+        description = "Scan text/source files comments for presence of offensive terms",
         priority = Priority.MAJOR)
 public class ITSCommentsRule extends BaseTreeVisitor implements JavaFileScanner {
 

src/main/java/org/sonar/plugins/its/java/checks/ITSJavaFilesSensor.java

@@ -1,5 +1,5 @@
 /***********************************************************
- * Copyright 2022 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  * SPDX-License-Identifier: BSD-2
  ***********************************************************/
 package org.sonar.plugins.its.java.checks;
@@ -12,9 +12,13 @@
 import org.sonar.api.batch.sensor.Sensor;
 import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.api.batch.sensor.SensorDescriptor;
+import org.sonar.plugins.its.service.ConfigService;
 import org.sonar.plugins.its.service.ItsFileScanner;
 import org.sonar.plugins.java.api.JavaFileScannerContext;
 
+import java.util.List;
+import java.util.Map;
+
 /**
  * Generates issues on all java files at line 1. This rule must be activated in
  * the Quality profile.
@@ -41,6 +45,9 @@ public void describe(SensorDescriptor descriptor) {
     public void execute(SensorContext context) {
         FileSystem fs = context.fileSystem();
         Iterable<InputFile> files = fs.inputFiles(fs.predicates().all());
+
+        Map<String, List<String>> config = ConfigService.loadConfig(context);
+
         for (InputFile file : files) {
             try {
                 String filename = file.filename();
@@ -50,9 +57,8 @@ public void execute(SensorContext context) {
                     continue;
                 }
                 logger.info("Scanning " + file.filename());
-
                 ItsFileScanner scanner = new ItsFileScanner();
-                scanner.scanFile(context, this, file);
+                scanner.scanFile(context, file, config.get(file.relativePath()));
             } catch (Exception e) {
                 logger.error("An error occurred with file " + file.filename());
                 logger.error(e.getMessage(), e.getStackTrace());

src/main/java/org/sonar/plugins/its/service/ConfigService.java

@@ -0,0 +1,55 @@
+/***********************************************************
+ * Copyright 2023 VMware, Inc.
+ * SPDX-License-Identifier: BSD-2
+ ***********************************************************/
+package org.sonar.plugins.its.service;
+
+import org.apache.commons.io.IOUtils;
+import org.json.JSONArray;
+import org.json.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.sonar.api.batch.fs.FileSystem;
+import org.sonar.api.batch.sensor.SensorContext;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Class responsible for loading the external configuration for the plugin.
+ */
+public class ConfigService {
+    private static final Logger logger = LoggerFactory.getLogger(ConfigService.class);
+
+    public static Map<String, List<String>> loadConfig(SensorContext context) {
+        FileSystem fs = context.fileSystem();
+
+        File[] configFiles = fs.baseDir().listFiles((dir, name) -> name.contains("its-sonar-config"));
+
+        Map<String, List<String>> config = new HashMap<>();
+
+        if (configFiles.length > 0) {
+            try {
+                InputStream is = new FileInputStream(configFiles[0]);
+                String jsonTxt = IOUtils.toString(is, "UTF-8");
+                logger.info("ConfigLoader: " + jsonTxt);
+                JSONArray jsonConfig = new JSONArray(jsonTxt);
+                for (int i = 0; i < jsonConfig.length(); i++) {
+                    JSONObject property = jsonConfig.getJSONObject(i);
+                    String filepath = property.getString("filepath");
+                    String terms = property.getString("terms");
+                    config.put(filepath, Arrays.asList(terms.split(",")));
+                }
+            } catch (Exception e) {
+                logger.error("Config file can't be opened", e);
+            }
+        }
+
+        return config;
+    }
+}

src/main/java/org/sonar/plugins/its/service/ItsFileScanner.java

@@ -1,5 +1,5 @@
 /***********************************************************
- * Copyright 2022 VMware, Inc.
+ * Copyright 2023 VMware, Inc.
  * SPDX-License-Identifier: BSD-2
  ***********************************************************/
 package org.sonar.plugins.its.service;
@@ -9,6 +9,7 @@
 import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -23,14 +24,18 @@
 import org.sonar.plugins.its.utils.LargeFileEncounteredException;
 import org.sonar.plugins.its.utils.LineNumberFinderUtil;
 
-/** Implementation of regex scanner using ITS rules */
+/**
+ * Implementation of regex scanner using ITS rules
+ */
 public class ItsFileScanner {
 
     private static final Logger logger = LoggerFactory.getLogger(ItsFileScanner.class);
     protected static final int MAX_CHARACTERS_SCANNED = 10 * 1024 * 1024; // 10 Mb limit
 
-    /** Scan file for offensive terms */
-    public void scanFile(SensorContext context, Sensor sensor, InputFile file) {
+    /**
+     * Scan file for offensive terms
+     */
+    public void scanFile(SensorContext context, InputFile file, List<String> excludeTerms) {
         int lineNumberOfTriggerMatch = -1;
 
         List<SourceComment> comments = new ArrayList<SourceComment>();
@@ -71,7 +76,17 @@ public void scanFile(SensorContext context, Sensor sensor, InputFile file) {
             }
         }
 
-        List<ItsScanRule> rules = ItsRulesManager.getRules();
+        List<ItsScanRule> rules = ItsRulesManager.getRules()
+                .stream()
+                .filter(rule -> {
+                    if (excludeTerms != null && !excludeTerms.isEmpty()) {
+                        return !excludeTerms.contains(rule.getTerm());
+                    } else {
+                        return true;
+                    }
+                })
+                .collect(Collectors.toList());
+
         if (rules == null)
             return;
 
@@ -89,11 +104,11 @@ public void scanFile(SensorContext context, Sensor sensor, InputFile file) {
                 // checks if in comment and sets different rule
                 if (isInComment(matcher, comments)) {
                     String message = "Offensive term: " + rule.getTerm() + ", replace with: " + rule.getReplacements();
-                    logger.info("COMMENT Offensive Term "+path + ":" + lineNumberOfTriggerMatch + " - " + message);
+                    logger.info("COMMENT Offensive Term " + path + ":" + lineNumberOfTriggerMatch + " - " + message);
                     createViolation(context, file, rule, lineNumberOfTriggerMatch, message, true);
                 } else {
                     String message = "SOURCE Offensive term: " + rule.getTerm() + ", replace with: " + rule.getReplacements();
-                    logger.info("SOURCE Offensive Term "+path + ":" + lineNumberOfTriggerMatch + " - " + message);
+                    logger.info("SOURCE Offensive Term " + path + ":" + lineNumberOfTriggerMatch + " - " + message);
                     createViolation(context, file, rule, lineNumberOfTriggerMatch, message, false);
                 }
             }
@@ -115,7 +130,7 @@ private boolean isInComment(Matcher matcher, List<SourceComment> comments) {
     }
 
     private void createViolation(SensorContext context, InputFile file, ItsScanRule rule, int line, String message,
-            boolean commentRule) {
+                                 boolean commentRule) {
         // no need to define the severity as it is automatically set according to the
         // configured Quality profile
         NewIssue issue;