Revize c3914f4b

Reading anti-patterns from json files modified

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/repository/AntiPatternRepository.java

@@ -16 +16 @@
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.lang.reflect.InvocationTargetException;
-import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.*;
 
@@ -70 +69 @@
                 AntiPatternDetector antiPatternDetector = subType.getDeclaredConstructor().newInstance();
 
                 // loading anti-pattern from json file and linking it to the detector file
-                antiPatternDetector.setAntiPattern(getAntiPatternFromJsonFile(antiPatternDetector.getJsonFileName()));
+                AntiPattern antiPattern = getAntiPatternFromJsonFile(antiPatternDetector.getJsonFileName());
+
+                // anti-pattern was not read from file properly
+                if(antiPattern == null) {
+                    LOGGER.error("Anti-pattern from " + antiPatternDetector.getJsonFileName() + " was not read correctly");
+                    continue;
+                }
+                antiPatternDetector.setAntiPattern(antiPattern);
 
                 antiPatterns.putIfAbsent(antiPatternDetector.getAntiPatternModel().getId(), antiPatternDetector);
                 LOGGER.info("Creating detector " + antiPatternDetector.getAntiPatternModel().getPrintName());
@@ -133 +139 @@
         return queries;
     }
 
+
     /**
-     * Method for reading anti-pattern information from json files
+     * Method for reading anti-pattern parameters from json file
      *
      * @param jsonFileName Name of the file
      * @return AntiPattern object
      */
