SonarQube Exclude a directory

Question

I am trying to exclude a directory from being analyzed by Sonar  I have the following properties defined in my sonar-project properties file   sonar sources src java sonar exclusions src java test        java   The directory structure I have is   src java dig src java test dig   When I run the sonar-runner I get the following info    INFO  - Excluded sources   INFO  -   src java test      java  INFO  - Excluded tests   INFO  -      package-info java   But when I check the result of the analysis all the packages inside the test directory are still there   I just need to tell Sonar to not analyze the test directory and any packages inside it

User · Answer

Add comma separated folder paths sonar exclusions    abc       def     This worked in an angular project

User · Answer

You can do the same with build gradle  sonarqube   properties       property  sonar exclusions       src java test      java          And if you want to exclude more files directories then   sonarqube   properties       property  sonar exclusions       src java test      java     src java main      java

User · Answer

If you re an Azure DevOps user looking for both where and how to exclude files and folders  here ya go    Edit your pipeline Make sure you have the  Prepare analysis on SonarQube  task added  You ll need to look elsewhere if you need help configuring this  Suggestion  Use the UI pipeline editor vs the yaml editor if you are missing the manage link  At present  there is no way to convert to UI from yaml  Just recreate the pipeline  If using git  you can delete the yaml from the root of your repo  Under the  Advanced  section of the  Prepare analysis on SonarQube  task  you can add exclusions  See advice given by others for specific exclusion formats    Example     Additional properties that will be passed to the scanner     Put one key value per line  example    sonar exclusions      bin sonar exclusions MyProjectName MyWebContentFolder      Note  If you re not sure on the path  you can go into sonarqube  view your project  look at all or new  Code Smells  and the path you need is listed above each grouping of issues  You can grab the full path to a file or use wilds like these examples    MyProjectName MyCodeFile cs MyProjectName      If you don t have the  Run Code Analysis  task added  do that and place it somewhere after the  Build solution      sln   task   Save and Queue and then check out your sonarqube server to see if the exclusions worked

User · Answer

If we want to skip the entire folder following can be used   sonar exclusions folderName        And if we have only one particular file just give the complete path   All the folder which needs to be exclude and be appended here

User · Answer

what version of sonar are you using  There is one option called  sonar skippedModules yourmodulename    This will skip the whole module  So be aware of it

User · Answer

Just to mention that once you excluded the files from Sonar  do the same for Jacoco plugin    lt configuration gt   lt excludes gt        lt exclude gt com acme model persistence entity TransactionEntity  lt  exclude gt   lt exclude gt com acme model persistence ModelConstants class lt  exclude gt   lt  excludes gt   lt  configuration gt

User · Answer

add this line to your sonar-project properties file  ex  sonar exclusions src   java be careful if you want to exclude a folder and inside the folder there is a file you must first exclude the files or add the files one by one  for example imagine there is a folder like below   src app java src controllers home java src services test java  you have to do this  sonar exclusions src app java src controllers   java src services   java  It worked for me

User · Answer

Another configuration option is adding a maven properties sonar exclusions   Below is a sample pom file with exclusions of static jquery directory and static pdf viewer directory    lt project  gt   lt modelVersion gt 4 0 0 lt  modelVersion gt   lt artifactId gt my Artifact lt  artifactId gt   lt  -- Enviroment variables can be referenced as such    env PATH  -- gt   lt packaging gt war lt  packaging gt   lt url gt http   maven apache org lt  url gt    lt properties gt        lt junit version gt 4 9 lt  junit version gt       lt mockito version gt 1 9 5 lt  mockito version gt       lt jackson version gt 1 9 7 lt  jackson version gt       lt powermock version gt 1 5 lt  powermock version gt        lt  --Exclude the files Here-- gt       lt sonar exclusions gt src main webapp static jquery ui   src main webapp static pdf-viewer   src main webapp static pdf-viewer    src main webapp static pdf-viewer      lt  sonar exclusions gt   lt  properties gt

User · Answer

This will work for your case   sonar exclusions    src java dig          src java test dig

User · Answer

This worked for me   sonar exclusions src    wwwroot      js src    wwwroot      css   It excludes any  js and  css files under any of the sub directories of a folder  wwwroot  appearing as one of the sub directories of the  src  folder  project root

User · Answer

Easiest way is to go to the server URL after starting the server localhost 8080  then login as admin Go to settings Exclusions  Source File Exclusions- Add your packages here  Restart the server

User · Answer

I m able to exclude multiple directories using the below config  comma separated folder paths   sonar exclusions system     test     application third party     application logs     And while running the sonar runner I got the following in the log  Excluded sources     system      test      application third party      application logs

User · Answer

Try something like this   sonar exclusions src java test

[sonarqube] SonarQube Exclude a directory

Examples related to sonarqube

Examples related to sonar-runner