withinTry = new LinkedList<>();
diff --git a/java-plugin/src/main/java/fr/greencodeinitiative/java/checks/IncrementCheck.java b/java-plugin/src/main/java/fr/greencodeinitiative/java/checks/IncrementCheck.java
index 41a54c1ca..00c3094dd 100644
--- a/java-plugin/src/main/java/fr/greencodeinitiative/java/checks/IncrementCheck.java
+++ b/java-plugin/src/main/java/fr/greencodeinitiative/java/checks/IncrementCheck.java
@@ -1,21 +1,32 @@
+/*
+ * ecoCode - Java language - Provides rules to reduce the environmental footprint of your Java programs
+ * Copyright Β© 2023 Green Code Initiative (https://www.ecocode.io)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see The 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.
-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):
-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
-++i
diff --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 4bb67e113..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 transfert.
-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 d3f65bcf6..000000000
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC74.html
+++ /dev/null
@@ -1,21 +0,0 @@
-Databases servers have to solve fields regarding the schema. Knowing and using the schema save 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, adress 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.
-
-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.
-
-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 8de04cef2..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 non negligible 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/files/ArrayCopyCheck.java b/java-plugin/src/test/files/ArrayCopyCheck.java
index d18890515..09c780eaa 100644
--- a/java-plugin/src/test/files/ArrayCopyCheck.java
+++ b/java-plugin/src/test/files/ArrayCopyCheck.java
@@ -1,3 +1,20 @@
+/*
+ * ecoCode - Java language - Provides rules to reduce the environmental footprint of your Java programs
+ * Copyright Β© 2023 Green Code Initiative (https://www.ecocode.io)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see
- 4.0.0
-
-
- io.ecocode
- ecocode-parent
- 1.1.1-SNAPSHOT
-
-
- ecocode-javascript-plugin
- sonar-plugin
-
- ecoCode - JavaScript language
- Provides rules to reduce the environmental footprint of your JavaScript programs
- https://github.com/green-code-initiative/ecoCode/tree/main/javascript-plugin
-
-
-
-
- org.sonarsource.javascript
- sonar-javascript-plugin
- sonar-plugin
-
-
-
- org.sonarsource.sonarqube
- sonar-plugin-api
-
-
-
- org.sonarsource.sonarqube
- sonar-plugin-api-impl
-
-
-
- org.sonarsource.analyzer-commons
- sonar-analyzer-commons
-
-
-
-
-
- junit
- junit
- test
-
-
-
- org.assertj
- assertj-core
- test
-
-
-
-
-
-
-
- org.sonarsource.sonar-packaging-maven-plugin
- sonar-packaging-maven-plugin
- true
-
- ecocodejavascript
- ${project.name}
- fr.greencodeinitiative.javascript.JavaScriptPlugin
- true
- ${sonarqube.version}
- javascript
- ${java.version}
-
-
-
- org.apache.maven.plugins
- maven-shade-plugin
-
-
- package
-
- shade
-
-
-
-
- commons-*:*
-
- META-INF/**
-
-
-
- org.*:*
-
- META-INF/**
- org/sonar/api/batch/sensor/**
-
-
-
-
-
-
-
-
- org.apache.maven.plugins
- maven-dependency-plugin
-
-
- copy-bundle
- package
-
- copy
-
-
-
-
- ${project.groupId}
- ${project.artifactId}
- ${project.version}
- jar
- true
-
-
- ../lib
-
-
-
-
-
- org.jacoco
- jacoco-maven-plugin
-
- file
- false
-
-
-
- prepare-agent
-
- prepare-agent
-
-
-
- report
- test
-
- report
-
-
-
-
-
-
-
diff --git a/javascript-plugin/src/main/java/fr/greencodeinitiative/javascript/JavaScriptPlugin.java b/javascript-plugin/src/main/java/fr/greencodeinitiative/javascript/JavaScriptPlugin.java
deleted file mode 100644
index 6959ea2e1..000000000
--- a/javascript-plugin/src/main/java/fr/greencodeinitiative/javascript/JavaScriptPlugin.java
+++ /dev/null
@@ -1,12 +0,0 @@
-package fr.greencodeinitiative.javascript;
-
-import org.sonar.api.Plugin;
-
-public class JavaScriptPlugin implements Plugin {
-
- @Override
- public void define(Context context) {
- context.addExtension(JavaScriptRulesDefinition.class);
- }
-
-}
diff --git a/javascript-plugin/src/main/java/fr/greencodeinitiative/javascript/JavaScriptRulesDefinition.java b/javascript-plugin/src/main/java/fr/greencodeinitiative/javascript/JavaScriptRulesDefinition.java
deleted file mode 100644
index e5fbae09d..000000000
--- a/javascript-plugin/src/main/java/fr/greencodeinitiative/javascript/JavaScriptRulesDefinition.java
+++ /dev/null
@@ -1,24 +0,0 @@
-package fr.greencodeinitiative.javascript;
-
-import org.sonar.api.server.rule.RulesDefinition;
-import org.sonarsource.analyzer.commons.ExternalRuleLoader;
-
-public class JavaScriptRulesDefinition implements RulesDefinition {
-
- private static final String LANGUAGE = "js";
-
- /*
- As we integrate our rules using SonarJS, these values should remain to "eslint_repo" and "ESLint" in order to import them correctly
- see: https://github.com/green-code-initiative/ecoCode/pull/79#discussion_r1137797583
- */
- private static final String LINTER_KEY = "eslint_repo";
- private static final String LINTER_NAME = "ESLint";
- private static final String METADATA_PATH = "fr/greencodeinitiative/l10n/javascript/rules.json";
-
- @Override
- public void define(Context context) {
- new ExternalRuleLoader(LINTER_KEY, LINTER_NAME, METADATA_PATH, LANGUAGE)
- .createExternalRuleRepository(context);
- }
-
-}
diff --git a/javascript-plugin/src/main/resources/fr/greencodeinitiative/l10n/javascript/rules.json b/javascript-plugin/src/main/resources/fr/greencodeinitiative/l10n/javascript/rules.json
deleted file mode 100644
index 5beda43e8..000000000
--- a/javascript-plugin/src/main/resources/fr/greencodeinitiative/l10n/javascript/rules.json
+++ /dev/null
@@ -1,14 +0,0 @@
-[
- {
- "key": "@ecocode/no-multiple-access-dom-element",
- "type": "CODE_SMELL",
- "name": "Disallow multiple access of same DOM element",
- "description": "\n\nRule details \nThis rule aims to reduce DOM access assigning its object to variable when access multiple time. It saves CPU cycles.
\nExamples \nExamples of incorrect code for this rule:
\nvar el1 = document.getElementById("block1").test1;\nvar el2 = document.getElementById("block1").test2;\nExamples of correct code for this rule:
\nvar blockElement = document.getElementById("block1");\nvar el1 = blockElement.test1;\nvar el2 = blockElement.test2;\nClick here to access the rule details. ",
- "constantDebtMinutes": 5,
- "severity": "MINOR",
- "tags": [
- "eco-design",
- "ecocode"
- ]
- }
-]
diff --git a/javascript-plugin/src/test/java/fr/greencodeinitiative/javascript/JavaScriptPluginTest.java b/javascript-plugin/src/test/java/fr/greencodeinitiative/javascript/JavaScriptPluginTest.java
deleted file mode 100644
index a558e0626..000000000
--- a/javascript-plugin/src/test/java/fr/greencodeinitiative/javascript/JavaScriptPluginTest.java
+++ /dev/null
@@ -1,41 +0,0 @@
-package fr.greencodeinitiative.javascript;
-
-import org.junit.Test;
-import org.sonar.api.*;
-import org.sonar.api.utils.Version;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
-public class JavaScriptPluginTest {
-
- @Test
- public void extensions() {
- Plugin.Context context = new Plugin.Context(new MockedSonarRuntime());
- new JavaScriptPlugin().define(context);
- assertThat(context.getExtensions()).hasSize(1);
- }
-
- private static class MockedSonarRuntime implements SonarRuntime {
-
- @Override
- public Version getApiVersion() {
- return Version.create(9, 9);
- }
-
- @Override
- public SonarProduct getProduct() {
- return SonarProduct.SONARQUBE;
- }
-
- @Override
- public SonarQubeSide getSonarQubeSide() {
- return SonarQubeSide.SCANNER;
- }
-
- @Override
- public SonarEdition getEdition() {
- return SonarEdition.COMMUNITY;
- }
- }
-
-}
diff --git a/javascript-plugin/src/test/java/fr/greencodeinitiative/javascript/JavaScriptRulesDefinitionTest.java b/javascript-plugin/src/test/java/fr/greencodeinitiative/javascript/JavaScriptRulesDefinitionTest.java
deleted file mode 100644
index 60bdc8510..000000000
--- a/javascript-plugin/src/test/java/fr/greencodeinitiative/javascript/JavaScriptRulesDefinitionTest.java
+++ /dev/null
@@ -1,22 +0,0 @@
-package fr.greencodeinitiative.javascript;
-
-import org.junit.Test;
-import org.sonar.api.server.rule.RulesDefinition;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
-public class JavaScriptRulesDefinitionTest {
-
- @Test
- public void createExternalRepository() {
- RulesDefinition.Context context = new RulesDefinition.Context();
- new JavaScriptRulesDefinition().define(context);
- assertThat(context.repositories()).hasSize(1);
-
- RulesDefinition.Repository repository = context.repositories().get(0);
- assertThat(repository.isExternal()).isTrue();
- assertThat(repository.language()).isEqualTo("js");
- assertThat(repository.key()).isEqualTo("external_eslint_repo");
- }
-
-}
diff --git a/php-plugin/README.md b/php-plugin/README.md
deleted file mode 100644
index d7c7e9847..000000000
--- a/php-plugin/README.md
+++ /dev/null
@@ -1 +0,0 @@
-https://github.com/SonarSource/sonar-custom-rules-examples/tree/master/php-custom-rules
\ No newline at end of file
diff --git a/php-plugin/pom.xml b/php-plugin/pom.xml
deleted file mode 100644
index a79f181ef..000000000
--- a/php-plugin/pom.xml
+++ /dev/null
@@ -1,161 +0,0 @@
-
-
- 4.0.0
-
-
- io.ecocode
- ecocode-parent
- 1.1.1-SNAPSHOT
-
-
- ecocode-php-plugin
- sonar-plugin
-
- ecoCode - PHP language
- Provides rules to reduce the environmental footprint of your PHP programs
- https://github.com/green-code-initiative/ecoCode/tree/main/php-plugin
-
-
-
-
- org.sonarsource.php
- sonar-php-plugin
- sonar-plugin
-
-
-
- org.sonarsource.sonarqube
- sonar-plugin-api
-
-
-
- org.sonarsource.sonarqube
- sonar-plugin-api-impl
-
-
-
-
-
-
-
-
-
-
- junit
- junit
- test
-
-
-
- org.assertj
- assertj-core
- test
-
-
-
-
-
-
-
- org.sonarsource.sonar-packaging-maven-plugin
- sonar-packaging-maven-plugin
- true
-
- ecocodephp
- ${project.name}
- fr.greencodeinitiative.php.PHPPlugin
- true
- ${sonarqube.version}
- php
- ${java.version}
- php:${sonarphp.version}
- ${sonarqube.version}
- ${java.version}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- org.apache.maven.plugins
- maven-dependency-plugin
-
-
- copy-bundle
- package
-
- copy
-
-
-
-
- ${project.groupId}
- ${project.artifactId}
- ${project.version}
- jar
- true
-
-
- ../lib
-
-
-
-
-
- org.jacoco
- jacoco-maven-plugin
-
- file
- false
-
-
-
- prepare-agent
-
- prepare-agent
-
-
-
- report
- test
-
- report
-
-
-
-
-
-
-
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/PHPPlugin.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/PHPPlugin.java
deleted file mode 100644
index c9bd1ce55..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/PHPPlugin.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*
- * SonarQube PHP Custom Rules Example
- * Copyright (C) 2016-2016 SonarSource SA
- * mailto:contact AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.php;
-
-import org.sonar.api.Plugin;
-
-/**
- * Extension point to define a Sonar Plugin.
- */
-public class PHPPlugin implements Plugin {
-
- @Override
- public void define(Context context) {
- context.addExtension(PhpRuleRepository.class);
- }
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/PhpRuleRepository.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/PhpRuleRepository.java
deleted file mode 100644
index bebb9e605..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/PhpRuleRepository.java
+++ /dev/null
@@ -1,121 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.php;
-
-import java.io.ByteArrayOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.URL;
-import java.nio.charset.StandardCharsets;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import com.google.common.collect.ImmutableList;
-import fr.greencodeinitiative.php.checks.AvoidDoubleQuoteCheck;
-import fr.greencodeinitiative.php.checks.AvoidFullSQLRequestCheck;
-import fr.greencodeinitiative.php.checks.AvoidSQLRequestInLoopCheck;
-import fr.greencodeinitiative.php.checks.AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements;
-import fr.greencodeinitiative.php.checks.AvoidUsingGlobalVariablesCheck;
-import fr.greencodeinitiative.php.checks.IncrementCheck;
-import fr.greencodeinitiative.php.checks.NoFunctionCallWhenDeclaringForLoop;
-import fr.greencodeinitiative.php.checks.UseOfMethodsForBasicOperations;
-import org.sonar.api.rules.RuleType;
-import org.sonar.api.server.rule.RulesDefinition;
-import org.sonar.api.server.rule.RulesDefinitionAnnotationLoader;
-import org.sonar.plugins.php.api.visitors.PHPCustomRuleRepository;
-
-public class PhpRuleRepository implements RulesDefinition, PHPCustomRuleRepository {
-
- public static final String LANGUAGE = "php";
- public static final String NAME = "ecoCode";
- public static final String RESOURCE_BASE_PATH = "/fr/greencodeinitiative/l10n/php/rules/custom/";
- public static final String REPOSITORY_KEY = "ecocode-php";
-
- @Override
- public void define(Context context) {
- NewRepository repository = context.createRepository(repositoryKey(), LANGUAGE).setName(NAME);
-
- new RulesDefinitionAnnotationLoader().load(repository, checkClasses().toArray(new Class[] {}));
-
- // technical debt
- Map remediationCosts = new HashMap<>();
- remediationCosts.put(AvoidSQLRequestInLoopCheck.RULE_KEY, "10min");
- remediationCosts.put(AvoidFullSQLRequestCheck.RULE_KEY, "20min");
- repository.rules().forEach(rule -> {
- rule.setType(RuleType.CODE_SMELL);
- String debt = remediationCosts.get(rule.key());
-
- // TODO DDC : create support to use org.apache.commons.lang.StringUtils
-// if (StringUtils.isBlank(debt)) {
- if (debt == null || debt.trim().equals("")) {
- // default debt to 5min for issue correction
- rule.setDebtRemediationFunction(
- rule.debtRemediationFunctions().constantPerIssue("5min"));
- } else {
- rule.setDebtRemediationFunction(
- rule.debtRemediationFunctions().constantPerIssue(debt));
- }
- });
-
- // HTML description
- repository.rules().forEach(rule ->
- rule.setHtmlDescription(loadResource(RESOURCE_BASE_PATH + rule.key() + ".html")));
-
- repository.done();
- }
-
- @Override
- public String repositoryKey() {
- return REPOSITORY_KEY;
- }
-
- @Override
- public List> checkClasses() {
- return ImmutableList.of(
- AvoidDoubleQuoteCheck.class,
- AvoidFullSQLRequestCheck.class,
- AvoidSQLRequestInLoopCheck.class,
- AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements.class,
- AvoidUsingGlobalVariablesCheck.class,
- IncrementCheck.class,
- NoFunctionCallWhenDeclaringForLoop.class,
- UseOfMethodsForBasicOperations.class
- );
- }
-
- private String loadResource(String path) {
- URL resource = getClass().getResource(path);
- if (resource == null) {
- throw new IllegalStateException("Resource not found: " + path);
- }
- ByteArrayOutputStream result = new ByteArrayOutputStream();
- try (InputStream in = resource.openStream()) {
- byte[] buffer = new byte[1024];
- for (int len = in.read(buffer); len != -1; len = in.read(buffer)) {
- result.write(buffer, 0, len);
- }
- return new String(result.toByteArray(), StandardCharsets.UTF_8);
- } catch (IOException e) {
- throw new IllegalStateException("Failed to read resource: " + path, e);
- }
- }
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidDoubleQuoteCheck.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidDoubleQuoteCheck.java
deleted file mode 100644
index 2fe45079c..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidDoubleQuoteCheck.java
+++ /dev/null
@@ -1,72 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.php.api.tree.Tree;
-import org.sonar.plugins.php.api.tree.expression.LiteralTree;
-import org.sonar.plugins.php.api.visitors.PHPSubscriptionCheck;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidDoubleQuoteCheck.RULE_KEY,
- name = AvoidDoubleQuoteCheck.ERROR_MESSAGE,
- description = AvoidDoubleQuoteCheck.ERROR_MESSAGE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-php", ruleKey = "S66")
-public class AvoidDoubleQuoteCheck extends PHPSubscriptionCheck {
-
- public static final String RULE_KEY = "EC66";
- public static final String ERROR_MESSAGE = "Avoid using double quote (\"), prefer using simple quote (')";
- private static final Map> linesWithIssuesByFile = new HashMap<>();
-
- @Override
- public List nodesToVisit() {
- return Collections.singletonList(Tree.Kind.REGULAR_STRING_LITERAL);
- }
-
- @Override
- public void visitNode(Tree tree) {
- LiteralTree method = (LiteralTree) tree;
- checkIssue(method);
- }
-
- public void checkIssue(LiteralTree literalTree) {
- if (lineAlreadyHasThisIssue(literalTree)) return;
- if (literalTree.value().indexOf("\"") == 0 && literalTree.value().lastIndexOf("\"") == literalTree.value().length() - 1) {
- repport(literalTree);
- }
- }
-
- private void repport(LiteralTree literalTree) {
- if (literalTree.token() != null) {
-
- final String classname = context().getPhpFile().toString();
- final int line = literalTree.token().line();
- linesWithIssuesByFile.computeIfAbsent(classname, k -> new ArrayList<>());
- linesWithIssuesByFile.get(classname).add(line);
- }
- context().newIssue(this, literalTree, ERROR_MESSAGE);
-
- }
-
- private boolean lineAlreadyHasThisIssue(LiteralTree literalTree) {
- if (literalTree.token() != null) {
- final String filename = context().getPhpFile().toString();
- final int line = literalTree.token().line();
-
- return linesWithIssuesByFile.containsKey(filename)
- && linesWithIssuesByFile.get(filename).contains(line);
- }
-
- return false;
- }
-
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidFullSQLRequestCheck.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidFullSQLRequestCheck.java
deleted file mode 100644
index fdc016916..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidFullSQLRequestCheck.java
+++ /dev/null
@@ -1,43 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.util.Arrays;
-import java.util.List;
-import java.util.regex.Pattern;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.php.api.tree.Tree;
-import org.sonar.plugins.php.api.tree.Tree.Kind;
-import org.sonar.plugins.php.api.tree.expression.LiteralTree;
-import org.sonar.plugins.php.api.visitors.PHPSubscriptionCheck;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidFullSQLRequestCheck.RULE_KEY,
- name = AvoidFullSQLRequestCheck.ERROR_MESSAGE,
- description = AvoidFullSQLRequestCheck.ERROR_MESSAGE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-php", ruleKey = "S74")
-public class AvoidFullSQLRequestCheck extends PHPSubscriptionCheck {
-
- public static final String RULE_KEY = "EC74";
-
- public static final String ERROR_MESSAGE = "Don't use the query SELECT * FROM";
-
- private static final Pattern PATTERN = Pattern.compile("(?i).*select.*\\*.*from.*");
-
- @Override
- public List nodesToVisit() {
- return Arrays.asList(Kind.REGULAR_STRING_LITERAL);
- }
-
- @Override
- public void visitNode(Tree tree) {
-
- LiteralTree literal = (LiteralTree) tree;
- if (PATTERN.matcher(literal.value()).matches()) {
- context().newIssue(this, tree, ERROR_MESSAGE);
- }
- }
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidSQLRequestInLoopCheck.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidSQLRequestInLoopCheck.java
deleted file mode 100644
index 358f43008..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidSQLRequestInLoopCheck.java
+++ /dev/null
@@ -1,89 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.util.Arrays;
-import java.util.List;
-import java.util.regex.Pattern;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.php.api.tree.Tree;
-import org.sonar.plugins.php.api.tree.Tree.Kind;
-import org.sonar.plugins.php.api.tree.statement.BlockTree;
-import org.sonar.plugins.php.api.tree.statement.DoWhileStatementTree;
-import org.sonar.plugins.php.api.tree.statement.ExpressionStatementTree;
-import org.sonar.plugins.php.api.tree.statement.ForEachStatementTree;
-import org.sonar.plugins.php.api.tree.statement.ForStatementTree;
-import org.sonar.plugins.php.api.tree.statement.IfStatementTree;
-import org.sonar.plugins.php.api.tree.statement.StatementTree;
-import org.sonar.plugins.php.api.visitors.PHPSubscriptionCheck;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidSQLRequestInLoopCheck.RULE_KEY,
- name = AvoidSQLRequestInLoopCheck.ERROR_MESSAGE,
- description = AvoidSQLRequestInLoopCheck.ERROR_MESSAGE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-php", ruleKey = "S72")
-public class AvoidSQLRequestInLoopCheck extends PHPSubscriptionCheck {
-
- public static final String RULE_KEY = "EC72";
- public static final String ERROR_MESSAGE = "Avoid SQL request in loop";
- private static final Pattern PATTERN = Pattern.compile("(mysql(i::|_)query\\s*\\(.*)|(oci_execute\\(.*)");
-
- @Override
- public List nodesToVisit() {
- return Arrays.asList(Kind.FOR_STATEMENT, Kind.FOREACH_STATEMENT, Kind.DO_WHILE_STATEMENT);
- }
-
- @Override
- public void visitNode(Tree tree) {
- if (tree.is(Kind.FOR_STATEMENT)) {
- StatementTree stTree = ((ForStatementTree) tree).statements().get(0);
- if (stTree.is(Kind.BLOCK)) {
- visitBlockNode((BlockTree) stTree);
- }
- }
-
- if (tree.is(Kind.FOREACH_STATEMENT)) {
- StatementTree stTree = ((ForEachStatementTree) tree).statements().get(0);
- if (stTree.is(Kind.BLOCK)) {
- visitBlockNode((BlockTree) stTree);
- }
- }
-
- if (tree.is(Kind.DO_WHILE_STATEMENT)) {
- StatementTree stTree = ((DoWhileStatementTree) tree).statement();
- if (stTree.is(Kind.BLOCK)) {
- visitBlockNode((BlockTree) stTree);
- }
- }
- }
-
- private void visitBlockNode(BlockTree block) {
- block.statements().forEach(this::visiteChildNode);
- }
-
- private void visiteChildNode(Tree tree) {
- if (tree.is(Kind.EXPRESSION_STATEMENT)) {
- ExpressionStatementTree expressionStatementTree = (ExpressionStatementTree) tree;
- String expression = expressionStatementTree.expression().toString();
- verifyIfThereIsAError(expression, expressionStatementTree);
- }
-
- if (tree.is(Kind.IF_STATEMENT)) {
- StatementTree statementTree = ((IfStatementTree) tree).statements().get(0);
- if (statementTree.is(Kind.BLOCK)) {
- visitBlockNode((BlockTree) statementTree);
- } else {
- visiteChildNode(statementTree);
- }
- }
- }
-
- private void verifyIfThereIsAError(String expression, ExpressionStatementTree expressionStatementTree) {
- if (PATTERN.matcher(expression).find())
- context().newIssue(this, expressionStatementTree, ERROR_MESSAGE);
- }
-
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements.java
deleted file mode 100644
index bced0aa40..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements.java
+++ /dev/null
@@ -1,34 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.util.Collections;
-import java.util.List;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.php.api.tree.Tree;
-import org.sonar.plugins.php.api.visitors.PHPSubscriptionCheck;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements.RULE_KEY,
- name = AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements.ERROR_MESSAGE,
- description = AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements.ERROR_MESSAGE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-php", ruleKey = "S34")
-public class AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements extends PHPSubscriptionCheck {
-
- public static final String RULE_KEY = "EC34";
- public static final String ERROR_MESSAGE = "Avoid using try-catch";
-
- @Override
- public List nodesToVisit() {
- return Collections.singletonList(Tree.Kind.TRY_STATEMENT);
- }
-
- @Override
- public void visitNode(Tree tree) {
- context().newIssue(this, tree, ERROR_MESSAGE);
- }
-
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidUsingGlobalVariablesCheck.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidUsingGlobalVariablesCheck.java
deleted file mode 100644
index 76607760d..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/AvoidUsingGlobalVariablesCheck.java
+++ /dev/null
@@ -1,31 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.util.regex.Pattern;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.php.api.tree.declaration.FunctionDeclarationTree;
-import org.sonar.plugins.php.api.visitors.PHPVisitorCheck;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidUsingGlobalVariablesCheck.RULE_KEY,
- name = AvoidUsingGlobalVariablesCheck.ERROR_MESSAGE,
- description = AvoidUsingGlobalVariablesCheck.ERROR_MESSAGE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-php", ruleKey = "D4")
-public class AvoidUsingGlobalVariablesCheck extends PHPVisitorCheck {
-
- public static final String RULE_KEY = "EC4";
- public static final String ERROR_MESSAGE = "Prefer local variables to globals";
-
- private static final Pattern PATTERN = Pattern.compile("^.*(global \\$|\\$GLOBALS).*$", Pattern.CASE_INSENSITIVE);
-
- @Override
- public void visitFunctionDeclaration(FunctionDeclarationTree tree) {
- if (PATTERN.matcher(tree.body().toString()).matches()) {
- context().newIssue(this, tree, String.format(ERROR_MESSAGE, tree.body().toString()));
- }
- }
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/IncrementCheck.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/IncrementCheck.java
deleted file mode 100644
index ba2c09e57..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/IncrementCheck.java
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- * SonarQube PHP Custom Rules Example
- * Copyright (C) 2016-2016 SonarSource SA
- * mailto:contact AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.php.checks;
-
-import java.util.Collections;
-import java.util.List;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.php.api.tree.Tree;
-import org.sonar.plugins.php.api.tree.Tree.Kind;
-import org.sonar.plugins.php.api.visitors.PHPSubscriptionCheck;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = IncrementCheck.RULE_KEY,
- name = IncrementCheck.ERROR_MESSAGE,
- description = IncrementCheck.ERROR_MESSAGE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-php", ruleKey = "S67")
-public class IncrementCheck extends PHPSubscriptionCheck {
-
- public static final String RULE_KEY = "EC67";
- public static final String ERROR_MESSAGE = "Remove the usage of $i++. prefer ++$i";
-
- @Override
- public List nodesToVisit() {
- return Collections.singletonList(Kind.POSTFIX_INCREMENT);
- }
-
- @Override
- public void visitNode(Tree tree) {
- context().newIssue(this, tree, ERROR_MESSAGE);
- }
-
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/NoFunctionCallWhenDeclaringForLoop.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/NoFunctionCallWhenDeclaringForLoop.java
deleted file mode 100644
index 4381c8a12..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/NoFunctionCallWhenDeclaringForLoop.java
+++ /dev/null
@@ -1,58 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.util.Collections;
-import java.util.List;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.php.api.tree.SeparatedList;
-import org.sonar.plugins.php.api.tree.Tree;
-import org.sonar.plugins.php.api.tree.Tree.Kind;
-import org.sonar.plugins.php.api.tree.expression.BinaryExpressionTree;
-import org.sonar.plugins.php.api.tree.expression.ExpressionTree;
-import org.sonar.plugins.php.api.tree.statement.ForStatementTree;
-import org.sonar.plugins.php.api.visitors.PHPSubscriptionCheck;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = NoFunctionCallWhenDeclaringForLoop.RULE_KEY,
- name = NoFunctionCallWhenDeclaringForLoop.ERROR_MESSAGE,
- description = NoFunctionCallWhenDeclaringForLoop.ERROR_MESSAGE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-php", ruleKey = "S69")
-public class NoFunctionCallWhenDeclaringForLoop extends PHPSubscriptionCheck {
-
- public static final String RULE_KEY = "EC69";
- public static final String ERROR_MESSAGE = "Do not call a function in for-type loop declaration";
-
- @Override
- public List nodesToVisit() {
- return Collections.singletonList(Kind.FOR_STATEMENT);
- }
-
- @Override
- public void visitNode(Tree tree) {
- ForStatementTree method = (ForStatementTree) tree;
- checkExpressionsTree(method.update());
- checkExpressionsTree(method.condition());
- }
-
- public void checkExpressionsTree(SeparatedList treeSeparatedList) {
- treeSeparatedList.forEach(this::checkBothSideExpression);
- }
-
- public void checkBothSideExpression(ExpressionTree expressionTree) {
- if (expressionTree.getKind().getAssociatedInterface() == BinaryExpressionTree.class) {
- BinaryExpressionTree binaryExpressionTree = (BinaryExpressionTree) expressionTree;
- isFunctionCall(binaryExpressionTree.leftOperand());
- isFunctionCall(binaryExpressionTree.rightOperand());
- } else
- isFunctionCall(expressionTree);
- }
-
- public void isFunctionCall(ExpressionTree expressionTree) {
- if (expressionTree.getKind() == Tree.Kind.FUNCTION_CALL)
- context().newIssue(this, expressionTree, ERROR_MESSAGE);
- }
-}
diff --git a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/UseOfMethodsForBasicOperations.java b/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/UseOfMethodsForBasicOperations.java
deleted file mode 100644
index 4af8d8d9e..000000000
--- a/php-plugin/src/main/java/fr/greencodeinitiative/php/checks/UseOfMethodsForBasicOperations.java
+++ /dev/null
@@ -1,100 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.stream.Collectors;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.php.api.tree.ScriptTree;
-import org.sonar.plugins.php.api.tree.Tree;
-import org.sonar.plugins.php.api.tree.declaration.ClassDeclarationTree;
-import org.sonar.plugins.php.api.tree.declaration.ClassMemberTree;
-import org.sonar.plugins.php.api.tree.declaration.MethodDeclarationTree;
-import org.sonar.plugins.php.api.tree.expression.FunctionCallTree;
-import org.sonar.plugins.php.api.tree.statement.StatementTree;
-import org.sonar.plugins.php.api.visitors.PHPSubscriptionCheck;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = UseOfMethodsForBasicOperations.RULE_KEY,
- name = UseOfMethodsForBasicOperations.ERROR_MESSAGE,
- description = UseOfMethodsForBasicOperations.ERROR_MESSAGE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-php", ruleKey = "D2")
-public class UseOfMethodsForBasicOperations extends PHPSubscriptionCheck {
-
- public static final String RULE_KEY = "EC22";
- protected static final String ERROR_MESSAGE = "Use of methods for basic operations";
-
- @Override
- public List nodesToVisit() {
- return Collections.singletonList(Tree.Kind.FUNCTION_CALL);
- }
-
- @Override
- public void visitNode(Tree tree) {
- AtomicBoolean contains = new AtomicBoolean(false);
-
- final FunctionCallTree functionTree = ((FunctionCallTree) tree);
- final String functionName = functionTree.callee().toString();
-
- final List parents = this.getAllParent(tree, new ArrayList<>());
-
- parents.forEach(parent -> {
- if (parent.is(Tree.Kind.SCRIPT)) {
-
- final ScriptTree specific = (ScriptTree) parent;
- final List trees = specific.statements();
-
- trees.forEach(statement -> {
-
- if (statement.is(Tree.Kind.CLASS_DECLARATION)) {
-
- final List methodDeclarations = ((ClassDeclarationTree) statement).members()
- .stream()
- .filter(member -> member.is(Tree.Kind.METHOD_DECLARATION))
- .map(MethodDeclarationTree.class::cast)
- .filter(declarationTree -> this.isFunctionDeclared(declarationTree, functionName))
- .collect(Collectors.toList());
-
- if (methodDeclarations != null && !methodDeclarations.isEmpty()) {
- contains.set(true);
- }
- }
- });
- }
- });
-
- if (!contains.get()) {
- context().newIssue(this, tree, ERROR_MESSAGE);
- }
- }
-
- public boolean isFunctionDeclared(final MethodDeclarationTree method, final String name) {
- if (method == null) {
- return false;
- }
-
- return method.name().text()
- .trim()
- .equals(name.trim());
- }
-
- public List getAllParent(final Tree tree, final List list) {
- if (tree == null)
- return list;
-
- final Tree parent = tree.getParent();
-
- if (parent == null)
- return list;
-
- list.add(parent);
-
- return this.getAllParent(parent, list);
- }
-}
diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC22.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC22.html
deleted file mode 100644
index f5d6da36f..000000000
--- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC22.html
+++ /dev/null
@@ -1,9 +0,0 @@
-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/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)
-Case for a 1GB database:
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC4.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC4.html
deleted file mode 100644
index 6e9687fa7..000000000
--- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC4.html
+++ /dev/null
@@ -1,27 +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).
-
-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 5e06ebef7..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 simple quotes avoid PHP to search inexisting 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)
-Case for a 1GB database:
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC67.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC67.html
deleted file mode 100644
index 6e087ebf4..000000000
--- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC67.html
+++ /dev/null
@@ -1,88 +0,0 @@
-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)
-Case for a 1GB database:
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC69.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC69.html
deleted file mode 100644
index 655f6cab1..000000000
--- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC69.html
+++ /dev/null
@@ -1,104 +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
-
-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)
-Case for a 1GB database:
-
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC72.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC72.html
deleted file mode 100644
index 7973ec509..000000000
--- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC72.html
+++ /dev/null
@@ -1,349 +0,0 @@
-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)
- Case for a 1GB database:
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Case for a 2GB database:
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Case for a 4GB database:
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Case for a 8GB database:
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC74.html b/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC74.html
deleted file mode 100644
index 3b1edba30..000000000
--- a/php-plugin/src/main/resources/fr/greencodeinitiative/l10n/php/rules/custom/EC74.html
+++ /dev/null
@@ -1,101 +0,0 @@
-Databases servers have to solve fields regarding the schema. Knowing and using the schema save 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, adress FROM users ";
- ...
- }
-
-The three sources of impacts of a code identified are:
-- Energy (measured in joules)
-Case for a 1GB database:
-
-
-
-Total:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/PhpPluginTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/PhpPluginTest.java
deleted file mode 100644
index 3c89dab5a..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/PhpPluginTest.java
+++ /dev/null
@@ -1,40 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.php;
-
-import static org.assertj.core.api.Assertions.assertThat;
-import org.junit.Test;
-import org.sonar.api.Plugin;
-import org.sonar.api.SonarEdition;
-import org.sonar.api.SonarQubeSide;
-import org.sonar.api.SonarRuntime;
-import org.sonar.api.internal.PluginContextImpl;
-import org.sonar.api.internal.SonarRuntimeImpl;
-import org.sonar.api.utils.Version;
-
-public class PhpPluginTest {
- @Test
- public void test() {
- SonarRuntime sonarRuntime = SonarRuntimeImpl.forSonarQube(Version.create(9, 9), SonarQubeSide.SCANNER, SonarEdition.DEVELOPER);
- Plugin.Context context = new PluginContextImpl.Builder().setSonarRuntime(sonarRuntime).build();
- new PHPPlugin().define(context);
- assertThat(context.getExtensions()).hasSize(1);
- }
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/PhpRuleRepositoryTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/PhpRuleRepositoryTest.java
deleted file mode 100644
index f2345716d..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/PhpRuleRepositoryTest.java
+++ /dev/null
@@ -1,60 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.php;
-
-import static org.assertj.core.api.Assertions.assertThat;
-import org.assertj.core.api.SoftAssertions;
-import org.junit.Before;
-import org.junit.Test;
-import org.sonar.api.server.rule.RulesDefinition;
-
-public class PhpRuleRepositoryTest {
-
- private PhpRuleRepository phpRuleRepository;
- private RulesDefinition.Context context;
-
- @Before
- public void init() {
- phpRuleRepository = new PhpRuleRepository();
- context = new RulesDefinition.Context();
- phpRuleRepository.define(context);
- }
-
- @Test
- public void test() {
- assertThat(phpRuleRepository.repositoryKey()).isEqualTo(PhpRuleRepository.REPOSITORY_KEY);
- assertThat(context.repositories()).hasSize(1).extracting("key").containsExactly(phpRuleRepository.repositoryKey());
- assertThat(context.repositories().get(0).rules()).hasSize(8);
- assertThat(phpRuleRepository.checkClasses()).hasSize(8);
- }
-
- /**
- * Check all rule keys must be prefixed by 'EC'
- */
- @Test()
- public void testRuleKeyPrefix() {
- RulesDefinition.Repository repository = context.repository(PhpRuleRepository.REPOSITORY_KEY);
- SoftAssertions assertions = new SoftAssertions();
- repository.rules().forEach(
- rule -> assertions.assertThat(rule.key()).startsWith("EC")
- );
- assertions.assertAll();
- }
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidDoubleQuoteCheckTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidDoubleQuoteCheckTest.java
deleted file mode 100644
index 1bd7f2ddb..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidDoubleQuoteCheckTest.java
+++ /dev/null
@@ -1,16 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.io.File;
-
-import org.junit.Test;
-import org.sonar.plugins.php.api.tests.PHPCheckTest;
-import org.sonar.plugins.php.api.tests.PhpTestFile;
-
-public class AvoidDoubleQuoteCheckTest {
-
- @Test
- public void test() throws Exception {
- PHPCheckTest.check(new AvoidDoubleQuoteCheck(), new PhpTestFile(new File("src/test/resources/checks/avoidDoubleQuote.php")));
- }
-
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidFullSQLRequestCheckTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidFullSQLRequestCheckTest.java
deleted file mode 100644
index de90bec78..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidFullSQLRequestCheckTest.java
+++ /dev/null
@@ -1,15 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.io.File;
-
-import org.junit.Test;
-import org.sonar.plugins.php.api.tests.PHPCheckTest;
-import org.sonar.plugins.php.api.tests.PhpTestFile;
-
-public class AvoidFullSQLRequestCheckTest {
-
- @Test
- public void test() {
- PHPCheckTest.check(new AvoidFullSQLRequestCheck(), new PhpTestFile(new File("src/test/resources/checks/AvoidFullSQLRequest.php")));
- }
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidSQLRequestInLoopCheckTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidSQLRequestInLoopCheckTest.java
deleted file mode 100644
index e124b8547..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidSQLRequestInLoopCheckTest.java
+++ /dev/null
@@ -1,15 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.io.File;
-
-import org.junit.Test;
-import org.sonar.plugins.php.api.tests.PHPCheckTest;
-import org.sonar.plugins.php.api.tests.PhpTestFile;
-
-public class AvoidSQLRequestInLoopCheckTest {
-
- @Test
- public void test() throws Exception {
- PHPCheckTest.check(new AvoidSQLRequestInLoopCheck(), new PhpTestFile(new File("src/test/resources/checks/AvoidSQLRequestInLoop.php")));
- }
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidTryCatchFinallyCheckNOKfailsAllTryStatementsTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidTryCatchFinallyCheckNOKfailsAllTryStatementsTest.java
deleted file mode 100644
index 7a14288ce..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidTryCatchFinallyCheckNOKfailsAllTryStatementsTest.java
+++ /dev/null
@@ -1,16 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.io.File;
-
-import org.junit.Test;
-import org.sonar.plugins.php.api.tests.PHPCheckTest;
-import org.sonar.plugins.php.api.tests.PhpTestFile;
-
-public class AvoidTryCatchFinallyCheckNOKfailsAllTryStatementsTest {
-
- @Test
- public void test() throws Exception {
- PHPCheckTest.check(new AvoidTryCatchFinallyCheck_NOK_failsAllTryStatements(), new PhpTestFile(new File("src/test/resources/checks/avoidTryCatchFinallyCheck_NOK_FailsAllTryStatements.php")));
- }
-
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidUsingGlobalVariablesCheckTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidUsingGlobalVariablesCheckTest.java
deleted file mode 100644
index 4b8bda378..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/AvoidUsingGlobalVariablesCheckTest.java
+++ /dev/null
@@ -1,38 +0,0 @@
-/*
- * SonarQube PHP Custom Rules Example
- * Copyright (C) 2016-2016 SonarSource SA
- * mailto:contact AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.php.checks;
-
-import java.io.File;
-
-import org.junit.Test;
-import org.sonar.plugins.php.api.tests.PHPCheckTest;
-import org.sonar.plugins.php.api.tests.PhpTestFile;
-
-/**
- * Test class to test the check implementation.
- */
-public class AvoidUsingGlobalVariablesCheckTest {
-
- @Test
- public void test() throws Exception {
- PHPCheckTest.check(new AvoidUsingGlobalVariablesCheck(), new PhpTestFile(new File("src/test/resources/checks/AvoidUsingGlobalVariablesCheck.php")));
- }
-
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/IncrementCheckTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/IncrementCheckTest.java
deleted file mode 100644
index 777531563..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/IncrementCheckTest.java
+++ /dev/null
@@ -1,38 +0,0 @@
-/*
- * SonarQube PHP Custom Rules Example
- * Copyright (C) 2016-2016 SonarSource SA
- * mailto:contact AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.php.checks;
-
-import java.io.File;
-
-import org.junit.Test;
-import org.sonar.plugins.php.api.tests.PHPCheckTest;
-import org.sonar.plugins.php.api.tests.PhpTestFile;
-
-/**
- * Test class to test the check implementation.
- */
-public class IncrementCheckTest {
-
- @Test
- public void test() throws Exception {
- PHPCheckTest.check(new IncrementCheck(), new PhpTestFile(new File("src/test/resources/checks/incrementCheck.php")));
- }
-
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/NoFunctionCallWhenDeclaringForLoopTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/NoFunctionCallWhenDeclaringForLoopTest.java
deleted file mode 100644
index 2f47ad768..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/NoFunctionCallWhenDeclaringForLoopTest.java
+++ /dev/null
@@ -1,15 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.io.File;
-
-import org.junit.Test;
-import org.sonar.plugins.php.api.tests.PHPCheckTest;
-import org.sonar.plugins.php.api.tests.PhpTestFile;
-
-public class NoFunctionCallWhenDeclaringForLoopTest {
-
- @Test
- public void test() throws Exception {
- PHPCheckTest.check(new NoFunctionCallWhenDeclaringForLoop(), new PhpTestFile(new File("src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.php")));
- }
-}
diff --git a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/UseOfMethodsForBasicOperationsTest.java b/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/UseOfMethodsForBasicOperationsTest.java
deleted file mode 100644
index ba878b1b6..000000000
--- a/php-plugin/src/test/java/fr/greencodeinitiative/php/checks/UseOfMethodsForBasicOperationsTest.java
+++ /dev/null
@@ -1,15 +0,0 @@
-package fr.greencodeinitiative.php.checks;
-
-import java.io.File;
-
-import org.junit.Test;
-import org.sonar.plugins.php.api.tests.PHPCheckTest;
-import org.sonar.plugins.php.api.tests.PhpTestFile;
-
-public class UseOfMethodsForBasicOperationsTest {
-
- @Test
- public void test() throws Exception {
- PHPCheckTest.check(new UseOfMethodsForBasicOperations(), new PhpTestFile(new File("src/test/resources/checks/useOfMethodsForBasicOperations.php")));
- }
-}
diff --git a/php-plugin/src/test/resources/checks/AvoidFullSQLRequest.php b/php-plugin/src/test/resources/checks/AvoidFullSQLRequest.php
deleted file mode 100644
index f32480b78..000000000
--- a/php-plugin/src/test/resources/checks/AvoidFullSQLRequest.php
+++ /dev/null
@@ -1,24 +0,0 @@
-SqlCall("SeLeCt * FrOm table"); // NOK {{Don't use the query SELECT * FROM}}
- OtherClass->SqlCall("SeLeCt DiStInCt * FrOm table"); // NOK {{Don't use the query SELECT * FROM}}
- OtherClass->SqlCall("SeLeCt name FrOm table");
- }
-
- public function PasseAsVariable()
- {
- $sqlQuery1 = "SeLeCt * FrOm table"; // NOK {{Don't use the query SELECT * FROM}}
- $sqlQuery2 = "SeLeCt DiStInCt * FrOm table"; // NOK {{Don't use the query SELECT * FROM}}
- $sqlQuery3 = "SeLeCt name FrOm table";
- OtherClass->SqlCall($sqlQuery1);
- OtherClass->SqlCall($sqlQuery2);
- }
-}
\ No newline at end of file
diff --git a/php-plugin/src/test/resources/checks/AvoidSQLRequestInLoop.php b/php-plugin/src/test/resources/checks/AvoidSQLRequestInLoop.php
deleted file mode 100644
index 8a1fb1293..000000000
--- a/php-plugin/src/test/resources/checks/AvoidSQLRequestInLoop.php
+++ /dev/null
@@ -1,74 +0,0 @@
-Init();
- $this->NoLoop();
- $this->ForLoop($expectedNbOfRequest, $someCondition);
- $this->ForEachLoop($arrayOfQuery, $someCondition);
- $this->WhileLoop($expectedNbOfRequest, $someCondition);
- }
- private function Init()
- {
- $this->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'");
- }
-
- private function NoLoop()
- {
- $result = mysql_query($this->Query);
- // display result or work with it
- }
-
- private function ForLoop($expectedNbOfRequest, $someCondition)
- {
- for($index = 0; $expectedNbOfRequest > $index; ++$index){
- $result = mysql_query($this->Query); // NOK {{Avoid SQL request in loop}}
- // display result or work with it
- if($someCondition)
- {
- $result = mysql_query($OtherQuery); // NOK {{Avoid SQL request in loop}}
- $result = mysql_query($OtherQuery); // NOK {{Avoid SQL request in loop}}
- }
- }
- }
-
- private function ForEachLoop($arrayOfQuery, $someCondition)
- {
- foreach($arrayOfQuery as $query){
- $result = mysql_query($Query); // NOK {{Avoid SQL request in loop}}
- // display result or work with it
- if($someCondition)
- $result = mysql_query($OtherQuery); // NOK {{Avoid SQL request in loop}}
- }
- }
-
- private function WhileLoop($expectedNbOfRequest, $someCondition)
- {
- $nbOfRequest = 0;
- do{
- $result = mysql_query($this->Query); // NOK {{Avoid SQL request in loop}}
- // display result or work with it
- if($someCondition)
- $result = mysql_query($OtherQuery); // NOK {{Avoid SQL request in loop}}
- ++$nbOfRequest;
- }while($expectedNbOfRequest > $nbOfRequest);
- }
-
- private function EmptyLoop()
- {
- for ($i = 1, $j = 0; $i <= 10; $j += $i, print $i, $i++);
- }
-}
\ No newline at end of file
diff --git a/php-plugin/src/test/resources/checks/AvoidUsingGlobalVariablesCheck.php b/php-plugin/src/test/resources/checks/AvoidUsingGlobalVariablesCheck.php
deleted file mode 100644
index 2f5d4eadb..000000000
--- a/php-plugin/src/test/resources/checks/AvoidUsingGlobalVariablesCheck.php
+++ /dev/null
@@ -1,16 +0,0 @@
-
diff --git a/php-plugin/src/test/resources/checks/avoidDoubleQuote.php b/php-plugin/src/test/resources/checks/avoidDoubleQuote.php
deleted file mode 100644
index dd9b9da96..000000000
--- a/php-plugin/src/test/resources/checks/avoidDoubleQuote.php
+++ /dev/null
@@ -1,35 +0,0 @@
-';
- echo $age;
-
- $lastName = 'Hadrien';
- $age = 18;
-
- echo $lastName;
- echo "io.ecocode
ecocode-parent
- 1.1.1-SNAPSHOT
+ 1.4.1-SNAPSHOT
pom
ecoCode Sonar Plugins Project
Provides rules to reduce the environmental footprint of your programs
+ 2023
https://github.com/green-code-initiative/ecocode
green-code-initiative
@@ -22,11 +23,64 @@
+
+
+
+ Gilles Grousset
+ zippy1978@users.noreply.github.com
+ green-code-initiative
+ https://github.com/green-code-initiative
+
+
+ Maxime Malgorn
+ utarwyn@users.noreply.github.com
+ green-code-initiative
+ https://github.com/green-code-initiative
+
+
+ Geoffrey LallouΓ©
+ glalloue@users.noreply.github.com
+ green-code-initiative
+ https://github.com/green-code-initiative
+
+
+ David DE CARVALHO
+ dedece35@users.noreply.github.com
+ green-code-initiative
+ https://github.com/green-code-initiative
+
+
+ Olivier Le GoaΓ«r
+ olegoaer@users.noreply.github.com
+ green-code-initiative
+ https://github.com/green-code-initiative
+
+
+ Julien Hertout
+ jhertout@users.noreply.github.com
+ green-code-initiative
+ https://github.com/green-code-initiative
+
+
+ Jules Delecour
+ jules-delecour-dav@users.noreply.github.com
+ green-code-initiative
+ https://github.com/green-code-initiative
+
+
+ DUBOIS Maxime
+ mdubois81@users.noreply.github.com
+ green-code-initiative
+ https://github.com/green-code-initiative
+
+
+
- python-plugin
+ ecocode-rules-specifications
java-plugin
- javascript-plugin
- php-plugin
@@ -50,26 +104,20 @@
${encoding}
${encoding}
- 9.4.0.54424
- 7.15.0.30507
-
green-code-initiative
https://sonarcloud.io
-
- 0.8.8
+ 9.4.0.54424
+ 7.19.0.31550
+
+ 2.5.0.1358
- 9.7.1.62043
- 2.1.0.1111
- 3.19.0.10254
- 3.25.0.9077
- 9.13.0.20537
1.21.0.505
true
- 3.4.1
- 4.13.2
+
5.9.1
3.23.1
+ 5.3.1
1.7
@@ -92,12 +140,6 @@
${sonar-analyzer-commons.version}
-
- org.sonarsource.sonarqube
- sonar-plugin-api-impl
- ${sonar-plugin-api-impl.version}
-
-
com.google.re2j
@@ -114,33 +156,6 @@
provided
-
-
- org.sonarsource.javascript
- sonar-javascript-plugin
- ${sonarjavascript.version}
- sonar-plugin
- provided
-
-
-
-
- org.sonarsource.php
- sonar-php-plugin
- ${sonarphp.version}
- sonar-plugin
- provided
-
-
-
-
- org.sonarsource.python
- sonar-python-plugin
- ${sonar.python.version}
- sonar-plugin
- provided
-
-
org.sonarsource.java
@@ -156,13 +171,6 @@
test
-
- org.junit.jupiter
- junit-jupiter-migrationsupport
- ${junit.jupiter.version}
- test
-
-
org.assertj
assertj-core
@@ -171,16 +179,9 @@
- junit
- junit
- ${junit.version}
- test
-
-
-
- org.sonarsource.python
- python-checks-testkit
- ${sonar.python.version}
+ org.mockito
+ mockito-junit-jupiter
+ ${mockito.version}
test
@@ -193,12 +194,12 @@
org.apache.maven.plugins
maven-compiler-plugin
- 3.10.1
+ 3.11.0
org.apache.maven.plugins
maven-dependency-plugin
- 3.3.0
+ 3.6.0
org.sonarsource.sonar-packaging-maven-plugin
@@ -208,14 +209,154 @@
org.apache.maven.plugins
maven-shade-plugin
- ${maven-shade-plugin.version}
+ 3.5.0
+
+
+
+ package
+
+ shade
+
+
+
+
+ commons-*:*
+
+ META-INF/**
+
+
+
+ org.*:*
+
+ META-INF/**
+ org/sonar/api/batch/sensor/**
+ javax/annotation/**
+
+
+
+ com.*:*
+
+ META-INF/**
+
+
+
+ junit:*
+
+ META-INF/**
+
+
+
+
+
+
+
+
+ org.apache.maven.plugins
+ maven-surefire-plugin
+ 3.1.2
org.jacoco
jacoco-maven-plugin
- ${jacoco.version}
+ 0.8.10
+
+
+ com.mycila
+ license-maven-plugin
+ 4.1
+
+
+ Green Code Initiative
+ https://www.ecocode.io
+
+
+
+ com/mycila/maven/plugin/license/templates/GPL-3.txt
+
+ **/*.java
+
+
+
+
+
+
+ validate
+
+ check
+
+ validate
+
+
+
+
+
+
+
+ maven-central-publishing
+
+
+
+
+ ossrh
+ https://s01.oss.sonatype.org/content/repositories/snapshots
+
+
+
+
+
+ org.sonatype.plugins
+ nexus-staging-maven-plugin
+ 1.6.13
+ true
+
+ ossrh
+ https://s01.oss.sonatype.org/
+ true
+
+
+
+ org.apache.maven.plugins
+ maven-gpg-plugin
+ 3.1.0
+
+
+ sign-artifacts
+ verify
+
+ sign
+
+
+
+ --pinentry-mode
+ loopback
+
+
+
+
+
+
+
+
+
diff --git a/python-plugin/README.md b/python-plugin/README.md
deleted file mode 100644
index 4e77f52dc..000000000
--- a/python-plugin/README.md
+++ /dev/null
@@ -1 +0,0 @@
-https://github.com/SonarSource/sonar-custom-rules-examples/tree/master/python-custom-rules
\ No newline at end of file
diff --git a/python-plugin/pom.xml b/python-plugin/pom.xml
deleted file mode 100644
index bfef526ff..000000000
--- a/python-plugin/pom.xml
+++ /dev/null
@@ -1,157 +0,0 @@
-
-
- 4.0.0
-
-
- io.ecocode
- ecocode-parent
- 1.1.1-SNAPSHOT
-
-
- ecocode-python-plugin
- sonar-plugin
-
- ecoCode - Python language
- Provides rules to reduce the environmental footprint of your Python programs
- https://github.com/green-code-initiative/ecoCode/tree/main/python-plugin
-
-
-
-
- org.sonarsource.python
- sonar-python-plugin
- sonar-plugin
-
-
-
- org.sonarsource.sonarqube
- sonar-plugin-api
-
-
- org.sonarsource.sonarqube
- sonar-plugin-api-impl
-
-
-
-
-
-
-
-
-
- org.sonarsource.python
- python-checks-testkit
- test
-
-
-
- junit
- junit
- test
-
-
-
-
-
-
-
- org.sonarsource.sonar-packaging-maven-plugin
- sonar-packaging-maven-plugin
- true
-
- ecocodepython
- ${project.name}
- fr.greencodeinitiative.python.PythonPlugin
- true
- python:${sonar.python.version}
- ${sonarqube.version}
- ${java.version}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- org.apache.maven.plugins
- maven-dependency-plugin
-
-
- copy-bundle
- package
-
- copy
-
-
-
-
- ${project.groupId}
- ${project.artifactId}
- ${project.version}
- jar
- true
-
-
- ../lib
-
-
-
-
-
- org.jacoco
- jacoco-maven-plugin
-
-
- file
- false
-
-
-
- prepare-agent
-
- prepare-agent
-
-
-
- report
- test
-
- report
-
-
-
-
-
-
-
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/PythonPlugin.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/PythonPlugin.java
deleted file mode 100644
index 73678cb08..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/PythonPlugin.java
+++ /dev/null
@@ -1,31 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.python;
-
-import org.sonar.api.Plugin;
-
-public class PythonPlugin implements Plugin {
-
- @Override
- public void define(Context context) {
- context.addExtension(PythonRuleRepository.class);
- }
-
-}
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/PythonRuleRepository.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/PythonRuleRepository.java
deleted file mode 100644
index 93de44ffb..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/PythonRuleRepository.java
+++ /dev/null
@@ -1,117 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.python;
-
-import java.io.ByteArrayOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.URL;
-import java.nio.charset.StandardCharsets;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import fr.greencodeinitiative.python.checks.AvoidFullSQLRequest;
-import fr.greencodeinitiative.python.checks.AvoidGettersAndSetters;
-import fr.greencodeinitiative.python.checks.AvoidGlobalVariableInFunctionCheck;
-import fr.greencodeinitiative.python.checks.AvoidSQLRequestInLoop;
-import fr.greencodeinitiative.python.checks.AvoidTryCatchFinallyCheck;
-import fr.greencodeinitiative.python.checks.NoFunctionCallWhenDeclaringForLoop;
-import org.apache.commons.lang.StringUtils;
-import org.sonar.api.rules.RuleType;
-import org.sonar.api.server.rule.RulesDefinition;
-import org.sonar.api.server.rule.RulesDefinitionAnnotationLoader;
-import org.sonar.plugins.python.api.PythonCustomRuleRepository;
-
-public class PythonRuleRepository implements RulesDefinition, PythonCustomRuleRepository {
-
- public static final String LANGUAGE = "py";
- public static final String NAME = "ecoCode";
- public static final String RESOURCE_BASE_PATH = "/fr/greencodeinitiative/l10n/python/rules/python/";
- public static final String REPOSITORY_KEY = "ecocode-python";
-
- @Override
- public void define(Context context) {
- NewRepository repository = context.createRepository(repositoryKey(), LANGUAGE).setName(NAME);
-
- new RulesDefinitionAnnotationLoader().load(repository, checkClasses().toArray(new Class[] {}));
-
- // technical debt
- Map remediationCosts = new HashMap<>();
- remediationCosts.put(AvoidSQLRequestInLoop.RULE_KEY, "10min");
- remediationCosts.put(AvoidFullSQLRequest.RULE_KEY, "20min");
- repository.rules().forEach(rule -> {
- rule.setType(RuleType.CODE_SMELL);
- String debt = remediationCosts.get(rule.key());
-
- // TODO DDC : create support to use org.apache.commons.lang.StringUtils
-// if (StringUtils.isBlank(debt)) {
- if (debt == null || debt.trim().equals("")) {
- // default debt to 5min for issue correction
- rule.setDebtRemediationFunction(
- rule.debtRemediationFunctions().constantPerIssue("5min"));
- } else {
- rule.setDebtRemediationFunction(
- rule.debtRemediationFunctions().constantPerIssue(debt));
- }
- });
-
- // HTML description
- repository.rules().forEach(rule ->
- rule.setHtmlDescription(loadResource(RESOURCE_BASE_PATH + rule.key() + ".html")));
-
- repository.done();
- }
-
- @Override
- public String repositoryKey() {
- return REPOSITORY_KEY;
- }
-
- @Override
- public List checkClasses() {
- return Arrays.asList(
- AvoidGettersAndSetters.class,
- AvoidGlobalVariableInFunctionCheck.class,
- AvoidSQLRequestInLoop.class,
- AvoidTryCatchFinallyCheck.class,
- NoFunctionCallWhenDeclaringForLoop.class,
- AvoidFullSQLRequest.class
- );
- }
-
- private String loadResource(String path) {
- URL resource = getClass().getResource(path);
- if (resource == null) {
- throw new IllegalStateException("Resource not found: " + path);
- }
- ByteArrayOutputStream result = new ByteArrayOutputStream();
- try (InputStream in = resource.openStream()) {
- byte[] buffer = new byte[1024];
- for (int len = in.read(buffer); len != -1; len = in.read(buffer)) {
- result.write(buffer, 0, len);
- }
- return new String(result.toByteArray(), StandardCharsets.UTF_8);
- } catch (IOException e) {
- throw new IllegalStateException("Failed to read resource: " + path, e);
- }
- }
-}
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequest.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequest.java
deleted file mode 100644
index 39e700245..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequest.java
+++ /dev/null
@@ -1,76 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.regex.Pattern;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.python.api.PythonSubscriptionCheck;
-import org.sonar.plugins.python.api.SubscriptionContext;
-import org.sonar.plugins.python.api.tree.StringElement;
-import org.sonar.plugins.python.api.tree.StringLiteral;
-import org.sonar.plugins.python.api.tree.Tree;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidFullSQLRequest.RULE_KEY,
- name = AvoidFullSQLRequest.MESSAGERULE,
- description = AvoidFullSQLRequest.MESSAGERULE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "S74")
-public class AvoidFullSQLRequest extends PythonSubscriptionCheck {
-
- public static final String RULE_KEY = "EC74";
-
- protected static final String MESSAGERULE = "Don't use the query SELECT * FROM";
-
- // TODO DDC : create support to add in deployment th dependency com.google.re2j:re2j
- // and replace "import java.util.regex.Pattern" by "import com.google.re2j.Pattern"
- private static final Pattern PATTERN = Pattern.compile("(?i).*select.*\\*.*from.*");
- private static final Map> linesWithIssuesByFile = new HashMap<>();
-
-
- @Override
- public void initialize(Context context) {
- context.registerSyntaxNodeConsumer(Tree.Kind.STRING_LITERAL, this::visitNodeString);
- }
-
- public void visitNodeString(SubscriptionContext ctx) {
- StringLiteral stringLiteral = (StringLiteral) ctx.syntaxNode();
- stringLiteral.stringElements().forEach(stringElement -> checkIssue(stringElement, ctx));
- }
-
- public void checkIssue(StringElement stringElement, SubscriptionContext ctx) {
- if (lineAlreadyHasThisIssue(stringElement, ctx)) return;
- if (PATTERN.matcher(stringElement.value()).matches()) {
- repport(stringElement, ctx);
- }
- }
-
- private void repport(StringElement stringElement, SubscriptionContext ctx) {
- if (stringElement.firstToken() != null) {
- final String classname = ctx.pythonFile().fileName();
- final int line = stringElement.firstToken().line();
- linesWithIssuesByFile.computeIfAbsent(classname, k -> new ArrayList<>());
- linesWithIssuesByFile.get(classname).add(line);
- }
- ctx.addIssue(stringElement, MESSAGERULE);
- }
-
- private boolean lineAlreadyHasThisIssue(StringElement stringElement, SubscriptionContext ctx) {
- if (stringElement.firstToken() != null) {
- final String filename = ctx.pythonFile().fileName();
- final int line = stringElement.firstToken().line();
-
- return linesWithIssuesByFile.containsKey(filename)
- && linesWithIssuesByFile.get(filename).contains(line);
- }
-
- return false;
- }
-}
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSetters.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSetters.java
deleted file mode 100644
index b3aeccde1..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSetters.java
+++ /dev/null
@@ -1,81 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import java.util.List;
-import java.util.stream.Collectors;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.python.api.PythonSubscriptionCheck;
-import org.sonar.plugins.python.api.SubscriptionContext;
-import org.sonar.plugins.python.api.tree.AnyParameter;
-import org.sonar.plugins.python.api.tree.AssignmentStatement;
-import org.sonar.plugins.python.api.tree.FunctionDef;
-import org.sonar.plugins.python.api.tree.ParameterList;
-import org.sonar.plugins.python.api.tree.QualifiedExpression;
-import org.sonar.plugins.python.api.tree.ReturnStatement;
-import org.sonar.plugins.python.api.tree.Statement;
-import org.sonar.plugins.python.api.tree.StatementList;
-import org.sonar.plugins.python.api.tree.Tree;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidGettersAndSetters.RULE_KEY,
- name = AvoidGettersAndSetters.DESCRIPTION,
- description = AvoidGettersAndSetters.DESCRIPTION,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "D7")
-public class AvoidGettersAndSetters extends PythonSubscriptionCheck {
-
- public static final String RULE_KEY = "EC7";
- public static final String DESCRIPTION = "Avoid creating getter and setter methods in classes";
-
- @Override
- public void initialize(Context context) {
- context.registerSyntaxNodeConsumer(Tree.Kind.FUNCDEF, ctx -> {
- FunctionDef functionDef = (FunctionDef) ctx.syntaxNode();
- StatementList statementList = functionDef.body();
- List statements = statementList.statements();
- if (functionDef.parent().parent().is(Tree.Kind.CLASSDEF)) {
- checkAllGetters(statements, functionDef, ctx);
- checkAllSetters(statements, functionDef, ctx);
- }
- });
- }
-
- public void checkAllSetters(List statements, FunctionDef functionDef, SubscriptionContext ctx) {
- if (statements.size() == 1 && statements.get(0).is(Tree.Kind.ASSIGNMENT_STMT)) {
- AssignmentStatement assignmentStatement = (AssignmentStatement) statements.get(0);
- if (checkIfStatementIsQualifiedExpressionAndStartsWithSelfDot((QualifiedExpression) assignmentStatement.children().get(0).children().get(0))) {
- // Check if assignedValue is a parameter of the function
- ParameterList parameters = functionDef.parameters();
- if (parameters != null && !parameters.all().stream().filter(p -> checkAssignementFromParameter(assignmentStatement, p)).collect(Collectors.toList()).isEmpty()) {
- ctx.addIssue(functionDef.defKeyword(), AvoidGettersAndSetters.DESCRIPTION);
- }
- }
- }
- }
-
- public void checkAllGetters(List statements, FunctionDef functionDef, SubscriptionContext ctx) {
- Statement lastStatement = statements.get(statements.size() - 1);
- if (lastStatement.is(Tree.Kind.RETURN_STMT)) {
- List returnStatementChildren = ((ReturnStatement) lastStatement).children();
- if (returnStatementChildren.get(1).is(Tree.Kind.QUALIFIED_EXPR) &&
- checkIfStatementIsQualifiedExpressionAndStartsWithSelfDot((QualifiedExpression) returnStatementChildren.get(1))) {
- ctx.addIssue(functionDef.defKeyword(), AvoidGettersAndSetters.DESCRIPTION);
- }
- }
- }
-
- public boolean checkAssignementFromParameter(AssignmentStatement assignmentStatement, AnyParameter parameter) {
- String parameterToString = parameter.firstToken().value();
- return assignmentStatement.assignedValue().firstToken().value().equalsIgnoreCase(parameterToString);
- }
-
- public boolean checkIfStatementIsQualifiedExpressionAndStartsWithSelfDot(QualifiedExpression qualifiedExpression) {
- List qualifedExpressionChildren = qualifiedExpression.children();
- return qualifedExpressionChildren.size() == 3 &&
- qualifedExpressionChildren.get(0).firstToken().value().equalsIgnoreCase("self") &&
- qualifedExpressionChildren.get(1).firstToken().value().equalsIgnoreCase(".");
- }
-}
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheck.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheck.java
deleted file mode 100644
index ef712ec35..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheck.java
+++ /dev/null
@@ -1,327 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.python.api.PythonSubscriptionCheck;
-import org.sonar.plugins.python.api.SubscriptionCheck;
-import org.sonar.plugins.python.api.SubscriptionContext;
-import org.sonar.plugins.python.api.symbols.Symbol;
-import org.sonar.plugins.python.api.tree.AnnotatedAssignment;
-import org.sonar.plugins.python.api.tree.ArgList;
-import org.sonar.plugins.python.api.tree.AssertStatement;
-import org.sonar.plugins.python.api.tree.AssignmentExpression;
-import org.sonar.plugins.python.api.tree.AssignmentStatement;
-import org.sonar.plugins.python.api.tree.AwaitExpression;
-import org.sonar.plugins.python.api.tree.BinaryExpression;
-import org.sonar.plugins.python.api.tree.CallExpression;
-import org.sonar.plugins.python.api.tree.CompoundAssignmentStatement;
-import org.sonar.plugins.python.api.tree.ComprehensionExpression;
-import org.sonar.plugins.python.api.tree.ComprehensionFor;
-import org.sonar.plugins.python.api.tree.ComprehensionIf;
-import org.sonar.plugins.python.api.tree.ConditionalExpression;
-import org.sonar.plugins.python.api.tree.DictCompExpression;
-import org.sonar.plugins.python.api.tree.DictionaryLiteral;
-import org.sonar.plugins.python.api.tree.ElseClause;
-import org.sonar.plugins.python.api.tree.ExceptClause;
-import org.sonar.plugins.python.api.tree.ExecStatement;
-import org.sonar.plugins.python.api.tree.ExpressionList;
-import org.sonar.plugins.python.api.tree.ExpressionStatement;
-import org.sonar.plugins.python.api.tree.FileInput;
-import org.sonar.plugins.python.api.tree.FinallyClause;
-import org.sonar.plugins.python.api.tree.ForStatement;
-import org.sonar.plugins.python.api.tree.FunctionDef;
-import org.sonar.plugins.python.api.tree.IfStatement;
-import org.sonar.plugins.python.api.tree.KeyValuePair;
-import org.sonar.plugins.python.api.tree.LambdaExpression;
-import org.sonar.plugins.python.api.tree.ListLiteral;
-import org.sonar.plugins.python.api.tree.Name;
-import org.sonar.plugins.python.api.tree.Parameter;
-import org.sonar.plugins.python.api.tree.ParameterList;
-import org.sonar.plugins.python.api.tree.ParenthesizedExpression;
-import org.sonar.plugins.python.api.tree.PrintStatement;
-import org.sonar.plugins.python.api.tree.RaiseStatement;
-import org.sonar.plugins.python.api.tree.RegularArgument;
-import org.sonar.plugins.python.api.tree.ReprExpression;
-import org.sonar.plugins.python.api.tree.ReturnStatement;
-import org.sonar.plugins.python.api.tree.SetLiteral;
-import org.sonar.plugins.python.api.tree.StatementList;
-import org.sonar.plugins.python.api.tree.SubscriptionExpression;
-import org.sonar.plugins.python.api.tree.Tree;
-import org.sonar.plugins.python.api.tree.TryStatement;
-import org.sonar.plugins.python.api.tree.Tuple;
-import org.sonar.plugins.python.api.tree.TupleParameter;
-import org.sonar.plugins.python.api.tree.UnaryExpression;
-import org.sonar.plugins.python.api.tree.UnpackingExpression;
-import org.sonar.plugins.python.api.tree.WhileStatement;
-import org.sonar.plugins.python.api.tree.YieldExpression;
-import org.sonar.plugins.python.api.tree.YieldStatement;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidGlobalVariableInFunctionCheck.RULE_KEY,
- name = "Do not call global variables directly inside functions",
- description = AvoidGlobalVariableInFunctionCheck.DESCRIPTION,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "D4")
-public class AvoidGlobalVariableInFunctionCheck extends PythonSubscriptionCheck {
-
- public static final String RULE_KEY = "EC4";
- public static final String DESCRIPTION = "Use local variable (function/class scope) instead of global variable (application scope)";
-
- private List globalVariables;
- private List definedLocalVariables;
- private Map usedLocalVariables;
-
- @Override
- public void initialize(SubscriptionCheck.Context context) {
- globalVariables = new ArrayList<>();
- context.registerSyntaxNodeConsumer(Tree.Kind.FILE_INPUT, this::visitFileInput);
- context.registerSyntaxNodeConsumer(Tree.Kind.FUNCDEF, this::visitFuncDef);
- }
-
- public void visitFileInput(SubscriptionContext ctx) {
- FileInput fileInput = (FileInput) ctx.syntaxNode();
- fileInput.globalVariables().stream().filter(v -> v.is(Symbol.Kind.OTHER)).forEach(v -> this.globalVariables.add(v.name()));
- }
-
- void visitFuncDef(SubscriptionContext ctx) {
- this.definedLocalVariables = new ArrayList<>();
- this.usedLocalVariables = new HashMap<>();
-
- FunctionDef functionDef = (FunctionDef) ctx.syntaxNode();
-
- ParameterList parameterList = functionDef.parameters();
- if (parameterList != null) {
- parameterList.nonTuple().forEach(p -> extractVariablesFromExpression(p, true));
- }
-
- functionDef.body().statements()
- .forEach(s -> extractVariablesFromExpression(s, false));
-
- this.usedLocalVariables.entrySet().stream()
- .filter(e -> !this.definedLocalVariables.contains(e.getValue()) && this.globalVariables.contains(e.getValue()))
- .forEach(e -> ctx.addIssue(e.getKey(), DESCRIPTION));
- }
-
- void extractVariablesFromExpression(Tree element, boolean isAssigned) {
- if (element == null) {
- return;
- }
-
- switch (element.getKind()) {
- case REGULAR_ARGUMENT:
- extractVariablesFromExpression(((RegularArgument) element).expression(), isAssigned);
- break;
- case ARG_LIST:
- ((ArgList) element).arguments().forEach(a -> extractVariablesFromExpression(a, isAssigned));
- break;
- case ANNOTATED_ASSIGNMENT:
- AnnotatedAssignment annotatedAssignment = (AnnotatedAssignment) element;
- extractVariablesFromExpression(annotatedAssignment.variable(), true);
- extractVariablesFromExpression(annotatedAssignment.assignedValue(), false);
- break;
- case ASSERT_STMT:
- AssertStatement assertStatement = (AssertStatement) element;
- extractVariablesFromExpression(assertStatement.condition(), false);
- extractVariablesFromExpression(assertStatement.message(), false);
- break;
- case ASSIGNMENT_STMT:
- AssignmentStatement assignmentStatement = (AssignmentStatement) element;
- assignmentStatement.lhsExpressions().forEach(e -> extractVariablesFromExpression(e, true));
- extractVariablesFromExpression(assignmentStatement.assignedValue(), false);
- break;
- case CALL_EXPR:
- extractVariablesFromExpression(((CallExpression) element).argumentList(), isAssigned);
- break;
- case CONDITIONAL_EXPR:
- ConditionalExpression conditionalExpression = (ConditionalExpression) element;
- extractVariablesFromExpression(conditionalExpression.trueExpression(), isAssigned);
- extractVariablesFromExpression(conditionalExpression.falseExpression(), false);
- extractVariablesFromExpression(conditionalExpression.condition(), isAssigned);
- break;
- case COMPOUND_ASSIGNMENT:
- CompoundAssignmentStatement compoundAssignmentStatement = (CompoundAssignmentStatement) element;
- extractVariablesFromExpression(compoundAssignmentStatement.lhsExpression(), true);
- extractVariablesFromExpression(compoundAssignmentStatement.rhsExpression(), false);
- break;
- case DICTIONARY_LITERAL:
- ((DictionaryLiteral) element).elements().forEach(e -> extractVariablesFromExpression(e, false));
- break;
- case ELSE_CLAUSE:
- extractVariablesFromExpression(((ElseClause) element).body(), isAssigned);
- break;
- case EXCEPT_CLAUSE:
- extractVariablesFromExpression(((ExceptClause) element).body(), isAssigned);
- break;
- case EXEC_STMT:
- ExecStatement execStatement = (ExecStatement) element;
- extractVariablesFromExpression(execStatement.expression(), isAssigned);
- extractVariablesFromExpression(execStatement.globalsExpression(), isAssigned);
- extractVariablesFromExpression(execStatement.localsExpression(), isAssigned);
- break;
- case EXPRESSION_LIST:
- ((ExpressionList) element).expressions().forEach(e -> extractVariablesFromExpression(e, isAssigned));
- break;
- case EXPRESSION_STMT:
- ((ExpressionStatement) element).expressions().forEach(e -> extractVariablesFromExpression(e, isAssigned));
- break;
- case FILE_INPUT:
- extractVariablesFromExpression(((FileInput) element).statements(), isAssigned);
- break;
- case FINALLY_CLAUSE:
- extractVariablesFromExpression(((FinallyClause) element).body(), isAssigned);
- break;
- case FOR_STMT:
- ForStatement forStatement = ((ForStatement) element);
- forStatement.expressions().forEach(e -> extractVariablesFromExpression(e, true));
- forStatement.testExpressions().forEach(e -> extractVariablesFromExpression(e, false));
- extractVariablesFromExpression(forStatement.body(), isAssigned);
- extractVariablesFromExpression(forStatement.elseClause(), isAssigned);
- break;
- case IF_STMT:
- IfStatement ifStatement = (IfStatement) element;
- extractVariablesFromExpression(ifStatement.condition(), false);
- extractVariablesFromExpression(ifStatement.body(), isAssigned);
- extractVariablesFromExpression(ifStatement.elseBranch(), isAssigned);
- ifStatement.elifBranches().forEach(b -> extractVariablesFromExpression(b, isAssigned));
- break;
- case LAMBDA:
- extractVariablesFromExpression(((LambdaExpression) element).expression(), isAssigned);
- break;
- case LIST_LITERAL:
- extractVariablesFromExpression(((ListLiteral) element).elements(), false);
- break;
- case NAME:
- if (isAssigned) {
- this.definedLocalVariables.add(((Name) element).name());
- } else {
- this.usedLocalVariables.put(element, ((Name) element).name());
- }
- break;
- case PRINT_STMT:
- ((PrintStatement) element).expressions().forEach(e -> extractVariablesFromExpression(e, false));
- break;
- case RAISE_STMT:
- RaiseStatement raiseStatement = (RaiseStatement) element;
- extractVariablesFromExpression(raiseStatement.fromExpression(), false);
- raiseStatement.expressions().forEach(e -> extractVariablesFromExpression(e, false));
- break;
- case REPR:
- extractVariablesFromExpression(((ReprExpression) element).expressionList(), isAssigned);
- break;
- case RETURN_STMT:
- ((ReturnStatement) element).expressions().forEach(e -> extractVariablesFromExpression(e, false));
- break;
- case SET_LITERAL:
- ((SetLiteral) element).elements().forEach(e -> extractVariablesFromExpression(e, false));
- break;
- case STATEMENT_LIST:
- ((StatementList) element).statements().forEach(s -> extractVariablesFromExpression(s, isAssigned));
- break;
- case TRY_STMT:
- TryStatement tryStatement = (TryStatement) element;
- extractVariablesFromExpression(tryStatement.body(), isAssigned);
- tryStatement.exceptClauses().forEach(c -> extractVariablesFromExpression(c, isAssigned));
- extractVariablesFromExpression(tryStatement.elseClause(), isAssigned);
- extractVariablesFromExpression(tryStatement.finallyClause(), isAssigned);
- break;
- case PARAMETER:
- Parameter parameter = (Parameter) element;
- extractVariablesFromExpression(parameter.name(), true);
- extractVariablesFromExpression(parameter.defaultValue(), false);
- break;
- case TUPLE_PARAMETER:
- ((TupleParameter) element).parameters().forEach(p -> extractVariablesFromExpression(p, isAssigned));
- break;
- case PARAMETER_LIST:
- ((ParameterList) element).all().forEach(a -> extractVariablesFromExpression(a, true));
- break;
- case WHILE_STMT:
- WhileStatement whileStatement = (WhileStatement) element;
- extractVariablesFromExpression(whileStatement.condition(), false);
- extractVariablesFromExpression(whileStatement.body(), isAssigned);
- extractVariablesFromExpression(whileStatement.elseClause(), isAssigned);
- break;
- case YIELD_EXPR:
- ((YieldExpression) element).expressions().forEach(e -> extractVariablesFromExpression(e, isAssigned));
- break;
- case YIELD_STMT:
- extractVariablesFromExpression(((YieldStatement) element).yieldExpression(), isAssigned);
- break;
- case PARENTHESIZED:
- extractVariablesFromExpression(((ParenthesizedExpression) element).expression(), isAssigned);
- break;
- case UNPACKING_EXPR:
- extractVariablesFromExpression(((UnpackingExpression) element).expression(), isAssigned);
- break;
- case AWAIT:
- extractVariablesFromExpression(((AwaitExpression) element).expression(), false);
- break;
- case TUPLE:
- ((Tuple) element).elements().forEach(e -> extractVariablesFromExpression(e, isAssigned));
- break;
- case DICT_COMPREHENSION:
- extractVariablesFromExpression(((DictCompExpression) element).comprehensionFor(), false);
- break;
- case LIST_COMPREHENSION:
- case SET_COMPREHENSION:
- case GENERATOR_EXPR:
- extractVariablesFromExpression(((ComprehensionExpression) element).resultExpression(), false);
- extractVariablesFromExpression(((ComprehensionExpression) element).comprehensionFor(), true);
- break;
- case COMP_FOR:
- extractVariablesFromExpression(((ComprehensionFor) element).loopExpression(), true);
- extractVariablesFromExpression(((ComprehensionFor) element).iterable(), false);
- break;
- case COMP_IF:
- extractVariablesFromExpression(((ComprehensionIf) element).condition(), false);
- break;
- case SUBSCRIPTION:
- extractVariablesFromExpression(((SubscriptionExpression) element).object(), false);
- extractVariablesFromExpression(((SubscriptionExpression) element).subscripts(), false);
- break;
- case PLUS:
- case MINUS:
- case MULTIPLICATION:
- case DIVISION:
- case FLOOR_DIVISION:
- case MODULO:
- case MATRIX_MULTIPLICATION:
- case SHIFT_EXPR:
- case BITWISE_AND:
- case BITWISE_OR:
- case BITWISE_XOR:
- case AND:
- case OR:
- case COMPARISON:
- case POWER:
- BinaryExpression binaryExpression = (BinaryExpression) element;
- extractVariablesFromExpression(binaryExpression.leftOperand(), false);
- extractVariablesFromExpression(binaryExpression.rightOperand(), false);
- break;
- case UNARY_PLUS:
- case UNARY_MINUS:
- case BITWISE_COMPLEMENT:
- case NOT:
- extractVariablesFromExpression(((UnaryExpression) element).expression(), false);
- break;
- case ASSIGNMENT_EXPRESSION:
- AssignmentExpression assignmentExpression = (AssignmentExpression) element;
- extractVariablesFromExpression(assignmentExpression.lhsName(), true);
- extractVariablesFromExpression(assignmentExpression.expression(), false);
- break;
- case KEY_VALUE_PAIR:
- KeyValuePair keyValuePair = (KeyValuePair) element;
- extractVariablesFromExpression(keyValuePair.key(), true);
- extractVariablesFromExpression(keyValuePair.value(), false);
- break;
- default:
- }
- }
-}
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoop.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoop.java
deleted file mode 100644
index 97877cf22..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoop.java
+++ /dev/null
@@ -1,92 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import java.util.Arrays;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Objects;
-import java.util.Set;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.python.api.PythonSubscriptionCheck;
-import org.sonar.plugins.python.api.SubscriptionContext;
-import org.sonar.plugins.python.api.symbols.Symbol;
-import org.sonar.plugins.python.api.tree.AliasedName;
-import org.sonar.plugins.python.api.tree.BaseTreeVisitor;
-import org.sonar.plugins.python.api.tree.CallExpression;
-import org.sonar.plugins.python.api.tree.FileInput;
-import org.sonar.plugins.python.api.tree.Name;
-import org.sonar.plugins.python.api.tree.QualifiedExpression;
-import org.sonar.plugins.python.api.tree.Tree;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidSQLRequestInLoop.RULE_KEY,
- name = "Avoid SQL request in loop",
- description = AvoidSQLRequestInLoop.MESSAGE_RULE,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "S72")
-public class AvoidSQLRequestInLoop extends PythonSubscriptionCheck {
-
- public static final String RULE_KEY = "EC72";
-
- // TODO: Handle ORM lib
- private static final List SQL_LIBS = Arrays.asList("cx_Oracle", "mysql.connector", "psycopg2", "pymssql", "pyodbc", "sqlite3");
-
- protected static final String MESSAGE_RULE = "Avoid performing SQL queries within a loop";
-
- private boolean isUsingSqlLib = false;
-
- @Override
- public void initialize(Context context) {
- context.registerSyntaxNodeConsumer(Tree.Kind.FILE_INPUT, this::visitFile);
- context.registerSyntaxNodeConsumer(Tree.Kind.CALL_EXPR, this::checkCallExpression);
- }
-
- private void visitFile(SubscriptionContext ctx) {
- FileInput tree = (FileInput) ctx.syntaxNode();
- SymbolsFromImport visitor = new SymbolsFromImport();
- tree.accept(visitor);
- visitor.symbols.stream()
- .filter(Objects::nonNull)
- .map(Symbol::fullyQualifiedName)
- .filter(Objects::nonNull)
- .forEach(qualifiedName -> {
- if (SQL_LIBS.contains(qualifiedName)) {
- isUsingSqlLib = true;
- }
- });
- }
-
- private static class SymbolsFromImport extends BaseTreeVisitor {
- private final Set symbols = new HashSet<>();
-
- @Override
- public void visitAliasedName(AliasedName aliasedName) {
- List names = aliasedName.dottedName().names();
- symbols.add(names.get(names.size() - 1).symbol());
- }
- }
-
- private void checkCallExpression(SubscriptionContext context) {
- CallExpression expression = (CallExpression) context.syntaxNode();
-
- if (expression.callee().is(Tree.Kind.QUALIFIED_EXPR)) {
- String name = ((QualifiedExpression) expression.callee()).name().name();
- if (isUsingSqlLib && "execute".equals(name) && hasLoopParent(expression)) {
- context.addIssue(expression, AvoidSQLRequestInLoop.MESSAGE_RULE);
- }
- }
- }
-
- private boolean hasLoopParent(Tree tree) {
- for (Tree parent = tree.parent(); parent != null; parent = parent.parent()) {
- Tree.Kind kind = parent.getKind();
- if (kind == Tree.Kind.FOR_STMT || kind == Tree.Kind.WHILE_STMT) {
- return true;
- }
- }
- return false;
- }
-}
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheck.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheck.java
deleted file mode 100644
index 2d70e97f3..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheck.java
+++ /dev/null
@@ -1,34 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.python.api.PythonSubscriptionCheck;
-import org.sonar.plugins.python.api.SubscriptionContext;
-import org.sonar.plugins.python.api.tree.Tree;
-import org.sonar.plugins.python.api.tree.TryStatement;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = AvoidTryCatchFinallyCheck.RULE_KEY,
- name = "Avoid using try-catch-finally statement",
- description = AvoidTryCatchFinallyCheck.DESCRIPTION,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "S34")
-public class AvoidTryCatchFinallyCheck extends PythonSubscriptionCheck {
-
- public static final String RULE_KEY = "EC34";
- public static final String DESCRIPTION = "Avoid the use of try-catch";
-
- @Override
- public void initialize(Context context) {
- context.registerSyntaxNodeConsumer(Tree.Kind.TRY_STMT, this::visitNode);
- }
-
- public void visitNode(SubscriptionContext ctx) {
- TryStatement tryStatement = (TryStatement) ctx.syntaxNode();
- ctx.addIssue(tryStatement.tryKeyword(), DESCRIPTION);
-
- }
-
-}
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoop.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoop.java
deleted file mode 100644
index 906a43253..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoop.java
+++ /dev/null
@@ -1,31 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import org.sonar.check.Priority;
-import org.sonar.check.Rule;
-import org.sonar.plugins.python.api.PythonSubscriptionCheck;
-import org.sonar.plugins.python.api.tree.CallExpression;
-import org.sonar.plugins.python.api.tree.Tree;
-import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
-
-@Rule(
- key = NoFunctionCallWhenDeclaringForLoop.RULE_KEY,
- name = NoFunctionCallWhenDeclaringForLoop.DESCRIPTION,
- description = NoFunctionCallWhenDeclaringForLoop.DESCRIPTION,
- priority = Priority.MINOR,
- tags = {"bug", "eco-design", "ecocode"})
-@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "S69")
-public class NoFunctionCallWhenDeclaringForLoop extends PythonSubscriptionCheck {
-
- public static final String RULE_KEY = "EC69";
- public static final String DESCRIPTION = "Do not call a function when declaring a for-type loop";
-
- @Override
- public void initialize(Context context) {
- context.registerSyntaxNodeConsumer(Tree.Kind.CALL_EXPR, ctx -> {
- CallExpression callExpression = (CallExpression) ctx.syntaxNode();
- if (callExpression.parent().getKind() == Tree.Kind.FOR_STMT) {
- ctx.addIssue(callExpression, NoFunctionCallWhenDeclaringForLoop.DESCRIPTION);
- }
- });
- }
-}
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/package-info.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/package-info.java
deleted file mode 100644
index 63be179f7..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/checks/package-info.java
+++ /dev/null
@@ -1,24 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-@ParametersAreNonnullByDefault
-package fr.greencodeinitiative.python.checks;
-
-import javax.annotation.ParametersAreNonnullByDefault;
-
diff --git a/python-plugin/src/main/java/fr/greencodeinitiative/python/package-info.java b/python-plugin/src/main/java/fr/greencodeinitiative/python/package-info.java
deleted file mode 100644
index 58299e2f7..000000000
--- a/python-plugin/src/main/java/fr/greencodeinitiative/python/package-info.java
+++ /dev/null
@@ -1,24 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-@ParametersAreNonnullByDefault
-package fr.greencodeinitiative.python;
-
-import javax.annotation.ParametersAreNonnullByDefault;
-
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 e72e14b5b..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 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:
- 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/EC69.html b/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC69.html
deleted file mode 100644
index 6d2b10475..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 iterations. 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 837f0493d..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 transfert.
-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 8d977de29..000000000
--- a/python-plugin/src/main/resources/fr/greencodeinitiative/l10n/python/rules/python/EC74.html
+++ /dev/null
@@ -1,21 +0,0 @@
-Databases servers have to solves fileds regarding to schema. Knowing and using the schema save 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, adress 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
deleted file mode 100644
index 03c88941b..000000000
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java
+++ /dev/null
@@ -1,40 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package fr.greencodeinitiative.python;
-
-import static org.assertj.core.api.Assertions.assertThat;
-import org.junit.Test;
-import org.sonar.api.Plugin;
-import org.sonar.api.SonarEdition;
-import org.sonar.api.SonarQubeSide;
-import org.sonar.api.SonarRuntime;
-import org.sonar.api.internal.PluginContextImpl;
-import org.sonar.api.internal.SonarRuntimeImpl;
-import org.sonar.api.utils.Version;
-
-public class PythonPluginTest {
- @Test
- public void test() {
- SonarRuntime sonarRuntime = SonarRuntimeImpl.forSonarQube(Version.create(9, 9), SonarQubeSide.SCANNER, SonarEdition.DEVELOPER);
- Plugin.Context context = new PluginContextImpl.Builder().setSonarRuntime(sonarRuntime).build();
- new PythonPlugin().define(context);
- 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
deleted file mode 100644
index 101ff2841..000000000
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java
+++ /dev/null
@@ -1,63 +0,0 @@
-/*
- * SonarQube Python Plugin
- * Copyright (C) 2012-2019 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-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.sonar.api.server.rule.RulesDefinition;
-
-public 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);
- }
-
- @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(6);
- assertThat(pythonRuleRepository.checkClasses()).hasSize(6);
- }
-
-
- /**
- * Check all rule keys must be prefixed by 'EC'
- */
- @Test
- public void testRuleKeyPrefix() {
- SoftAssertions assertions = new SoftAssertions();
- repository.rules().forEach(
- rule -> assertions.assertThat(rule.key()).startsWith("EC")
- );
- assertions.assertAll();
- }
-}
diff --git a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequestTest.java b/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequestTest.java
deleted file mode 100644
index e03a71fa2..000000000
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequestTest.java
+++ /dev/null
@@ -1,12 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import org.junit.Test;
-import org.sonar.python.checks.utils.PythonCheckVerifier;
-
-public class AvoidFullSQLRequestTest {
-
- @Test
- public void test() {
- PythonCheckVerifier.verify("src/test/resources/checks/avoidFullSQLRequest.py", new AvoidFullSQLRequest());
- }
-}
diff --git a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSettersTest.java b/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSettersTest.java
deleted file mode 100644
index 26d7b4db3..000000000
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSettersTest.java
+++ /dev/null
@@ -1,12 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import org.junit.Test;
-import org.sonar.python.checks.utils.PythonCheckVerifier;
-
-public class AvoidGettersAndSettersTest {
-
- @Test
- public void test() {
- PythonCheckVerifier.verify("src/test/resources/checks/avoidGettersAndSetters.py", new AvoidGettersAndSetters());
- }
-}
diff --git a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheckTest.java b/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheckTest.java
deleted file mode 100644
index c58ed4bc8..000000000
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheckTest.java
+++ /dev/null
@@ -1,11 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import org.junit.Test;
-import org.sonar.python.checks.utils.PythonCheckVerifier;
-
-public class AvoidGlobalVariableInFunctionCheckTest {
- @Test
- public void test() {
- PythonCheckVerifier.verify("src/test/resources/checks/avoidGlobalVariableInFunction.py", new AvoidGlobalVariableInFunctionCheck());
- }
-}
diff --git a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoopTest.java b/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoopTest.java
deleted file mode 100644
index a982bf0ef..000000000
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoopTest.java
+++ /dev/null
@@ -1,12 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import org.junit.Test;
-import org.sonar.python.checks.utils.PythonCheckVerifier;
-
-public class AvoidSQLRequestInLoopTest {
- @Test
- public void test() {
- PythonCheckVerifier.verify("src/test/resources/checks/avoidSQLRequestInLoop.py", new AvoidSQLRequestInLoop());
- PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/avoidSQLRequestInLoopNoImports.py", new AvoidSQLRequestInLoop());
- }
-}
diff --git a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheckTest.java b/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheckTest.java
deleted file mode 100644
index 03450d068..000000000
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheckTest.java
+++ /dev/null
@@ -1,12 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-
-import org.junit.Test;
-import org.sonar.python.checks.utils.PythonCheckVerifier;
-
-public class AvoidTryCatchFinallyCheckTest {
- @Test
- public void test() {
- PythonCheckVerifier.verify("src/test/resources/checks/avoidTryCatchFinallyCheck.py", new AvoidTryCatchFinallyCheck());
- }
-}
diff --git a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoopTest.java b/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoopTest.java
deleted file mode 100644
index 77b1feb31..000000000
--- a/python-plugin/src/test/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoopTest.java
+++ /dev/null
@@ -1,11 +0,0 @@
-package fr.greencodeinitiative.python.checks;
-
-import org.junit.Test;
-import org.sonar.python.checks.utils.PythonCheckVerifier;
-
-public class NoFunctionCallWhenDeclaringForLoopTest {
- @Test
- public void test() {
- PythonCheckVerifier.verify("src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py", new NoFunctionCallWhenDeclaringForLoop());
- }
-}
diff --git a/python-plugin/src/test/resources/checks/avoidFullSQLRequest.py b/python-plugin/src/test/resources/checks/avoidFullSQLRequest.py
deleted file mode 100644
index 217cb6c9a..000000000
--- a/python-plugin/src/test/resources/checks/avoidFullSQLRequest.py
+++ /dev/null
@@ -1,12 +0,0 @@
-def displayMessage(argument1):
- print(argument)
-
-displayMessage(' sElEcT * fRoM myTable') # Noncompliant {{Don't use the query SELECT * FROM}}
-displayMessage(' sElEcT user fRoM myTable')
-
-requestNonCompiliant = ' SeLeCt * FrOm myTable' # Noncompliant {{Don't use the query SELECT * FROM}}
-requestCompiliant = ' SeLeCt user FrOm myTable'
-displayMessage(requestNonCompiliant)
-displayMessage(requestCompiliant)
-
-
diff --git a/python-plugin/src/test/resources/checks/avoidGettersAndSetters.py b/python-plugin/src/test/resources/checks/avoidGettersAndSetters.py
deleted file mode 100644
index fd72053ad..000000000
--- a/python-plugin/src/test/resources/checks/avoidGettersAndSetters.py
+++ /dev/null
@@ -1,26 +0,0 @@
-from datetime import date
-
-class Client():
-
- def __init__(self, age, weight):
- self.age = age
- self.weight = weight
-
- def set_age(self, age): # Noncompliant {{Avoid creating getter and setter methods in classes}}
- self.age = age
-
- def set_age(self, age2): # Noncompliant {{Avoid creating getter and setter methods in classes}}
- self.age = age2
-
- def get_age_in_five_years(self):
- a = Client()
- return a.age
-
- def get_age(self): # Noncompliant {{Avoid creating getter and setter methods in classes}}
- return self.age
-
- def is_major(self):
- return self.age >= 18
-
- def get_weight(self): # Noncompliant {{Avoid creating getter and setter methods in classes}}
- return self.weight
\ No newline at end of file
diff --git a/python-plugin/src/test/resources/checks/avoidGlobalVariableInFunction.py b/python-plugin/src/test/resources/checks/avoidGlobalVariableInFunction.py
deleted file mode 100644
index 9b77dfa72..000000000
--- a/python-plugin/src/test/resources/checks/avoidGlobalVariableInFunction.py
+++ /dev/null
@@ -1,43 +0,0 @@
-global_var = 'global'
-
-def print_global_var_details():
- print(len(global_var)) # Noncompliant
- print('Global var : ', global_var) # Noncompliant
- print('Global var : ' + global_var) # Noncompliant
- for c in global_var: # Noncompliant
- print(c)
- if len(global_var) > 0: # Noncompliant
- print('global_var len positive')
- elif 0 < len(global_var): # Noncompliant
- print('global_var len negative')
- else:
- print('global_var len = 0')
-
- try:
- print(global_var) # Noncompliant
- except:
- print(global_var) # Noncompliant
- else:
- print(global_var) # Noncompliant
- finally:
- print(global_var) # Noncompliant
-
- assert len(global_var) > 0, 'Failed' # Noncompliant
- assert len('test') > 0, 'Failed : ' + global_var # Noncompliant
- test = ''
- test += global_var # Noncompliant
- test = {'test': global_var, 'global_var': 1 } # Noncompliant
-
-# Compliant
-def print_var_length(local_var = global_var):
- global_var = 'local' # Here it create a local var and do not use the global var
- global_var: str = 'local' # Here it create a local var and do not use the global var
- global_var += 'local' # Here it create a local var and do not use the global var
- global_var = 'local' if True else 'global' # Here it create a local var and do not use the global var
- print(len(global_var)) # Compliant for the use, but not for the name of the var
- print(len(local_var))
- for global_var in local_var: # Compliant but not for the name
- print(global_var)
-
-print_global_var_details()
-print_var_length(global_var)
diff --git a/python-plugin/src/test/resources/checks/avoidSQLRequestInLoop.py b/python-plugin/src/test/resources/checks/avoidSQLRequestInLoop.py
deleted file mode 100644
index 394088199..000000000
--- a/python-plugin/src/test/resources/checks/avoidSQLRequestInLoop.py
+++ /dev/null
@@ -1,42 +0,0 @@
-import mysql.connector
-import psycopg2
-import pyodbc
-import sqlite3
-
-def mysql_loop():
- connection = mysql.connector.connect(database='local')
- cursor = connection.cursor()
- results = []
- for id in range(5):
- results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}}
- connection.close()
- return results
-
-def psycopg2_loop():
- connection = psycopg2.connect(database='local')
- cursor = connection.cursor()
- results = []
- id = 0
- while id <= 5:
- results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}}
- id += 1
- connection.close()
- return results
-
-def pyodbc_loop():
- connection = pyodbc.connect('DRIVER={ODBC Driver 17 for SQL Server};SERVER=localhost;DATABASE=local')
- cursor = connection.cursor()
- results = []
- for id in range(5):
- results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}}
- connection.close()
- return results
-
-def sqlite3_loop():
- connection = sqlite3.connect("local.db")
- cursor = connection.cursor()
- results = []
- for id in range(5):
- results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}}
- connection.close()
- return results
diff --git a/python-plugin/src/test/resources/checks/avoidSQLRequestInLoopCheck.py b/python-plugin/src/test/resources/checks/avoidSQLRequestInLoopCheck.py
deleted file mode 100644
index 7f98cd548..000000000
--- a/python-plugin/src/test/resources/checks/avoidSQLRequestInLoopCheck.py
+++ /dev/null
@@ -1,83 +0,0 @@
-import mysql.connector
-
-
-class AvoidSQLRequestInLoopCheck:
- maxrows = 20
-
- def testWithNoLoop(self):
- try :
- db = mysql.connector.connect(option_files='my.conf', use_pure=True)
- cursor = db.cursor(dictionary=True)
-
- cursor.execute('SELECT id, name FROM users LIMIT %(limit)s', {'limit': self.maxrows})
- for row in cursor.fetchall():
- print("{}: {}".format(row['id'], row['name']))
-
- cursor.close()
- db.close()
- except mysql.connector.Error as err:
- print("Got an exception: {}".format(err))
- db.close()
-
- def testWithForLoop(self):
- try:
- db = mysql.connector.connect(option_files='my.conf', use_pure=True)
- cursor = db.cursor(dictionary=True)
-
- for i in range(0, self.maxrows):
- cursor.execute("SELECT id, name FROM users WHERE id = %(id)s", {'id': i+1}) #Noncompliant
- for row in cursor.fetchall():
- print("{}: {}".format(row['id'], row['name']))
-
- cursor.close()
- db.close()
- except mysql.connector.Error as err:
- print("Got an exception: {}".format(err))
- db.close()
-
- def testWithWhileLoop(self):
- try:
- db = mysql.connector.connect(option_files='my.conf', use_pure=True)
- cursor = db.cursor(dictionary=True)
-
- i = 0
- while i < self.maxrows:
- cursor.execute("SELECT id, name FROM users WHERE id = %(id)s", {'id': i+1}) #Noncompliant
- for row in cursor.fetchall():
- print("name: {}".format(row['name']))
- i += 1
-
- cursor.close()
- db.close()
- except mysql.connector.Error as err:
- print("Got an exception: {}".format(err))
- db.close()
-
- def testWithWhileLoopUpdate(self):
- try:
- db = mysql.connector.connect(option_files='my.conf', use_pure=True)
- cursor=db.cursor()
-
- i = 0
- while i < self.maxrows:
- cursor.execute('UPDATE users set name=%(name)s where id=%(id)s', {'name': "anonymous", 'id': i+1})
- i+=1
- db.commit()
-
- cursor.close()
- db.close()
- except mysql.connector.Error as err:
- print("Got an exception: {}".format(err))
- db.close()
-
-if __name__ == '__main__':
- test = AvoidSQLRequestInLoopCheck()
-
- print("testWithNoLoop")
- test.testWithNoLoop()
- print("testWithForLoop")
- test.testWithForLoop()
- print("testWithWhileLoop")
- test.testWithWhileLoop()
- print("testWithWhileLoopUpdate")
- test.testWithWhileLoopUpdate()
diff --git a/python-plugin/src/test/resources/checks/avoidSQLRequestInLoopNoImports.py b/python-plugin/src/test/resources/checks/avoidSQLRequestInLoopNoImports.py
deleted file mode 100644
index fe8513844..000000000
--- a/python-plugin/src/test/resources/checks/avoidSQLRequestInLoopNoImports.py
+++ /dev/null
@@ -1,26 +0,0 @@
-def mysql_loop():
- connection = mysql.connector.connect(database='local')
- cursor = connection.cursor()
- results = []
- for id in range(5):
- results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # OK
- connection.close()
- return results
-
-def pyodbc_loop():
- connection = pyodbc.connect('DRIVER={ODBC Driver 17 for SQL Server};SERVER=localhost;DATABASE=local')
- cursor = connection.cursor()
- results = []
- for id in range(5):
- results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # OK
- connection.close()
- return results
-
-def sqlite3_loop():
- connection = sqlite3.connect("local.db")
- cursor = connection.cursor()
- results = []
- for id in range(5):
- results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # OK
- connection.close()
- return results
diff --git a/python-plugin/src/test/resources/checks/avoidTryCatchFinallyCheck.py b/python-plugin/src/test/resources/checks/avoidTryCatchFinallyCheck.py
deleted file mode 100644
index a026587ed..000000000
--- a/python-plugin/src/test/resources/checks/avoidTryCatchFinallyCheck.py
+++ /dev/null
@@ -1,29 +0,0 @@
-import os.path
-
-path = 'hello.txt'
-
-
-def my_function():
- x=0
-
- try: # Noncompliant {{Avoid the use of try-catch-finally}}
- print(x)
- except:
- print("Something went wrong")
- finally:
- print("The 'try except' is finished")
-
-def foo():
- try: # Noncompliant {{Avoid the use of try-catch-finally}}
- f = open(path)
- print(f.read())
- except:
- print('No such file '+path)
- finally:
- f.close()
-
-def boo():
- if os.path.isfile(path):
- fh = open(path, 'r')
- print(fh.read())
- fh.close
\ No newline at end of file
diff --git a/python-plugin/src/test/resources/checks/init_dbtest.sql b/python-plugin/src/test/resources/checks/init_dbtest.sql
deleted file mode 100644
index 9a7a0a524..000000000
--- a/python-plugin/src/test/resources/checks/init_dbtest.sql
+++ /dev/null
@@ -1,34 +0,0 @@
-DROP TABLE IF EXISTS users;
-
-CREATE TABLE users (
- id INT NOT NULL AUTO_INCREMENT,
- name VARCHAR(255),
- PRIMARY KEY (id)
-);
-
-INSERT INTO users(name) VALUES('a');
-INSERT INTO users(name) VALUES('b');
-INSERT INTO users(name) VALUES('c');
-INSERT INTO users(name) VALUES('d');
-INSERT INTO users(name) VALUES('e');
-INSERT INTO users(name) VALUES('f');
-INSERT INTO users(name) VALUES('g');
-INSERT INTO users(name) VALUES('h');
-INSERT INTO users(name) VALUES('i');
-INSERT INTO users(name) VALUES('j');
-INSERT INTO users(name) VALUES('k');
-INSERT INTO users(name) VALUES('l');
-INSERT INTO users(name) VALUES('m');
-INSERT INTO users(name) VALUES('n');
-INSERT INTO users(name) VALUES('o');
-INSERT INTO users(name) VALUES('p');
-INSERT INTO users(name) VALUES('q');
-INSERT INTO users(name) VALUES('r');
-INSERT INTO users(name) VALUES('s');
-INSERT INTO users(name) VALUES('t');
-INSERT INTO users(name) VALUES('u');
-INSERT INTO users(name) VALUES('v');
-INSERT INTO users(name) VALUES('w');
-INSERT INTO users(name) VALUES('x');
-INSERT INTO users(name) VALUES('y');
-INSERT INTO users(name) VALUES('z');
diff --git a/python-plugin/src/test/resources/checks/my.conf.sample b/python-plugin/src/test/resources/checks/my.conf.sample
deleted file mode 100644
index e10dc23bc..000000000
--- a/python-plugin/src/test/resources/checks/my.conf.sample
+++ /dev/null
@@ -1,5 +0,0 @@
-[client]
-host = localhost
-user = dbtest
-password = dbtest
-database = dbtest
diff --git a/python-plugin/src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py b/python-plugin/src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py
deleted file mode 100644
index a3755d3e3..000000000
--- a/python-plugin/src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py
+++ /dev/null
@@ -1,11 +0,0 @@
-def my_function():
- return 6
-
-for i in my_function(): # Noncompliant {{Do not call a function when declaring a for-type loop}}
- print("Test")
- my_function()
- pass
-
-
-
-my_function()
\ No newline at end of file
diff --git a/tool_build.sh b/tool_build.sh
index bfac031a1..c6f1fba5f 100755
--- a/tool_build.sh
+++ b/tool_build.sh
@@ -1,3 +1,4 @@
#!/usr/bin/env sh
+rm -rf ./lib/*.jar
mvn clean package -DskipTests
'
+ // ...
+}
+```
+
+## 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 95%
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
index 13530377d..eaa045e90 100644
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC27.json
+++ b/ecocode-rules-specifications/src/main/rules/EC27/EC27.json
@@ -7,10 +7,9 @@
"constantCost": "20min"
},
"tags": [
- "eco-design",
"performance",
- "bug",
+ "eco-design",
"ecocode"
],
"defaultSeverity": "Minor"
-}
\ No newline at end of file
+}
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 86%
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
index 80cf37817..c85d2ee51 100644
--- a/java-plugin/src/main/resources/fr/greencodeinitiative/l10n/java/rules/java/EC28.json
+++ b/ecocode-rules-specifications/src/main/rules/EC28/EC28.json
@@ -7,8 +7,9 @@
"constantCost": "5min"
},
"tags": [
+ "performance",
+ "error-handling",
"eco-design",
- "bug",
"ecocode"
],
"defaultSeverity": "Minor"
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 a8b365948..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,10 +7,10 @@
"constantCost": "5min"
},
"tags": [
+ "bad-practice",
"eco-design",
"performance",
- "bug",
"ecocode"
],
"defaultSeverity": "Minor"
-}
\ No newline at end of file
+}
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
+List
-
-
-
-
-
-
-
-
-