Upgrade SonarLint Language Server and analyzers

necto · necto · commit f8da49e9b8d9 · 2023-08-01T14:06:45.000+02:00
Despite the smaller major version, 2.19.0 is the latest version of
SonarLint language server, it is newer than 4.6.0. I don't know what
happened with the versioning. All the recent analyzer jars are published
on the Maven or repox.jfrog.io instead of binaries.sonarsoruce.com.

Also add basic continuous tests for each supported analyzer on Linux and MacOS.
diff --git a/README.md b/README.md
@@ -105,7 +105,9 @@ Out of the box, SonarLint automatically checks your code against the following r
 * `lsp-sonarlint-disable-telemetry` - Disable telemetry option (disabled by default).
 * `lsp-sonarlint-test-file-pattern` - Regex to find test file, most rules are not evaluated on test files.
 * `lsp-sonarlint-show-analyzer-logs` - Show analyzer logs.
-* `lsp-sonarlint-server-download-url` - Sonarlint server download URL.
+* `lsp-sonarlint-verbose-logs` - Make SonarLint logs verbose.
+* `lsp-sonarlint-server-download-url` - SonarLint server download URL.
+* `lsp-sonarlint-plugin-autodownload` - Not ask for confirmation and download analyzers if they are missing.
 
 ### Plugins supported settings
 This settigns are common for all the language plugins.
