sonar-scan 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ionut88
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+sonar-scan
+==================
+
+Wrap [SonarQube Scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) as a node module.
+
+# Installation
+
+This plugin requires JAVA runtime installed
+
+You can install sonar-scan as a development dependency and add it as a script property in your package.json.
+
+```shell
+npm i sonar-scan --save-dev
+```     
+
+```json
+{
+  "scripts": {
+    "sonar-scan": "node_modules/sonar-scan/bin/sonar-scanner"
+  }
+}
+```
+
+```shell
+npm run sonar-scan
+```     
+# Forked from
+
+https://github.com/bcaudan/node-sonar-scanner
+
+This library is not updated currentlly for a few years but we need & support it

package/bin/sonar-scanner

@@ -0,0 +1,67 @@
+#!/bin/sh
+#
+# SonarQube Scanner Startup Script for Unix
+#
+# Optional ENV vars:
+#   SONAR_SCANNER_OPTS - Parameters passed to the Java VM when running the SonarQube Scanner
+#   SONAR_SCANNER_DEBUG_OPTS - Extra parameters passed to the Java VM for debugging
+#   JAVA_HOME - Location of Java's installation
+
+real_path () {
+  target=$1
+
+  (
+  while true; do
+    cd "$(dirname "$target")"
+    target=$(basename "$target")
+    test -L "$target" || break
+    target=$(readlink "$target")
+  done
+
+  echo "$(pwd -P)/$target"
+  )
+}
+
+script_path=$(real_path "$0")
+sonar_scanner_home=$(dirname "$script_path")/..
+
+# make it fully qualified
+sonar_scanner_home=$(cd "$sonar_scanner_home" && pwd -P)
+
+jar_file=$sonar_scanner_home/lib/sonar-scanner-cli-3.1.0.1141.jar
+
+# check that sonar_scanner_home has been correctly set
+if [ ! -f "$jar_file" ] ; then
+  echo "File does not exist: $jar_file"
+  echo "'$sonar_scanner_home' does not point to a valid installation directory: $sonar_scanner_home"
+  exit 1
+fi
+
+use_embedded_jre=false
+if [ "$use_embedded_jre" = true ]; then
+  export JAVA_HOME=$sonar_scanner_home/jre
+fi
+
+if [ -n "$JAVA_HOME" ]
+then
+  java_cmd="$JAVA_HOME/bin/java"
+else
+  java_cmd="$(which java)"
+fi
+
+project_home=$(pwd)
+
+#echo "Info: Using sonar-scanner at $sonar_scanner_home"
+#echo "Info: Using java at $java_cmd"
+#echo "Info: Using classpath $jar_file"
+#echo "Info: Using project $project_home"
+
+exec "$java_cmd" \
+  -Djava.awt.headless=true \
+  $SONAR_SCANNER_OPTS \
+  $SONAR_SCANNER_DEBUG_OPTS \
+  -classpath  "$jar_file" \
+  -Dscanner.home="$sonar_scanner_home" \
+  -Dproject.home="$project_home" \
+  org.sonarsource.scanner.cli.Main "$@"
+

package/bin/sonar-scanner-debug

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+# SonarQube Scanner Startup Script for Unix
+#
+# Optional ENV vars:
+#   SONAR_SCANNER_OPTS - parameters passed to the Java VM when running the SonarQube Scanner
+#   JAVA_HOME - Location of Java's installation
+
+SONAR_SCANNER_DEBUG_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000"
+
+echo "Executing SonarQube Scanner in Debug Mode"
+echo "SONAR_SCANNER_DEBUG_OPTS=\"-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000\""
+
+env SONAR_SCANNER_OPTS="$SONAR_SCANNER_OPTS" SONAR_SCANNER_DEBUG_OPTS="$SONAR_SCANNER_DEBUG_OPTS" "$(dirname "$0")"/sonar-scanner "$@"

package/bin/sonar-scanner-debug.bat

@@ -0,0 +1,13 @@
+@REM SonarQube Scanner Startup Script for Windows
+@REM
+@REM Required ENV vars:
+@REM   JAVA_HOME - location of a JDK home dir
+@REM
+@REM Optional ENV vars:
+@REM   SONAR_SCANNER_OPTS - parameters passed to the Java VM when running the SonarQube Scanner
+
+@setlocal
+@set SONAR_SCANNER_DEBUG_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
+echo "Executing SonarQube Scanner in Debug Mode"
+echo "SONAR_SCANNER_DEBUG_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000"
+@call "%~dp0"sonar-scanner.bat %*

package/bin/sonar-scanner.bat

