chore: sonarqube v2 plugin

scripts/sql/33703800_sonarqube_plugin_v2.down.sql

@@ -0,0 +1,6 @@
+DELETE FROM plugin_step_variable WHERE plugin_step_id =(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version='1.2.0' and p.name='Sonarqube v1.2.0' and p.deleted=false and ps."index"=1 and ps.deleted=false);
+DELETE FROM plugin_step WHERE plugin_id = (SELECT id FROM plugin_metadata WHERE plugin_version='1.2.0' and name='Sonarqube v1.2.0' and deleted=false);
+DELETE FROM plugin_pipeline_script where id = (SELECT script_id from plugin_step WHERE plugin_id=(SELECT id FROM plugin_metadata WHERE plugin_version='1.2.0' and name='Sonarqube v1.2.0' and deleted=false));
+DELETE FROM plugin_stage_mapping WHERE plugin_id =(SELECT id FROM plugin_metadata WHERE plugin_version='1.2.0' and name='Sonarqube v1.2.0' and deleted=false);
+DELETE FROM plugin_metadata WHERE plugin_version='1.2.0' and name ='Sonarqube v1.2.0' and deleted=false;
+UPDATE plugin_metadata SET is_latest = true WHERE id = (SELECT id FROM plugin_metadata WHERE name= 'Sonarqube v1.2.0' and is_latest= false and plugin_version='1.2.0');

scripts/sql/33703800_sonarqube_plugin_v2.up.sql