diff --git a/fixtures/javascript-sample.js b/fixtures/javascript-sample.js
@@ -0,0 +1,4 @@
+function f1() {
+  // TODO: FIXME here
+  return 18;
+}
diff --git a/fixtures/sample.html b/fixtures/sample.html
@@ -0,0 +1,3 @@
+<body>
+  <!-- TODO: complete this document -->
+</body>
diff --git a/fixtures/sample.java b/fixtures/sample.java
@@ -0,0 +1,6 @@
+class HelloWorld {
+    // TODO: flag this comment
+    public static void main(String[] args) {
+        System.out.println("Hello, World!");
+    }
+}
diff --git a/fixtures/sample.php b/fixtures/sample.php
@@ -0,0 +1,4 @@
+<?php
+echo "Hello, World!";
+// TODO: something more elaborate
+?>
diff --git a/fixtures/sample.py b/fixtures/sample.py
@@ -0,0 +1,4 @@
+
+# TODO: why not do this todo now?
+if true or false:
+    break
diff --git a/fixtures/sample.ts b/fixtures/sample.ts
@@ -0,0 +1,4 @@
+function f1() {
+  // TODO: FIXME here
+  return 18;
+}
diff --git a/fixtures/sample.xml b/fixtures/sample.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <!-- TODO: this comment then -->
+  <message>Hello, World!</message>
+</root>
diff --git a/languages/html/lsp-sonarlint-html.el b/languages/html/lsp-sonarlint-html.el
@@ -28,16 +28,16 @@
 (defgroup lsp-sonarlint-html nil
   "lsp-sonarlint html analyzer group"
   :group 'lsp-sonarlint
-  :version '(lsp-sonarlint-html . "3.2.0"))
+  :version '(lsp-sonarlint-html . "3.7.1"))
 
 (defcustom lsp-sonarlint-html-enabled nil
   "Enable lsp-sonarlint-html plugin."
   :group 'lsp-sonarlint-html
   :type 'boolean)
 
 (defcustom lsp-sonarlint-html-download-url
-  "https://binaries.sonarsource.com/Distribution/sonar-html-plugin/sonar-html-plugin-3.2.0.2082.jar"
-  "Html plugin download URL."
+  "https://repo.maven.apache.org/maven2/org/sonarsource/html/sonar-html-plugin/3.7.1.3306/sonar-html-plugin-3.7.1.3306.jar"
+  "HTML plugin download URL."
   :group 'lsp-sonarlint-html
   :type 'string)
 
diff --git a/languages/java/lsp-sonarlint-java.el b/languages/java/lsp-sonarlint-java.el
@@ -28,15 +28,15 @@
 (defgroup lsp-sonarlint-java nil
   "lsp-sonarlint java analyzer group"
   :group 'lsp-sonarlint
-  :version '(lsp-sonarlint-java . "6.4.0"))
+  :version '(lsp-sonarlint-java . "7.18.0"))
 
 (defcustom lsp-sonarlint-java-enabled nil
   "Enable lsp-sonarlint-java plugin."
   :group 'lsp-sonarlint-java
   :type 'boolean)
 
 (defcustom lsp-sonarlint-java-download-url
-  "https://binaries.sonarsource.com/Distribution/sonar-java-plugin/sonar-java-plugin-6.4.0.21967.jar"
+  "https://repo.maven.apache.org/maven2/org/sonarsource/java/sonar-java-plugin/7.18.0.31443/sonar-java-plugin-7.18.0.31443.jar"
   "Java plugin download URL."
   :group 'lsp-sonarlint-java
   :type 'string)
diff --git a/languages/javascript/lsp-sonarlint-javascript.el b/languages/javascript/lsp-sonarlint-javascript.el
@@ -28,15 +28,15 @@
 (defgroup lsp-sonarlint-javascript nil
   "lsp-sonarlint javascript analyzer group"
   :group 'lsp-sonarlint
-  :version '(lsp-sonarlint-javascript . "8.2.0"))
+  :version '(lsp-sonarlint-javascript . "10.1.0"))
 
 (defcustom lsp-sonarlint-javascript-enabled nil
   "Enable lsp-sonarlint-javascript plugin."
   :group 'lsp-sonarlint-javascript
   :type 'boolean)
 
 (defcustom lsp-sonarlint-javascript-download-url
-  "https://binaries.sonarsource.com/Distribution/sonar-javascript-plugin/sonar-javascript-plugin-8.2.0.16042.jar"
+  "https://repo.maven.apache.org/maven2/org/sonarsource/javascript/sonar-javascript-plugin/10.1.0.21143/sonar-javascript-plugin-10.1.0.21143.jar"
   "Javascript plugin download URL."
   :group 'lsp-sonarlint-javascript
   :type 'string)
diff --git a/languages/php/lsp-sonarlint-php.el b/languages/php/lsp-sonarlint-php.el
@@ -28,15 +28,15 @@
 (defgroup lsp-sonarlint-php nil
   "lsp-sonarlint php analyzer group"
   :group 'lsp-sonarlint
-  :version '(lsp-sonarlint-php . "3.5.0"))
+  :version '(lsp-sonarlint-php . "3.28.0"))
 
 (defcustom lsp-sonarlint-php-enabled nil
   "Enable lsp-sonarlint-php plugin."
   :group 'lsp-sonarlint-php
   :type 'boolean)
 
 (defcustom lsp-sonarlint-php-download-url
-  "https://binaries.sonarsource.com/Distribution/sonar-php-plugin/sonar-php-plugin-3.5.0.5655.jar"
+  "https://repo.maven.apache.org/maven2/org/sonarsource/php/sonar-php-plugin/3.28.0.9490/sonar-php-plugin-3.28.0.9490.jar"
   "Php plugin download URL."
   :group 'lsp-sonarlint-php
   :type 'string)
diff --git a/languages/python/lsp-sonarlint-python.el b/languages/python/lsp-sonarlint-python.el
@@ -28,15 +28,15 @@
 (defgroup lsp-sonarlint-python nil
   "lsp-sonarlint python analyzer group"
   :group 'lsp-sonarlint
-  :version '(lsp-sonarlint-python . "2.9.0"))
+  :version '(lsp-sonarlint-python . "4.2.0"))
 
 (defcustom lsp-sonarlint-python-enabled nil
   "Enable lsp-sonarlint-python plugin."
   :group 'lsp-sonarlint-python
   :type 'boolean)
 
 (defcustom lsp-sonarlint-python-download-url
-  "https://binaries.sonarsource.com/Distribution/sonar-python-plugin/sonar-python-plugin-2.9.0.6410.jar"
+  "https://repo.maven.apache.org/maven2/org/sonarsource/python/sonar-python-plugin/4.2.0.11487/sonar-python-plugin-4.2.0.11487.jar"
   "Python plugin download URL."
   :group 'lsp-sonarlint-python
   :type 'string)
diff --git a/languages/typescript/lsp-sonarlint-typescript.el b/languages/typescript/lsp-sonarlint-typescript.el
@@ -28,23 +28,23 @@
 (defgroup lsp-sonarlint-typescript nil
   "lsp-sonarlint typescript analyzer group"
   :group 'lsp-sonarlint
-  :version '(lsp-sonarlint-typescript . "8.2.0"))
+  :version '(lsp-sonarlint-typescript . "10.1.0"))
 
 (defcustom lsp-sonarlint-typescript-enabled nil
   "Enable lsp-sonarlint-typescript plugin."
   :group 'lsp-sonarlint-typescript
   :type 'boolean)
 
 (defcustom lsp-sonarlint-typescript-download-url
-  "https://binaries.sonarsource.com/Distribution/sonar-javascript-plugin/sonar-javascript-plugin-8.2.0.16042.jar"
+  "https://repo.maven.apache.org/maven2/org/sonarsource/javascript/sonar-javascript-plugin/10.1.0.21143/sonar-javascript-plugin-10.1.0.21143.jar"
   "Typescript plugin download URL."
   :group 'lsp-sonarlint-typescript
   :type 'string)
 
 (defcustom lsp-sonarlint-typescript-analyzer-path
 (concat
    (file-name-directory load-file-name)
-   "sonar-typescript.jar")
+   "sonar-javascript.jar") ;; Note: it is the same as for javascript, and that is intentional
   "Lsp-sonarlint typescript analyzer location."
   :group 'lsp-sonarlint-typescript
   :type 'file)
diff --git a/languages/xml/lsp-sonarlint-xml.el b/languages/xml/lsp-sonarlint-xml.el
@@ -28,15 +28,15 @@
 (defgroup lsp-sonarlint-xml nil
   "lsp-sonarlint xml analyzer group"
   :group 'lsp-sonarlint
-  :version '(lsp-sonarlint-xml . "2.0.1"))
+  :version '(lsp-sonarlint-xml . "2.7.0"))
 
 (defcustom lsp-sonarlint-xml-enabled nil
   "Enable lsp-sonarlint-xml plugin."
   :group 'lsp-sonarlint-xml
   :type 'boolean)
 
 (defcustom lsp-sonarlint-xml-download-url
-  "https://binaries.sonarsource.com/Distribution/sonar-xml-plugin/sonar-xml-plugin-2.0.1.2020.jar"
+  "https://repo.maven.apache.org/maven2/org/sonarsource/xml/sonar-xml-plugin/2.7.0.3820/sonar-xml-plugin-2.7.0.3820.jar"
   "Xml plugin download URL."
   :group 'lsp-sonarlint-xml
   :type 'string)
diff --git a/lsp-sonarlint.el b/lsp-sonarlint.el
@@ -82,93 +82,155 @@ Example: `{**/test/**,**/*test*,**/*Test*}`"
   :group 'lsp-sonarlint
   :type 'string)
 
-(defcustom lsp-sonarlint-sonarqube-server-url ""
-  "URL of the server.
-e.g https://<myServerUrl>"
-  :group 'lsp-sonarlint
-  :type 'string)
-
 (defcustom lsp-sonarlint-show-analyzer-logs nil
   "Show analyzer's logs in the SonarLint output."
   :group 'lsp-sonarlint
   :type 'boolean)
 
+(defcustom lsp-sonarlint-verbose-logs nil
+  "Enable verbose logging of the SonarLint language server."
+  :group 'lsp-sonarlint
+  :type 'boolean)
+
 (defcustom lsp-sonarlint-vmargs ""
   "Extra JVM arguments used to launch the SonarLint LSP.
 e.g. `-Xmx1024m`."
   :group 'lsp-sonarlint
   :type 'string)
 
 (defcustom lsp-sonarlint-server-download-url
-  "https://binaries.sonarsource.com/Distribution/sonarlint-language-server/sonarlint-language-server-4.6.0.2652.jar"
-  "Sonarlint Language Server jar file download URL."
+  "https://repox.jfrog.io/repox/sonarsource/org/sonarsource/sonarlint/ls/sonarlint-language-server/2.19.0.72769/sonarlint-language-server-2.19.0.72769.jar"
+  "SonarLint Language Server jar file download URL."
   :group 'lsp-sonarlint
   :type 'string)
 
+(defcustom lsp-sonarlint-plugin-autodownload nil
+  "Whether to go ahead and download missing plugins not asking for a confirmation.
+Useful for batch testing."
+  :group 'lsp-sonarlint
+  :type 'boolean)
+
 (let ((languages-directory-path (concat (file-name-directory load-file-name) "languages")))
   (if (file-directory-p languages-directory-path)
       (add-to-list 'load-path languages-directory-path)
-    (error "There were and error with the `load-file-name` function")))
+    (error "There was an error with the `load-file-name` function")))
+
+(defun lsp-sonarlint--remove-duplicate-plugins (jars)
+  "Return copy of JARS with duplicates removed.
+The duplicates may occur if the same plugin implements different languages,
+for example sonar-javascript.jar covers both JavaScript and TypeScript.
+If a duplicate occurs, SonarLint will throw an exception."
+  (cl-remove-duplicates jars :test #'equal :key (lambda (jar-path) (file-name-base jar-path))))
 
 (defun lsp-sonarlint--plugin-list ()
   "Check for the enabled extensions and return a path list.
-If the analyzer path is not a file, it ask for download the
-analyzer"
+If the analyzer path is not a file, and
+lsp-sonarlint-plugin-autodownload is not nil it offers to
+download the analyzer, and does that."
   (let* ((lsp-sonarlint--enabled-plugins
 	  (-filter (lambda (member)
 		     (when (eval
 			    (intern (concat (format "%s" (car member) ) "-enabled")))
 		       t))
 		   (custom-group-members 'lsp-sonarlint t))))
 
-    (-map (lambda (enabled-member)
-	    (let* ((enabled-member--download-url
-		    (eval (intern (concat (format "%s" (car enabled-member) ) "-download-url"))))
-		   (enabled-member--analyzer-path
-		    (eval (intern (concat (format "%s" (car enabled-member) ) "-analyzer-path")))))
-	      (unless (file-exists-p
-		       enabled-member--analyzer-path)
-		(when (yes-or-no-p "lsp-sonarlint language plugin not found, do you want to download it? ")
-		  (url-copy-file enabled-member--download-url enabled-member--analyzer-path)))
-	      (concat "file://"  enabled-member--analyzer-path " ")))
-	  lsp-sonarlint--enabled-plugins)))
-
-(defun lsp-sonarlint--code-action-open-rule (rule)
-  "Create an HTML rendered buffer with the RULE text in it."
+    (lsp-sonarlint--remove-duplicate-plugins
+     (-map (lambda (enabled-member)
+             (let* ((enabled-member--download-url
+                     (eval (intern (concat (format "%s" (car enabled-member) ) "-download-url"))))
+                    (enabled-member--analyzer-path
+                     (eval (intern (concat (format "%s" (car enabled-member) ) "-analyzer-path")))))
+               (unless (file-exists-p
+                        enabled-member--analyzer-path)
+                 (when (or lsp-sonarlint-plugin-autodownload
+                           (yes-or-no-p
+                            (format "%s language plugin not found, do you want to download it? "
+                                    (car enabled-member))))
+                   (url-copy-file enabled-member--download-url enabled-member--analyzer-path)))
+               enabled-member--analyzer-path))
+           lsp-sonarlint--enabled-plugins))))
+
+(defun lsp-sonarlint--code-action-open-rule (_workspace params)
+  "Create a buffer with rendered rule from PARAMS text in it.
+Extracts the title ahd htmlDescription, and renders the HTML in a
+temporary buffer."
   (with-temp-buffer
-    (let* ((rule-title (format "%s" (aref (ht-get rule "arguments") 1)))
-	   (rule-formated-title (replace-regexp-in-string ">" " "
-							  (replace-regexp-in-string "<"  " "  rule-title)))
-	   (rule-body (aref  (ht-get rule "arguments" ) 2)))
-      (insert rule-formated-title)
+    (let* ((rule-title (format "<h1>%s</h1><hr/>" (ht-get params "name")))
+           (rule-body (ht-get params "htmlDescription")))
+      (insert rule-title)
        (insert "\n")
        (insert rule-body))
     (shr-render-buffer (current-buffer))))
 
 
 (defun lsp-sonarlint-server-start-fun (port)
-  "Lsp-sonarlint start function, it need PORT as parameter."
+  "Start lsp-sonarlint in TCP mode listening to port PORT."
   (-concat
-   `("java" "-jar" ,(eval  lsp-sonarlint-server-path )  ,(number-to-string port))
-   (lsp-sonarlint--plugin-list)))
-
+   `("java" "-jar" ,(eval  lsp-sonarlint-server-path)  ,(format "-port=%d" port))
+   (mapcar (lambda (plugin-path) (format "-analyzers=%s" plugin-path))
+           (lsp-sonarlint--plugin-list))))
 
-(defconst lsp-sonarlint--action-handlers
-  '(("SonarLint.OpenRuleDesc" .
-     (lambda (rule) (lsp-sonarlint--code-action-open-rule rule)))))
 
+(defconst lsp-sonarlint--action-handlers '())
 
 (lsp-register-custom-settings
  '(("sonarlint.disableTelemetry" lsp-sonarlint-disable-telemetry)
    ("sonarlint.testFilePattern" lsp-sonarlint-test-file-pattern)
    ("sonarlint.output.showAnalyzerLogs" lsp-sonarlint-show-analyzer-logs)
+   ("sonarlint.output.verboseLogs" lsp-sonarlint-verbose-logs)
    ("sonarlint.ls.vmargs" lsp-sonarlint-vmargs)))
 
+(defun lsp-sonarlint--request-handlers ()
+  "SonarLint-specific request handlers.
+See REQUEST-HANDLERS in lsp--client in lsp-mode."
+  (let ((ht (make-hash-table :test 'equal)))
+    ;; Check whether the file is just being previewed or is actually open in an editor
+    ;; to save some wasted work.
+    ;; I guess it is safe to assume, when lsp-mode sends a file over to the server,
+    ;; it is because it is open in editor.
+    (puthash "sonarlint/isOpenInEditor" (lambda (_workspace _params) t) ht)
+    ;; Check if the file is ignored by Source Control Manager (a.k.e. VCS, version control system).
+    ;; I think this is related to .gitignore and similar files.
+    ;; Probably safe to assume as a first step that you don't care, and want your diagnostics.
+    ;; TODO: implement a proper check here.
+    (puthash "sonarlint/isIgnoredByScm" (lambda (_workspace _params) nil) ht)
+    ;; Get the VCS branch name. Let it be nil for now
+    ;; TODO: implement a proper response
+    (puthash "sonarlint/getBranchNameForFolder" (lambda (_workspace _params) nil) ht)
+    ;; Probably only relevant to the java analyzer.
+    ;; Some additional java configuration for the project.
+    ;; TODO: implement
+    (puthash "sonarlint/getJavaConfig" (lambda (_workspace _params) nil) ht)
+    ht))
+
+(defun lsp-sonarlint--notification-handlers ()
+  "SonarLint-specific notification handlers.
+See NOTIFICATION-HANDLERS in lsp--client in lsp-mode."
+  (let ((ht (make-hash-table :test 'equal)))
+    ;; Security Hotspots are a special kind of issue that have particular
+    ;; interface on SonarCloud, SonarQube, and in SonarLint. See
+    ;; https://docs.sonarcloud.io/digging-deeper/security-hotspots/ I presume
+    ;; the PARAMS contain a list of issues of this category, similar to the
+    ;; normal issues.
+    ;; TODO: display them, perhaps optionally, as they could be noisy sometimes,
+    ;; especially without the possibility to "review" them once and forever.
+    (puthash "sonarlint/publishSecurityHotspots" (lambda (_workspace _params) nil) ht)
+    ;; Not sure what this is for. Testing of SonarLint itself?
+    (puthash "sonarlint/readyForTests" (lambda (_workspace _params) nil) ht)
+    ;; This is probably just to raise awareness of the new kind of issues:
+    ;; secrets. That'd be too booring to implement. Hopefully, the user is
+    ;; paying attention and will notice anyway.
+    (puthash "sonarlint/showNotificationForFirstSecretsIssue" (lambda (_workspace _params) nil) ht)
+    (puthash "sonarlint/showRuleDescription" #'lsp-sonarlint--code-action-open-rule ht)
+    ht))
+
 (lsp-register-client
  (make-lsp-client
   :new-connection (lsp-tcp-server-command 'lsp-sonarlint-server-start-fun)
   :major-modes lsp-sonarlint-modes-enabled
   :priority -1
+  :request-handlers (lsp-sonarlint--request-handlers)
+  :notification-handlers (lsp-sonarlint--notification-handlers)
   :multi-root t
   :add-on? t
   :server-id 'sonarlint
diff --git a/server/sonarlint-language-server.jar b/server/sonarlint-language-server.jar
diff --git a/test/lsp-sonarlint-integration-test.el b/test/lsp-sonarlint-integration-test.el

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<body>`
	`2`	`+ <!-- TODO: complete this document -->`
	`3`	`+</body>`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +<?php
 +echo "Hello, World!";
 +// TODO: something more elaborate
 +?>