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=http://simgrid.org
   9 sonar.links.issue=https://github.com/simgrid/simgrid/issues
  10 sonar.links.scm=https://github.com/simgrid/simgrid.git
  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,jni1,jni2,c1,c2a,c2b,c3,c4a,c4b,c5a,c5b,c6a,c6b,c7,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 # "reinterpret_cast" should not be used
  29 # But this is exactly intended to store a pointer into a long -- what we do here
  30 sonar.issue.ignore.multicriteria.jni1.ruleKey=cpp:S3630
  31 sonar.issue.ignore.multicriteria.jni1.resourceKey=src/bindings/java/*.cpp
  32
  33 # Unused function parameters should be removed
  34 # But JNI mandates these parameters
  35 sonar.issue.ignore.multicriteria.jni2.ruleKey=cpp:S1172
  36 sonar.issue.ignore.multicriteria.jni2.resourceKey=src/bindings/java/*.cpp
  37
  38
  39 # Pointers should not be cast to integral types
  40 # But we need that for jMSG, smpi and other places
  41 sonar.issue.ignore.multicriteria.c1.ruleKey=cpp:S1767
  42 sonar.issue.ignore.multicriteria.c1.resourceKey=**/*.cpp
  43
  44 # Preprocessor operators "#" and "##" should not be used
  45 # This poses portability issues, but we test on a large panel of architectures on purpose
  46 sonar.issue.ignore.multicriteria.c2a.ruleKey=cpp:PPStringifyAndPastingUsage
  47 sonar.issue.ignore.multicriteria.c2a.resourceKey=**/*.cpp
  48 sonar.issue.ignore.multicriteria.c2b.ruleKey=cpp:PPStringifyAndPastingUsage
  49 sonar.issue.ignore.multicriteria.c2b.resourceKey=**/*.hpp
  50
  51 # Macro names should comply with a naming convention
  52 # But the macros in this file are named after the MPI standard
  53 sonar.issue.ignore.multicriteria.c3.ruleKey=c:PPMacroName
  54 sonar.issue.ignore.multicriteria.c3.resourceKey=include/smpi/smpi_extended_traces.h
  55
  56 # Declarations should be placed in a namespace
  57 # But examples are intended to remain small and simple
  58 sonar.issue.ignore.multicriteria.c4a.ruleKey=cpp:GlobalNamespaceMembers
  59 sonar.issue.ignore.multicriteria.c4a.resourceKey=examples/**/*.cpp
  60 sonar.issue.ignore.multicriteria.c4b.ruleKey=cpp:GlobalNamespaceMembers
  61 sonar.issue.ignore.multicriteria.c4b.resourceKey=examples/**/*.hpp
  62
  63 # Replace alternative operator "not" with "!"
  64 # I like it better, so please leave me alone
  65 sonar.issue.ignore.multicriteria.c5a.ruleKey=cpp:S3659
  66 sonar.issue.ignore.multicriteria.c5a.resourceKey=**/*.cpp
  67 sonar.issue.ignore.multicriteria.c5b.ruleKey=cpp:S3659
  68 sonar.issue.ignore.multicriteria.c5b.resourceKey=**/*.hpp
  69
  70 # Dynamically allocated memory should be released
  71 # We have better ways to detect memleaks in SimGrid
  72 # This is not disabled in example/ because our code should be nice looking
  73 sonar.issue.ignore.multicriteria.c6a.ruleKey=cpp:S3584
  74 sonar.issue.ignore.multicriteria.c6a.resourceKey=src/**/*.cpp
  75 sonar.issue.ignore.multicriteria.c6b.ruleKey=cpp:S3584
  76 sonar.issue.ignore.multicriteria.c6b.resourceKey=teshsuite/**/*.cpp
  77
  78 # Preprocessor operators "#" and "##" should not be used
  79 # Until after Augustin goes to rehab, we cannot remove them all
  80 sonar.issue.ignore.multicriteria.c7.ruleKey=c:PPStringifyAndPastingUsage
  81 sonar.issue.ignore.multicriteria.c7.resourceKey=**/*
  82
  83 # "reinterpret_cast" should not be used
  84 # But we need this to interface C and Fortran
  85 sonar.issue.ignore.multicriteria.f1.ruleKey=cpp:S3630
  86 sonar.issue.ignore.multicriteria.f1.resourceKey=src/smpi/bindings/smpi_f77*.cpp
  87
  88
  89 # Exclude some files from the analysis:
  90 #  - our unit tests
  91 #  - the tests that we borrowed elsewhere (MPICH and ISP)
  92 #  - Flex-generated files
  93 #  - Collectives that we borrowed elsewhere (mpich, openMPI and other implems)
  94 #  - the NAS, that are included in our examples
  95 #  - RngStream, that is included in SimGrid
  96 sonar.exclusions=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
  97
  98 # Exclude our examples from the duplication detection.
  99 # Examples are expected to be somehow repetitive
 100 sonar.cpd.exclusions=examples/**,teshsuite/**
 101
 102 # The build-wrapper output dir
 103 sonar.cfamily.build-wrapper-output=bw-outputs
 104
 105 # Where the coverage files are located
 106 # See https://docs.sonarqube.org/pages/viewpage.action?pageId=5312222
 107 sonar.cfamily.gcov.reportsPath=Testing/CoverageInfo
 108 # Files to ignore from coverage analysis:
 109 #   - foreign test suites
 110 #   - platform files (I fail to get sonar ignore *.xml files)
 111 #   - Java code, examples and tests
 112 sonar.coverage.exclusions=teshsuite/smpi/isp/**,teshsuite/smpi/mpich3-test/**,examples/platforms/**,src/bindings/java/**,examples/java/**,teshsuite/java/**
 113
 114 # Encoding of the source files
 115 sonar.sourceEncoding=UTF-8
 116
 117 # Version of the used prog languages
 118 sonar.java.source=7
 119 sonar.java.binaries=CMakeFiles/simgrid-java_jar.dir,examples/java
 120 sonar.c.std=gnu11
 121 sonar.cpp.std=gnu++11
 122
 123 # Don't talk to me: travis don't like your verbosity
 124 # sonar.verbose=true