@@ -0,0 +1,91 @@
+@REM SonarQube Scanner Startup Script for Windows
+@REM
+@REM Required ENV vars:
+@REM   JAVA_HOME - location of a JDK home dir
+@REM
+@REM Optional ENV vars:
+@REM   SONAR_SCANNER_OPTS - parameters passed to the Java VM when running the SonarQube Scanner
+
+@echo off
+
+set ERROR_CODE=0
+
+@REM set local scope for the variables with windows NT shell
+@setlocal
+
+set "scriptdir=%~dp0"
+if #%scriptdir:~-1%# == #\# set scriptdir=%scriptdir:~0,-1%
+set "SONAR_SCANNER_HOME=%scriptdir%\.."
+
+@REM ==== START VALIDATION ====
+@REM *** JAVA EXEC VALIDATION ***
+
+set use_embedded_jre=false
+if "%use_embedded_jre%" == "true" (
+  set "JAVA_HOME=%SONAR_SCANNER_HOME%\jre"
+)
+
+if not "%JAVA_HOME%" == "" goto foundJavaHome
+
+for %%i in (java.exe) do set JAVA_EXEC=%%~$PATH:i
+
+if not "%JAVA_EXEC%" == "" (
+  set JAVA_EXEC="%JAVA_EXEC%"
+  goto OkJava
+)
+
+if not "%JAVA_EXEC%" == "" goto OkJava
+
+echo.
+echo ERROR: JAVA_HOME not found in your environment, and no Java
+echo        executable present in the PATH.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation, or add "java.exe" to the PATH
+echo.
+goto error
+
+:foundJavaHome
+if EXIST "%JAVA_HOME%\bin\java.exe" goto foundJavaExeFromJavaHome
+
+echo.
+echo ERROR: JAVA_HOME exists but does not point to a valid Java home
+echo        folder. No "\bin\java.exe" file can be found there.
+echo.
+goto error
+
+:foundJavaExeFromJavaHome
+set JAVA_EXEC="%JAVA_HOME%\bin\java.exe"
+
+:OkJava
+goto run
+
+
+@REM ==== START RUN ====
+:run
+
+set PROJECT_HOME=%CD%
+
+@REM remove trailing backslash, see https://groups.google.com/d/msg/sonarqube/wi7u-CyV_tc/3u9UKRmABQAJ
+IF %PROJECT_HOME:~-1% == \ SET PROJECT_HOME=%PROJECT_HOME:~0,-1%
+
+%JAVA_EXEC% -Djava.awt.headless=true %SONAR_SCANNER_DEBUG_OPTS% %SONAR_SCANNER_OPTS% -cp "%SONAR_SCANNER_HOME%\lib\sonar-scanner-cli-3.1.0.1141.jar" "-Dscanner.home=%SONAR_SCANNER_HOME%" "-Dproject.home=%PROJECT_HOME%" org.sonarsource.scanner.cli.Main %*
+if ERRORLEVEL 1 goto error
+goto end
+
+:error
+set ERROR_CODE=1
+
+@REM ==== END EXECUTION ====
+
+:end
+@REM set local scope for the variables with windows NT shell
+@endlocal & set ERROR_CODE=%ERROR_CODE%
+
+@REM see http://code-bear.com/bearlog/2007/06/01/getting-the-exit-code-from-a-batch-file-that-is-run-from-a-python-program/
+goto exit
+
+:returncode
+exit /B %1
+
+:exit
+call :returncode %ERROR_CODE%

package/conf/sonar-scanner.properties

@@ -0,0 +1,9 @@
+#Configure here general information about the environment, such as SonarQube server connection details for example
+#No information about specific project should appear here
+
+#----- Default SonarQube server
+#sonar.host.url=http://localhost:9000
+
+#----- Default source code encoding
+#sonar.sourceEncoding=UTF-8
+

package/index.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+'use strict';
+
+var child_process = require('child_process'),
+	path = require('path');
+
+var args = process.argv.slice(2),
+	script = path.join(__dirname, 'bin', 'sonar-scanner'),
+	command;
+
+if (process.platform === 'win32') {
+	command = 'cmd.exe';
+	args = ['/c', (script + '.bat')].concat(args);
+}
+else {
+	command = script;
+}
+
+var child = child_process.spawn(command, args, {
+	stdio: 'inherit'
+});
+
+child.on('close', function(code) {
+	process.exit(code);
+});

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "sonar-scan",
+  "version": "1.0.0",
+  "description": "Wrap sonar-scan as a node module",
+  "keywords": [
+    "node",
+    "sonar",
+    "scanner"
+  ],
+  "main": "index.js",
+  "bin": {
+    "sonar-scanner": "index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "postinstall": "node postinstall.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ionut88/sonar-scan"
+  },
+  "bugs": {
+    "url": "https://github.com/ionut88/sonar-scan/issues"
+  },
+  "homepage": "https://github.com/ionut88/sonar-scan",
+  "license": "MIT"
+}

package/postinstall.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+'use strict';
+
+var child_process = require('child_process'),
+    path = require('path');
+
+if (process.platform === 'win32') {
+    process.exit(0);
+}
+
+var script = path.join(__dirname, 'bin', 'sonar-scanner'),
+    command = 'chmod',
+    args = ['+x', script];
+
+var child = child_process.spawn(command, args, {
+    stdio: 'inherit'
+});
+
+child.on('close', function(code) {
+    process.exit(code);
+});