3 |
2 |
3 |
2 | To avoid draining the battery, an Android device that is left idle quickly falls asleep.
3 | Hence, keeping the screen on should be avoided, unless it is absolutely necessary.
4 | If so, developers typically use a Power Manager system service feature called wake locks
5 | by invoking PowerManager.WakeLock#newWakeLock(int levelAndFlags, String tag),
6 | along with the specific permission WAKE_LOCK in their manifest.
9 | <manifest> 10 | <uses-permission android:name="android.permission.WAKE_LOCK" /> 11 | </manifest> 12 |13 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/EIDL005.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Idleness: Keep CPU On", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "1h" 8 | }, 9 | "tags": [ 10 | "idleness", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/EPOW002.html: -------------------------------------------------------------------------------- 1 |
2 | A negative effect on the device s battery is when an app is paired with a companion device (over Bluetooth, BLE, or Wi-Fi)
3 | and that it has been excluded from battery optimizations (run in the background) using the declaration
4 | Manifest.permission.REQUEST_COMPANION_RUN_IN_BACKGROUND.
7 | <manifest> 8 | <uses-permission android:name="android.permission.REQUEST_COMPANION_RUN_IN_BACKGROUND"> 9 | </manifest> 10 |-------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/EPOW002.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Power: Compagnion In Background", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "power", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/EPOW003.html: -------------------------------------------------------------------------------- 1 |
2 | An app holding the permission REQUEST_IGNORE_BATTERY_OPTIMIZATIONS asks the user to allow it to ignore
3 | battery optimizations (that is, put them on the whitelist of apps).
Most applications should not use this; there are many facilities provided by the platform for applications to 5 | operate correctly in the various power saving modes.
6 | 7 |9 | <manifest> 10 | <uses-permission android:name="android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS" /> 11 | </manifest> 12 |13 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/EPOW003.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Power: Ignore Battery Optimizations", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "1h" 8 | }, 9 | "tags": [ 10 | "power", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/EPOW005.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Power: Charge Awareness", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "0min" 8 | }, 9 | "tags": [ 10 | "power", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Info" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/EPOW007.html: -------------------------------------------------------------------------------- 1 |
2 | Taking into account when the device is entering or exiting the power save mode is higly desirable for the battery
3 | life.
4 | It implies the existence of a broadcast receiver registered on the action
5 | ACTION_POWER_SAVE_MODE_CHANGED,
6 | or programmaticaly with a call to PowerManager#isPowerSaveMode().
9 | <receiver android:name="io.ecocode.testapp.core.service.MyReceiver"> 10 | <intent-filter> 11 | <action android:name="android.intent.action.BATTERY_CHANGED"/> 12 | </intent-filter> 13 | </receiver> 14 |-------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/EPOW007.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Power: Save Mode Awareness", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "0min" 8 | }, 9 | "tags": [ 10 | "power", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Info" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/ESOB003.html: -------------------------------------------------------------------------------- 1 |
2 | Displaying dark colors is particularly beneficial for mobile devices with (AM)OLED screens.
3 | Consequently, custom resources like bright colors values and bitmap images with too high luminance should be avoided.
6 | <TextView 7 | android:layout_width="match_parent" 8 | android:layout_height="match_parent" 9 | android:foreground="#FFFFFF" 10 | android:foregroundTint="#FFFFFF"> 11 | </TextView> 12 |-------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/ESOB003.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Dark UI (Bright Colors)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "1h" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/ESOB004.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Dark UI (Theme)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "1h" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/io/ecocode/xml/rules/README.md: -------------------------------------------------------------------------------- 1 | # These files are GENERATED 2 | 3 | The files from this folder are **generated** directly from our rules descriptions project. 4 | 5 | Consequently, do not attempt to manually modify files here, nor submit Pull Request (PR) modifying description 6 | or rule metatada. Any PR will be systematically rejected. 7 | 8 | If you want to: 9 | 10 | * update descriptions; 11 | * extends their content; 12 | * fix misleading content; 13 | * adjust rule metadata; 14 | * etc. 15 | 16 | Then, please reach us though our mail
2 | Opening and closing internet connection continuously is extremely battery-inefficient since HTTP exchange is the most
3 | consuming operation of the network. This bug typically occurs when one obtain a new HttpURLConnection
4 | by calling URL#openConnection() within a loop control structure (while, for, do-while, for-each).
5 | Also, this bad practice must be early prevented because it is the root of another evil that consists in polling
6 | data at regular intervals, instead of using push notifications to save a lot of battery power.
9 | for (int val : myArray) {
10 | URL.openConnection();
11 | }
12 |
13 |
--------------------------------------------------------------------------------
/src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EBOT001_java.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Bottleneck: Internet In The Loop",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "3h"
8 | },
9 | "tags": [
10 | "optimized-api",
11 | "environment",
12 | "ecocode"
13 | ],
14 | "defaultSeverity": "Critical"
15 | }
--------------------------------------------------------------------------------
/src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EBOT002_java.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Bottleneck: Wifi Multicast Lock",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "20min"
8 | },
9 | "tags": [
10 | "bottleneck",
11 | "environment",
12 | "ecocode"
13 | ],
14 | "defaultSeverity": "Minor"
15 | }
--------------------------------------------------------------------------------
/src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EBOT003_java.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Bottleneck: Uncompressed Data Transmission",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "10min"
8 | },
9 | "tags": [
10 | "bottleneck",
11 | "environment",
12 | "ecocode"
13 | ],
14 | "defaultSeverity": "Minor"
15 | }
16 |
--------------------------------------------------------------------------------
/src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL001_java.html:
--------------------------------------------------------------------------------
1 | 
2 | To avoid draining the battery, an Android device that is left idle quickly falls asleep.
3 | Hence, keeping the screen on should be avoided, unless it is absolutely necessary. If so, developers typically
4 | use the FLAG_KEEP_SCREEN_ON in their activity. Another way to implement this is in their application's
5 | layout XML file, by using the android:keepScreenOn attribute.
8 | getWindow().addFlags(FLAG_KEEP_SCREEN_ON); 9 |10 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL001_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Idleness: Keep Screen On (addFlags)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "idleness", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL002_java.html: -------------------------------------------------------------------------------- 1 |
2 | To avoid draining the battery, an Android device that is left idle quickly falls asleep.
3 | Hence, keeping the screen on should be avoided, unless it is absolutely necessary. If so, developers typically
4 | use the FLAG_KEEP_SCREEN_ON in their activity. Another way to implement this is in their application's
5 | layout XML file, by using the android:keepScreenOn attribute.
8 | getWindow().setFlags(FLAG_KEEP_SCREEN_ON, FLAG_KEEP_SCREEN_ON); 9 |10 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL002_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Idleness: Keep Screen On (setFlags)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "idleness", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL004_java.html: -------------------------------------------------------------------------------- 1 |
2 | To avoid draining the battery, an Android device that is left idle quickly falls asleep.
3 | Hence, keeping the CPU on should be avoided, unless it is absolutely necessary.
4 | If so, developers typically use a Power Manager system service feature called wake locks
5 | by invoking PowerManager.WakeLock#newWakeLock(int levelAndFlags, String tag),
6 | along with the specific permission WAKE_LOCK in their manifest.
9 | PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE); 10 | WakeLock manager = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, "TAG"); 11 |-------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL004_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Idleness: Keep Cpu On", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "1h" 8 | }, 9 | "tags": [ 10 | "idleness", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL006_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Idleness: Durable Wake Lock", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "10min" 8 | }, 9 | "tags": [ 10 | "idleness", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL007_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Idleness: Rigid Alarm", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "1d" 8 | }, 9 | "tags": [ 10 | "idleness", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL008_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Idleness: Continuous Rendering", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "10min" 8 | }, 9 | "tags": [ 10 | "idleness", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Minor" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EIDL009_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Idleness: Keep Voice Awake", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "10min" 8 | }, 9 | "tags": [ 10 | "idleness", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ELEA002_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Leakage: Camera Leak", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "leakage", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Critical" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ELEA003_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Leakage: Location Leak", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "leakage", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Minor" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ELEA004_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Leakage: SensorManager Leak", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "leakage", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ELEA005_java.html: -------------------------------------------------------------------------------- 1 |
2 | Creation of a Media Recorder object with new MediaRecorder() is used to record
3 | audio and video. Class own a release() method.
In addition to unnecessary resources (such as memory and instances of codecs) being held, 5 | failure to call this method immediately if a media object is no longer needed may also lead to 6 | continuous battery consumption for mobile devices.
7 |9 | MediaRecorder mr = new MediaRecorder(); 10 |11 |
13 | MediaRecorder mr = new MediaRecorder(); 14 | mr.release(); 15 |16 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ELEA005_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Leakage: Media Leak (MediaRecorder)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "leakage", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ELEA006_java.html: -------------------------------------------------------------------------------- 1 |
2 | Creation of a Media Player object with new MediaPlayer() can
3 | be used to control playback of audio/video files and streams. Class own arelease() method.
In addition to unnecessary resources (such as memory and instances of codecs) being held, 5 | failure to call this method immediately if a media object is no longer needed may also lead to 6 | continuous battery consumption for mobile devices.
7 |9 | MediaPlayer mp = new MediaPlayer(); 10 |11 |
13 | MediaPlayer mp = new MediaPlayer(); 14 | mp.release(); 15 |16 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ELEA006_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Leakage: Media Leak (MediaPlayer)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "leakage", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EOPT001_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Optimized API: Fused Location", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "optimized-api", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EOPT002_java.html: -------------------------------------------------------------------------------- 1 |
2 | In contrast to classic Bluetooth, Bluetooth Low Energy (BLE)
3 | is designed to provide significantly lower power consumption.
4 | Its purpose is to save energy on both paired devices but very few
5 | developers are aware of this alternative API.
6 | From the Android client side, it means append android.bluetooth.le.*
7 | imports to android.bluetooth.* imports in order to benefits from
8 | low-energy features.
11 | import android.bluetooth.* 12 |13 |
15 | import android.bluetooth.le.* 16 |-------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EOPT002_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Optimized API: Bluetooth Low-Energy", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "optimized-api", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EPOW004_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Power: Charge Awareness", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "0min" 8 | }, 9 | "tags": [ 10 | "power", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Info" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EPOW006_java.html: -------------------------------------------------------------------------------- 1 |
2 | Taking into account when the device is entering or exiting the power save mode is higly desirable for the battery
3 | life.
4 | It implies the existence of a broadcast receiver registered on the action
5 | ACTION_POWER_SAVE_MODE_CHANGED,
6 | or programmaticaly with a call to PowerManager#isPowerSaveMode().
9 | new IntentFilter(Intent.ACTION_POWER_SAVE_MODE_CHANGED) 10 |11 | OR 12 |
13 | intentFilter.addAction(ACTION_POWER_SAVE_MODE_CHANGED) 14 |15 | OR 16 |
17 | IntentFilter.create(ACTION_POWER_SAVE_MODE_CHANGED,"") 18 |19 | OR 20 |
21 | powerManager.isPowerSaveMode() 22 |-------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/EPOW006_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Power: Save Mode Awareness", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "0min" 8 | }, 9 | "tags": [ 10 | "power", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Info" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB001_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Thrifty Motion Sensor", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Minor" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB002_java.html: -------------------------------------------------------------------------------- 1 |
2 | Introduced in Android 9, the adaptive brightness feature raises or lower the brightness of the screen depending on
3 | the light in the current environment.
4 | For some reasons, developers may disable this feature programmatically, setting the field
5 | WindowManager.LayoutParams#screenBrightness with the constant BRIGHTNESS_OVERRIDE_FULL.
6 | This feature was introduced to improve battery life, be careful when deactivating it.
9 | getWindow().getAttributes().screenBrightness = BRIGHTNESS_OVERRIDE_FULL; 10 |11 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB002_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Brightness Override", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Minor" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB005_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Thrifty Geolocation (minTime)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "10min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB006_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Thrifty Geolocation Criteria", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } 16 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB007_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Thrifty Bluetooth Low Energy (setAdvertiseMode)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "10min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB008_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Thrifty Bluetooth Low Energy (requestConnectionPriority)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "10min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB010_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Thrifty Geolocation (minDistance)", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "10min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Minor" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB011_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Vibration Free", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Minor" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB012_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: Thrifty Notification", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Minor" 15 | } 16 | -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB013_java.html: -------------------------------------------------------------------------------- 1 |
2 | Turning on the torch mode programmatically with CameraManager#setTorchMode(..., true) must absolutely be
3 | avoided because the flashlight is one of the most energy-intensive component.
6 | CameraManager camManager = (CameraManager) getSystemService(Context.CAMERA_SERVICE);
7 | String cameraId = null;
8 | try {
9 | cameraId = camManager.getCameraIdList()[0];
10 | camManager.setTorchMode(cameraId, true);
11 | } catch (CameraAccessException e) {
12 | e.printStackTrace();
13 | }
14 |
--------------------------------------------------------------------------------
/src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB013_java.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Sobriety: Torch Free",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "sobriety",
11 | "environment",
12 | "ecocode"
13 | ],
14 | "defaultSeverity": "Major"
15 | }
16 |
--------------------------------------------------------------------------------
/src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB014_java.html:
--------------------------------------------------------------------------------
1 |
2 | In Android 11 (API level 30) or higher, a call to
3 | Surface#setFrameRate(float frameRate, int compatibility) results in a change to the display refresh
4 | rate. However, a regular app displays 60 frames per second (60Hz). In order to optimize content refreshes and hence
5 | saving energy, this frequency should not be raised to 90Hz or 120Hz, despite this is now supported by many devices.
6 |
9 | surface.setFrameRate(120f, FRAME_RATE_COMPATIBILITY_DEFAULT); 10 |11 |
13 | surface.setFrameRate(60f, FRAME_RATE_COMPATIBILITY_DEFAULT); 14 |-------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/ESOB014_java.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Sobriety: High Frame Rate", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "sobriety", 11 | "environment", 12 | "ecocode" 13 | ], 14 | "defaultSeverity": "Major" 15 | } -------------------------------------------------------------------------------- /src/android-plugin/src/main/resources/org/sonar/l10n/java/rules/squid/README.md: -------------------------------------------------------------------------------- 1 | # These files are GENERATED 2 | 3 | The files from this folder are **generated** directly from our rules descriptions project. 4 | 5 | Consequently, do not attempt to manually modify files here, nor submit Pull Request (PR) modifying description 6 | or rule metatada. Any PR will be systematically rejected. 7 | 8 | If you want to: 9 | 10 | * update descriptions; 11 | * extends their content; 12 | * fix misleading content; 13 | * adjust rule metadata; 14 | * etc. 15 | 16 | Then, please reach us though our mail
Using Spring repository in loop induced unnecessary calculation by the cpu so unless energy consumption.
2 |
4 | private final List<Integer> ids = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
5 |
6 | List<Employee> employees = new ArrayList<>();
7 |
8 | for (Integer id: ids) {
9 | Optional<Employee> employee = employeeRepository.findById(id); // Noncompliant
10 | if (employee.isPresent()) {
11 | employees.add(employee.get());
12 | }
13 | }
14 |
15 |
16 | 18 | private final List<Integer> ids = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10); 19 | List<Employee> employees = employeeRepository.findAllById(ids); 20 |21 | -------------------------------------------------------------------------------- /src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/GRC1.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Avoid Spring repository call in loop", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "50min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/GRPS0027.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Use System.arraycopy to copy arrays", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "20min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/GRSP0028.html: -------------------------------------------------------------------------------- 1 |
Optimize read file exception
2 |
4 | public void readPreferences(String filename) {
5 | //...
6 | InputStream in = null;
7 | try {
8 | in = new FileInputStream(filename);
9 | } catch (FileNotFoundException e) {
10 | logger.log(e);
11 | }
12 | in.read(...);
13 | //...
14 | }
15 |
16 |
17 |
19 | public void readPreferences(String filename)
20 | throws IllegalArgumentException,
21 | FileNotFoundException, IOException {
22 | if (filename == null) {
23 | throw new IllegalArgumentException ("filename is null");
24 | } //if
25 | //...
26 | InputStream in = new FileInputStream(filename);
27 | //...
28 | }
29 |
30 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/GRSP0028.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Optimize read file exceptions",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
14 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/GRSP0032.html:
--------------------------------------------------------------------------------
1 | 2 | If you know in advance how many characters would be appended, initialize builder/buffer with the appropriate size. 3 | They will thus never have to be resized, It saves CPU cycles so unless energy consumption. 4 |
5 |
7 | StringBuilder sb = new StringBuilder(); // Noncompliant
8 | for (int i = 0; i < 100; i++) {
9 | sb.append(...);
10 | }
11 |
12 |
14 | StringBuilder sb = new StringBuilder(100);
15 | for (int i = 0; i < 100; i++) {
16 | sb.append(...);
17 | }
18 |
19 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/GRSP0032.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Initialize builder/buffer with the appropriate size",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/GSCIL.html:
--------------------------------------------------------------------------------
1 | While iterating through any collection get the size of the collection beforehand and never get it during iteration, It saves CPU cycles so unless energy consumption. The sample is provided below as an illustration which is to be avoided as follows.
2 |
4 | List<String> objList = getData();
5 |
6 | for (int i = 0; i < objList.size(); i++) {
7 | // execute code
8 | }
9 |
10 |
11 |
13 | List<String> objList = getData();
14 |
15 | int size = objList.size();
16 | for (int i = 0; i < size; i++) {
17 | // execute code
18 | }
19 |
20 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/GSCIL.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Avoid getting the size of the collection in the loop",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S53.html:
--------------------------------------------------------------------------------
1 | Using List instead of Arrays with Foreach save CPU cycles calculations and RAM consumption.
2 |
4 | private final Integer[] intArray = new Integer[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
5 |
6 | for (Integer i : intArray) {
7 | ...
8 | }
9 |
10 |
11 |
13 | private final List<Integer> intList = Arrays.asList(new Integer[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 });
14 |
15 | for (Integer i : intList) {
16 | ...
17 | }
18 |
19 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S53.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Avoid the use of Foreach with Arrays",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S63.html:
--------------------------------------------------------------------------------
1 | Do not unnecessarily assign values to variables. It increase unless RAM memory usage.
2 |4 | String var1 = getValue(); 5 | return var1; 6 | 7 | String var2 = "hello" 8 | var2 = "world" //Non compliant cause never assigned 9 | 10 |11 |
return getValue();13 | -------------------------------------------------------------------------------- /src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S63.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Do not unnecessarily assign values to variables", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S67.html: -------------------------------------------------------------------------------- 1 |
The form $i++ creates a temporary variable whereas ++$i does not. It save CPU cycles.
2 |4 | i++ 5 |6 |
++i8 | -------------------------------------------------------------------------------- /src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S67.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Use ++i instead of i++", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S69.html: -------------------------------------------------------------------------------- 1 |
Do not call a function when declaring a for-type loop in order to avoid function calls each iterations. It saves CPU cycles.
2 |
4 | public void foo() {
5 | for (int i = 0; i < getMyValue(); i++) { // Noncompliant
6 | System.out.println(i);
7 | boolean b = getMyValue() > 6;
8 | }
9 | }
10 |
11 |
12 |
14 |
15 | public void foo() {
16 | int myValue = getMyValue();
17 | for (int i = 0; i < myValue; i++) {
18 | System.out.println(i);
19 | boolean b = getMyValue() > 6;
20 | }
21 | }
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S69.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Do not call a function when declaring a for-type loop",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S72.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Avoid SQL request in loop",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "10min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S74.html:
--------------------------------------------------------------------------------
1 | Databases servers have to solves fileds regarding to schema. Knowing and using the schema save CPU cycles and network transfer.
2 |
4 | public void foo() {
5 | ...
6 | String baseQuery = "SELECT * FROM users"; // Noncompliant
7 |
8 | ...
9 | }
10 |
11 |
12 |
14 |
15 | public void foo() {
16 | ...
17 | String query = "SELECT id,name, adress FROM users ";
18 | ...
19 | }
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S74.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Don't use the query SELECT * FROM",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "20min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S75.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Don't concatenate Strings in loop, use StringBuilder instead.",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "20min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
14 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S76.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Avoid usage of static collections.",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "20min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S77.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Avoid using Pattern.compile() in a non-static context.",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "20min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
14 |
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S78.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Don't set const parameter in batch update => Put its in query",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "15min"
8 | },
9 | "tags": [
10 | "eco-conception", "eco-sql"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/S79.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Free resources",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "15min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/main/resources/fr/cnumr/l10n/java/rules/java/SDMLQ1.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Use PreparedStatement instead of Statement",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "10min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/java-plugin/src/test/files/AvoidConcatenateStringsInLoop.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.java.utils;
2 |
3 | public class AvoidConcatenateStringsInLoop {
4 |
5 | public String concatenateStrings(String[] strings) {
6 | String result1 = "";
7 |
8 | for (String string : strings) {
9 | result1 += string; // Noncompliant
10 | }
11 | return result1;
12 | }
13 |
14 | public String concatenateStrings2() {
15 | String result2 = "";
16 |
17 | for (int i = 0; i < 1000; ++i) {
18 | result2 += "another"; // Noncompliant
19 | }
20 | return result2;
21 | }
22 |
23 | public String concatenateStrings3() {
24 | String result3 = "";
25 |
26 | for (int i = 0; i < 1000; ++i) {
27 | result3 = result3 + "another"; // Noncompliant
28 | }
29 | return result3;
30 | }
31 |
32 | }
33 |
--------------------------------------------------------------------------------
/src/java-plugin/src/test/files/AvoidGettingSizeCollectionInLoopBad.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.java.checks;
2 |
3 | import java.util.Collection;
4 | import java.util.ArrayList;
5 | import java.util.List;
6 |
7 | class AvoidGettingSizeCollectionInLoopBad {
8 | AvoidGettingSizeCollectionInLoopBad() {
9 |
10 | }
11 |
12 | public void badLoop()
13 | {
14 | ListUse of methods for basic operations
2 |4 | $min = min($a, $b); // NOK 5 |6 |
8 | $min = ($a < $b) ? $a : $b; // NOK 9 |10 | -------------------------------------------------------------------------------- /src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/D2.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Use of methods for basic operations", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/D4.html: -------------------------------------------------------------------------------- 1 |
2 | Prefer local variables as parameters 3 |
4 |A l'appel d'une variable globale, le moteur d'interprétation doit vérifier son existence dans tous les scopes, qu'elle dispose d'une valeur, etc. Passer les variables globales en argument de routines les rend locales dans la fonction, permettant ainsi d'économiser du temps de calcul (cycles CPU). 5 |
6 |exemple:
7 | var aGlobal = new String('Hello');
8 | function globalLength(){
9 | length = aGlobal.length;
10 | console.log(length);
11 | }
12 | globalLength();
13 |
14 | var aGlobal = new String('Hello');
15 | function someVarLength(str){
16 | length = str.length;
17 | console.log(length);
18 | }
19 | somVarLength(aGlobal);
PHP allows declaring a string with simple or double quotes. Using double quotes allows developers to insert variables which will be substituted during execution. When the string has no variables, using simple quotes avoid PHP to search inexisting variables. It will save CPU cycles consumption.
2 |
4 | myFunction("name", "age", "IsStudent");
5 | $lastName = "Hugo";
6 |
7 |
9 | myFunction('name', 'age', 'IsStudent');
10 | $lastName = 'Hugo';
11 | $concatenatedString = "$lastName is a student";
12 |
13 |
14 |
--------------------------------------------------------------------------------
/src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/S66.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Avoid using double quote (\"), prefer using simple quote (')",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/S67.html:
--------------------------------------------------------------------------------
1 | The form $i++ creates a temporary variable whereas ++$i does not. It save CPU cycles.
2 |4 | $i++ 5 |6 |
++$i8 | -------------------------------------------------------------------------------- /src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/S67.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Use ++i instead of i++", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/S69.html: -------------------------------------------------------------------------------- 1 |
Do not call a function when declaring a for-type loop in order to avoid function calls each iterations. It saves CPU cycles.
2 |
4 | for ($i = 0; $i <= foo(); $i++) { // NOK
5 | ......
6 | }
7 |
8 |
10 | $maxI = foo();
11 | for ($i = 0; $i <= $maxI; $i++) {
12 | .....
13 | }
14 |
15 | OR
16 |
17 | for ($i = 0, $maxI = foo(); $i <= $maxI; $i++) {
18 | .....
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/S69.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Do not call a function when declaring a for-type loop",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/S72.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Avoid SQL request in loop",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "10min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/S74.html:
--------------------------------------------------------------------------------
1 | Databases servers have to solves fileds regarding to schema. Knowing and using the schema save CPU cycles and network transfer.
2 |
4 | public function foo() {
5 | ...
6 | $baseQuery = "SELECT * FROM users"; // Noncompliant
7 |
8 | ...
9 | }
10 |
11 |
13 | public function foo() {
14 | ...
15 | $baseQuery = "SELECT id,name, adress FROM users ";
16 | ...
17 | }
18 |
19 |
--------------------------------------------------------------------------------
/src/php-plugin/src/main/resources/fr/cnumr/l10n/php/rules/custom/S74.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Don't use the query SELECT * FROM",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "20min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/php-plugin/src/test/java/fr/cnumr/php/MyPhpRulesTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.php;
2 |
3 | import org.junit.Test;
4 | import org.sonar.api.server.rule.RulesDefinition;
5 |
6 | import static org.junit.Assert.assertEquals;
7 |
8 | public class MyPhpRulesTest {
9 |
10 | private int NumberOfRuleInRepository = 6;
11 |
12 | @Test
13 | public void rules() {
14 | MyPhpRules rulesDefinition = new MyPhpRules();
15 | RulesDefinition.Context context = new RulesDefinition.Context();
16 | rulesDefinition.define(context);
17 | RulesDefinition.Repository repository = context.repository(MyPhpRules.REPOSITORY_KEY);
18 | assertEquals(NumberOfRuleInRepository, repository.rules().size());
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/java/fr/cnumr/php/checks/AvoidDoubleQuoteCheckTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.php.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.plugins.php.api.tests.PHPCheckTest;
5 | import org.sonar.plugins.php.api.tests.PhpTestFile;
6 |
7 | import java.io.File;
8 |
9 | public class AvoidDoubleQuoteCheckTest {
10 |
11 | @Test
12 | public void test() throws Exception {
13 | PHPCheckTest.check(new AvoidDoubleQuoteCheck(), new PhpTestFile(new File("src/test/resources/checks/avoidDoubleQuote.php")));
14 | }
15 |
16 | }
17 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/java/fr/cnumr/php/checks/AvoidFullSQLRequestCheckTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.php.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.plugins.php.api.tests.PHPCheckTest;
5 | import org.sonar.plugins.php.api.tests.PhpTestFile;
6 |
7 | import java.io.File;
8 |
9 | public class AvoidFullSQLRequestCheckTest {
10 |
11 | @Test
12 | public void test() {
13 | PHPCheckTest.check(new AvoidFullSQLRequestCheck(), new PhpTestFile(new File("src/test/resources/checks/AvoidFullSQLRequest.php")));
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/java/fr/cnumr/php/checks/AvoidSQLRequestInLoopCheckTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.php.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.plugins.php.api.tests.PHPCheckTest;
5 | import org.sonar.plugins.php.api.tests.PhpTestFile;
6 |
7 | import java.io.File;
8 |
9 | public class AvoidSQLRequestInLoopCheckTest {
10 |
11 | @Test
12 | public void test() throws Exception {
13 | PHPCheckTest.check(new AvoidSQLRequestInLoopCheck(), new PhpTestFile(new File("src/test/resources/checks/AvoidSQLRequestInLoop.php")));
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/java/fr/cnumr/php/checks/AvoidTryCatchFinallyCheckNOKfailsAllTryStatementsTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.php.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.plugins.php.api.tests.PHPCheckTest;
5 | import org.sonar.plugins.php.api.tests.PhpTestFile;
6 |
7 | import java.io.File;
8 |
9 | public class AvoidTryCatchFinallyCheckNOKfailsAllTryStatementsTest {
10 |
11 | @Test
12 | public void test() throws Exception {
13 | PHPCheckTest.check(new AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements(), new PhpTestFile(new File("src/test/resources/checks/avoidTryCatchFinallyCheck_NOK_FailsAllTryStatements.php")));
14 | }
15 |
16 | }
17 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/java/fr/cnumr/php/checks/NoFunctionCallWhenDeclaringForLoopTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.php.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.plugins.php.api.tests.PHPCheckTest;
5 | import org.sonar.plugins.php.api.tests.PhpTestFile;
6 |
7 | import java.io.File;
8 |
9 | public class NoFunctionCallWhenDeclaringForLoopTest {
10 |
11 | @Test
12 | public void test() throws Exception {
13 | PHPCheckTest.check(new NoFunctionCallWhenDeclaringForLoop(), new PhpTestFile(new File("src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.php")));
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/java/fr/cnumr/php/checks/UseOfMethodsForBasicOperationsTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.php.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.plugins.php.api.tests.PHPCheckTest;
5 | import org.sonar.plugins.php.api.tests.PhpTestFile;
6 |
7 | import java.io.File;
8 |
9 | public class UseOfMethodsForBasicOperationsTest {
10 |
11 | @Test
12 | public void test() throws Exception {
13 | PHPCheckTest.check(new UseOfMethodsForBasicOperations(), new PhpTestFile(new File("src/test/resources/checks/useOfMethodsForBasicOperations.php")));
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/resources/checks/AvoidUsingGlobalVariablesCheck.php:
--------------------------------------------------------------------------------
1 |
17 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/resources/checks/incrementCheck.php:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/src/php-plugin/src/test/resources/checks/useOfMethodsForBasicOperations.php:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/src/prepare-codenarc:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | # Define CodeNarc version
4 | codenarcVersion="2.2.3"
5 |
6 | # Build CodeNarc
7 | cd codenarc-converter/CodeNarc
8 | ./gradlew build -x test
9 |
10 | # Deploy to local repository
11 | mvn -B install:install-file -Dfile=build/libs/CodeNarc-${codenarcVersion}.jar -DgroupId=org.codenarc -DartifactId=CodeNarc -Dversion=${codenarcVersion} -Dpackaging=jar
12 |
13 |
--------------------------------------------------------------------------------
/src/prepare-codenarc.bat:
--------------------------------------------------------------------------------
1 | REM == Define CodeNarc version
2 | set codenarc_version=2.2.3
3 |
4 | REM == Build CodeNarc
5 | cd codenarc-converter/CodeNarc
6 | call ./gradlew build -x test
7 |
8 | REM == Deploy to local repository
9 | mvn -B install:install-file -Dfile=build/libs/CodeNarc-%codenarc_version%.jar -DgroupId=org.codenarc -DartifactId=CodeNarc -Dversion=%codenarc_version% -Dpackaging=jar
10 |
--------------------------------------------------------------------------------
/src/python-plugin/README.md:
--------------------------------------------------------------------------------
1 | https://github.com/SonarSource/sonar-custom-rules-examples/tree/master/python-custom-rules
--------------------------------------------------------------------------------
/src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/D4.html:
--------------------------------------------------------------------------------
1 | When function calls global variables, a lot a CPU cycles is consumed.
2 |
4 | global_var = 'foo'
5 | def print_global_var_details():
6 | print(len(global_var)) # Noncompliant
7 | print('Global var : ', global_var) # Noncompliant
8 | print('Global var : ' + global_var) # Noncompliant
9 | print_global_var_details()
10 |
11 |
13 | global_var = 'foo';
14 | def print_var_details(local_var) {
15 | print(len(local_var));
16 | print('Var : ', local_var)
17 | print('Var : ' + local_var)
18 | }
19 | print_length(global_var);
20 |
21 |
--------------------------------------------------------------------------------
/src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/D4.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Do not call global variables directly inside functions",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "5min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/D7.html:
--------------------------------------------------------------------------------
1 | Avoid Getters and Setters in class, It increase unless RAM memory usage.
2 |4 | class Client(): 5 | 6 | def __init__(self, age): 7 | self.age = age 8 | 9 | def get_age(self): 10 | return self.age 11 | 12 | def set_age(self, age): 13 | self.age = age 14 | 15 | client = Client(25) 16 | client.get_age() # Getter inutile 17 | client.set_age(25) # Setter inutile 18 | 19 |20 |
22 | class Client(): 23 | 24 | def __init__(self, age): 25 | self.age = age 26 | 27 | def get_age(self): 28 | return self.age 29 | 30 | def set_age(self, age): 31 | self.age = age 32 | 33 | client = Client(25) 34 | client.age # Récupérer l'attribut age 35 | client.age = 26 # Modifier l'attribut age 36 |37 | -------------------------------------------------------------------------------- /src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/D7.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Avoid creating getter and setter methods in classes.", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/S34.html: -------------------------------------------------------------------------------- 1 |
Inside complex code parts (for exemple multiple loops, complex data constructions...), avoid using try...catch...finally. 2 |
When an exception is thrown, a variable (the exception itself) is created in a catch block and it's destruction consumes unnecessary CPU cycles and RAM. Prefer using logical tests in this cases.
3 | 4 |
6 | try:
7 | f = open(path)
8 | print(fh.read())
9 | except:
10 | print('No such file '+path
11 | finally:
12 | f.close()
13 |
14 |
15 | 17 | if os.path.isfile(path): 18 | fh = open(path, 'r') 19 | print(fh.read()) 20 | fh.close 21 |22 | -------------------------------------------------------------------------------- /src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/S34.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Avoid using try-catch-finally statement", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/S69.html: -------------------------------------------------------------------------------- 1 |
Do not call a function when declaring a for-type loop in order to avoid function calls each iterations. It saves CPU cycles.
2 |4 | for i in my_function(): 5 | ...... 6 | 7 |8 |
10 | limit = my_function() 11 | for i in limit: 12 | ...... 13 |14 | -------------------------------------------------------------------------------- /src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/S69.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Do not call a function when declaring a for-type loop", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/S72.html: -------------------------------------------------------------------------------- 1 |
Executing SQL queries in loop induced unnecessary calculation by the cpu, RAM usage and network transfert.
2 |
4 | def foo():
5 | ...
6 | results = []
7 | for id in range(20):
8 | results.append(cursor.execute("SELECT name FROM users where id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}}
9 | ...
10 |
11 |
13 |
14 | def foo():
15 | ...
16 | ids = range(20)
17 | results = cursor.execute("SELECT name FROM users where id IN ({0})".format(', '.join("?" * len(ids))), ids).fetchmany() # Compliant
18 | ...
19 | }
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/S72.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Avoid SQL request in loop",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "10min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/S74.html:
--------------------------------------------------------------------------------
1 | Databases servers have to solves fileds regarding to schema. Knowing and using the schema save CPU cycles and network transfer.
2 |
4 | public void foo() {
5 | ...
6 | String baseQuery = "SELECT * FROM users"; // Noncompliant
7 |
8 | ...
9 | }
10 |
11 |
12 |
14 |
15 | public void foo() {
16 | ...
17 | String query = "SELECT id,name, adress FROM users ";
18 | ...
19 | }
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/python-plugin/src/main/resources/fr/cnumr/l10n/python/rules/python/S74.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Don't use the query SELECT * FROM",
3 | "type": "CODE_SMELL",
4 | "status": "ready",
5 | "remediation": {
6 | "func": "Constant\/Issue",
7 | "constantCost": "20min"
8 | },
9 | "tags": [
10 | "eco-conception"
11 | ],
12 | "defaultSeverity": "Minor"
13 | }
--------------------------------------------------------------------------------
/src/python-plugin/src/test/java/fr/cnumr/python/checks/AvoidFullSQLRequestTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.python.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.python.checks.utils.PythonCheckVerifier;
5 |
6 | public class AvoidFullSQLRequestTest {
7 |
8 | @Test
9 | public void test() {
10 | PythonCheckVerifier.verify("src/test/resources/checks/avoidFullSQLRequest.py", new AvoidFullSQLRequest());
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/java/fr/cnumr/python/checks/AvoidGettersAndSettersTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.python.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.python.checks.utils.PythonCheckVerifier;
5 |
6 | public class AvoidGettersAndSettersTest {
7 |
8 | @Test
9 | public void test() {
10 | PythonCheckVerifier.verify("src/test/resources/checks/avoidGettersAndSetters.py", new AvoidGettersAndSetters());
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/java/fr/cnumr/python/checks/AvoidGlobalVariableInFunctionCheckTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.python.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.python.checks.utils.PythonCheckVerifier;
5 |
6 | public class AvoidGlobalVariableInFunctionCheckTest {
7 | @Test
8 | public void test() {
9 | PythonCheckVerifier.verify("src/test/resources/checks/avoidGlobalVariableInFunction.py", new AvoidGlobalVariableInFunctionCheck());
10 | }
11 | }
12 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/java/fr/cnumr/python/checks/AvoidSQLRequestInLoopTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.python.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.python.checks.utils.PythonCheckVerifier;
5 |
6 | public class AvoidSQLRequestInLoopTest {
7 | @Test
8 | public void test() {
9 | PythonCheckVerifier.verify("src/test/resources/checks/avoidSQLRequestInLoop.py", new AvoidSQLRequestInLoop());
10 | PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/avoidSQLRequestInLoopNoImports.py", new AvoidSQLRequestInLoop());
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/java/fr/cnumr/python/checks/AvoidTryCatchFinallyCheckTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.python.checks;
2 |
3 |
4 | import org.junit.Test;
5 | import org.sonar.python.checks.utils.PythonCheckVerifier;
6 |
7 | public class AvoidTryCatchFinallyCheckTest {
8 | @Test
9 | public void test() {
10 | PythonCheckVerifier.verify("src/test/resources/checks/avoidTryCatchFinallyCheck.py", new AvoidTryCatchFinallyCheck());
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/java/fr/cnumr/python/checks/NoFunctionCallWhenDeclaringForLoopTest.java:
--------------------------------------------------------------------------------
1 | package fr.cnumr.python.checks;
2 |
3 | import org.junit.Test;
4 | import org.sonar.python.checks.utils.PythonCheckVerifier;
5 |
6 | public class NoFunctionCallWhenDeclaringForLoopTest {
7 | @Test
8 | public void test() {
9 | PythonCheckVerifier.verify("src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py", new NoFunctionCallWhenDeclaringForLoop());
10 | }
11 | }
12 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/resources/checks/.gitignore:
--------------------------------------------------------------------------------
1 | my.conf
2 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/resources/checks/avoidFullSQLRequest.py:
--------------------------------------------------------------------------------
1 | def displayMessage(argument1):
2 | print(argument)
3 |
4 | displayMessage(' sElEcT * fRoM myTable') # Noncompliant {{Don't use the query SELECT * FROM}}
5 | displayMessage(' sElEcT user fRoM myTable')
6 |
7 | requestNonCompiliant = ' SeLeCt * FrOm myTable' # Noncompliant {{Don't use the query SELECT * FROM}}
8 | requestCompiliant = ' SeLeCt user FrOm myTable'
9 | displayMessage(requestNonCompiliant)
10 | displayMessage(requestCompiliant)
11 |
12 |
13 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/resources/checks/avoidGettersAndSetters.py:
--------------------------------------------------------------------------------
1 | from datetime import date
2 |
3 | class Client():
4 |
5 | def __init__(self, age, weight):
6 | self.age = age
7 | self.weight = weight
8 |
9 | def set_age(self, age): # Noncompliant {{Avoid the use of getters and setters}}
10 | self.age = age
11 |
12 | def set_age(self, age2): # Noncompliant {{Avoid the use of getters and setters}}
13 | self.age = age2
14 |
15 | def get_age_in_five_years(self):
16 | a = Client()
17 | return a.age
18 |
19 | def get_age(self): # Noncompliant {{Avoid the use of getters and setters}}
20 | return self.age
21 |
22 | def is_major(self):
23 | return self.age >= 18
24 |
25 | def get_weight(self): # Noncompliant {{Avoid the use of getters and setters}}
26 | return self.weight
--------------------------------------------------------------------------------
/src/python-plugin/src/test/resources/checks/avoidTryCatchFinallyCheck.py:
--------------------------------------------------------------------------------
1 | import os.path
2 |
3 | path = 'hello.txt'
4 |
5 |
6 | def my_function():
7 | x=0
8 |
9 | try: # Noncompliant {{Avoid the use of try-catch-finally}}
10 | print(x)
11 | except:
12 | print("Something went wrong")
13 | finally:
14 | print("The 'try except' is finished")
15 |
16 | def foo():
17 | try: # Noncompliant {{Avoid the use of try-catch-finally}}
18 | f = open(path)
19 | print(f.read())
20 | except:
21 | print('No such file '+path)
22 | finally:
23 | f.close()
24 |
25 | def boo():
26 | if os.path.isfile(path):
27 | fh = open(path, 'r')
28 | print(fh.read())
29 | fh.close
--------------------------------------------------------------------------------
/src/python-plugin/src/test/resources/checks/my.conf.sample:
--------------------------------------------------------------------------------
1 | [client]
2 | host = localhost
3 | user = dbtest
4 | password = dbtest
5 | database = dbtest
6 |
--------------------------------------------------------------------------------
/src/python-plugin/src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py:
--------------------------------------------------------------------------------
1 | def my_function():
2 | return 6
3 |
4 | for i in my_function(): # Noncompliant {{Do not call a function when declaring a for-type loop}}
5 | print("Test")
6 | my_function()
7 | pass
8 |
9 |
10 |
11 | my_function()
--------------------------------------------------------------------------------
/src/sonar-project.properties:
--------------------------------------------------------------------------------
1 | # must be unique in a given SonarQube instance
2 | sonar.projectKey=sonar-custom-plugin-example
3 |
4 | # --- optional properties ---
5 |
6 | # defaults to project key
7 | #sonar.projectName=My project
8 | # defaults to 'not provided'
9 | #sonar.projectVersion=1.0
10 |
11 | # Path is relative to the sonar-project.properties file. Defaults to .
12 | #sonar.sources=.
13 |
14 | # Encoding of the source code. Default is default system encoding
15 | #sonar.sourceEncoding=UTF-8
16 |
17 | sonar.eslint.reportPaths=/opt/project/eslint-report.json
18 | sonar.css.stylelint.reportPaths=/opt/project/stylelint-report.json
19 | sonar.java.binaries=/opt/project/java-plugin/target/classes
20 | sonar.scm.disabled=true
--------------------------------------------------------------------------------
/src/xml-plugin/README.md:
--------------------------------------------------------------------------------
1 | https://github.com/SonarSource/sonar-custom-rules-examples/tree/master/xml-custom-rules
--------------------------------------------------------------------------------
/src/xml-plugin/src/main/resources/fr/cnumr/l10n/xml/rules/custom/S99.html:
--------------------------------------------------------------------------------
1 | Avoid the use of unoptimized vector images
2 |4 | Votre image contient des métadata non nécessaires à la visualisation de l'image 5 | Your image has metadatas that are not necessary to visualize it 6 | 7 |8 |
10 | Use SVGO to scan your image 11 |12 | -------------------------------------------------------------------------------- /src/xml-plugin/src/main/resources/fr/cnumr/l10n/xml/rules/custom/S99.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Avoid the use of unoptimized vector images", 3 | "type": "CODE_SMELL", 4 | "status": "ready", 5 | "remediation": { 6 | "func": "Constant\/Issue", 7 | "constantCost": "5min" 8 | }, 9 | "tags": [ 10 | "eco-conception" 11 | ], 12 | "defaultSeverity": "Minor" 13 | } -------------------------------------------------------------------------------- /src/xml-plugin/src/test/java/fr/cnumr/xml/MyXmlRulesTest.java: -------------------------------------------------------------------------------- 1 | package fr.cnumr.xml; 2 | 3 | import static org.junit.Assert.assertEquals; 4 | 5 | import org.junit.Test; 6 | import org.sonar.api.server.rule.RulesDefinition; 7 | 8 | public class MyXmlRulesTest { 9 | 10 | private int NumberOfRuleInRepository = 6; 11 | 12 | @Test 13 | public void rules() { 14 | MyXmlRules rulesDefinition = new MyXmlRules(); 15 | RulesDefinition.Context context = new RulesDefinition.Context(); 16 | rulesDefinition.define(context); 17 | RulesDefinition.Repository repository = context.repository(MyXmlRules.REPOSITORY_KEY); 18 | assertEquals(NumberOfRuleInRepository, repository.rules().size()); 19 | } 20 | } 21 | --------------------------------------------------------------------------------