Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
sonar: point to framagit instead of github
[simgrid.git] / 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,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 # UNUSED: c7
85
86 # Deprecated code should be removed
87 # We do have a process to remove deprecated code
88 sonar.issue.ignore.multicriteria.c8.ruleKey=cpp:S1133
89 sonar.issue.ignore.multicriteria.c8.resourceKey=**/*
90
91 # Lambda return types should be implicit
92 # I don't see the point in general, plus we mostly use them when forced, to disambiguate
93 sonar.issue.ignore.multicriteria.c9.ruleKey=cpp:S3574
94 sonar.issue.ignore.multicriteria.c9.resourceKey=**/*
95
96 # "reinterpret_cast" should not be used
97 # But we need this to interface C and Fortran
98 sonar.issue.ignore.multicriteria.f1.ruleKey=cpp:S3630
99 sonar.issue.ignore.multicriteria.f1.resourceKey=src/smpi/bindings/smpi_f77*.cpp
100
101 # Exclude some files from the analysis:
102 #  - our unit tests
103 #  - the tests that we borrowed elsewhere (MPICH and ISP)
104 #  - Flex-generated files
105 #  - Collectives that we borrowed elsewhere (mpich, openMPI and other implems)
106 #  - the NAS, that are included in our examples
107 #  - The Catch2 library, that is included in our unit tests
108 #  - RngStream, that is included in SimGrid
109 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
110
111 # Exclude our examples from the duplication detection.
112 # Examples are expected to be somehow repetitive
113 sonar.cpd.exclusions=examples/**,teshsuite/**
114
115 # The build-wrapper output dir
116 sonar.cfamily.build-wrapper-output=bw-outputs
117
118 # Allow multithreaded execution
119 sonar.cfamily.threads=4
120
121 # Where the coverage files are located
122 # See https://docs.sonarqube.org/pages/viewpage.action?pageId=5312222
123 sonar.cfamily.gcov.reportsPath=Testing/CoverageInfo
124 # Files to ignore from coverage analysis:
125 #   - foreign test suites
126 #   - XML files
127 #   - Python files used to generate either simcalls or deployment files
128 sonar.coverage.exclusions=teshsuite/smpi/isp/**,teshsuite/smpi/mpich3-test/**,**/*.xml,src/simix/simcalls.py,**/generate.py
129
130 # Encoding of the source files
131 sonar.sourceEncoding=UTF-8
132
133 # Version of the used prog languages
134 sonar.java.source=7
135 sonar.java.binaries=CMakeFiles/simgrid-java_jar.dir,examples/deprecated/java
136
137 # Don't talk to me: travis don't like your verbosity
138 # sonar.verbose=true
139
140 ### NOTE: the following properties are overridden by Jenkins configuration
141 ###
142 #sonar.java.binaries
143 #sonar.cfamily.build-wrapper-output
144 #sonar.cfamily.gcov.reportsPath
145 #sonar.python.coverage.reportPath
146 #sonar.coverage.jacoco.xmlReportPaths
147 #sonar.cfamily.threads