X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d0b97e9f37660aadb6271704dd87afbef0088e53..2a07cc1dc95048c86a3fc76aca2e9c088f7b5025:/sonar-project.properties diff --git a/sonar-project.properties b/sonar-project.properties index 5d2130cce0..54b6f87e62 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -1,70 +1,160 @@ # This file is used to scan the project for issues automatically -# Browse the result here: https://nemo.sonarqube.org/overview?id=simgrid +# Browse the result here: https://sonarcloud.io/dashboard/?id=simgrid sonar.projectKey=simgrid sonar.projectName=SimGrid -sonar.projectVersion=3.15 +sonar.projectVersion=3.22.90 -sonar.links.homepage=http://simgrid.org -sonar.links.issue=https://github.com/simgrid/simgrid/issues -sonar.links.scm=https://github.com/simgrid/simgrid.git +sonar.links.homepage=https://simgrid.org +sonar.links.issue=https://framagit.org/simgrid/simgrid/issues +sonar.links.scm=https://framagit.org/simgrid/simgrid/ # Comma-separated paths to directories with sources (required) sonar.sources=src,examples,include,teshsuite # Disable some rules on some files -sonar.issue.ignore.multicriteria=j1,c1,c2,c3 +sonar.issue.ignore.multicriteria=j1,j2,j3,jni1,jni2,c1,c2a,c2b,c3,c4a,c4b,c5a,c5b,c6a,c6b,c7,c8,c9,c10,f1,p1 # The Object.finalize() method should not be overriden # But we need to clean the native memory with JNI sonar.issue.ignore.multicriteria.j1.ruleKey=squid:ObjectFinalizeOverridenCheck sonar.issue.ignore.multicriteria.j1.resourceKey=**/*.java -# Pointers should not be cast to integral types -# But we need that for jMSG +# Throwable.printStackTrace(...) should not be called +# But we don't have no better mechanism, and our Java apps are not rocket science +sonar.issue.ignore.multicriteria.j2.ruleKey=squid:S1148 +sonar.issue.ignore.multicriteria.j2.resourceKey=**/*.java + +# Using command line arguments is security-sensitive +# But the authors of the applications using our library will be their only users, so there is no security concern +sonar.issue.ignore.multicriteria.j3.ruleKey=squid:S4823 +sonar.issue.ignore.multicriteria.j3.resourceKey=**/*.java + +# "reinterpret_cast" should not be used +# But this is exactly intended to store a pointer into a long -- what we do here +sonar.issue.ignore.multicriteria.jni1.ruleKey=cpp:S3630 +sonar.issue.ignore.multicriteria.jni1.resourceKey=src/bindings/java/*.cpp + +# Unused function parameters should be removed +# But JNI mandates these parameters +sonar.issue.ignore.multicriteria.jni2.ruleKey=cpp:S1172 +sonar.issue.ignore.multicriteria.jni2.resourceKey=src/bindings/java/*.cpp + + +# Pointers should not be cast to integral types +# But we need that for jMSG, smpi and other places sonar.issue.ignore.multicriteria.c1.ruleKey=cpp:S1767 sonar.issue.ignore.multicriteria.c1.resourceKey=**/*.cpp # Preprocessor operators "#" and "##" should not be used -# This poses portability issues, but we check our usage on a large panel of architectures on purpose -sonar.issue.ignore.multicriteria.c2.ruleKey=cpp:PPStringifyAndPastingUsage -sonar.issue.ignore.multicriteria.c2.resourceKey=**/*.cpp +# This poses portability issues, but we test on a large panel of architectures on purpose +# Until after Augustin goes to rehab, we cannot remove them all +sonar.issue.ignore.multicriteria.c2a.ruleKey=c:PPStringifyAndPastingUsage +sonar.issue.ignore.multicriteria.c2a.resourceKey=**/* +sonar.issue.ignore.multicriteria.c2b.ruleKey=cpp:PPStringifyAndPastingUsage +sonar.issue.ignore.multicriteria.c2b.resourceKey=**/* # Macro names should comply with a naming convention # But the macros in this file are named after the MPI standard sonar.issue.ignore.multicriteria.c3.ruleKey=c:PPMacroName sonar.issue.ignore.multicriteria.c3.resourceKey=include/smpi/smpi_extended_traces.h +# Declarations should be placed in a namespace +# But examples are intended to remain small and simple +sonar.issue.ignore.multicriteria.c4a.ruleKey=cpp:GlobalNamespaceMembers +sonar.issue.ignore.multicriteria.c4a.resourceKey=examples/**/*.cpp +sonar.issue.ignore.multicriteria.c4b.ruleKey=cpp:GlobalNamespaceMembers +sonar.issue.ignore.multicriteria.c4b.resourceKey=examples/**/*.hpp + +# Replace alternative operator "not" with "!" +# I like it better, so please leave me alone +sonar.issue.ignore.multicriteria.c5a.ruleKey=cpp:S3659 +sonar.issue.ignore.multicriteria.c5a.resourceKey=**/*.cpp +sonar.issue.ignore.multicriteria.c5b.ruleKey=cpp:S3659 +sonar.issue.ignore.multicriteria.c5b.resourceKey=**/*.hpp + +# Dynamically allocated memory should be released +# We have better ways to detect memleaks in SimGrid +# This is not disabled in example/ because our code should be nice looking +sonar.issue.ignore.multicriteria.c6a.ruleKey=cpp:S3584 +sonar.issue.ignore.multicriteria.c6a.resourceKey=src/**/*.cpp +sonar.issue.ignore.multicriteria.c6b.ruleKey=cpp:S3584 +sonar.issue.ignore.multicriteria.c6b.resourceKey=teshsuite/**/*.cpp + +# Macros should not be used to define constants +# *.h includes are meant to be usable in C +sonar.issue.ignore.multicriteria.c7.ruleKey=cpp:S5028 +sonar.issue.ignore.multicriteria.c7.resourceKey=**/*.h + +# Deprecated code should be removed +# We do have a process to remove deprecated code +sonar.issue.ignore.multicriteria.c8.ruleKey=cpp:S1133 +sonar.issue.ignore.multicriteria.c8.resourceKey=**/* + +# Lambda return types should be implicit +# I don't see the point in general, plus we mostly use them when forced, to disambiguate +sonar.issue.ignore.multicriteria.c9.ruleKey=cpp:S3574 +sonar.issue.ignore.multicriteria.c9.resourceKey=**/* + +# Standard outputs should not be used directly to log anything +# Irrelevant for parsing examples in teshsuite/simdag +sonar.issue.ignore.multicriteria.c10.ruleKey=cpp:S106 +sonar.issue.ignore.multicriteria.c10.resourceKey=teshsuite/simdag/**/*.cpp + +# "reinterpret_cast" should not be used +# But we need this to interface C and Fortran +sonar.issue.ignore.multicriteria.f1.ruleKey=cpp:S3630 +sonar.issue.ignore.multicriteria.f1.resourceKey=src/smpi/bindings/smpi_f77*.cpp + +# In Python, Using command line arguments is security-sensitive +# But we are cautionous with it +sonar.issue.ignore.multicriteria.p1.ruleKey=python:S4823 +sonar.issue.ignore.multicriteria.p1.resourceKey=**/*.py + # Exclude some files from the analysis: -# - our unit tests +# - our unit tests # - the tests that we borrowed elsewhere (MPICH and ISP) # - Flex-generated files # - Collectives that we borrowed elsewhere (mpich, openMPI and other implems) # - the NAS, that are included in our examples -sonar.exclusions=src/*_unit.c*,teshsuite/smpi/mpich3-test/**,teshsuite/smpi/isp/**,**/*_dtd.c,src/smpi/colls/*,examples/smpi/NAS/* - -# Ignore some files based on regex on their content -sonar.issue.ignore.allfile=flexGenerated,flexMLGenerated -# - The one that are generated from Flex -sonar.issue.ignore.allfile.flexGenerated.fileRegexp="generated by flex" -# - The one that are generated from FlexML (the header files are directly generated, not going though Flex) -sonar.issue.ignore.allfile.flexMLGenerated.fileRegexp="generated with the FleXML XML processor generator" - -# Ignore the files that SMPI scavenged here and there (not working) -#sonar.issue.ignore.allfile=mpiColls -#sonar.issue.ignore.allfile.flexGenerated.mpiColls="Ahmad Faraj" -#sonar.issue.ignore.allfile=mpivapich -#sonar.issue.ignore.allfile.flexGenerated.mpivapich="This file is part of the MVAPICH2 software package" -#sonar.issue.ignore.allfile=mpiOmpi -#sonar.issue.ignore.allfile.flexGenerated.mpiOmpi="University of Tennessee" +# - The Catch2 library, that is included in our unit tests +# - RngStream, that is included in SimGrid +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 + +# Exclude our examples from the duplication detection. +# Examples are expected to be somehow repetitive +sonar.cpd.exclusions=examples/**,teshsuite/** # The build-wrapper output dir sonar.cfamily.build-wrapper-output=bw-outputs +# Allow multithreaded execution +sonar.cfamily.threads=4 + +# Where the coverage files are located +# See https://docs.sonarqube.org/pages/viewpage.action?pageId=5312222 +sonar.cfamily.gcov.reportsPath=Testing/CoverageInfo +# Files to ignore from coverage analysis: +# - foreign test suites +# - XML files +# - Python files used to generate either simcalls or deployment files +sonar.coverage.exclusions=teshsuite/smpi/isp/**,teshsuite/smpi/mpich3-test/**,**/*.xml,src/simix/simcalls.py,**/generate.py + # Encoding of the source files sonar.sourceEncoding=UTF-8 +# Version of the used prog languages sonar.java.source=7 +sonar.java.binaries=CMakeFiles/simgrid-java_jar.dir,examples/deprecated/java -# Talk to me (travis don't like it, it's too much) +# Don't talk to me: travis don't like your verbosity # sonar.verbose=true + +### NOTE: the following properties are overridden by Jenkins configuration +### +#sonar.java.binaries +#sonar.cfamily.build-wrapper-output +#sonar.cfamily.gcov.reportsPath +#sonar.python.coverage.reportPath +#sonar.coverage.jacoco.xmlReportPaths +#sonar.cfamily.threads