@@ -0,0 +1,195 @@
+INSERT INTO "plugin_parent_metadata" ("id", "name", "identifier", "description", "type", "icon", "deleted", "created_on", "created_by", "updated_on", "updated_by")
+SELECT nextval('id_seq_plugin_parent_metadata'), 'Sonarqube v1.1.0','sonarqube-v1-1-0', 'Enhance your workflow with continuous code quality and code security using the Sonarqube plugin','PRESET','https://raw.githubusercontent.com/devtron-labs/devtron/main/assets/sonarqube-plugin-icon.png','f', 'now()', 1, 'now()', 1
+ WHERE NOT EXISTS (
+ SELECT 1
+ FROM plugin_parent_metadata
+ WHERE identifier='sonarqube-v1-1-0'
+ AND deleted = false
+);
+
+-- update the plugin_metadata with the plugin_parent_metadata_id
+UPDATE plugin_metadata
+SET plugin_parent_metadata_id = (
+ SELECT id
+ FROM plugin_parent_metadata
+ WHERE identifier='sonarqube-v1-1-0'
+ AND deleted = false
+),plugin_version='1.2.0'
+WHERE name='Sonarqube v1.1.0'
+ AND (
+ plugin_parent_metadata_id IS NULL
+ OR plugin_parent_metadata_id = 0
+ )
+ AND deleted = false;
+
+UPDATE plugin_metadata SET is_latest = false WHERE id = (SELECT id FROM plugin_metadata WHERE name= 'Sonarqube v1.1.0' and is_latest= true);
+
+INSERT INTO "plugin_metadata" ("id", "name", "description","deleted", "created_on", "created_by", "updated_on", "updated_by","plugin_parent_metadata_id","plugin_version","is_deprecated","is_latest")
+VALUES (nextval('id_seq_plugin_metadata'), 'Sonarqube v1.2.0','Enhance your workflow with continuous code quality and code security using the Sonarqube v1.2.0 plugin','f', 'now()', 1, 'now()', 1, (SELECT id FROM plugin_parent_metadata WHERE identifier='sonarqube-v1-1-0'),'1.2.0', false, true);
+
+INSERT INTO "plugin_stage_mapping" ("plugin_id","stage_type","created_on", "created_by", "updated_on", "updated_by")
+VALUES ((SELECT id FROM plugin_metadata WHERE plugin_version='1.2.0' and name='Sonarqube v1.2.0' and deleted= false),0,'now()', 1, 'now()', 1);
+
+INSERT INTO "plugin_pipeline_script" ("id", "script","type","deleted","created_on", "created_by", "updated_on", "updated_by")
+VALUES (
+ nextval('id_seq_plugin_pipeline_script'),
+ '#!/bin/sh
+
+ # Defining the variables
+ repoName=""
+ branchName=""
+ GlobalSonarqubeProjectName=""
+ GlobalSonarqubeBranchName=""
+
+ # Fetching the environment variables and converting them to lowercase
+ CheckForSonarAnalysisReport=$(echo "$CheckForSonarAnalysisReport" | tr "[:upper:]" "[:lower:]")
+ AbortPipelineOnPolicyCheckFailed=$(echo "$AbortPipelineOnPolicyCheckFailed" | tr "[:upper:]" "[:lower:]")
+ UsePropertiesFileFromProject=$(echo "$UsePropertiesFileFromProject" | tr "[:upper:]" "[:lower:]")
+ MultiBranchScanEnabled=$(echo "$MultiBranchScanEnabled" | tr "[:upper:]" "[:lower:]")
+
+ if [ -z "$SonarqubeApiKey" ]
+ then
+ echo "************* Sonarqube analysis api key has not been provided *************"
+ exit 1
+ fi
+ if [ -z "$SonarqubeEndpoint" ]
+ then
+ echo "********** Sonarqube endpoint URL has not been provided ********* "
+ exit 1
+ fi
+
+ # Function to fetch the repository and branch name from the environment variable
+ FetchRepoBranchNameFunction() {
+ CiMaterialsRequests=$GIT_MATERIAL_REQUEST
+ materials=$(echo $CiMaterialsRequests | tr "|" "\n")
+ for material in $materials
+ do
+ # echo "material : $material"
+ data=$(echo $material | tr "," "\n")
+ # echo "data: $data"
+ repo_name=$(echo "$data" | sed -n ''1p'')
+ branch_name=$(echo "$data" | sed -n ''3p'')
+ # echo Reponame: $repo_name and branchName: $branch_name
+ repoName="${repoName}-$repo_name"
+ branchName="${branchName}-$branch_name"
+ done
+ repoName="${repoName#-}"
+ branchName="${branchName#-}"
+ }
+
+ # Function to run the Sonarqube scan
+ SonarqubeScanFunction() {
+ echo -e "
+ ********** Starting the scanning ************"
+ if [[ -z "$SonarContainerImage" ]]
+ then 
+ SonarContainerImage="quay.io/devtron/sonar-scanner-cli:v1"
+ fi
+
+ docker run --rm -e SONAR_HOST_URL=$SonarqubeEndpoint -e SONAR_LOGIN=$SonarqubeApiKey -v "/$PWD:/usr/src" $SonarContainerImage
+ SonarScanStatusCode=$?
+ echo -e "
+ Status code of sonarqube scanning command : $SonarScanStatusCode"
+ if [ "$SonarScanStatusCode" -ne 0 ]; then
+ echo -e "****** Sonarqube scanning command failed to run *********"
+ exit 1
+ fi
+ if [[ $CheckForSonarAnalysisReport == true && ! -z "$CheckForSonarAnalysisReport" ]]
+ then
+ status=$(curl -u ${SonarqubeApiKey}: -sS ${SonarqubeEndpoint}/api/qualitygates/project_status?projectKey=$GlobalSonarqubeProjectName&branch=$SonarqubeBranchName)
+ project_status=$(echo $status | jq -r ".projectStatus.status")
+ export SonarqubeProjectStatus=$project_status
+ echo "********* SonarQube Policy Report *********"
+ echo $status
+ if [[ $AbortPipelineOnPolicyCheckFailed == true && $project_status == "ERROR" ]]
+ then
+ echo "********* SonarQube Policy Violated *********"
+ echo "********* Exiting Build *********"
+ exit
+ elif [[ $AbortPipelineOnPolicyCheckFailed == true && $project_status == "OK" ]]
+ then
+ echo "********* SonarQube Policy Passed *********"
+ fi
+ else
+ echo -e "
+ Finding the Vulnerabilities and High hotspots in source code ........
+ "
+ sleep 5
+ export SonarqubeVulnerabilities=$(curl -u ${SonarqubeApiKey}: --location --request GET "$SonarqubeEndpoint/api/issues/search?componentKeys=$GlobalSonarqubeProjectNamee&types=VULNERABILITY" | jq ".issues | length")
+ export SonarqubeHighHotspots=$(curl -u ${SonarqubeApiKey}: --location --request GET "$SonarqubeEndpoint/api/hotspots/search?projectKey=$GlobalSonarqubeProjectName" | jq ''.hotspots|[.[]|select(.vulnerabilityProbability=="HIGH")]|length'')
+ echo "Total Sonarqube Vulnerability: $SonarqubeVulnerabilities"
+ echo "Total High Hotspots: $SonarqubeHighHotspots"
+ export TotalSonarqubeIssues=$((SonarqubeVulnerabilities + SonarqubeHighHotspots))
+ echo "Total number of issues found by sonarqube scanner : $TotalSonarqubeIssues"
+ echo -e "For analysis report please visit $SonarqubeEndpoint/dashboard?id=$GlobalSonarqubeProjectName"
+ fi
+ }
+
+ # Checkout path for sonar-project.properties file
+ PathToCodeDir=/devtroncd$CheckoutPath
+ cd $PathToCodeDir
+
+ FetchRepoBranchNameFunction
+ if [ -z $SonarqubeProjectPrefixName ]
+ then
+ SonarqubeProjectPrefixName=$repoName
+ fi
+ if [ -z $SonarqubeBranchName ]
+ then
+ SonarqubeBranchName=$branchName
+ fi
+
+ if [ -z $SonarqubeProjectKey ]
+ then
+ GlobalSonarqubeProjectName=$SonarqubeProjectPrefixName-$SonarqubeBranchName
+ else
+ GlobalSonarqubeProjectName=$SonarqubeProjectKey
+ fi
+
+ if [ -z $SonarqubeBranchName ]
+ then
+ GlobalSonarqubeBranchName=master
+ else
+ GlobalSonarqubeBranchName=$SonarqubeBranchName
+ fi
+
+ if [[ -z "$UsePropertiesFileFromProject" || $UsePropertiesFileFromProject == false ]]
+ then
+ echo "sonar.projectKey=$GlobalSonarqubeProjectName" > sonar-project.properties
+ if [ $MultiBranchScanEnabled == true ]
+ then
+ echo "sonar.branch.name=$GlobalSonarqubeBranchName" >> sonar-project.properties
+ fi
+ fi
+
+ SonarqubeScanFunction',
+ 'SHELL',
+ 'f',
+ 'now()',
+ 1,
+ 'now()',
+ 1
+);
+INSERT INTO "plugin_step" ("id", "plugin_id","name","description","index","step_type","script_id","deleted", "created_on", "created_by", "updated_on", "updated_by") VALUES (nextval('id_seq_plugin_step'), (SELECT id FROM plugin_metadata WHERE plugin_version='1.2.0' and name='Sonarqube v1.2.0' and deleted= false),'Step 1','Step 1 - Sonarqube v1.2.0','1','INLINE',(SELECT last_value FROM id_seq_plugin_pipeline_script),'f','now()', 1, 'now()', 1);
+
+INSERT INTO plugin_step_variable (id,plugin_step_id,name,format,description,is_exposed,allow_empty_value,default_value,value,variable_type,value_type,previous_step_index,variable_step_index,variable_step_index_in_plugin,reference_variable_name,deleted,created_on,created_by,updated_on,updated_by) 
+VALUES (nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarqubeProjectPrefixName','STRING','This is the SonarQube project prefix name. If not provided, the prefix name is automatically generated.','t','t',null,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarqubeBranchName','STRING','Branch name to be used to send the scanned result on sonarqube project','t','t',null,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarqubeProjectKey','STRING','Project key of sonarqube account','t','t',null,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'CheckForSonarAnalysisReport','BOOL','Boolean value - true or false. Set true to poll for generated report from sonarqube.','t','t',null,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'AbortPipelineOnPolicyCheckFailed','BOOL','Boolean value - true or false. Set true to abort on report check failed','t','t',null,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'UsePropertiesFileFromProject','BOOL','Boolean value - true or false. Set true to use source code sonar-properties file.','t','f',false,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarqubeEndpoint','STRING','Sonrqube endpoint URL','t','f',null,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'CheckoutPath','STRING','Checkout path of git material','t','t',null,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarqubeApiKey','STRING','api key of sonarqube account','t','f',null,null,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'TotalSonarqubeIssues','STRING','Total issues in the scanned code result from the sum of vulnerabilities and high hotspots','t','f',false,null,'OUTPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarqubeHighHotspots','STRING','Total number of SonarQube hotspots (HIGH) in the source code','t','f',false,null,'OUTPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarqubeProjectStatus','STRING','Quality gate status of Sonarqube Project ,it may be "ERROR","OK" ,"NONE"','t','f',false,null,'OUTPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarqubeVulnerabilities','STRING','Total number of SonarQube vulnerabilities in the source code','t','f',false,null,'OUTPUT','NEW',null,1,null,null,'f','now()',1,'now()',1);
+
+INSERT INTO plugin_step_variable ("id", "plugin_step_id", "name", "format", "description", "is_exposed", "allow_empty_value","value","variable_type", "value_type", "variable_step_index",reference_variable_name, "deleted", "created_on", "created_by", "updated_on", "updated_by") VALUES
+(nextval('id_seq_plugin_step_variable'), (SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false), 'GIT_MATERIAL_REQUEST','STRING','git material data',false,true,3,'INPUT','GLOBAL',1 ,'GIT_MATERIAL_REQUEST','f','now()', 1, 'now()', 1);
+
+INSERT INTO plugin_step_variable (id,plugin_step_id,name,format,description,is_exposed,allow_empty_value,default_value,variable_type,value_type,previous_step_index,variable_step_index,variable_step_index_in_plugin,reference_variable_name,deleted,created_on,created_by,updated_on,updated_by) 
+VALUES(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'SonarContainerImage','STRING','Container Image that will be used for sonar scanning purpose.','t','t','quay.io/devtron/sonar-scanner-cli:v1','INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1),
+(nextval('id_seq_plugin_step_variable'),(SELECT ps.id FROM plugin_metadata p inner JOIN plugin_step ps on ps.plugin_id=p.id WHERE p.plugin_version = '1.2.0' and p.name='Sonarqube v1.2.0' and ps."index"=1 and ps.deleted=false),'MultiBranchScanEnabled','BOOL','SonarQube supports multi branch analysis?','t','t',false,'INPUT','NEW',null,1,null,null,'f','now()',1,'now()',1);