sonar-project.properties

   1 # This file is used to scan the project for issues automatically
   2 # Browse the result here: https://sonarcloud.io/dashboard/?id=simgrid
   3
   4 sonar.projectKey=simgrid
   5 sonar.projectName=SimGrid
   6 sonar.projectVersion=3.21.90
   7
   8 sonar.links.homepage=https://simgrid.org
   9 sonar.links.issue=https://framagit.org/simgrid/simgrid/issues
  10 sonar.links.scm=https://framagit.org/simgrid/simgrid/
  11 # Comma-separated paths to directories with sources (required)
  12 sonar.sources=src,examples,include,teshsuite
  13
  14
  15 # Disable some rules on some files
  16 sonar.issue.ignore.multicriteria=j1,j2,j3,jni1,jni2,c1,c2a,c2b,c3,c4a,c4b,c5a,c5b,c6a,c6b,c7,c8,c9,f1
  17
  18 # The Object.finalize() method should not be overriden
  19 # But we need to clean the native memory with JNI
  20 sonar.issue.ignore.multicriteria.j1.ruleKey=squid:ObjectFinalizeOverridenCheck
  21 sonar.issue.ignore.multicriteria.j1.resourceKey=**/*.java
  22
  23 # Throwable.printStackTrace(...) should not be called
  24 # But we don't have no better mechanism, and our Java apps are not rocket science
  25 sonar.issue.ignore.multicriteria.j2.ruleKey=squid:S1148
  26 sonar.issue.ignore.multicriteria.j2.resourceKey=**/*.java
  27
  28 # Using command line arguments is security-sensitive
  29 # But the authors of the applications using our library will be their only users, so there is no security concern
  30 sonar.issue.ignore.multicriteria.j3.ruleKey=squid:S4823
  31 sonar.issue.ignore.multicriteria.j3.resourceKey=**/*.java
  32
  33 # "reinterpret_cast" should not be used
  34 # But this is exactly intended to store a pointer into a long -- what we do here
  35 sonar.issue.ignore.multicriteria.jni1.ruleKey=cpp:S3630
  36 sonar.issue.ignore.multicriteria.jni1.resourceKey=src/bindings/java/*.cpp
  37
  38 # Unused function parameters should be removed
  39 # But JNI mandates these parameters
  40 sonar.issue.ignore.multicriteria.jni2.ruleKey=cpp:S1172
  41 sonar.issue.ignore.multicriteria.jni2.resourceKey=src/bindings/java/*.cpp
  42
  43
  44 # Pointers should not be cast to integral types
  45 # But we need that for jMSG, smpi and other places
  46 sonar.issue.ignore.multicriteria.c1.ruleKey=cpp:S1767
  47 sonar.issue.ignore.multicriteria.c1.resourceKey=**/*.cpp
  48
  49 # Preprocessor operators "#" and "##" should not be used
  50 # This poses portability issues, but we test on a large panel of architectures on purpose
  51 # Until after Augustin goes to rehab, we cannot remove them all
  52 sonar.issue.ignore.multicriteria.c2a.ruleKey=c:PPStringifyAndPastingUsage
  53 sonar.issue.ignore.multicriteria.c2a.resourceKey=**/*
  54 sonar.issue.ignore.multicriteria.c2b.ruleKey=cpp:PPStringifyAndPastingUsage
  55 sonar.issue.ignore.multicriteria.c2b.resourceKey=**/*
  56
  57 # Macro names should comply with a naming convention
  58 # But the macros in this file are named after the MPI standard
  59 sonar.issue.ignore.multicriteria.c3.ruleKey=c:PPMacroName
  60 sonar.issue.ignore.multicriteria.c3.resourceKey=include/smpi/smpi_extended_traces.h
  61
  62 # Declarations should be placed in a namespace
  63 # But examples are intended to remain small and simple
  64 sonar.issue.ignore.multicriteria.c4a.ruleKey=cpp:GlobalNamespaceMembers
  65 sonar.issue.ignore.multicriteria.c4a.resourceKey=examples/**/*.cpp
  66 sonar.issue.ignore.multicriteria.c4b.ruleKey=cpp:GlobalNamespaceMembers
  67 sonar.issue.ignore.multicriteria.c4b.resourceKey=examples/**/*.hpp
  68
  69 # Replace alternative operator "not" with "!"
  70 # I like it better, so please leave me alone
  71 sonar.issue.ignore.multicriteria.c5a.ruleKey=cpp:S3659
  72 sonar.issue.ignore.multicriteria.c5a.resourceKey=**/*.cpp
  73 sonar.issue.ignore.multicriteria.c5b.ruleKey=cpp:S3659
  74 sonar.issue.ignore.multicriteria.c5b.resourceKey=**/*.hpp
  75
  76 # Dynamically allocated memory should be released
  77 # We have better ways to detect memleaks in SimGrid
  78 # This is not disabled in example/ because our code should be nice looking
  79 sonar.issue.ignore.multicriteria.c6a.ruleKey=cpp:S3584
  80 sonar.issue.ignore.multicriteria.c6a.resourceKey=src/**/*.cpp
  81 sonar.issue.ignore.multicriteria.c6b.ruleKey=cpp:S3584
  82 sonar.issue.ignore.multicriteria.c6b.resourceKey=teshsuite/**/*.cpp
  83
  84 # Macros should not be used to define constants
  85 # *.h includes are meant to be usable in C
  86 sonar.issue.ignore.multicriteria.c7.ruleKey=cpp:S5028
  87 sonar.issue.ignore.multicriteria.c7.resourceKey=**/*.h
  88
  89 # Deprecated code should be removed
  90 # We do have a process to remove deprecated code
  91 sonar.issue.ignore.multicriteria.c8.ruleKey=cpp:S1133
  92 sonar.issue.ignore.multicriteria.c8.resourceKey=**/*
  93
  94 # Lambda return types should be implicit
  95 # I don't see the point in general, plus we mostly use them when forced, to disambiguate
  96 sonar.issue.ignore.multicriteria.c9.ruleKey=cpp:S3574
  97 sonar.issue.ignore.multicriteria.c9.resourceKey=**/*
  98
  99 # "reinterpret_cast" should not be used
 100 # But we need this to interface C and Fortran
 101 sonar.issue.ignore.multicriteria.f1.ruleKey=cpp:S3630
 102 sonar.issue.ignore.multicriteria.f1.resourceKey=src/smpi/bindings/smpi_f77*.cpp
 103
 104 # Exclude some files from the analysis:
 105 #  - our unit tests
 106 #  - the tests that we borrowed elsewhere (MPICH and ISP)
 107 #  - Flex-generated files
 108 #  - Collectives that we borrowed elsewhere (mpich, openMPI and other implems)
 109 #  - the NAS, that are included in our examples
 110 #  - The Catch2 library, that is included in our unit tests
 111 #  - RngStream, that is included in SimGrid
 112 sonar.exclusions=src/include/catch.hpp,src/*_unit.c*,teshsuite/smpi/mpich3-test/**,teshsuite/smpi/isp/**,**/*_dtd.c,**/*_dtd.h,**/*yy.c,src/xbt/automaton/parserPromela.tab.*,src/smpi/colls/**/*,examples/smpi/NAS/*,src/xbt/RngStream.c,include/xbt/RngStream.h
 113
 114 # Exclude our examples from the duplication detection.
 115 # Examples are expected to be somehow repetitive
 116 sonar.cpd.exclusions=examples/**,teshsuite/**
 117
 118 # The build-wrapper output dir
 119 sonar.cfamily.build-wrapper-output=bw-outputs
 120
 121 # Allow multithreaded execution
 122 sonar.cfamily.threads=4
 123
 124 # Where the coverage files are located
 125 # See https://docs.sonarqube.org/pages/viewpage.action?pageId=5312222
 126 sonar.cfamily.gcov.reportsPath=Testing/CoverageInfo
 127 # Files to ignore from coverage analysis:
 128 #   - foreign test suites
 129 #   - XML files
 130 #   - Python files used to generate either simcalls or deployment files
 131 sonar.coverage.exclusions=teshsuite/smpi/isp/**,teshsuite/smpi/mpich3-test/**,**/*.xml,src/simix/simcalls.py,**/generate.py
 132
 133 # Encoding of the source files
 134 sonar.sourceEncoding=UTF-8
 135
 136 # Version of the used prog languages
 137 sonar.java.source=7
 138 sonar.java.binaries=CMakeFiles/simgrid-java_jar.dir,examples/deprecated/java
 139
 140 # Don't talk to me: travis don't like your verbosity
 141 # sonar.verbose=true
 142
 143 ### NOTE: the following properties are overridden by Jenkins configuration
 144 ###
 145 #sonar.java.binaries
 146 #sonar.cfamily.build-wrapper-output
 147 #sonar.cfamily.gcov.reportsPath
 148 #sonar.python.coverage.reportPath
 149 #sonar.coverage.jacoco.xmlReportPaths
 150 #sonar.cfamily.threads