-    public AntiPattern getAntiPatternFromJsonFile(String jsonFileName){
-        String json = "";   // json configuration file
-        JsonNode node = null;
+    private AntiPattern getAntiPatternFromJsonFile(String jsonFileName){
+        String json = "";  // json configuration file content as string
 
         LOGGER.info("Reading anti-pattern from json file " + jsonFileName);
 
         try {
             URL url = servletContext.getResource(AP_DIR + jsonFileName);
+
             BufferedReader read = new BufferedReader(
                     new InputStreamReader(url.openStream()));
 
@@ -154 +161 @@
             while ((line = read.readLine()) != null) {
                 json += line;
             }
-            node = JsonParser.parse(json);
-        } catch (IOException e) {
+        } catch (Exception e) {
             LOGGER.warn("Cannot read anti-pattern from json file " + jsonFileName);
             return null;
         }
 
-        Long APid = Long.parseLong(node.get("id").asText());
-        String APPrintName = node.get("printName").asText();
-        String APName = node.get("name").asText();
-        String APDescription = node.get("description").asText();
-        String APCatalogueFileName = node.get("catalogueFileName") != null ? node.get("catalogueFileName").asText() : null;
+        return parseAntiPatternFromJson(json);
+    }
+
+    /**
+     * Method for parsing json file content and making AntiPattern object
+     * @param jsonString Json file content
+     * @return AntiPattern object made from json file
+     */
+    private AntiPattern parseAntiPatternFromJson(String jsonString){
+        Long APid;
+        JsonNode node = null;
+        String APPrintName, APName, APDescription, APCatalogueFileName;
+
+        // reading of anti-pattern basic information
+        try {
+            node = JsonParser.parse(jsonString);
 
-        Map<String, Threshold> APMap = new HashMap<>();
+            APid = Long.parseLong(node.get("id").asText());
+            APPrintName = node.get("printName").asText();
+            APName = node.get("name").asText();
+            APDescription = node.get("description").asText();
+            APCatalogueFileName = node.get("catalogueFileName") != null ? node.get("catalogueFileName").asText() : null; // optional field
+        }
+        catch(Exception e){
+            return null;
+        }
 
+        // reading of thresholds
+        Map<String, Threshold> thresholdMap = new HashMap<>();
         JsonNode array = node.get("thresholds");
         Threshold tmpThreshold = null;
 
+        String thresholdName, thresholdType, thresholdPrintName, thresholdDescription, thresholdErrorMess;
+
         for(int i = 0; i < array.size(); i++){
             JsonNode tmpNode = array.get(i);
+            try {
+                thresholdName = tmpNode.get("thresholdName").asText();
+                thresholdType = tmpNode.get("thresholdType").asText();
+                thresholdPrintName = tmpNode.get("thresholdPrintName").asText();
+                thresholdDescription = tmpNode.get("thresholdDescription").asText();
+                thresholdErrorMess = tmpNode.get("thresholdErrorMess").asText();
+            }
+            catch(Exception e){
+                return null;
+            }
 
-            String thresholdName = tmpNode.get("thresholdName").asText();
-            String thresholdType = tmpNode.get("thresholdType").asText();
-
-            JsonNode thresholdNode = tmpNode.get("threshold");
-
-            String tThresholdName = thresholdNode.get("thresholdName").asText();
-            String tThresholdPrintName = thresholdNode.get("thresholdPrintName").asText();
-            String tThresholdDescription = thresholdNode.get("thresholdDescription").asText();
-            String tThresholdErrorMess = thresholdNode.get("thresholdErrorMess").asText();
-
-            tmpThreshold = getThreshold(thresholdType, tThresholdName, tThresholdPrintName, tThresholdDescription, tThresholdErrorMess);
-
-            APMap.put(thresholdName, tmpThreshold);
+            // creating of Threshold object and storing it in map
+            tmpThreshold = getThreshold(thresholdType, thresholdName, thresholdPrintName, thresholdDescription, thresholdErrorMess);
+            thresholdMap.put(thresholdName, tmpThreshold);
         }
 
-        AntiPattern newAP = new AntiPattern(APid, APPrintName, APName, APDescription, APMap, APCatalogueFileName);
+        // creating of the AntiPattern object
+        AntiPattern result = new AntiPattern(APid, APPrintName, APName, APDescription, thresholdMap, APCatalogueFileName);
 
-        return newAP;
+        return result;
     }
 
     /**

src/main/webapp/antipatterns/BusinessAsUsual.json

@@ -7 +7 @@
         {
             "thresholdName": "divisionOfIterationsWithRetrospective",
             "thresholdType": "Percentage",
-            "threshold": {
-                "thresholdName": "divisionOfIterationsWithRetrospective",
-                "thresholdPrintName": "Division of iterations with retrospective",
-                "thresholdDescription": "Minimum percentage of the total number of iterations with a retrospective (0,100)",
-                "thresholdErrorMess": "Percentage must be float number between 0 and 100"
-            }
+            "thresholdPrintName": "Division of iterations with retrospective",
+            "thresholdDescription": "Minimum percentage of the total number of iterations with a retrospective (0,100)",
+            "thresholdErrorMess": "Percentage must be float number between 0 and 100"
         },
         {
             "thresholdName": "searchSubstringsWithRetrospective",
             "thresholdType": "String",
-            "threshold": {
-                "thresholdName": "searchSubstringsWithRetrospective",
-                "thresholdPrintName": "Search substrings with retrospective",
-                "thresholdDescription": "Substring that will be search in wikipages and activities",
-                "thresholdErrorMess": "Maximum number of substrings is ten and must not starts and ends with characters || "
-            }
+            "thresholdPrintName": "Search substrings with retrospective",
+            "thresholdDescription": "Substring that will be search in wikipages and activities",
+            "thresholdErrorMess": "Maximum number of substrings is ten and must not starts and ends with characters || "
         }
     ],
     "catalogueFileName": "Business_As_Usual.md"

src/main/webapp/antipatterns/LongOrNonExistentFeedbackLoops.json

@@ -7 +7 @@
         {
             "thresholdName": "divisionOfIterationsWithFeedbackLoop",
             "thresholdType": "Percentage",
-            "threshold": {
-                "thresholdName": "divisionOfIterationsWithFeedbackLoop",
-                "thresholdPrintName": "Division of iterations with feedback loop",
-                "thresholdDescription": "Minimum percentage of the total number of iterations with feedback loop (0,100)",
-                "thresholdErrorMess": "Percentage must be float number between 0 and 100"
-            }
+            "thresholdPrintName": "Division of iterations with feedback loop",
+            "thresholdDescription": "Minimum percentage of the total number of iterations with feedback loop (0,100)",
+            "thresholdErrorMess": "Percentage must be float number between 0 and 100"
         },
         {
             "thresholdName": "maxGapBetweenFeedbackLoopRate",
             "thresholdType": "PositiveFloat",
-            "threshold": {
-                "thresholdName": "maxGapBetweenFeedbackLoopRate",
-                "thresholdPrintName": "Maximum gap between feedback loop rate",
-                "thresholdDescription": "Value that multiplies average iteration length for given project. Result is maximum threshold value for gap between feedback loops in days.",
-                "thresholdErrorMess": "Maximum gap between feedback loop rate must be positive float number"
-            }
+            "thresholdPrintName": "Maximum gap between feedback loop rate",
+            "thresholdDescription": "Value that multiplies average iteration length for given project. Result is maximum threshold value for gap between feedback loops in days.",
+            "thresholdErrorMess": "Maximum gap between feedback loop rate must be positive float number"
         },
         {
             "thresholdName": "searchSubstringsWithFeedbackLoop",
             "thresholdType": "String",
-            "threshold": {
-                "thresholdName": "searchSubstringsWithFeedbackLoop",
-                "thresholdPrintName": "Search substrings with feedback loop",
-                "thresholdDescription": "Substring that will be search in wikipages and activities",
-                "thresholdErrorMess": "Maximum number of substrings is ten and must not starts and ends with characters ||"
-            }
+            "thresholdPrintName": "Search substrings with feedback loop",
+            "thresholdDescription": "Substring that will be search in wikipages and activities",
+            "thresholdErrorMess": "Maximum number of substrings is ten and must not starts and ends with characters ||"
         }
     ]
 }

src/main/webapp/antipatterns/NinetyNinetyRule.json

@@ -7 +7 @@
         {
             "thresholdName": "maxDivisionRange",
             "thresholdType": "PositiveFloat",
-            "threshold": {
-                "thresholdName": "maxDivisionRange",
-                "thresholdPrintName": "Maximum ration value",
-                "thresholdDescription": "Maximum ratio value of spent and estimated time",
-                "thresholdErrorMess": "Ration values must be positive float number"
-            }
+            "thresholdPrintName": "Maximum ration value",
+            "thresholdDescription": "Maximum ratio value of spent and estimated time",
+            "thresholdErrorMess": "Ration values must be positive float number"
         },
         {
             "thresholdName": "maxBadDivisionLimit",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "maxBadDivisionLimit",
-                "thresholdPrintName": "Maximum iterations thresholds",
-                "thresholdDescription": "Maximum number of consecutive iterations where the thresholds were exceeded",
-                "thresholdErrorMess": "Maximum number of consecutive iterations must be positive integer number"
-            }
+            "thresholdPrintName": "Maximum iterations thresholds",
+            "thresholdDescription": "Maximum number of consecutive iterations where the thresholds were exceeded",
+            "thresholdErrorMess": "Maximum number of consecutive iterations must be positive integer number"
         }
     ]
 }

src/main/webapp/antipatterns/RoadToNowhere.json

@@ -7 +7 @@
         {
             "thresholdName": "minNumberOfWikiPagesWithProjectPlan",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "minNumberOfWikiPagesWithProjectPlan",
-                "thresholdPrintName": "Minimum number of wiki pages with project plan",
-                "thresholdDescription": "Number of wiki pages",
-                "thresholdErrorMess": "Minimum number of wikipages must be positive integer number"
-            }
+            "thresholdPrintName": "Minimum number of wiki pages with project plan",
+            "thresholdDescription": "Number of wiki pages",
+            "thresholdErrorMess": "Minimum number of wikipages must be positive integer number"
         },
         {
             "thresholdName": "minNumberOfActivitiesWithProjectPlan",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "minNumberOfActivitiesWithProjectPlan",
-                "thresholdPrintName": "Minimum number of activities with project plan",
-                "thresholdDescription": "Number of activities",
-                "thresholdErrorMess": "Minimum number of activities must be positive integer number"
-            }
+            "thresholdPrintName": "Minimum number of activities with project plan",
+            "thresholdDescription": "Number of activities",
+            "thresholdErrorMess": "Minimum number of activities must be positive integer number"
         },
         {
             "thresholdName": "searchSubstringsWithProjectPlan",
             "thresholdType": "String",
-            "threshold": {
-                "thresholdName": "searchSubstringsWithProjectPlan",
-                "thresholdPrintName": "Search substrings with project plan",
-                "thresholdDescription": "Substring that will be search in wikipages and activities",
-                "thresholdErrorMess": "Maximum number of substrings is ten and must not starts and ends with characters ||"
-            }
+            "thresholdPrintName": "Search substrings with project plan",
+            "thresholdDescription": "Substring that will be search in wikipages and activities",
+            "thresholdErrorMess": "Maximum number of substrings is ten and must not starts and ends with characters ||"
         }
     ],
     "catalogueFileName": "Road_To_Nowhere.md"

src/main/webapp/antipatterns/SpecifyNothing.json

@@ -7 +7 @@
         {
             "thresholdName": "minNumberOfWikiPagesWithSpecification",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "minNumberOfWikiPagesWithSpecification",
-                "thresholdPrintName": "Minimum number of wiki pages with project specification",
-                "thresholdDescription": "Number of wiki pages",
-                "thresholdErrorMess": "Minimum number of wikipages must be positive integer number"
-            }
+            "thresholdPrintName": "Minimum number of wiki pages with project specification",
+            "thresholdDescription": "Number of wiki pages",
+            "thresholdErrorMess": "Minimum number of wikipages must be positive integer number"
         },
         {
             "thresholdName": "minNumberOfActivitiesWithSpecification",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "minNumberOfActivitiesWithSpecification",
-                "thresholdPrintName": "Minimum number of activities with project specification",
-                "thresholdDescription": "Number of activities",
-                "thresholdErrorMess": "Minimum number of activities with project specification must be positive integer number"
-            }
+            "thresholdPrintName": "Minimum number of activities with project specification",
+            "thresholdDescription": "Number of activities",
+            "thresholdErrorMess": "Minimum number of activities with project specification must be positive integer number"
         },
         {
             "thresholdName": "minAvgLengthOfActivityDescription",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "minAvgLengthOfActivityDescription",
-                "thresholdPrintName": "Minimum average length of activity description",
-                "thresholdDescription": "Minimum average number of character of activity description",
-                "thresholdErrorMess": "Minimum average length of activity description must be positive integer number"
-            }
+            "thresholdPrintName": "Minimum average length of activity description",
+            "thresholdDescription": "Minimum average number of character of activity description",
+            "thresholdErrorMess": "Minimum average length of activity description must be positive integer number"
         },
         {
             "thresholdName": "searchSubstringsWithProjectSpecification",
             "thresholdType": "String",
-            "threshold": {
-                "thresholdName": "searchSubstringsWithProjectSpecification",
-                "thresholdPrintName": "Search substrings with project specification",
-                "thresholdDescription": "Substring that will be search in wikipages and activities",
-                "thresholdErrorMess": "Maximum number of substrings is ten and must not starts and ends with characters ||"
-            }
+            "thresholdPrintName": "Search substrings with project specification",
+            "thresholdDescription": "Substring that will be search in wikipages and activities",
+            "thresholdErrorMess": "Maximum number of substrings is ten and must not starts and ends with characters ||"
         }
     ],
     "catalogueFileName": "Specify_Nothing.md"

src/main/webapp/antipatterns/TooLongSprint.json

@@ -7 +7 @@
         {
             "thresholdName": "maxIterationLength",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "maxIterationLength",
-                "thresholdPrintName": "Max Iteration Length",
-                "thresholdDescription": "Maximum iteration length in days",
-                "thresholdErrorMess": "Max iteration length must be positive integer"
-            }
+            "thresholdPrintName": "Max Iteration Length",
+            "thresholdDescription": "Maximum iteration length in days",
+            "thresholdErrorMess": "Max iteration length must be positive integer"
         },
         {
             "thresholdName": "maxNumberOfTooLongIterations",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "maxNumberOfTooLongIterations",
-                "thresholdPrintName": "Max number of foo long iterations",
-                "thresholdDescription": "Maximum number of too long iterations in project",
-                "thresholdErrorMess": "Max number of too long iterations must be positive integer"
-            }
+            "thresholdPrintName": "Max number of foo long iterations",
+            "thresholdDescription": "Maximum number of too long iterations in project",
+            "thresholdErrorMess": "Max number of too long iterations must be positive integer"
+
         }
     ]
 }

src/main/webapp/antipatterns/VaryingSprintLength.json

@@ -7 +7 @@
         {
             "thresholdName": "maxDaysDifference",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "maxDaysDifference",
-                "thresholdPrintName": "Max days difference",
-                "thresholdDescription": "Maximum distance of two consecutive iterations in days",
-                "thresholdErrorMess": "Maximum distance must be positive integer number"
-            }
+            "thresholdPrintName": "Max days difference",
+            "thresholdDescription": "Maximum distance of two consecutive iterations in days",
+            "thresholdErrorMess": "Maximum distance must be positive integer number"
         },
         {
             "thresholdName": "maxIterationChanged",
             "thresholdType": "PositiveInteger",
-            "threshold": {
-                "thresholdName": "maxIterationChanged",
-                "thresholdPrintName": "Max number of iteration changed",
-                "thresholdDescription": "Maximum allowed number of significant changes in iteration lengths",
-                "thresholdErrorMess": "Maximum number of iterations changed must be positive integer number"
-            }
+            "thresholdPrintName": "Max number of iteration changed",
+            "thresholdDescription": "Maximum allowed number of significant changes in iteration lengths",
+            "thresholdErrorMess": "Maximum number of iterations changed must be positive integer number"
         }
     ]
 }