'
+ // ...
+}
+```
+
+## Compliant Solution
+
+```
+public void foo() {
+ // ...
+ return '
'
+ // ...
+}
+```
+
+Or
+
+```
+ public void foo() {
+ // ...
+ return ('')
+ // ...
+}
+```
diff --git a/ecocode-rules-specifications/src/main/rules/EC22/EC22.json b/ecocode-rules-specifications/src/main/rules/EC22/EC22.json
new file mode 100644
index 000000000..9d3ed8c36
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC22/EC22.json
@@ -0,0 +1,15 @@
+{
+ "title": "Use of methods for basic operations",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "eco-design",
+ "performance",
+ "ecocode"
+ ],
+ "defaultSeverity": "Minor"
+}
diff --git a/ecocode-rules-specifications/src/main/rules/EC22/php/EC22.asciidoc b/ecocode-rules-specifications/src/main/rules/EC22/php/EC22.asciidoc
new file mode 100644
index 000000000..c42338993
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC22/php/EC22.asciidoc
@@ -0,0 +1,13 @@
+Use of methods for basic operations
+
+## Noncompliant Code Example
+
+```php
+$min = min($a, $b); // Noncompliant
+```
+
+## Compliant Solution
+
+```php
+$min = $a < $b ? $a : $b;
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC27.json b/ecocode-rules-specifications/src/main/rules/EC27/EC27.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC27.json
rename to ecocode-rules-specifications/src/main/rules/EC27/EC27.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC27/java/EC27.asciidoc b/ecocode-rules-specifications/src/main/rules/EC27/java/EC27.asciidoc
new file mode 100644
index 000000000..455e0a137
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC27/java/EC27.asciidoc
@@ -0,0 +1,28 @@
+Using `System.arraycopy` to copy arrays
+
+Programs spend most of the time in loops. These can be resource consuming, especially when they integrate heavy processing (IO access). Moreover, the size of the data and processing inside the loops will not allow full use of hardware mechanisms such as the cache or compiler optimization mechanisms.
+
+For example, an array copy is potentially a non-performance source if it is poorly designed. Indeed, the use of a single copy loop can be twice as consuming as dedicated methods.
+Loops must be optimized to reduce processing time and make full use of hardware and processor mechanisms and optimizations.
+In the case of table copying (table), use the native `System.arraycopy`.
+We can also use `copyOf` or `clone` that are slightly less efficient.
+The looping method will be outlawed.
+
+## Noncompliant Code Example
+
+```java
+int len = array.length;
+boolean[] copy = new boolean[array.length];
+for (int i = 0; i < len; i++) {
+ copy[i] = array[i]; // Noncompliant
+}
+return copy;
+```
+
+## Compliant Solution
+
+```java
+int[] copy = new int[array.length];
+System.arraycopy(array, 0, copy, 0, array.length);
+return copy;
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC28.json b/ecocode-rules-specifications/src/main/rules/EC28/EC28.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC28.json
rename to ecocode-rules-specifications/src/main/rules/EC28/EC28.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC28/java/EC28.asciidoc b/ecocode-rules-specifications/src/main/rules/EC28/java/EC28.asciidoc
new file mode 100644
index 000000000..841ee9f8c
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC28/java/EC28.asciidoc
@@ -0,0 +1,30 @@
+Optimize read file exception
+
+## Noncompliant Code Example
+
+```java
+public void readPreferences(String filename) {
+ //...
+ InputStream in = null;
+ try {
+ in = new FileInputStream(filename);
+ } catch (FileNotFoundException e) {
+ logger.log(e);
+ }
+ in.read(...);
+ //...
+}
+```
+
+## Compliant Solution
+
+```java
+public void readPreferences(String filename) throws IllegalArgumentException, FileNotFoundException, IOException {
+ if (filename == null) {
+ throw new IllegalArgumentException ("filename is null");
+ }
+ //...
+ InputStream in = new FileInputStream(filename);
+ //...
+}
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC3.json b/ecocode-rules-specifications/src/main/rules/EC3/EC3.json
similarity index 93%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC3.json
rename to ecocode-rules-specifications/src/main/rules/EC3/EC3.json
index f511c1c2a..33916b15e 100644
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC3.json
+++ b/ecocode-rules-specifications/src/main/rules/EC3/EC3.json
@@ -7,6 +7,7 @@
"constantCost": "5min"
},
"tags": [
+ "bad-practice",
"eco-design",
"performance",
"ecocode"
diff --git a/ecocode-rules-specifications/src/main/rules/EC3/java/EC3.asciidoc b/ecocode-rules-specifications/src/main/rules/EC3/java/EC3.asciidoc
new file mode 100644
index 000000000..49fcb223e
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC3/java/EC3.asciidoc
@@ -0,0 +1,22 @@
+When iterating over any collection, fetch the size of the collection in advance to avoid fetching it on each iteration, this saves CPU cycles, and therefore consumes less power. The example provided below illustrates what should be avoided.
+
+## Noncompliant Code Example
+
+```java
+ListWhen function calls global variables, a lot a CPU cycles is consumed.
-Noncompliant Code Example
-
+When function calls global variables, a lot a CPU cycles is consumed.
+
+## Noncompliant Code Example
+
+```python
global_var = 'foo'
def print_global_var_details():
print(len(global_var)) # Noncompliant
print('Global var : ', global_var) # Noncompliant
print('Global var : ' + global_var) # Noncompliant
print_global_var_details()
-
-Compliant Solution
-
+```
+
+## Compliant Solution
+
+```python
global_var = 'foo';
def print_var_details(local_var) {
- print(len(local_var));
- print('Var : ', local_var)
- print('Var : ' + local_var)
+ print(len(local_var));
+ print('Var : ', local_var)
+ print('Var : ' + local_var)
}
print_length(global_var);
-
+```
diff --git a/ecocode-rules-specifications/src/main/rules/EC404/EC404.json b/ecocode-rules-specifications/src/main/rules/EC404/EC404.json
new file mode 100644
index 000000000..c04d919d3
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC404/EC404.json
@@ -0,0 +1,15 @@
+{
+ "title": "Use generator comprehension instead of list comprehension in for loop declaration",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "15min"
+ },
+ "tags": [
+ "performance",
+ "eco-design",
+ "ecocode"
+ ],
+ "defaultSeverity": "Minor"
+}
diff --git a/ecocode-rules-specifications/src/main/rules/EC404/python/EC404.asciidoc b/ecocode-rules-specifications/src/main/rules/EC404/python/EC404.asciidoc
new file mode 100644
index 000000000..4a0738f9f
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC404/python/EC404.asciidoc
@@ -0,0 +1,20 @@
+Use generator comprehension instead of list comprehension in for loop declaration.
+
+Python generators resemble lazy lists from other programming languages: when iterated over, they compute their values on the fly. They lack some list behaviors (indexing, len method, ...) but are memory-efficient, as they do not store each of their values in memory, unlike lists. Thus, when declared in a for-loop declaration, list comprehensions can be safely replaced with generator comprehensions.
+
+For more details on list comprehensions vs generator comprehensions, see https://docs.python.org/3/howto/functional.html#generator-expressions-and-list-comprehensions[Python documentation].
+
+## Noncompliant Code Example
+
+```python
+for var in [var2 for var2 in range(100)]:
+ ...
+
+```
+
+## Compliant Solution
+
+```python
+for var in (var2 for var2 in range(100)):
+ ...
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC5.json b/ecocode-rules-specifications/src/main/rules/EC5/EC5.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC5.json
rename to ecocode-rules-specifications/src/main/rules/EC5/EC5.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC5/java/EC5.asciidoc b/ecocode-rules-specifications/src/main/rules/EC5/java/EC5.asciidoc
new file mode 100644
index 000000000..229a3503d
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC5/java/EC5.asciidoc
@@ -0,0 +1,22 @@
+Use `PreparedStatement` instead of `Statement`, because SQL will only commit the query once, whereas if you used only one statement, it would commit the query every time and thus induce unnecessary calculations by the CPU and therefore superfluous energy consumption.
+
+## Noncompliant Code Example
+
+```java
+public void select() {
+ Statement statement = connection.createStatement();
+ statement.executeUpdate("INSERT INTO persons(id, name) VALUES(2, 'John DOE')"); // Noncompliant
+}
+```
+
+## Compliant Solution
+
+```java
+public void select() {
+ PreparedStatement statement = connection.prepareStatement(INSERT INTO persons(id, name) VALUES(?, ?));
+
+ statement.setInt(1, 2);
+ statement.setString(2, "John DOE");
+ statement.executeQuery();
+}
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC53.json b/ecocode-rules-specifications/src/main/rules/EC53/EC53.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC53.json
rename to ecocode-rules-specifications/src/main/rules/EC53/EC53.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC53/java/EC53.asciidoc b/ecocode-rules-specifications/src/main/rules/EC53/java/EC53.asciidoc
new file mode 100644
index 000000000..924efda63
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC53/java/EC53.asciidoc
@@ -0,0 +1,21 @@
+Using List instead of Arrays with Foreach save CPU cycles calculations and RAM consumption.
+
+## Noncompliant Code Example
+
+```java
+private final Integer[] intArray = new Integer[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
+
+for (Integer i : intArray) {
+ // ...
+}
+```
+
+## Compliant Solution
+
+```java
+private final ListAvoid using getters and setters in a class, as they increase unnecessary RAM memory usage.
-Noncompliant Code Example
-
+Avoid using getters and setters in a class, as they increase unnecessary RAM memory usage.
+
+## Noncompliant Code Example
+
+```python
class Client():
def __init__(self, age):
@@ -15,10 +17,11 @@ Noncompliant Code Example
client = Client(25)
client.get_age() # Getter inutile
client.set_age(25) # Setter inutile
+```
-
-Compliant Solution
-
+## Compliant Solution
+
+```python
class Client():
def __init__(self, age):
@@ -33,4 +36,5 @@ Compliant Solution
client = Client(25)
client.age # Récupérer l'attribut age
client.age = 26 # Modifier l'attribut age
-
+```
+
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC72.json b/ecocode-rules-specifications/src/main/rules/EC72/EC72.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC72.json
rename to ecocode-rules-specifications/src/main/rules/EC72/EC72.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC72/java/EC72.asciidoc b/ecocode-rules-specifications/src/main/rules/EC72/java/EC72.asciidoc
new file mode 100644
index 000000000..7032eb960
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC72/java/EC72.asciidoc
@@ -0,0 +1,50 @@
+Executing SQL queries in loop induced unnecessary calculation by the CPU, RAM usage and network transfer.
+
+## Noncompliant Code Example
+
+```java
+public void foo() {
+ // ...
+ String baseQuery = "SELECT name FROM users where id = ";
+
+ for (int i = 0; i < 20; i++) {
+
+ String query = baseQuery.concat("" + i);
+ Statement st = conn.createStatement();
+ ResultSet rs = st.executeQuery(query); // Noncompliant
+
+ // iterate through the java resultset
+ while (rs.next()) {
+ String name = rs.getString("name");
+ System.out.println(name);
+ }
+ st.close();
+ }
+ // ...
+}
+```
+
+## Compliant Solution
+
+```java
+public void foo() {
+ // ...
+ String query = "SELECT name FROM users where id in (0 ";
+ for (int i = 1; i < 20; i++) {
+
+ query = baseQuery.concat("," + i);
+ }
+
+ query = baseQuery.concat(")");
+ Statement st = conn.createStatement();
+ ResultSet rs = st.executeQuery(query); // compliant
+
+ // iterate through the java resultset
+ while (rs.next()) {
+ String name = rs.getString("name");
+ System.out.println(name);
+ }
+ st.close();
+ // ...
+}
+```
diff --git a/ecocode-rules-specifications/src/main/rules/EC72/php/1GB.etsdiff.csv b/ecocode-rules-specifications/src/main/rules/EC72/php/1GB.etsdiff.csv
new file mode 100644
index 000000000..b006091ac
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC72/php/1GB.etsdiff.csv
@@ -0,0 +1,3 @@
+Energy (J),73.907586,82.15627099999998
+Transfer (B),49526,221836
+Storage (B),637549572,637549572
diff --git a/ecocode-rules-specifications/src/main/rules/EC72/php/2GB.etsdiff.csv b/ecocode-rules-specifications/src/main/rules/EC72/php/2GB.etsdiff.csv
new file mode 100644
index 000000000..73f5bac22
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC72/php/2GB.etsdiff.csv
@@ -0,0 +1,3 @@
+Energy (J),159.4871645,169.746055
+Transfer (B),50385,228225
+Storage (B),1178614788,1178614788
diff --git a/ecocode-rules-specifications/src/main/rules/EC72/php/4GB.etsdiff.csv b/ecocode-rules-specifications/src/main/rules/EC72/php/4GB.etsdiff.csv
new file mode 100644
index 000000000..4c253ef72
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC72/php/4GB.etsdiff.csv
@@ -0,0 +1,3 @@
+Energy (J),395.7629349999999,404.37447649999996
+Transfer (B),51597,238884
+Storage (B),2357214212,2357214212
diff --git a/ecocode-rules-specifications/src/main/rules/EC72/php/8GB.etsdiff.csv b/ecocode-rules-specifications/src/main/rules/EC72/php/8GB.etsdiff.csv
new file mode 100644
index 000000000..2a518e5eb
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC72/php/8GB.etsdiff.csv
@@ -0,0 +1,3 @@
+Energy (J),992.128585,1005.4625534999999
+Transfer (B),52189,249499
+Storage (B),4685052932,4685052932
diff --git a/ecocode-rules-specifications/src/main/rules/EC72/php/EC72.asciidoc b/ecocode-rules-specifications/src/main/rules/EC72/php/EC72.asciidoc
new file mode 100644
index 000000000..12fe0d7b7
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC72/php/EC72.asciidoc
@@ -0,0 +1,91 @@
+Executing SQL queries in loop induced unnecessary network transfert, calculation by the cpu and RAM usage.
+
+## Noncompliant Code Example
+
+```php
+public function foo() {
+ ...
+ $baseQuery = "SELECT name FROM users where id = ";
+
+ for ($i = 0; $i < 20; ++$i) {
+
+ $query = $baseQuery . $i;
+ $connection = mysql_connect($dbhost, $dbuser, $dbpass) or die("Unable to Connect to '$dbhost'");
+ mysql_select_db($dbname) or die("Could not open the db '$dbname'");
+ $result = mysql_query($this->Query);// Noncompliant
+
+ // iterate through the result
+ ...
+ mysql_close($connection);
+ }
+ ...
+}
+```
+
+## Compliant Solution
+
+```php
+public function foo() {
+ ...
+ $query = "SELECT name FROM users where id in (";
+
+ for ($i = 0; $i < 20; ++$i) {
+ $query .= ',' . $i;
+ }
+ $query .= ')';
+
+ $connection = mysql_connect($dbhost, $dbuser, $dbpass) or die("Unable to Connect to '$dbhost'");
+ mysql_select_db($dbname) or die("Could not open the db '$dbname'");
+ $result = mysql_query($this->Query); // compliant
+
+ // iterate through the result
+ ...
+ mysql_close($connection);
+}
+```
+
+include::../../etsdiff-methodology.asciidoc[]
+
+## Case for a 1GB database:
+
+image::https://live.staticflickr.com/65535/52622813465_9c453a43b1_w.jpg[ETSdiff percent comparison" style="padding: 1rem;]
+
+[format=csv,cols="1h,1,1"]
+|===
+Source of impacts,Compliant,Non-compliant
+
+include::1GB.etsdiff.csv[]
+|===
+
+## Case for a 2GB database:
+
+image::https://live.staticflickr.com/65535/52622862388_720fd219ba_o.png[ETSdiff percent comparison" style="padding: 1rem;]
+
+[format=csv,cols="1h,1,1"]
+|===
+Source of impacts,Compliant,Non-compliant
+
+include::2GB.etsdiff.csv[]
+|===
+
+## Case for a 4GB database:
+
+image::https://live.staticflickr.com/65535/52622814395_f8aab7a5c0_o.png[ETSdiff percent comparison" style="padding: 1rem;]
+
+[format=csv,cols="1h,1,1"]
+|===
+Source of impacts,Compliant,Non-compliant
+
+include::4GB.etsdiff.csv[]
+|===
+
+## Case for a 8GB database:
+
+image::https://live.staticflickr.com/65535/52622635779_f1c5d9660e_o.png[ETSdiff percent comparison" style="padding: 1rem;]
+
+[format=csv,cols="1h,1,1"]
+|===
+Source of impacts,Compliant,Non-compliant
+
+include::8GB.etsdiff.csv[]
+|===
diff --git a/ecocode-rules-specifications/src/main/rules/EC72/python/EC72.asciidoc b/ecocode-rules-specifications/src/main/rules/EC72/python/EC72.asciidoc
new file mode 100644
index 000000000..ae85dfe3e
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC72/python/EC72.asciidoc
@@ -0,0 +1,23 @@
+Executing SQL queries in loop induced unnecessary calculation by the CPU, RAM usage and network transfer.
+
+## Noncompliant Code Example
+
+```python
+def foo():
+ ...
+ results = []
+ for id in range(20):
+ results.append(cursor.execute("SELECT name FROM users where id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}}
+ ...
+```
+
+## Compliant Solution
+
+```python
+def foo():
+ ...
+ ids = range(20)
+ results = cursor.execute("SELECT name FROM users where id IN ({0})".format(', '.join("?" * len(ids))), ids).fetchmany() # Compliant
+ ...
+}
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC74.json b/ecocode-rules-specifications/src/main/rules/EC74/EC74.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC74.json
rename to ecocode-rules-specifications/src/main/rules/EC74/EC74.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC74/java/EC74.asciidoc b/ecocode-rules-specifications/src/main/rules/EC74/java/EC74.asciidoc
new file mode 100644
index 000000000..4f1299b18
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC74/java/EC74.asciidoc
@@ -0,0 +1,21 @@
+Database servers have to resolve schema fields when using asterisk symbol (`*`). Knowing and using the schema saves CPU cycles and network transfer.
+
+## Noncompliant Code Example
+
+```java
+public void foo() {
+ // ...
+ String baseQuery = "SELECT * FROM users"; // Noncompliant
+ // ...
+}
+```
+
+## Compliant Solution
+
+```java
+public void foo() {
+ // ...
+ String query = "SELECT id, name, address FROM users";
+ // ...
+}
+```
diff --git a/ecocode-rules-specifications/src/main/rules/EC74/php/1GB.etsdiff.csv b/ecocode-rules-specifications/src/main/rules/EC74/php/1GB.etsdiff.csv
new file mode 100644
index 000000000..06710e417
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC74/php/1GB.etsdiff.csv
@@ -0,0 +1,3 @@
+Energy (J),0.040610499999999994,0.065223
+Transfer (B),779232,2697937
+Storage (B),637548827,637548827
diff --git a/ecocode-rules-specifications/src/main/rules/EC74/php/EC74.asciidoc b/ecocode-rules-specifications/src/main/rules/EC74/php/EC74.asciidoc
new file mode 100644
index 000000000..ffb380dd5
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC74/php/EC74.asciidoc
@@ -0,0 +1,34 @@
+Database servers have to resolve schema fields when using asterisk symbol (`*`). Knowing and using the schema saves CPU cycles and network transfer.
+
+## Noncompliant Code Example
+
+```php
+public function foo() {
+ ...
+ $baseQuery = "SELECT * FROM users"; // Noncompliant
+ ...
+}
+```
+
+## Compliant Solution
+
+```php
+public function foo() {
+ ...
+ $baseQuery = "SELECT id,name, address FROM users ";
+ ...
+}
+```
+
+include::../../etsdiff-methodology.asciidoc[]
+
+## Case for a 1GB database:
+
+image::https://live.staticflickr.com/65535/52622636584_52938fcf7e_o.png[ETSdiff percent comparison]
+
+[format=csv,cols="1h,1,1"]
+|===
+Source of impacts,Compliant,Non-compliant
+
+include::1GB.etsdiff.csv[]
+|===
diff --git a/ecocode-rules-specifications/src/main/rules/EC74/python/EC74.asciidoc b/ecocode-rules-specifications/src/main/rules/EC74/python/EC74.asciidoc
new file mode 100644
index 000000000..3b9b41c0f
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC74/python/EC74.asciidoc
@@ -0,0 +1,21 @@
+Database servers have to resolve schema fields when using asterisk symbol (`*`). Knowing and using the schema saves CPU cycles and network transfer.
+
+## Noncompliant Code Example
+
+```python
+public void foo() {
+ ...
+ String baseQuery = "SELECT * FROM users"; // Noncompliant
+ ...
+}
+```
+
+## Compliant Solution
+
+```python
+public void foo() {
+ ...
+ String query = "SELECT id, name, address FROM users ";
+ ...
+}
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC75.json b/ecocode-rules-specifications/src/main/rules/EC75/EC75.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC75.json
rename to ecocode-rules-specifications/src/main/rules/EC75/EC75.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC75/java/EC75.asciidoc b/ecocode-rules-specifications/src/main/rules/EC75/java/EC75.asciidoc
new file mode 100644
index 000000000..6cbc5ed2a
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC75/java/EC75.asciidoc
@@ -0,0 +1,38 @@
+Don't concatenate Strings in loop. Use `StringBuilder instead.
+
+Strings are immutable so each time you concatenate a String, a new String is created. This is a waste of memory and CPU.
+
+## Noncompliant Code Example
+
+```java
+public String concatenateStrings(String[] strings) {
+ String result = "";
+
+ for (String string : strings) {
+ result += string; // Noncompliant
+ }
+ return result;
+}
+
+public String concatenateStrings2() {
+ String result = "";
+
+ for (int i = 0; i < 1000; ++i) {
+ result += "another"; // Noncompliant
+ }
+ return result;
+}
+```
+
+## Compliant Solution
+
+```java
+public String concatenateStrings(String[] strings) {
+ StringBuilder result = new StringBuilder();
+
+ for (String string : strings) {
+ result.append(string);
+ }
+ return result.toString();
+}
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC76.json b/ecocode-rules-specifications/src/main/rules/EC76/EC76.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC76.json
rename to ecocode-rules-specifications/src/main/rules/EC76/EC76.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC76/java/EC76.asciidoc b/ecocode-rules-specifications/src/main/rules/EC76/java/EC76.asciidoc
new file mode 100644
index 000000000..f21e5298c
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC76/java/EC76.asciidoc
@@ -0,0 +1,36 @@
+Avoid usage of static collections.
+
+If you want to use static collections make them final and create for example a singleton if needed containing the collections.
+
+The static fields are more complicated for the Garbage Collector to manage and can lead to memory leaks.
+
+## Noncompliant Code Example
+
+```java
+/**
+ * Not compliant
+ */
+public class AvoidUsageOfStaticCollections {
+ public static final List<> LIST = new ArrayList<>();
+ public static final Set<> SET = new HashSet<>();
+ public static final Map<> MAP = new HashMap<>();
+}
+```
+
+## Compliant Solution
+
+```java
+/**
+ * Compliant
+ */
+public class GoodUsageOfStaticCollections {
+ public static volatile GoodUsageOfStaticCollections INSTANCE = new GoodUsageOfStaticCollections();
+
+ public final List<> LIST = new ArrayList<>();
+ public final Set<> SET = new HashSet<>();
+ public final Map<> MAP = new HashMap<>();
+
+ private GoodUsageOfStaticCollections() {
+ }
+}
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC77.json b/ecocode-rules-specifications/src/main/rules/EC77/EC77.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC77.json
rename to ecocode-rules-specifications/src/main/rules/EC77/EC77.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC77/java/EC77.asciidoc b/ecocode-rules-specifications/src/main/rules/EC77/java/EC77.asciidoc
new file mode 100644
index 000000000..188b8f648
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC77/java/EC77.asciidoc
@@ -0,0 +1,53 @@
+Avoid using `Pattern.compile()` in a non-static context.
+This operation requires a significant amount of computational power, Using a single match saves CPU cycles and RAM consumption.
+
+## Noncompliant Code Example
+
+```java
+public class AvoidRegexPatternNotStatic {
+ public boolean foo() {
+ final Pattern pattern = Pattern.compile("foo"); // Noncompliant
+ return pattern.matcher("foo").find();
+ }
+}
+```
+
+## Compliant Solution N°1
+
+```java
+public class ValidRegexPattern {
+ private static final Pattern pattern = Pattern.compile("foo"); // Compliant
+
+ public boolean foo() {
+ return pattern.matcher("foo").find();
+ }
+}
+```
+
+## Compliant Solution N°2
+
+```java
+public class ValidRegexPattern2 {
+ private final Pattern pattern = Pattern.compile("foo"); // Compliant
+
+ public boolean foo() {
+ return pattern.matcher("foo").find();
+ }
+}
+```
+
+## Compliant Solution N°3
+
+```java
+public class ValidRegexPattern3 {
+ private final Pattern pattern;
+
+ public ValidRegexPattern3() {
+ pattern = Pattern.compile("foo"); // Compliant
+ }
+
+ public boolean foo() {
+ return pattern.matcher("foo").find();
+ }
+}
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC78.json b/ecocode-rules-specifications/src/main/rules/EC78/EC78.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC78.json
rename to ecocode-rules-specifications/src/main/rules/EC78/EC78.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC78/java/EC78.asciidoc b/ecocode-rules-specifications/src/main/rules/EC78/java/EC78.asciidoc
new file mode 100644
index 000000000..3153a8742
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC78/java/EC78.asciidoc
@@ -0,0 +1,34 @@
+Don't set a constant parameter in batch update. Instead, put it in query. Creating this parameter and destroying it consumes CPU cycles and RAM unnecessarily.
+
+## Noncompliant Code Example
+
+```java
+public void foo() {
+ // ...
+ String query = "insert into mytable values(?,?,?)";
+ // ...
+ for(DummyClass o : list) {
+ stmt.setInt(1, 123); // Noncompliant
+ stmt.setString(2, o.getName());
+ stmt.setDouble(3, o.getPrice());
+ stmt.addBatch();
+ }
+ // ...
+}
+```
+
+## Compliant Solution
+
+```java
+public void foo() {
+ // ...
+ String query = "insert into mytable values(123,?,?)";
+ // ...
+ for(DummyClass o : list) {
+ stmt.setString(1, o.getName());
+ stmt.setDouble(2, o.getPrice());
+ stmt.addBatch();
+ }
+ // ...
+}
+```
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC79.json b/ecocode-rules-specifications/src/main/rules/EC79/EC79.json
similarity index 100%
rename from java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC79.json
rename to ecocode-rules-specifications/src/main/rules/EC79/EC79.json
diff --git a/ecocode-rules-specifications/src/main/rules/EC79/java/EC79.asciidoc b/ecocode-rules-specifications/src/main/rules/EC79/java/EC79.asciidoc
new file mode 100644
index 000000000..ef8bc2156
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC79/java/EC79.asciidoc
@@ -0,0 +1,28 @@
+Use `try-with-resources` statement for any object that implements the `AutoCloseable` interface, it save computer resources.
+
+## Noncompliant Code Example
+
+```java
+private static void printFileJava7() throws IOException {
+ FileInputStream input = new FileInputStream("file.txt");
+ int data = input.read();
+ while(data != -1){
+ System.out.print((char) data);
+ data = input.read();
+ }
+}
+```
+
+## Compliant Solution
+
+```java
+private static void printFileJava7() throws IOException {
+ try(FileInputStream input = new FileInputStream("file.txt")) {
+ int data = input.read();
+ while(data != -1){
+ System.out.print((char) data);
+ data = input.read();
+ }
+ }
+}
+```
diff --git a/ecocode-rules-specifications/src/main/rules/EC8/EC8.json b/ecocode-rules-specifications/src/main/rules/EC8/EC8.json
new file mode 100644
index 000000000..232f1ce0a
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC8/EC8.json
@@ -0,0 +1,19 @@
+{
+ "title": "Avoid using high accuracy geolocation in web applications.",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "5min"
+ },
+ "tags": [
+ "eco-design",
+ "performance",
+ "ecocode"
+ ],
+ "defaultSeverity": "Major",
+ "compatibleLanguages": [
+ "JAVASCRIPT",
+ "TYPESCRIPT"
+ ]
+}
diff --git a/ecocode-rules-specifications/src/main/rules/EC8/js/EC8.asciidoc b/ecocode-rules-specifications/src/main/rules/EC8/js/EC8.asciidoc
new file mode 100644
index 000000000..7528b2bb2
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC8/js/EC8.asciidoc
@@ -0,0 +1,43 @@
+## Rule details
+
+This rule aims at reducing CPU consumption by telling the device to use a less accurate yet more eco-friendly geolocation, when geolocation API is used.
+
+## Examples
+
+Examples of **non-compliant** code for this rule:
+
+```js
+var options = { enableHighAccuracy: true, timeout: 5000, maximumAge: 0 };
+function success(pos) {
+ console.log(pos.coords);
+}
+
+function error(err) {
+ console.warn(err);
+}
+
+navigator.geolocation.getCurrentPosition(success, error, options);
+```
+
+Examples of **compliant** code for this rule:
+
+```js
+// enableHighAccuracy is false by default, so not declaring it is correct
+function success(pos) {
+ console.log(pos);
+}
+navigator.geolocation.getCurrentPosition(success);
+```
+
+```js
+var options = { enableHighAccuracy: false, timeout: 5000, maximumAge: 0 };
+function success(pos) {
+ console.log(pos.coords);
+}
+
+function error(err) {
+ console.warn(err);
+}
+
+navigator.geolocation.getCurrentPosition(success, error, options);
+```
diff --git a/ecocode-rules-specifications/src/main/rules/EC9/EC9.json b/ecocode-rules-specifications/src/main/rules/EC9/EC9.json
new file mode 100644
index 000000000..99e524b50
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC9/EC9.json
@@ -0,0 +1,19 @@
+{
+ "title": "Should not import all from library",
+ "type": "CODE_SMELL",
+ "status": "ready",
+ "remediation": {
+ "func": "Constant\/Issue",
+ "constantCost": "15min"
+ },
+ "tags": [
+ "eco-design",
+ "performance",
+ "ecocode"
+ ],
+ "defaultSeverity": "Major",
+ "compatibleLanguages": [
+ "JAVASCRIPT",
+ "TYPESCRIPT"
+ ]
+}
diff --git a/ecocode-rules-specifications/src/main/rules/EC9/js/EC9.asciidoc b/ecocode-rules-specifications/src/main/rules/EC9/js/EC9.asciidoc
new file mode 100644
index 000000000..c6be22d50
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/EC9/js/EC9.asciidoc
@@ -0,0 +1,69 @@
+## Rule details
+
+This rule aims to reduce weight of programs by using only needed modules. Many libraries export only one module by default, but some of them are exporting ES modules or submodules. We should use them to select more precisly needed modules and avoid unnecessarily overloading files weight.
+
+*Example with the well-known https://lodash.com/[lodash] library, if you only need
+`isEmpty` method.*
+
+
+|===
+|Full lodash library |Only `isEmpty` method
+
+a|index.js - 531.46 KB
+
+* node_modules/lodash - 531.35 KB
+** lodash.js - 531.35 KB
+
+a|index.js - 24.42 KB
+
+* node_modules/lodash - 24.31 KB
+** isEmpty - 1.95 KB
+** _nodeUtil.js - 995 B
+** isArrayLike.js - 830 B
+** ...
+
+|===
+
+## Options
+
+You can externally add your own libraries to be checked. To add your own libraries you need to modify your .eslintrc.js by adding the following rule configuration:
+
+```js
+module.exports = {
+ ...yourConf,
+ rules: {
+ "no-import-all-from-library": [
+ "warn",
+ {
+ notAllowedLibraries: ["some-lib"], // will check for -> import someLib from "some-lib"
+ importByNamespaceNotAllowedLibraries: ["some-other-lib"], // will check for -> import * as someOtherLib from "some-other-lib"
+ },
+ ],
+ },
+};
+```
+
+## Examples
+
+Examples of **non-compliant** code for this rule:
+
+```js
+// Example with lodash
+import lodash from "lodash";
+import { isEmpty } from "lodash";
+import * as lodash from "lodash";
+
+// Example with underscore
+import _ from "underscore";
+```
+
+Examples of **compliant** code for this rule:
+
+```js
+// Example with lodash (uses submodules)
+import isEmpty from "lodash/isEmpty";
+import intersect from "lodash/intersect";
+
+// Example with underscore (uses esm modules)
+import map from "underscore/modules/map.js";
+```
diff --git a/ecocode-rules-specifications/src/main/rules/etsdiff-methodology.asciidoc b/ecocode-rules-specifications/src/main/rules/etsdiff-methodology.asciidoc
new file mode 100644
index 000000000..3239fa7d4
--- /dev/null
+++ b/ecocode-rules-specifications/src/main/rules/etsdiff-methodology.asciidoc
@@ -0,0 +1,11 @@
+## The three sources of impacts of a code identified are:
+
+- Energy: measured in joules (J)
+- Transfer: measured in Bytes (B)
+- Storage: measured in Bytes (B)
+
+The control of these 3 impacts allows to lengthen the life of the terminals as well as reduce their energy consumption.
+
+The _ETSdiff_ tool allows measuring a differential on these three values and in a given context (database and fixed measurement environment).
+
+The results generated by _ETSdiff_ must help define the interest of the rule reported by _SonarQube_ in the context of the code analyzed.
diff --git a/java-plugin/pom.xml b/java-plugin/pom.xml
index 0a956e82e..2f4e2476b 100644
--- a/java-plugin/pom.xml
+++ b/java-plugin/pom.xml
@@ -16,21 +16,24 @@
Prefer local variables to globals
", - priority = Priority.MINOR, - tags = {"performance", "eco-design", "ecocode"}) +@Rule(key = "EC4") @DeprecatedRuleKey(repositoryKey = "greencodeinitiative-java", ruleKey = "D4") public class AvoidUsingGlobalVariablesCheck extends IssuableSubscriptionVisitor { diff --git a/java-plugin/src/main/java/fr/greencodeinitiative/java/checks/FreeResourcesOfAutoCloseableInterface.java b/java-plugin/src/main/java/fr/greencodeinitiative/java/checks/FreeResourcesOfAutoCloseableInterface.java index 0cacf32d0..fb41ba0f7 100644 --- a/java-plugin/src/main/java/fr/greencodeinitiative/java/checks/FreeResourcesOfAutoCloseableInterface.java +++ b/java-plugin/src/main/java/fr/greencodeinitiative/java/checks/FreeResourcesOfAutoCloseableInterface.java @@ -8,7 +8,6 @@ import javax.annotation.ParametersAreNonnullByDefault; -import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.plugins.java.api.IssuableSubscriptionVisitor; import org.sonar.plugins.java.api.JavaFileScannerContext; @@ -19,12 +18,7 @@ import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey; -@Rule( - key = "EC79", - name = "Developpement", - description = FreeResourcesOfAutoCloseableInterface.MESSAGE_RULE, - priority = Priority.MINOR, - tags = {"performance", "eco-design", "ecocode"}) +@Rule(key = "EC79") @DeprecatedRuleKey(repositoryKey = "greencodeinitiative-java", ruleKey = "S79") public class FreeResourcesOfAutoCloseableInterface extends IssuableSubscriptionVisitor { private final DequeThe use of Spring repository in a loop induces unnecessary calculations by the CPU and therefore superfluous energy consumption.
-Noncompliant Code Example
-
- private final List<Integer> ids = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
-
- List<Employee> employees = new ArrayList<>();
-
- for (Integer id: ids) {
- Optional<Employee> employee = employeeRepository.findById(id); // Noncompliant
- if (employee.isPresent()) {
- employees.add(employee.get());
- }
- }
-
-
-Compliant Solution
-- private final List<Integer> ids = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10); - List<Employee> employees = employeeRepository.findAllById(ids); -diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC2.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC2.html deleted file mode 100644 index 7e5fcc2a0..000000000 --- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC2.html +++ /dev/null @@ -1,31 +0,0 @@ -
If we are using too many conditional if-else statements it will impact performance since JVM will have to compare the conditions. We can think of using a switch statement instead of multiple if-else if possible. Switch statement has a performance advantage over if – else.
- -Non-compliant Code Example
-
- int index = 1;
- int nb = 2;
-
- if (nb > index) {
- nb = nb + index;
- } else {
- nb = nb - 1;
- }
- if (nb != index + 1) {
- nb = nb + index;
- } else {
- nb = nb - 1;
- }
-
-
-
-Compliant Code Example
-
- int index = 1;
- int nb = 2;
-
- if (nb > index) {
- nb = nb + index;
- } else {
- nb = nb - 1;
- }
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC27.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC27.html
deleted file mode 100644
index 8bfb72e6b..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC27.html
+++ /dev/null
@@ -1,24 +0,0 @@
-Using System.arraycopy to copy arrays
-
- Programs spend most of the time in loops. These can be resource consuming, especially when they integrate heavy processing (IO access). Moreover, the size of the data and processing inside the loops will not allow full use of hardware mechanisms such as the cache or compiler optimization mechanisms.
- For example, an array copy is potentially a non-performance source if it is poorly designed. Indeed, the use of a single copy loop can be twice as consuming as dedicated methods.
- Loops must be optimized to reduce processing time and make full use of hardware and processor mechanisms and optimizations.
- In the case of table copying (table), the native System.arraycopy.
- We can also use copyOf or clone that are slightly less efficient.
- The looping method will be outlawed.
-
Noncompliant Code Example
-
- int len = array.length;
- boolean[] copy = new boolean[array.length];
- for (int i = 0; i < len; i++) {
- copy[i] = array[i]; // Noncompliant
- }
- return copy;
-
-Compliant Solution
-- int[] copy = new int[array.length]; - System.arraycopy(array, 0, copy, 0, array.length); - return copy; -diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC28.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC28.html deleted file mode 100644 index d37bcef22..000000000 --- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC28.html +++ /dev/null @@ -1,29 +0,0 @@ -
Optimize read file exception
-Noncompliant Code Example
-
- public void readPreferences(String filename) {
- //...
- InputStream in = null;
- try {
- in = new FileInputStream(filename);
- } catch (FileNotFoundException e) {
- logger.log(e);
- }
- in.read(...);
- //...
- }
-
-
-Compliant Solution
-
- public void readPreferences(String filename)
- throws IllegalArgumentException,
- FileNotFoundException, IOException {
- if (filename == null) {
- throw new IllegalArgumentException ("filename is null");
- } //if
- //...
- InputStream in = new FileInputStream(filename);
- //...
- }
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC3.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC3.html
deleted file mode 100644
index b347d7141..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC3.html
+++ /dev/null
@@ -1,19 +0,0 @@
-When iterating over any collection, fetch the size of the collection in advance to avoid fetching it on each iteration, this saves CPU cycles, and therefore consumes less power. The example provided below illustrates what should be avoided.
-Noncompliant Code Example
-
- List<String> objList = getData();
-
- for (int i = 0; i < objList.size(); i++) { // Noncompliant
- // execute code
- }
-
-
-Compliant Solution
-
- List<String> objList = getData();
-
- int size = objList.size();
- for (int i = 0; i < size; i++) {
- // execute code
- }
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC32.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC32.html
deleted file mode 100644
index 253090269..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC32.html
+++ /dev/null
@@ -1,19 +0,0 @@
-- If you know in advance how many characters would be appended, initialize builder/buffer with the appropriate size. - They will thus never have to be resized. - This saves CPU cycles and therefore consumes less energy. -
-Noncompliant Code Example
-
- StringBuilder sb = new StringBuilder(); // Noncompliant
- for (int i = 0; i < 100; i++) {
- sb.append(...);
- }
-
-Compliant Solution
-
- StringBuilder sb = new StringBuilder(100);
- for (int i = 0; i < 100; i++) {
- sb.append(...);
- }
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC4.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC4.html
deleted file mode 100644
index e95fd679d..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC4.html
+++ /dev/null
@@ -1,34 +0,0 @@
-- Prefer local variables as parameters -
-When calling a global variable, the interpretation engine must check that it exists in all the scopes, that it has a value, etc. Passing global variables as arguments gives them the status of local variables inside the function, thus saving computing time (CPU cycles). -
-
-CASE 1 (Avoid as possible):
-You are back on the service code. You see that the func1() uses globalVariabl1. Okay, but whats its value by now ? How does it change ? Who mutates the globalVariabl1 before it comes to this function ? What have been the sequence of all these mutations ? You would have no idea. It will be quite difficult to figure all this out.
-
-CASE 2 (Recommended):
-You are back to you code, and see that the func0() fetches something and then passes it to func1(param1) as a parameter. You clearly know what the data is, how does it gets here.
-
Noncompliant Code Example
-
- var aGlobal = new String('Hello');
-
- function globalLength(){
- length = aGlobal.length;
- console.log(length);
- }
-
- globalLength();
-
-Compliant Solution
-
- var aGlobal = new String('Hello');
-
- function someVarLength(str){
- length = str.length;
- console.log(length);
- }
-
- somVarLength(aGlobal);
-
\ No newline at end of file
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC5.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC5.html
deleted file mode 100644
index 3fd5bb834..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC5.html
+++ /dev/null
@@ -1,18 +0,0 @@
-Use PreparedStatement instead of Statement, because SQL will only commit the query once, whereas if you used only one statement, it would commit the query every time and thus induce unnecessary calculations by the CPU and therefore superfluous energy consumption.
Noncompliant Code Example
-
- public void select() {
- Statement statement = connection.createStatement();
- statement.executeUpdate("INSERT INTO persons(id, name) VALUES(2, 'Toto')"); // Noncompliant
- }
-
-Compliant Solution
-
- public void select() {
- PreparedStatement statement = connection.prepareStatement(INSERT INTO persons(id, name) VALUES(?, ?));
-
- statement.setInt(1, 2);
- statement.setString(2, "Toto");
- statement.executeQuery();
- }
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC53.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC53.html
deleted file mode 100644
index b1d548c92..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC53.html
+++ /dev/null
@@ -1,18 +0,0 @@
-Using List instead of Arrays with Foreach save CPU cycles calculations and RAM consumption.
-Noncompliant Code Example
-
- private final Integer[] intArray = new Integer[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
-
- for (Integer i : intArray) {
- ...
- }
-
-
-Compliant Solution
-
- private final List<Integer> intList = Arrays.asList(new Integer[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 });
-
- for (Integer i : intList) {
- ...
- }
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC63.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC63.html
deleted file mode 100644
index be6d491d4..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC63.html
+++ /dev/null
@@ -1,12 +0,0 @@
-Do not unnecessarily assign values to variables. It increases the use of RAM memory.
-Noncompliant Code Example
--String var1 = getValue(); -return var1; - -String var2 = "hello" -var2 = "world" //Non compliant cause never assigned - --
Compliant Solution
-return getValue();diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC67.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC67.html deleted file mode 100644 index 3c55323e5..000000000 --- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC67.html +++ /dev/null @@ -1,7 +0,0 @@ -
The form $i++ creates a temporary variable whereas ++$i does not. It save CPU cycles.
-Noncompliant Code Example
--i++ // Noncompliant --
Compliant Solution
-++idiff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC69.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC69.html deleted file mode 100644 index 5d8c46aa1..000000000 --- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC69.html +++ /dev/null @@ -1,23 +0,0 @@ -
Do not call a function when declaring a for-type loop in order to avoid function calls each iterations. It saves CPU cycles.
-Noncompliant Code Example
-
- public void foo() {
- for (int i = 0; i < getMyValue(); i++) { // Noncompliant
- System.out.println(i);
- boolean b = getMyValue() > 6;
- }
- }
-
-
-Compliant Solution
-
-
- public void foo() {
- int myValue = getMyValue();
- for (int i = 0; i < myValue; i++) {
- System.out.println(i);
- boolean b = getMyValue() > 6;
- }
- }
-
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC72.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC72.html
deleted file mode 100644
index 7c6588afb..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC72.html
+++ /dev/null
@@ -1,49 +0,0 @@
-Executing SQL queries in loop induced unnecessary calculation by the cpu, RAM usage and network transfer.
-Noncompliant Code Example
-
- public void foo() {
- ...
- String baseQuery = "SELECT name FROM users where id = ";
-
- for (int i = 0; i < 20; i++) {
-
- String query = baseQuery.concat("" + i);
- Statement st = conn.createStatement();
- ResultSet rs = st.executeQuery(query); // Noncompliant
-
- // iterate through the java resultset
- while (rs.next()) {
- String name = rs.getString("name");
- System.out.println(name);
- }
- st.close();
- }
- ...
- }
-
-
-Compliant Solution
-
-
- public void foo() {
- ...
- String query = "SELECT name FROM users where id in (0 ";
- for (int i = 1; i < 20; i++) {
-
- query = baseQuery.concat("," + i);
- }
-
- query = baseQuery.concat(")");
- Statement st = conn.createStatement();
- ResultSet rs = st.executeQuery(query); // compliant
-
- // iterate through the java resultset
- while (rs.next()) {
- String name = rs.getString("name");
- System.out.println(name);
- }
- st.close();
- ...
- }
-
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC74.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC74.html
deleted file mode 100644
index 35ffbf7af..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC74.html
+++ /dev/null
@@ -1,21 +0,0 @@
-Database servers have to resolve schema fields when using asterisk symbol (*). Knowing and using the schema saves CPU cycles and network transfer.
-Noncompliant Code Example
-
- public void foo() {
- ...
- String baseQuery = "SELECT * FROM users"; // Noncompliant
-
- ...
- }
-
-
-Compliant Solution
-
-
- public void foo() {
- ...
- String query = "SELECT id, name, address FROM users ";
- ...
- }
-
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC75.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC75.html
deleted file mode 100644
index 67c1c1ccf..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC75.html
+++ /dev/null
@@ -1,41 +0,0 @@
-
- Don't concatenate Strings in loop. User StringBuilder instead.
- Strings are immutable so each time you concatenate a String, a new String is created. This is a waste of memory and CPU.
-
Noncompliant Code Example
-
-
- public String concatenateStrings(String[] strings) {
- String result = "";
-
- for (String string : strings) {
- result += string; // Noncompliant
- }
- return result;
- }
-
- public String concatenateStrings2() {
- String result = "";
-
- for (int i = 0; i < 1000; ++i) {
- result += "another"; // Noncompliant
- }
- return result;
- }
-
-
-
-Compliant Solution
-
-
- public String concatenateStrings(String[] strings) {
- StringBuilder result = new StringBuilder();
-
- for (String string : strings) {
- result.append(string);
- }
- return result.toString();
- }
-
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC76.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC76.html
deleted file mode 100644
index 608b0285b..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC76.html
+++ /dev/null
@@ -1,38 +0,0 @@
-
- Avoid usage of static collections.
- If you want to use static collections make them final and create for example a singleton if needed containing the collections.
- The static fields are more complicated for the Garbage Collector to manage and can lead to memory leaks.
-
Noncompliant Code Example
-
-
- /**
- * Not compliant
- */
- public class AvoidUsageOfStaticCollections {
- public static final List<> LIST = new ArrayList<>();
- public static final Set<> SET = new HashSet<>();
- public static final Map<> MAP = new HashMap<>();
- }
-
-
-
-Compliant Solution
-
-
- /**
- * Compliant
- */
- public class GoodUsageOfStaticCollections {
- public static volatile GoodUsageOfStaticCollections INSTANCE = new GoodUsageOfStaticCollections();
-
- public final List<> LIST = new ArrayList<>();
- public final Set<> SET = new HashSet<>();
- public final Map<> MAP = new HashMap<>();
-
- private GoodUsageOfStaticCollections() {
- }
- }
-
-
\ No newline at end of file
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC77.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC77.html
deleted file mode 100644
index f0aed4f4f..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC77.html
+++ /dev/null
@@ -1,67 +0,0 @@
-- Avoid using Pattern.compile() in a non-static context. - This operation requires a significant amount of computational power, Using a single match saves CPU cycles and RAM consumption. -
- -Noncompliant Code Example
-
-
- public class AvoidRegexPatternNotStatic {
-
- public boolean foo() {
- final Pattern pattern = Pattern.compile("foo"); // Noncompliant
- return pattern.matcher("foo").find();
- }
-
- }
-
-
-
-Compliant Solution N°1
-
-
- public class ValidRegexPattern {
-
- private static final Pattern pattern = Pattern.compile("foo"); // Compliant
-
- public boolean foo() {
- return pattern.matcher("foo").find();
- }
-
- }
-
-
-
-Compliant Solution N°2
-
-
- public class ValidRegexPattern2 {
-
- private final Pattern pattern = Pattern.compile("foo"); // Compliant
-
- public boolean foo() {
- return pattern.matcher("foo").find();
- }
-
- }
-
-
-
-Compliant Solution N°3
-
-
- public class ValidRegexPattern3 {
-
- private final Pattern pattern;
-
- public ValidRegexPattern3() {
- pattern = Pattern.compile("foo"); // Compliant
- }
-
- public boolean foo() {
- return pattern.matcher("foo").find();
- }
-
- }
-
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC78.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC78.html
deleted file mode 100644
index 2b0c687b0..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC78.html
+++ /dev/null
@@ -1,30 +0,0 @@
-Don't set const parameter in batch update => Put its in query. Creating this parameter and destroying it consumes CPU cycles and RAM unnecessarily.
-Noncompliant Code Example
-
- public void foo() {
- ...
- String query = "insert into mytable values(?,?,?)";
- ...
- for(DummyClass o : list) {
- stmt.setInt(1, 123); // Noncompliant
- stmt.setString(2, o.getName());
- stmt.setDouble(3, o.getPrice());
- stmt.addBatch();
- }
- ...
- }
-
-Compliant Solution
-
- public void foo() {
- ...
- String query = "insert into mytable values(123,?,?)";
- ...
- for(DummyClass o : list) {
- stmt.setString(1, o.getName());
- stmt.setDouble(2, o.getPrice());
- stmt.addBatch();
- }
- ...
- }
-
diff --git a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC79.html b/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC79.html
deleted file mode 100644
index f8801ef21..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC79.html
+++ /dev/null
@@ -1,24 +0,0 @@
-try-with-resources Statement needs to be implemented for any object that implements the AutoCloseable interface, it save computer resources.
-Noncompliant Code Example
-
- private static void printFileJava7() throws IOException {
- FileInputStream input = new FileInputStream("file.txt");
- int data = input.read();
- while(data != -1){
- System.out.print((char) data);
- data = input.read();
- }
- }
-
-Compliant Solution
-
- private static void printFileJava7() throws IOException {
- try(FileInputStream input = new FileInputStream("file.txt")) {
- int data = input.read();
- while(data != -1){
- System.out.print((char) data);
- data = input.read();
- }
- }
- }
-
diff --git a/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaPluginTest.java b/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaPluginTest.java
index c925ece4e..3d09e5b0e 100644
--- a/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaPluginTest.java
+++ b/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaPluginTest.java
@@ -16,6 +16,7 @@
*/
package fr.greencodeinitiative.java;
+import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.sonar.api.Plugin;
import org.sonar.api.SonarRuntime;
@@ -24,14 +25,17 @@
import static org.mockito.Mockito.mock;
class JavaPluginTest {
+ private Plugin.Context context;
- @Test
- void testName() {
+ @BeforeEach
+ void init() {
SonarRuntime sonarRuntime = mock(SonarRuntime.class);
- Plugin.Context context = new Plugin.Context(sonarRuntime);
-
+ context = new Plugin.Context(sonarRuntime);
new JavaPlugin().define(context);
+ }
+ @Test
+ void test() {
assertThat(context.getExtensions()).hasSize(2);
}
diff --git a/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaRulesDefinitionTest.java b/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaRulesDefinitionTest.java
index 20aabc21c..bb6f796d3 100644
--- a/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaRulesDefinitionTest.java
+++ b/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaRulesDefinitionTest.java
@@ -24,38 +24,65 @@
import org.sonar.api.rules.RuleType;
import org.sonar.api.server.debt.DebtRemediationFunction.Type;
import org.sonar.api.server.rule.RulesDefinition;
-import org.sonar.api.server.rule.RulesDefinition.Param;
-import org.sonar.api.server.rule.RulesDefinition.Repository;
import org.sonar.api.server.rule.RulesDefinition.Rule;
import org.sonar.api.utils.Version;
import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.fail;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
class JavaRulesDefinitionTest {
private RulesDefinition.Repository repository;
+ private RulesDefinition.Context context;
@BeforeEach
void init() {
- SonarRuntime sonarRuntime = mock(SonarRuntime.class);
+ // TODO: Remove this check after Git repo split
+ /*
+ On an IDE (like IntelliJ), if the developer runs the unit tests without building/generating the Maven goals on the
+ "ecocode-rules-specifications" module before, the unit tests will not see the generated HTML descriptions (from ASCIIDOC files).
+ The developer must therefore configure his IDE to build the `ecocode-rules-specifications` module before launching the Tests.
+
+ When the `java-plugin` submodule is in a specific Git repository, `ecocode-rules-specifications` will be fetched from a classic
+ external Maven dependency. There will therefore no longer be any need to perform this specific configuration.
+ */
+ if (JavaRulesDefinition.class.getResource("/io/ecocode/rules/java/EC4.json") == null) {
+ String message = "'ecocode-rules-specification' resources corrupted. Please check build of 'ecocode-rules-specification' module";
+ if (System.getProperties().keySet().stream().anyMatch(k -> k.toString().startsWith("idea."))) {
+ message += "\n\nOn 'IntelliJ IDEA':" +
+ "\n1. go to settings :" +
+ "\n > Build, Execution, Deployment > Build Tools > Maven > Runner" +
+ "\n2. check option:" +
+ "\n > Delegate IDE build/run actions to Maven" +
+ "\n3. Click on menu: " +
+ "\n > Build > Build Project"
+ ;
+ }
+ fail(message);
+ }
+
+ final SonarRuntime sonarRuntime = mock(SonarRuntime.class);
doReturn(Version.create(0, 0)).when(sonarRuntime).getApiVersion();
JavaRulesDefinition rulesDefinition = new JavaRulesDefinition(sonarRuntime);
RulesDefinition.Context context = new RulesDefinition.Context();
rulesDefinition.define(context);
- repository = context.repository(JavaRulesDefinition.REPOSITORY_KEY);
+ repository = context.repository(rulesDefinition.repositoryKey());
}
@Test
- void test() {
- assertThat(repository.name()).isEqualTo(JavaRulesDefinition.NAME);
- assertThat(repository.language()).isEqualTo(JavaRulesDefinition.LANGUAGE);
- assertThat(repository.rules()).hasSize(RulesList.getChecks().size());
- assertThat(repository.rules().stream().filter(Rule::template)).isEmpty();
+ @DisplayName("Test repository metadata")
+ void testMetadata() {
+ assertThat(repository.name()).isEqualTo("ecoCode");
+ assertThat(repository.language()).isEqualTo("java");
+ assertThat(repository.key()).isEqualTo("ecocode-java");
+ assertThat(repository.rules()).hasSize(19);
+ }
- assertRuleProperties(repository);
- assertAllRuleParametersHaveDescription(repository);
+ @Test
+ void testRegistredRules() {
+ assertThat(repository.rules()).hasSize(19);
}
@Test
@@ -68,7 +95,8 @@ void testRuleKeyPrefix() {
assertions.assertAll();
}
- private static void assertRuleProperties(Repository repository) {
+ @Test
+ void assertRuleProperties() {
Rule rule = repository.rule("EC67");
assertThat(rule).isNotNull();
assertThat(rule.name()).isEqualTo("Use ++i instead of i++");
@@ -76,12 +104,13 @@ private static void assertRuleProperties(Repository repository) {
assertThat(rule.type()).isEqualTo(RuleType.CODE_SMELL);
}
- private static void assertAllRuleParametersHaveDescription(Repository repository) {
- for (Rule rule : repository.rules()) {
- for (Param param : rule.params()) {
- assertThat(param.description()).as("description for " + param.key()).isNotEmpty();
- }
- }
+ @Test
+ void testAllRuleParametersHaveDescription() {
+ SoftAssertions assertions = new SoftAssertions();
+ repository.rules().stream()
+ .flatMap(rule -> rule.params().stream())
+ .forEach(param -> assertions.assertThat(param.description()).as("description for " + param.key()).isNotEmpty());
+ assertions.assertAll();
}
}
diff --git a/php-plugin/pom.xml b/php-plugin/pom.xml
index 29f2e31b3..c034e7e3b 100644
--- a/php-plugin/pom.xml
+++ b/php-plugin/pom.xml
@@ -16,16 +16,24 @@
Use of methods for basic operations
-Noncompliant Code Example
-- $min = min($a, $b); // Noncompliant --
Compliant Solution
-- $min = $a < $b ? $a : $b; -diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC3.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC3.html deleted file mode 100644 index 3eace53ff..000000000 --- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC3.html +++ /dev/null @@ -1,93 +0,0 @@ -
When iterating over any collection, fetch the size of the collection in advance to avoid fetching it on each iteration, this saves CPU cycles, and therefore consumes less power.
-NB : note that we are using the count() method to get the size of an array but it would work the same with the sizeof() and iterator_count() methods
- -Noncompliant Code Examples
-
- $array = array('orange', 'banana', 'apple', 'carrot', 'collard', 'pea');
-
- // FOR STATEMENTS / Right operand
- for ($i = 0; $i < count($array); ++$i) {
- var_dump($array[$i]);
- }
-
- // FOR STATEMENTS / Left operand
- for ($i = 0; count($array) > $i; ++$i) {
- var_dump($array[$i]);
- }
-
- // WHILE STATEMENTS / Right operand
- $i = 0;
- while($i < count($array)) {
- var_dump($array[$i]);
- ++$i;
- }
-
- // WHILE STATEMENTS / Left operand
- $i = 0;
- while(count($array) > $i) {
- var_dump($array[$i]);
- ++$i;
- }
-
- // DO WHILE STATEMENTS / Right operand
- $i = 0;
- do {
- var_dump($array[$i]);
- ++$i;
- } while ($i < count($array));
-
- // DO WHILE STATEMENTS / Left operand
- $i = 0;
- do {
- var_dump($array[$i]);
- ++$i;
- } while (count($array) > $i);
-
-
-Compliant Solution
-
- $array = array('orange', 'banana', 'apple', 'carrot', 'collard', 'pea');
- // FOR STATEMENTS / Right operand
- $size = sizeof($array);
- for ($i = 0; $i < $size; ++$i) {
- var_dump($array[$i]);
- }
-
- // FOR STATEMENTS / Left operand
- $size = sizeof($array);
- for ($i = 0; $size > $i; ++$i) {
- var_dump($array[$i]);
- }
-
- // WHILE STATEMENTS / Right operand
- $i = 0;
- $size = count($array);
- while($i < $size) {
- var_dump($array[$i]);
- ++$i;
- }
-
- // WHILE STATEMENTS / Left operand
- $i = 0;
- $size = count($array);
- while($size > $i) {
- var_dump($array[$i]);
- ++$i;
- }
-
- // DO WHILE STATEMENTS / Right operand
- $i = 0;
- $size = count($array);
- do {
- var_dump($array[$i]);
- ++$i;
- } while ($i < $size);
-
- // DO WHILE STATEMENTS / Left operand
- $i = 0;
- $size = count($array);
- do {
- var_dump($array[$i]);
- ++$i;
- } while ($size > $i);
-
diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC34.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC34.html
deleted file mode 100644
index 5b8bd83c2..000000000
--- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC34.html
+++ /dev/null
@@ -1,109 +0,0 @@
-Inside complex code parts (for exemple multiple loops, complex data constructions...), avoid using try...catch...finally.
-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.
-Noncompliant Code Example
-
-try
-{
- $picture = PDF_open_image_file($PDF, "jpeg", $imgFile, "", 0); // This is the original statement, this works on PHP4
-}
-catch(Exception $ex)
-{
- $msg = "Error opening $imgFile for Product $row['Identifier']";
- throw new Exception($msg);
-}
-
-
-Compliant Solution
-
-//try
-if (file_exists($imgFile)) {
- $picture = PDF_open_image_file($PDF, "jpeg", $imgFile, "", 0);
-}
-
-//catch
-if (!$picture) {
- $msg = "Error opening $imgFile for Product $row['Identifier']";
- print $msg;
-}
-
-The three sources of impacts of a code identified are:
-- Energy (measured in joules) -- Transfer (measured in Bytes) -
- Storage (measured in Bytes)
-
The control of these 3 impacts allows to lengthen the life of the terminals as well as reduce their energy consumption. -
The ETSdiff tool allows measuring a differential on these three values and in a given context (database and fixed measurement environment). -
The results generated by ETSdiff must help define the interest of the rule reported by Sonarqube in the context of the code analyzed. -
-
Case for a 1GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 515.855638
- |
-
-
-
- 516.9188409999999
- |
-
|
-
-
- Transfer
- |
-
-
-
- 1579453
- |
-
-
-
- 1579457
- |
-
|
-
-
- Storage
- |
-
-
-
- 637549804
- |
-
-
-
- 637549804
- |
-
- Prefer local variables as parameters -
-When calling a global variable, the interpretation engine must check that it exists in all the scopes, that it has a value, etc. Passing global variables as arguments gives them the status of local variables inside the function, thus saving computing time (CPU cycles). -
-Noncompliant Code Example
-
- var aGlobal = new String('Hello');
-
- function globalLength(){
- length = aGlobal.length;
- console.log(length);
- }
-
- globalLength();
-
-Compliant Solution
-
- var aGlobal = new String('Hello');
-
- function someVarLength(str){
- length = str.length;
- console.log(length);
- }
-
- somVarLength(aGlobal);
-
\ No newline at end of file
diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC66.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC66.html
deleted file mode 100644
index 233604feb..000000000
--- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC66.html
+++ /dev/null
@@ -1,94 +0,0 @@
-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 single quotes prevents PHP from searching for non-existent variables. It will save CPU cycles consumption and RAM usage.
-Noncompliant Code Example
-
-myFunction("name", "age", "IsStudent");
- $lastName = "Hugo";
- $concatenatedString = "$lastName is a student";
-
-Compliant Solution
-
-myFunction('name', 'age', 'IsStudent');
- $lastName = 'Hugo';
- $concatenatedString = $lastName . 'is a student';
-
-The three sources of impacts of a code identified are:
-- Energy (measured in joules) -- Transfer (measured in Bytes) -
- Storage (measured in Bytes)
-
The control of these 3 impacts allows to lengthen the life of the terminals as well as reduce their energy consumption. -
The ETSdiff tool allows measuring a differential on these three values and in a given context (database and fixed measurement environment). -
The results generated by ETSdiff must help define the interest of the rule reported by Sonarqube in the context of the code analyzed. -
-
Case for a 1GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 3.041966
- |
-
-
-
- 1.2651545000000002
- |
-
|
-
-
- Transfer
- |
-
-
-
- 68520884
- |
-
-
-
- 68588123
- |
-
|
-
-
- Storage
- |
-
-
-
- 637548795
- |
-
-
-
- 637548795
- |
-
The form $i++ creates a temporary variable whereas ++$i does not. It save CPU cycles.
-Noncompliant Code Example
--$i++ --
Compliant Solution
-++$i-
The three sources of impacts of a code identified are:
-- Energy (measured in joules) -- Transfer (measured in Bytes) -
- Storage (measured in Bytes)
-
The control of these 3 impacts allows to lengthen the life of the terminals as well as reduce their energy consumption. -
The ETSdiff tool allows measuring a differential on these three values and in a given context (database and fixed measurement environment). -
The results generated by ETSdiff must help define the interest of the rule reported by Sonarqube in the context of the code analyzed. -
-
Case for a 1GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 1.8163645000000002
- |
-
-
-
- 0.2613885000000001
- |
-
|
-
-
- Transfer
- |
-
-
-
- 11265758
- |
-
-
-
- 11290494
- |
-
|
-
-
- Storage
- |
-
-
-
- 637548673
- |
-
-
-
- 637548673
- |
-
Do not call a function when declaring a for-type loop in order to avoid function calls each iteration. It saves CPU cycles.
-Noncompliant Code Example
-
-for ($i = 0; $i <= foo(); $i++) { // Noncompliant
- // ......
-}
-
-Compliant Solution
-
-$maxI = foo();
-for ($i = 0; $i <= $maxI; $i++) {
- .....
-}
-
- OR
-
-for ($i = 0, $maxI = foo(); $i <= $maxI; $i++) {
- .....
-}
-}
-
-The three sources of impacts of a code identified are:
-- Energy (measured in joules) -- Transfer (measured in Bytes) -
- Storage (measured in Bytes)
-
The control of these 3 impacts allows to lengthen the life of the terminals as well as reduce their energy consumption. -
The ETSdiff tool allows measuring a differential on these three values and in a given context (database and fixed measurement environment). -
The results generated by ETSdiff must help define the interest of the rule reported by Sonarqube in the context of the code analyzed. -
- -
Case for a 1GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 144.635057
- |
-
-
-
- 144.58341249999998
- |
-
|
-
-
- Transfer
- |
-
-
-
- 50000
- |
-
-
-
- 50004
- |
-
|
-
-
- Storage
- |
-
-
-
- 637549590
- |
-
-
-
- 637549590
- |
-
Executing SQL queries in loop induced unnecessary network transfert, calculation by the cpu and RAM usage.
-Noncompliant Code Example
-
- public function foo() {
- ...
- $baseQuery = "SELECT name FROM users where id = ";
-
- for ($i = 0; $i < 20; ++$i) {
-
- $query = $baseQuery . $i;
- $connection = mysql_connect($dbhost, $dbuser, $dbpass) or die("Unable to Connect to '$dbhost'");
- mysql_select_db($dbname) or die("Could not open the db '$dbname'");
- $result = mysql_query($this->Query);// Noncompliant
-
- // iterate through the result
- ...
- mysql_close($connection);
- }
- ...
- }
-
-
-Compliant Solution
-
-
- public function foo() {
- ...
- $query = "SELECT name FROM users where id in (";
-
- for ($i = 0; $i < 20; ++$i) {
- $query .= ',' . $i;
- }
- $query .= ')';
-
- $connection = mysql_connect($dbhost, $dbuser, $dbpass) or die("Unable to Connect to '$dbhost'");
- mysql_select_db($dbname) or die("Could not open the db '$dbname'");
- $result = mysql_query($this->Query); // compliant
-
- // iterate through the result
- ...
- mysql_close($connection);
- }
-
-
-
- The three sources of impacts of a code identified are:
- - Energy (measured in joules) -- Transfer (measured in Bytes) -
- Storage (measured in Bytes)
-
The control of these 3 impacts allows to lengthen the life of the terminals as well as reduce their energy consumption. -
The ETSdiff tool allows measuring a differential on these three values and in a given context (database and fixed measurement environment). -
The results generated by ETSdiff must help define the interest of the rule reported by Sonarqube in the context of the code analyzed. -
- -
Case for a 1GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 73.907586
- |
-
-
-
- 82.15627099999998
- |
-
|
-
-
- Transfer
- |
-
-
-
- 49526
- |
-
-
-
- 221836
- |
-
|
-
-
- Storage
- |
-
-
-
- 637549572
- |
-
-
-
- 637549572
- |
-
Case for a 2GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 159.4871645
- |
-
-
-
- 169.746055
- |
-
|
-
-
- Transfer
- |
-
-
-
- 50385
- |
-
-
-
- 228225
- |
-
|
-
-
- Storage
- |
-
-
-
- 1178614788
- |
-
-
-
- 1178614788
- |
-
Case for a 4GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 395.7629349999999
- |
-
-
-
- 404.37447649999996
- |
-
|
-
-
- Transfer
- |
-
-
-
- 51597
- |
-
-
-
- 238884
- |
-
|
-
-
- Storage
- |
-
-
-
- 2357214212
- |
-
-
-
- 2357214212
- |
-
Case for a 8GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 992.128585
- |
-
-
-
- 1005.4625534999999
- |
-
|
-
-
- Transfer
- |
-
-
-
- 52189
- |
-
-
-
- 249499
- |
-
|
-
-
- Storage
- |
-
-
-
- 4685052932
- |
-
-
-
- 4685052932
- |
-
Database servers have to resolve schema fields when using asterisk symbol (*). Knowing and using the schema saves CPU cycles and network transfer.
-Noncompliant Code Example
-
- public function foo() {
- ...
- $baseQuery = "SELECT * FROM users"; // Noncompliant
-
- ...
- }
-
-Compliant Solution
-
- public function foo() {
- ...
- $baseQuery = "SELECT id,name, address FROM users ";
- ...
- }
-
-The three sources of impacts of a code identified are:
-- Energy (measured in joules) -- Transfer (measured in Bytes) -
- Storage (measured in Bytes)
-
The control of these 3 impacts allows to lengthen the life of the terminals as well as reduce their energy consumption. -
The ETSdiff tool allows measuring a differential on these three values and in a given context (database and fixed measurement environment). -
The results generated by ETSdiff must help define the interest of the rule reported by Sonarqube in the context of the code analyzed. -
- -
Case for a 1GB database:
-
-Total:
-| - |
-
-
- Compliant
- |
-
-
-
- Non-compliant
- |
-
|
-
-
- Energy
- |
-
-
-
- 0.040610499999999994
- |
-
-
-
- 0.065223
- |
-
|
-
-
- Transfer
- |
-
-
-
- 779232
- |
-
-
-
- 2697937
- |
-
|
-
-
- Storage
- |
-
-
-
- 637548827
- |
-
-
-
- 637548827
- |
-
SVG images generated by common drawing softwares contains unnecessary data: calc layer, metadata, namespaces and comments.
-Noncompliant Code Example
--<!-- Created with Inkscape (http://www.inkscape.org/) --> -<svg - width="210mm" - height="297mm" - viewBox="0 0 210 297" - version="1.1" - id="svg5" - inkscape:version="1.2.2 (b0a8486541, 2022-12-01)" - sodipodi:docname="dessin2.svg" - xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" - xmlns="http://www.w3.org/2000/svg" - xmlns:svg="http://www.w3.org/2000/svg"> - <g - inkscape:label="Calque 1" - inkscape:groupmode="layer" - id="layer1"> - <circle - style="fill:#ff00ff;stroke-width:0.264583" - id="path111" - cx="104.02724" - cy="152.19028" - r="73.177132" /> - </g> -</svg> --
Compliant Solution
--<svg - width="210mm" - height="297mm" - viewBox="0 0 210 297" - xmlns="http://www.w3.org/2000/svg" - xmlns:svg="http://www.w3.org/2000/svg"> - <g> - <circle - style="fill:#ff00ff;stroke-width:0.264583" - id="path111" - cx="104.02724" - cy="152.19028" - r="73.177132" /> - </g> -</svg> -diff --git a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC203.html b/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC203.html deleted file mode 100644 index 7f9e458fd..000000000 --- a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC203.html +++ /dev/null @@ -1,73 +0,0 @@ -
If possible, the utilisation of svg image format (or <svg/> html tag) is recommended over other image format.
-Because SVGs are generally smaller than other image format, they’re less taxing on your server despite needing to render on load.
-When to use SVG : -
-
-
- Your image is used for decorative website graphics, logos, icons, graphs and diagrams, and other simple images. -
- You image require animation. -
- You image need to be responsive and scale without lack of quality. -
Some advantages of using SVG: -
-
-
- SVGs are scalable and will render pixel-perfect at any resolution whereas JPEGs, PNGs and GIFs will not. -
- SVGs are vector images and therefore are usually much smaller in file-size than bitmap-based images. -
- SVGs can be embedded into the HTML which means they can be cached, edited directly using CSS and indexed for greater accessibility. -
- SVGs can be animated directly or by using CSS or JavaScript making it easy for web designers to add interactivity to a site. -
Noncompliant Code Example
-- ... - img_jpg = "image.jpg" - ... --
Compliant Solution
-- ... - img_svg = "image.svg" - ... -- -
Noncompliant Code Example
-
- public void foo() {
- ...
- image_format = testImage("image.jpg")
- ...
- }
-
-Compliant Solution
-
- public void foo() {
- ...
- image_format = testImage("image.svg")
- ...
- }
-
-
-Noncompliant Code Example
-
- public void foo() {
- ...
- return '<html><img src="xx/xx/image.bmp"></html>'
- ...
- }
-
-Compliant Solution
-
- public void foo() {
- ...
- return '<html><img src="xx/xx/image.svg"></html>'
- ...
- }
-
- public void foo2() {
- ...
- return ('<html><svg width="100" height="100">' +
- '<circle cx="50" cy="50" r="40" stroke="green" stroke-width="4" fill="yellow" />' +
- '</svg></html>')
- ...
- }
-
diff --git a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC34.html b/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC34.html
deleted file mode 100644
index d90cacc9e..000000000
--- a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC34.html
+++ /dev/null
@@ -1,21 +0,0 @@
-Inside complex code parts (for example multiple loops, complex data constructions...), avoid using try...catch...finally. -
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.
- -Noncompliant Code Example
-
-try:
- f = open(path)
- print(fh.read())
-except:
- print('No such file '+path
-finally:
- f.close()
-
-
-Compliant Solution
--if os.path.isfile(path): - fh = open(path, 'r') - print(fh.read()) - fh.close -diff --git a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC404.html b/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC404.html deleted file mode 100644 index f7c47727f..000000000 --- a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC404.html +++ /dev/null @@ -1,13 +0,0 @@ -
Use generator comprehension instead of list comprehension in for loop declaration.
-Python generators resemble lazy lists from other programming languages: when iterated over, they compute their values on the fly. They lack some list behaviors (indexing, len method, ...) but are memory-efficient, as they do not store each of their values in memory, unlike lists. Thus, when declared in a for-loop declaration, list comprehensions can be safely replaced with generator comprehensions.
-For more details on list comprehensions vs generator comprehensions, see Python documentation.
-Noncompliant Code Example
--for var in [var2 for var2 in range(100)]: - ... --
Compliant Solution
--for var in (var2 for var2 in range(100)): - ... -diff --git a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC66.html b/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC66.html deleted file mode 100644 index 0a94f3529..000000000 --- a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC66.html +++ /dev/null @@ -1,27 +0,0 @@ -
- The shape using the quotation marks (") allows the developer to insert variables that will be substituted at run time.
- But if the string does not have a variable, use quotes (') instead.
- Thus, language will not look for variables to substitute, which will reduce the consumption of CPU cycles.
-
Noncompliant Code Example
-
- # in variables
- firstname = "Andrea" # Noncompliant {{Avoid using quotation mark ("), prefer using simple quote (')}}
-
- # in functions
- def my_function(name, age):
- print(name + 'is' + age + ' yo.')
-
- my_function("Robert", 12) # Noncompliant {{Avoid using quotation mark ("), prefer using simple quote (')}}
-
-Compliant Solution
-
- # in variables
- firstname = 'Andrea'
-
- # in functions
- def my_function(name, age):
- print(name + 'is' + age + ' yo.')
-
- my_function('Robert', 12)
-
diff --git a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC69.html b/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC69.html
deleted file mode 100644
index 2c3c64ff1..000000000
--- a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC69.html
+++ /dev/null
@@ -1,13 +0,0 @@
-Do not call a function when declaring a for-type loop in order to avoid function calls each iteration. It saves CPU cycles.
-Noncompliant Code Example
--for i in my_function(): # Noncompliant - ...... - --
Compliant Solution
--limit = my_function() -for i in limit: - ...... -diff --git a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC72.html b/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC72.html deleted file mode 100644 index 2323c02f5..000000000 --- a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC72.html +++ /dev/null @@ -1,21 +0,0 @@ -
Executing SQL queries in loop induced unnecessary calculation by the cpu, RAM usage and network transfer.
-Noncompliant Code Example
-
- def foo():
- ...
- results = []
- for id in range(20):
- results.append(cursor.execute("SELECT name FROM users where id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}}
- ...
-
-Compliant Solution
-
-
- def foo():
- ...
- ids = range(20)
- results = cursor.execute("SELECT name FROM users where id IN ({0})".format(', '.join("?" * len(ids))), ids).fetchmany() # Compliant
- ...
- }
-
-
diff --git a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC74.html b/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC74.html
deleted file mode 100644
index 35ffbf7af..000000000
--- a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC74.html
+++ /dev/null
@@ -1,21 +0,0 @@
-Database servers have to resolve schema fields when using asterisk symbol (*). Knowing and using the schema saves CPU cycles and network transfer.
-Noncompliant Code Example
-
- public void foo() {
- ...
- String baseQuery = "SELECT * FROM users"; // Noncompliant
-
- ...
- }
-
-
-Compliant Solution
-
-
- public void foo() {
- ...
- String query = "SELECT id, name, address FROM users ";
- ...
- }
-
-
diff --git a/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java b/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java
index 477f5d4bb..e270ad449 100644
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java
+++ b/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java
@@ -16,20 +16,26 @@
*/
package fr.greencodeinitiative.python;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.sonar.api.Plugin;
import org.sonar.api.SonarRuntime;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
-public class PythonPluginTest {
+class PythonPluginTest {
+ private Plugin.Context context;
- @Test
- public void test() {
+ @BeforeEach
+ void init() {
SonarRuntime sonarRuntime = mock(SonarRuntime.class);
- Plugin.Context context = new Plugin.Context(sonarRuntime);
+ context = new Plugin.Context(sonarRuntime);
new PythonPlugin().define(context);
+ }
+
+ @Test
+ void test() {
assertThat(context.getExtensions()).hasSize(1);
}
diff --git a/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java b/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java
index 828447a4d..714ef278e 100644
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java
+++ b/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java
@@ -16,45 +16,88 @@
*/
package fr.greencodeinitiative.python;
-import static org.assertj.core.api.Assertions.assertThat;
-
import org.assertj.core.api.SoftAssertions;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.sonar.api.SonarRuntime;
import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.api.utils.Version;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.fail;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
-public class PythonRuleRepositoryTest {
+class PythonRuleRepositoryTest {
- private PythonRuleRepository pythonRuleRepository;
- private RulesDefinition.Context context;
private RulesDefinition.Repository repository;
- @Before
- public void init() {
- pythonRuleRepository = new PythonRuleRepository();
- context = new RulesDefinition.Context();
- pythonRuleRepository.define(context);
- repository = context.repository(PythonRuleRepository.REPOSITORY_KEY);
+ @BeforeEach
+ void init() {
+ // TODO: Remove this check after Git repo split
+ /*
+ On an IDE (like IntelliJ), if the developer runs the unit tests without building/generating the Maven goals on the
+ "ecocode-rules-specifications" module before, the unit tests will not see the generated HTML descriptions (from ASCIIDOC files).
+ The developer must therefore configure his IDE to build the `ecocode-rules-specifications` module before launching the Tests.
+
+ When the `python-plugin` submodule is in a specific Git repository, `ecocode-rules-specifications` will be fetched from a classic
+ external Maven dependency. There will therefore no longer be any need to perform this specific configuration.
+ */
+ if (PythonRuleRepository.class.getResource("/io/ecocode/rules/python/EC4.json") == null) {
+ String message = "'ecocode-rules-specification' resources corrupted. Please check build of 'ecocode-rules-specification' module";
+ if (System.getProperties().keySet().stream().anyMatch(k -> k.toString().startsWith("idea."))) {
+ message += "\n\nOn 'IntelliJ IDEA':" +
+ "\n1. go to settings :" +
+ "\n > Build, Execution, Deployment > Build Tools > Maven > Runner" +
+ "\n2. check option:" +
+ "\n > Delegate IDE build/run actions to Maven" +
+ "\n3. Click on menu: " +
+ "\n > Build > Build Project"
+ ;
+ }
+ fail(message);
+ }
+
+ final SonarRuntime sonarRuntime = mock(SonarRuntime.class);
+ doReturn(Version.create(0, 0)).when(sonarRuntime).getApiVersion();
+ PythonRuleRepository rulesDefinition = new PythonRuleRepository(sonarRuntime);
+ RulesDefinition.Context context = new RulesDefinition.Context();
+ rulesDefinition.define(context);
+ repository = context.repository(rulesDefinition.repositoryKey());
}
@Test
- public void test() {
- assertThat(pythonRuleRepository.repositoryKey()).isEqualTo(PythonRuleRepository.REPOSITORY_KEY);
- assertThat(context.repositories()).hasSize(1).extracting("key").containsExactly(pythonRuleRepository.repositoryKey());
- assertThat(context.repositories().get(0).rules()).hasSize(10);
- assertThat(pythonRuleRepository.checkClasses()).hasSize(10);
+ @DisplayName("Test repository metadata")
+ void testMetadata() {
+ assertThat(repository.name()).isEqualTo("ecoCode");
+ assertThat(repository.language()).isEqualTo("py");
+ assertThat(repository.key()).isEqualTo("ecocode-python");
}
+ @Test
+ void testRegistredRules() {
+ assertThat(repository.rules()).hasSize(10);
+ }
- /**
- * Check all rule keys must be prefixed by 'EC'
- */
@Test
- public void testRuleKeyPrefix() {
+ @DisplayName("All rule keys must be prefixed by 'EC'")
+ void testRuleKeyPrefix() {
SoftAssertions assertions = new SoftAssertions();
repository.rules().forEach(
rule -> assertions.assertThat(rule.key()).startsWith("EC")
);
assertions.assertAll();
}
+
+ @Test
+ void testAllRuleParametersHaveDescription() {
+ SoftAssertions assertions = new SoftAssertions();
+ repository.rules().stream()
+ .flatMap(rule -> rule.params().stream())
+ .forEach(param -> assertions.assertThat(param.description())
+ .as("description for " + param.key())
+ .isNotEmpty());
+ assertions.assertAll();
+ }
}