[ISSUE 142] cleaning + tests minor corrections

Author: dedece35

src/main/java/fr/greencodeinitiative/python/checks/AvoidMultipleIfElseStatementCheck.java

@@ -67,10 +67,6 @@ public void visitNode(SubscriptionContext context, Tree pTree) {
 
         FunctionDef method = (FunctionDef)pTree;
 
-//        if (!method.body().is(Tree.Kind.)) {
-//            return;
-//        }
-
         // reinit data structure before each method analysis
         variablesStruct = new VariablesPerLevelDataStructure();
 
@@ -91,10 +87,6 @@ private void visitNodeContent(SubscriptionContext context, List<Statement> pLstS
         }
 
         for (Statement statement : pLstStatements) {
-//            if (statement.is(Kind.BLOCK)) {
-//                // the cirrent node is a block : visit block content
-//                visitNodeContent(((BlockTree)statement).statements(), pLevel);
-//            } else
             if (statement.is(IF_STMT)) {
                 visitIfNode(context, (IfStatement)statement, pLevel);
             }
@@ -166,25 +158,12 @@ private void computeConditionVariables(SubscriptionContext context, BinaryExpres
                 computeConditionVariables(context, (BinaryExpression) pBinExprTree.rightOperand(), pLevel);
             }
         } else if (pBinExprTree.is(COMPARISON)) {
-//        else if (pBinExprTree.is(Tree.Kind.EQUAL_TO)
-//                || pBinExprTree.is(Tree.Kind.NOT_EQUAL_TO)
-//                || pBinExprTree.is(Tree.Kind.GREATER_THAN)
-//                || pBinExprTree.is(Tree.Kind.GREATER_THAN_OR_EQUAL_TO)
-//                || pBinExprTree.is(Tree.Kind.LESS_THAN_OR_EQUAL_TO)
-//                || pBinExprTree.is(Tree.Kind.LESS_THAN)
-//        ) {
-
-            // continue analyze with variables if some key-words are found
+
+            // continue to analyze with variables if some key-words are found
             if (pBinExprTree.leftOperand().is(NAME)) {
-//            if (pBinExprTree.leftOperand().is(Tree.Kind.VARIABLE_IDENTIFIER)) {
-//            if ("IDENTIFIER".equals(pBinExprTree.leftOperand().firstToken().type().getName())) {
-//                computeVariables(context, (VariableIdentifierTree) pBinExprTree.leftOperand(), pLevel);
                 computeVariables(context, pBinExprTree.leftOperand(), pLevel);
             }
             if (pBinExprTree.rightOperand().is(NAME)) {
-//            if ("IDENTIFIER".equals(pBinExprTree.rightOperand().firstToken().type().getName())) {
-//            if (pBinExprTree.rightOperand().is(Tree.Kind.VARIABLE_IDENTIFIER)) {
-//                computeVariables(context, (VariableIdentifierTree) pBinExprTree.rightOperand(), pLevel);
                 computeVariables(context, pBinExprTree.rightOperand(), pLevel);
             }
         }
@@ -195,22 +174,17 @@ private void computeConditionVariables(SubscriptionContext context, BinaryExpres
      * @param pVarIdTree The Variable AST structure
      * @param pLevel the level of structure
      */
-//    private void computeVariables(SubscriptionContext context, VariableIdentifierTree pVarIdTree, int pLevel) {
     private void computeVariables(SubscriptionContext context, Expression pVarIdTree, int pLevel) {
-//        if (pVarIdTree.variableExpression().is(Kind.VARIABLE_IDENTIFIER)) {
-            // increment the variable counter to list of all variables
-//            int nbUsed = variablesStruct.incrementVariableUsageForLevel(pVarIdTree.text(), pLevel);
+        // increment the variable counter to list of all variables
         int nbUsed = variablesStruct.incrementVariableUsageForLevel(pVarIdTree.firstToken().value(), pLevel);
 
-            // increment variable counter to list of variables already declared for current if or elseif struture
-//            variablesStruct.incrementVariableUsageForLevelForCurrentIfStruct(pVarIdTree.text(), pLevel);
+        // increment variable counter to list of variables already declared for current if or elseif struture
         variablesStruct.incrementVariableUsageForLevelForCurrentIfStruct(pVarIdTree.firstToken().value(), pLevel);
 
-            // raise an error if maximum
-            if (nbUsed > 2) {
-                context.addIssue(pVarIdTree.firstToken(), ERROR_MESSAGE);
-            }
-//        }
+        // raise an error if maximum
+        if (nbUsed > 2) {
+            context.addIssue(pVarIdTree.firstToken(), ERROR_MESSAGE);
+        }
     }
 
     /**
@@ -306,7 +280,7 @@ private static class VariablesPerLevelDataStructure {
 
         // map variable counters per level for current If / ElseIf structure
         // purpose : used by compute variables Else process (because Else structure is particular : 
-        // we don't know previous variables and we need previous If / ElseIf structure to know variables)
+        // we don't know previous variables, and we need previous If / ElseIf structure to know variables)
         private final Map<Integer, Map<String, Integer>> mapVariablesPerLevelForCurrentIfStruct;
 
         public VariablesPerLevelDataStructure() {

src/test/resources/checks/avoidMultipleIfElseStatementCompliant.py

@@ -11,7 +11,7 @@
 # COMPLIANT
 # USE CASE : compliant use case to check if a variable is used maximum twice on several IF / ELSE statements
 # at the same level AND no problem with several IF staments at the same level using different variables
-def shouldBeCompliantBecauseVariablesUsedMaximumTwiceAndDifferentsVariablesUsed():
+def compliant_variables_used_max_twice_and_differents_variables():
     nb1 = 0
     nb2 = 0
     nb3 = 0
@@ -28,7 +28,7 @@ def shouldBeCompliantBecauseVariablesUsedMaximumTwiceAndDifferentsVariablesUsed(
 # COMPLIANT
 # USE CASE : compliant use case to check if a variable is used maximum twice on several IF / ELSE statements
 # at the same level AND no problem with several IF staments at the same level using different variables
-def shouldBeCompliantBecauseVariablesUsedMaximumTwiceAndDifferentsVariablesUsedAtDiffLevels():
+def compliant_variables_used_max_twice_and_differents_variables_at_diff_levels():
     nb1 = 0
     nb2 = 0
     nb3 = 0
@@ -51,7 +51,7 @@ def shouldBeCompliantBecauseVariablesUsedMaximumTwiceAndDifferentsVariablesUsedA
 # COMPLIANT
 # USE CASE : compliant use case to check if a variable is used maximum twice on several IF / ELSE statements
 # at the same level AND no problem with several IF staments at the same level using different variables
-def shouldBeCompliantBecauseVariablesUsedMaximumTwiceAndDiffVariablesUsedAtDiffLevelsScenario2():
+def compliant_variables_used_max_twice_and_diff_variables_used_at_diff_levels_scenario_2():
     nb1 = 0
     nb2 = 0
     nb3 = 0
@@ -76,7 +76,7 @@ def shouldBeCompliantBecauseVariablesUsedMaximumTwiceAndDiffVariablesUsedAtDiffL
 
 # COMPLIANT
 # USE CASE : compliant use case to check if one variable is used maximum twice in different IF statements
-def shouldBeCompliantBecauseVariableUsedMaximumTwiceInIfStatements():
+def compliant_variables_used_maximum_twice_in_if_statements():
     nb1 = 0
     if nb1 == 1:
         nb1 = 1
@@ -88,7 +88,7 @@ def shouldBeCompliantBecauseVariableUsedMaximumTwiceInIfStatements():
 # USE CASE : compliant use case to check if following is OK :
 #  - two uses of the same variable
 #  - usage of the same variable on different levels of IF statements
-def shouldBeCompliantBecauseSereralVariablesUsedMaximumTwiceInComposedElseStatements():
+def compliant_variables_used_max_twice_in_composed_else_statements():
     nb1 = 0
     nb2 = 0
     nb3 = 0
@@ -108,7 +108,7 @@ def shouldBeCompliantBecauseSereralVariablesUsedMaximumTwiceInComposedElseStatem
 # USE CASE : compliant use case to check if following is OK :
 #  - two uses of the same variable
 #  - usage of the same variable on different kind of test statements (IF and elif)
-def shouldBeCompliantBecauseVariableUsedMaximumTwiceInIfOrelifStatements():
+def compliant_variables_used_max_twice_in_if_orelif_statements():
     nb1 = 0
     nb2 = 10
     if nb1 == 1:
@@ -121,7 +121,7 @@ def shouldBeCompliantBecauseVariableUsedMaximumTwiceInIfOrelifStatements():
 # USE CASE : compliant use case to check if following is OK :
 #  - two uses of the same variable
 #  - usage of the same variable on different kind of test statements (IF and elif)
-def shouldBeCompliantBecauseSeveralVariablesUsedMaximumTwiceInIfOrelifStatements():
+def compliant_variables_used_max_twice_in_if_orelif_statements_scenario_2():
     nb1 = 0
     nb2 = 10
     nb3 = 3

src/test/resources/checks/avoidMultipleIfElseStatementNonCompliant.py

@@ -12,7 +12,7 @@
 # USE CASE : Non compliant use case to check if following is NON OK :
 #  - two uses of the same variable
 #  - usage of the same variable on different levels of IF statements
-def shouldBeCompliantBecauseVariableUsedMaximumTwiceInComposedElseStatements():
+def not_compliant_variables_used_max_twice_in_composed_else_statements():
     nb1 = 0
     if nb1 == 1:
         nb1 = 2
@@ -24,7 +24,7 @@ def shouldBeCompliantBecauseVariableUsedMaximumTwiceInComposedElseStatements():
 # NON COMPLIANT
 # USE CASE : non compliant use case to check if a variable is not used max twice on several IF / ELSE statements
 # at the same level
-def shouldBeNotCompliantBecauseVariablesUsedMaximumTwiceAndDifferentsVariablesUsed():
+def not_compliant_variables_used_max_twice_and_differents_variables_used():
     nb1 = 0
     nb2 = 0
     nb3 = 0
@@ -41,7 +41,7 @@ def shouldBeNotCompliantBecauseVariablesUsedMaximumTwiceAndDifferentsVariablesUs
 # NON COMPLIANT
 # USE CASE : NON compliant use case to check if following is NOT COMPLIANT :
 # one variable is used maximum in two IF / ELSE / elif statements
-def shouldBeNotCompliantBecauseVariablesIsUsedMoreThanTwice():
+def not_compliant_variable_used_more_than_twice():
     nb1 = 0
     if nb1 == 1:
         nb1 = 2
@@ -54,7 +54,7 @@ def shouldBeNotCompliantBecauseVariablesIsUsedMoreThanTwice():
 # NON COMPLIANT
 # USE CASE : NON compliant use case to check if following is NOT OK :
 #  - same variable used maximum twice : no compliant because 2 IFs and 1 ELSE
-def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInIfStatementsAtDifferentsLevels():
+def not_compliant_variable_used_more_than_twice_in_if_statements_at_differents_levels():
     nb1 = 0
     if nb1 == 1:
         if nb1 == 2:
@@ -69,7 +69,7 @@ def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInIfStatementsAtDifferen
 # USE CASE : non compliant use case to check if following is NOT OK :
 #  - two uses of the same variable : use thre times with 2 IFs and 1 ELSE
 #  - usage of the same variable on different levels of IF statements
-def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInComposedElseStatements():
+def not_compliant_variable_used_more_than_twice_in_composed_else_statements():
     nb1 = 0
     if nb1 == 1:
         nb1 = 2
@@ -84,7 +84,7 @@ def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInComposedElseStatements
 # USE CASE : non compliant use case to check if following is NOT OK :
 #  - two uses of the same variable : use thre times with 2 IFs and 1 ELSE
 #  - usage of the same variable on different levels of IF statements
-def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInComposedElseStatementsScenario2():
+def not_compliant_variable_used_more_than_twice_in_composed_else_statements_scenario_2():
     nb1 = 0
     if nb1 == 1:
         if nb1 == 3:
@@ -102,7 +102,7 @@ def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInComposedElseStatements
 # USE CASE : non compliant use case to check if following is NOT OK :
 #  - two uses of the same variable : use thre times with 2 IFs and 1 ELSE
 #  - usage of the same variable on different levels of IF statements
-def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInComposedElseStatementsScenario3():
+def not_compliant_variable_used_more_than_twice_in_composed_else_statements_scenario_3():
     nb1 = 0
     nb2 = 0
     if nb1 == 1:
@@ -121,7 +121,7 @@ def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInComposedElseStatements
 # USE CASE : non compliant use case to check if following is NOT OK :
 #  - two uses of the same variable : use thre times with 2 IFs and 1 ELSE
 #  - usage of the same variable on different levels of IF statements
-def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInComposedElseStatementsScenario4():
+def not_compliant_variable_used_more_than_twice_in_composed_else_statements_scenario_4():
     nb1 = 0
     nb2 = 0
     if nb1 == 1:
@@ -140,7 +140,7 @@ def shouldBeNotCompliantBecauseVariableUsedMoreThanTwiceInComposedElseStatements
 # USE CASE : NON compliant use case to check if following is NOT OK :
 #  - the same variable must used maximum twice
 #  - usage of the same variable on different levels of IF / ELSE statements
-def shouldBeNotCompliantBecauseVariableUsedMaximumTwiceInComposedElseStatements():
+def not_compliant_variable_used_max_twice_in_composed_else_statements():
     nb1 = 0
     if nb1 == 1:
         nb1 = 2
@@ -158,7 +158,7 @@ def shouldBeNotCompliantBecauseVariableUsedMaximumTwiceInComposedElseStatements(
 # USE CASE : NON compliant use case to check if following is NOT OK :
 #  - more than twice uses of the same variable
 #  - usage of the same variable on different kind of test statements (IF and elif)
-def shouldBeNotCompliantBecauseTheSameVariableIsUsedMoreThanTwice():
+def not_compliant_the_same_variable_is_used_more_than_twice():
     nb1 = 0
     nb2 = 10
     if nb1 == 1:
@@ -173,7 +173,7 @@ def shouldBeNotCompliantBecauseTheSameVariableIsUsedMoreThanTwice():
 # USE CASE : NON compliant use case to check if following is NOT OK :
 #  - more than twice uses of the same variable
 #  - usage of the same variable on different kind of test statements (IF and elif)
-def shouldBeNotCompliantBecauseTheSameVariableIsUsedManyTimes():
+def not_compliant_the_same_variable_is_used_many_times():
     nb1 = 0
     nb2 = 10
     nb3 = 11