Merge pull request diffblue#523 from diffblue/cleanup/entry-point-detection-json

NathanJPhillips · web-flow · commit 05cdd635bd0e · 2018-08-01T15:59:17.000+01:00
Use camelCase for JSON property names
diff --git a/driver/mkbench.py b/driver/mkbench.py
@@ -38,10 +38,10 @@ def _find_java_binaries(start_path, java_binaries):
 def _read_info_of_class_files(class_files, configuration, cmdline):
 
     assert isinstance(class_files, list) and all(isinstance(s, str) for s in class_files)
-    class_list_json_file = configuration["collected_classes_path"]
+    class_list_json_file = configuration["collectedClassesPath"]
     with open(class_list_json_file, "w") as ofile:
         ofile.write(json.dumps(class_files, sort_keys=True, indent=4))
-    class_info_json_file = configuration["collected_classes_info_path"]
+    class_info_json_file = configuration["collectedClassesInfoPath"]
 
     os_command = (
         analyser.get_java_class_info_tool_pathname() +
@@ -141,7 +141,7 @@ def collect_java_binaries(cmdline):
     with utility.PushCwd(classes_temp_dir):
         os.system("jar cf \"" + java_binaries.jar_file + "\" .")
 
-    entry_points_file = configuration["detected_entry_points_path"]
+    entry_points_file = configuration["detectedEntryPointsPath"]
     if not os.path.exists(entry_points_file):
         print("WARNING: Unable to find any detected entry points. No analysis will be run.")
         return
@@ -154,12 +154,12 @@ def collect_java_binaries(cmdline):
 
     # Loop over all our detected entry points and create a folder for each.
     class_paths = [p for p in java_binaries.classpath_jar_files + java_libraries.classpath_jar_files + library_directories]
-    for ep_data in ep_config["entry_points"]:
+    for ep_data in ep_config["entryPoints"]:
 
         method_data = ep_data["method"]
 
         # We don't add the descriptor here as it's not recognized (and makes folder names too long).
-        fully_qualified_method = ep_data["class_name"] + "." + method_data["name"]
+        fully_qualified_method = ep_data["className"] + "." + method_data["name"]
 
         # Try to make sure the folder name isn't invalid.
         folder_name = fully_qualified_method.replace(os.path.sep, '.')
diff --git a/driver/run.py b/driver/run.py
@@ -213,31 +213,31 @@ def prepare_scan(cmdline):
         configuration = json.load(config_file)
         file_name = os.path.basename(config_file.name)
 
-    if not configuration["detected_entry_points_path"]:
-        configuration["detected_entry_points_path"] = \
+    if not configuration["detectedEntryPointsPath"]:
+        configuration["detectedEntryPointsPath"] = \
             os.path.join(cmdline.common_dir, "detected_entry_points.json")
 
-    if not configuration["di_configuration_path"]:
-        configuration["di_configuration_path"] = \
+    if not configuration["diConfigurationPath"]:
+        configuration["diConfigurationPath"] = \
             os.path.join(cmdline.common_dir, "di_configuration.json")
 
-    if not configuration["collected_classes_path"]:
-        configuration["collected_classes_path"] = \
+    if not configuration["collectedClassesPath"]:
+        configuration["collectedClassesPath"] = \
             os.path.join(cmdline.common_dir, "collected_classes.json")
 
-    if not configuration["collected_classes_info_path"]:
-        configuration["collected_classes_info_path"] = \
+    if not configuration["collectedClassesInfoPath"]:
+        configuration["collectedClassesInfoPath"] = \
             os.path.join(cmdline.common_dir, "collected_classes_info.json")
 
     # If we have an entry point coming in, just replace all rules.
     if cmdline.entry_point:
         class_name, method_name = cmdline.entry_point.rsplit('.', 1)
-        configuration["pattern_group"] = \
+        configuration["patternGroup"] = \
             [{
                 "id": "General",
                 "patterns": [{
-                    "method_pattern": {"names": [re.escape(method_name)]},
-                    "class_pattern": {"names": [re.escape(class_name)]}
+                    "methodPattern": {"names": [re.escape(method_name)]},
+                    "classPattern": {"names": [re.escape(class_name)]}
                 }]
             }]
 
diff --git a/src/java-class-info/default_config.json b/src/java-class-info/default_config.json
@@ -1,14 +1,14 @@
 {
-  "collected_classes_path": "",
-  "collected_classes_info_path": "",
-  "detected_entry_points_path": "",
-  "di_configuration_path": "",
-  "pattern_group": [
+  "collectedClassesPath": "",
+  "collectedClassesInfoPath": "",
+  "detectedEntryPointsPath": "",
+  "diConfigurationPath": "",
+  "patternGroup": [
     {
       "id": "Spring MVC",
       "patterns": [
         {
-          "method_pattern":
+          "methodPattern":
           {
             "annotations": ["org.springframework.web.bind.annotation.RequestMapping",
               "org.springframework.web.bind.annotation.PostMapping",
@@ -19,10 +19,10 @@
           }
         },
         {
-          "class_pattern": {
+          "classPattern": {
             "implements": ["org.springframework.web.servlet.mvc.Controller"]
           },
-          "method_pattern": {
+          "methodPattern": {
             "arguments": ["javax.servlet.http.HttpServletRequest", "javax.servlet.http.HttpServletResponse"],
             "returns": ["org.springframework.web.servlet.ModelAndView"]
           }
@@ -33,12 +33,12 @@
       "id": "JWS",
       "patterns": [
         {
-          "class_pattern": {
+          "classPattern": {
             "annotations": ["javax.jws.WebService"]
           }
         },
         {
-          "method_pattern": {
+          "methodPattern": {
             "annotations": ["javax.jws.WebMethod"]
           }
         }
@@ -48,7 +48,7 @@
       "id": "Java WS RS",
       "patterns": [
         {
-          "method_pattern": {
+          "methodPattern": {
             "annotations": ["javax.ws.rs.OPTIONS",
               "javax.ws.rs.POST",
               "javax.ws.rs.PUT",
@@ -64,7 +64,7 @@
       "id": "Alfresco",
       "patterns": [
         {
-          "method_pattern": {
+          "methodPattern": {
             "annotations": [
               "org.alfresco.web.app.servlet.ajax.InvokeCommand",
               "org.alfresco.web.app.servlet.ajax.GetCommand"
@@ -77,21 +77,21 @@
       "id": "Sakai",
       "patterns": [
         {
-          "class_pattern": {
+          "classPattern": {
             "extends": ["org.sakaiproject.cheftool.VelocityPortletPaneledAction"]
           },
-          "method_pattern": {
+          "methodPattern": {
             "arguments": [
               "org.sakaiproject.cheftool.RunData",
               "org.sakaiproject.cheftool.Context"
             ]
           }
         },
         {
-          "class_pattern": {
+          "classPattern": {
             "extends": ["org.sakaiproject.cheftool.VelocityPortletPaneledAction"]
           },
-          "method_pattern": {
+          "methodPattern": {
             "arguments": ["org.sakaiproject.cheftool.RunData"]
           }
         }
@@ -101,12 +101,12 @@
       "id": "Javax Servlet",
       "patterns": [
         {
-          "class_pattern": {
+          "classPattern": {
             "extends": [
               "javax.servlet.http.HttpServlet"
             ]
           },
-          "method_pattern": {
+          "methodPattern": {
             "names": [
               "doDelete",
               "doGet",
@@ -124,7 +124,7 @@
       "id": "GWT",
       "patterns": [
         {
-          "class_pattern": {
+          "classPattern": {
             "implements": [
               "com.google.gwt.user.client.rpc.RemoteService"
             ]
@@ -136,22 +136,22 @@
       "id": "Play!",
       "patterns": [
         {
-          "class_pattern": {
+          "classPattern": {
             "extends": [
               "play.mvc.Controller"
             ]
           },
-          "method_pattern": {
+          "methodPattern": {
             "returns": ["play.mvc.Result"]
           }
         },
         {
-          "class_pattern": {
+          "classPattern": {
             "extends": [
               "play.mvc.Action", "play.mvc.Action.Simple"
             ]
           },
-	  "method_pattern": {
+	  "methodPattern": {
             "names": ["call"],
             "arguments": ["play.mvc.Http.Context"]
  	  }
@@ -162,10 +162,10 @@
       "id": "Struts",
       "patterns": [
         {
-          "class_pattern": {
+          "classPattern": {
             "extends": ["com.opensymphony.xwork2.ActionSupport"]
           },
-          "method_pattern": {
+          "methodPattern": {
             "names": ["execute"],
             "returns": ["java.lang.String"]
           }
diff --git a/src/java-class-info/default_config.schema.json b/src/java-class-info/default_config.schema.json
@@ -1,31 +1,31 @@
 {
   "additionalProperties": false,
   "properties": {
-    "collected_classes_path": {
+    "collectedClassesPath": {
       "type": "string",
       "description": "Path to the collected_classes.json that is used to drive class file detection.",
       "default": ""
     },
 
-    "collected_classes_info_path": {
+    "collectedClassesInfoPath": {
       "type": "string",
       "description": "Path where the results of class file detection should be saved.",
       "default": ""
     },
 
-    "detected_entry_points_path": {
+    "detectedEntryPointsPath": {
       "type": "string",
       "description": "Path where the results of automatic entry point detection should be saved.",
       "default": ""
     },
 
-    "di_configuration_path": {
+    "diConfigurationPath": {
       "type": "string",
       "description": "Path where the output of the DI metadata harvesting result is output.",
       "default": ""
     },
 
-    "pattern_group": {
+    "patternGroup": {
       "type": "array",
       "description": "A pattern group is a set of class and method patterns that when considered together are used by a certain framework or technique to signify a website / web service entry-point.",
       "items": {
@@ -45,7 +45,7 @@
               "additionalProperties": false,
               "properties": {
 
-                "method_pattern": {
+                "methodPattern": {
                   "type": "object",
                   "description": "The selection of patterns a method must match to be considered an entry-point.",
                   "additionalProperties": false,
@@ -85,7 +85,7 @@
                   }
                 },
 
-                "class_pattern": {
+                "classPattern": {
                   "type": "object",
                   "description": "The selection of patterns a class must match to be considered an entry-point. If a method pattern is not stated, then all methods in a class will be matched.",
                   "additionalProperties": false,
diff --git a/src/java-class-info/detected_entry_points.h b/src/java-class-info/detected_entry_points.h
@@ -20,7 +20,7 @@ class detected_entry_pointst
   class json_namest
   {
   public:
-    static constexpr const char *entry_points = "entry_points";
+    static constexpr const char *entry_points = "entryPoints";
   };
 };
 
diff --git a/src/java-class-info/entry_point.h b/src/java-class-info/entry_point.h
@@ -24,8 +24,8 @@ class entry_pointt
     static constexpr const char *signature = "signature";
     static constexpr const char *type = "type";
     static constexpr const char *arguments = "arguments";
-    static constexpr const char *return_type = "return_type";
-    static constexpr const char *class_name = "class_name";
+    static constexpr const char *return_type = "returnType";
+    static constexpr const char *class_name = "className";
     static constexpr const char *method = "method";
   };
 
diff --git a/src/java-class-info/generation_configuration.cpp b/src/java-class-info/generation_configuration.cpp
@@ -2,20 +2,67 @@
 
 #include "generation_configuration.h"
 #include <boost/assign.hpp>
+#include <boost/filesystem.hpp>
 #include <list>
+#include <sstream>
 #include <util/json.h>
 
 generation_configurationt::generation_configurationt(const jsont &json)
 {
   detected_entry_points_path =
     json[json_namest::detected_entry_points_path].value;
+  for(const jsont &element : json[json_namest::pattern_group].array)
+  {
+    pattern_group.emplace_back(element);
+  }
+  if(!pattern_group.empty())
+  {
+    if(detected_entry_points_path.empty())
+    {
+      std::stringstream error;
+      error << "The configuration file contained pattern groups but not a "
+            << json_namest::detected_entry_points_path << " element.";
+      errors.push_back(error.str());
+    }
+    else if(boost::filesystem::is_directory(detected_entry_points_path))
+    {
+      std::stringstream error;
+      error << "The output path '" << detected_entry_points_path
+            << "' references an existing directory.";
+      errors.push_back(error.str());
+    }
+  }
+
   collected_classes_info_path =
     json[json_namest::collected_classes_info_path].value;
-  collected_classes_path = json[json_namest::collected_classes_path].value;
-  di_configuration_path = json[json_namest::di_configuration_path].value;
+  if(collected_classes_info_path.empty())
+  {
+    std::stringstream error;
+    error << "The configuration file did not contain a "
+          << json_namest::collected_classes_info_path << " element.";
+  }
+  else if(boost::filesystem::is_directory(collected_classes_info_path))
+  {
+    std::stringstream error;
+    error << "The output path '" << collected_classes_info_path
+          << "' references an existing directory.";
+  }
 
-  for(const jsont &element : json[json_namest::pattern_group].array)
+  collected_classes_path = json[json_namest::collected_classes_path].value;
+  if(collected_classes_path.empty())
   {
-    pattern_group.emplace_back(element);
+    std::stringstream error;
+    error << "The configuration file did not contain a "
+          << json_namest::collected_classes_path << " element.";
+    errors.push_back(error.str());
+  }
+  else if(!boost::filesystem::is_regular_file(collected_classes_path))
+  {
+    std::stringstream error;
+    error << "The input file '" << collected_classes_path
+          << "' does not exist.";
+    errors.push_back(error.str());
   }
+
+  di_configuration_path = json[json_namest::di_configuration_path].value;
 }
diff --git a/src/java-class-info/generation_configuration.h b/src/java-class-info/generation_configuration.h
diff --git a/src/java-class-info/java_class_info.cpp b/src/java-class-info/java_class_info.cpp
diff --git a/src/java-class-info/pattern.h b/src/java-class-info/pattern.h

Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,14 @@`
`1`	`1`	`{`
`2`		`- "collected_classes_path": "",`
`3`		`- "collected_classes_info_path": "",`
`4`		`- "detected_entry_points_path": "",`
`5`		`- "di_configuration_path": "",`
`6`		`- "pattern_group": [`
	`2`	`+ "collectedClassesPath": "",`
	`3`	`+ "collectedClassesInfoPath": "",`
	`4`	`+ "detectedEntryPointsPath": "",`
	`5`	`+ "diConfigurationPath": "",`
	`6`	`+ "patternGroup": [`
`7`	`7`	`{`
`8`	`8`	`"id": "Spring MVC",`
`9`	`9`	`"patterns": [`
`10`	`10`	`{`
`11`		`- "method_pattern":`
	`11`	`+ "methodPattern":`
`12`	`12`	`{`
`13`	`13`	`"annotations": ["org.springframework.web.bind.annotation.RequestMapping",`
`14`	`14`	`"org.springframework.web.bind.annotation.PostMapping",`
`@@ -19,10 +19,10 @@`
`19`	`19`	`}`
`20`	`20`	`},`
`21`	`21`	`{`
`22`		`- "class_pattern": {`
	`22`	`+ "classPattern": {`
`23`	`23`	`"implements": ["org.springframework.web.servlet.mvc.Controller"]`
`24`	`24`	`},`
`25`		`- "method_pattern": {`
	`25`	`+ "methodPattern": {`
`26`	`26`	`"arguments": ["javax.servlet.http.HttpServletRequest", "javax.servlet.http.HttpServletResponse"],`
`27`	`27`	`"returns": ["org.springframework.web.servlet.ModelAndView"]`
`28`	`28`	`}`
`@@ -33,12 +33,12 @@`
`33`	`33`	`"id": "JWS",`
`34`	`34`	`"patterns": [`
`35`	`35`	`{`
`36`		`- "class_pattern": {`
	`36`	`+ "classPattern": {`
`37`	`37`	`"annotations": ["javax.jws.WebService"]`
`38`	`38`	`}`
`39`	`39`	`},`
`40`	`40`	`{`
`41`		`- "method_pattern": {`
	`41`	`+ "methodPattern": {`
`42`	`42`	`"annotations": ["javax.jws.WebMethod"]`
`43`	`43`	`}`
`44`	`44`	`}`
`@@ -48,7 +48,7 @@`
`48`	`48`	`"id": "Java WS RS",`
`49`	`49`	`"patterns": [`
`50`	`50`	`{`
`51`		`- "method_pattern": {`
	`51`	`+ "methodPattern": {`
`52`	`52`	`"annotations": ["javax.ws.rs.OPTIONS",`
`53`	`53`	`"javax.ws.rs.POST",`
`54`	`54`	`"javax.ws.rs.PUT",`
`@@ -64,7 +64,7 @@`
`64`	`64`	`"id": "Alfresco",`
`65`	`65`	`"patterns": [`
`66`	`66`	`{`
`67`		`- "method_pattern": {`
	`67`	`+ "methodPattern": {`
`68`	`68`	`"annotations": [`
`69`	`69`	`"org.alfresco.web.app.servlet.ajax.InvokeCommand",`
`70`	`70`	`"org.alfresco.web.app.servlet.ajax.GetCommand"`
`@@ -77,21 +77,21 @@`
`77`	`77`	`"id": "Sakai",`
`78`	`78`	`"patterns": [`
`79`	`79`	`{`
`80`		`- "class_pattern": {`
	`80`	`+ "classPattern": {`
`81`	`81`	`"extends": ["org.sakaiproject.cheftool.VelocityPortletPaneledAction"]`
`82`	`82`	`},`
`83`		`- "method_pattern": {`
	`83`	`+ "methodPattern": {`
`84`	`84`	`"arguments": [`
`85`	`85`	`"org.sakaiproject.cheftool.RunData",`
`86`	`86`	`"org.sakaiproject.cheftool.Context"`
`87`	`87`	`]`
`88`	`88`	`}`
`89`	`89`	`},`
`90`	`90`	`{`
`91`		`- "class_pattern": {`
	`91`	`+ "classPattern": {`
`92`	`92`	`"extends": ["org.sakaiproject.cheftool.VelocityPortletPaneledAction"]`
`93`	`93`	`},`
`94`		`- "method_pattern": {`
	`94`	`+ "methodPattern": {`
`95`	`95`	`"arguments": ["org.sakaiproject.cheftool.RunData"]`
`96`	`96`	`}`
`97`	`97`	`}`
`@@ -101,12 +101,12 @@`
`101`	`101`	`"id": "Javax Servlet",`
`102`	`102`	`"patterns": [`
`103`	`103`	`{`
`104`		`- "class_pattern": {`
	`104`	`+ "classPattern": {`
`105`	`105`	`"extends": [`
`106`	`106`	`"javax.servlet.http.HttpServlet"`
`107`	`107`	`]`
`108`	`108`	`},`
`109`		`- "method_pattern": {`
	`109`	`+ "methodPattern": {`
`110`	`110`	`"names": [`
`111`	`111`	`"doDelete",`
`112`	`112`	`"doGet",`
`@@ -124,7 +124,7 @@`
`124`	`124`	`"id": "GWT",`
`125`	`125`	`"patterns": [`
`126`	`126`	`{`
`127`		`- "class_pattern": {`
	`127`	`+ "classPattern": {`
`128`	`128`	`"implements": [`
`129`	`129`	`"com.google.gwt.user.client.rpc.RemoteService"`
`130`	`130`	`]`
`@@ -136,22 +136,22 @@`
`136`	`136`	`"id": "Play!",`
`137`	`137`	`"patterns": [`
`138`	`138`	`{`
`139`		`- "class_pattern": {`
	`139`	`+ "classPattern": {`
`140`	`140`	`"extends": [`
`141`	`141`	`"play.mvc.Controller"`
`142`	`142`	`]`
`143`	`143`	`},`
`144`		`- "method_pattern": {`
	`144`	`+ "methodPattern": {`
`145`	`145`	`"returns": ["play.mvc.Result"]`
`146`	`146`	`}`
`147`	`147`	`},`
`148`	`148`	`{`
`149`		`- "class_pattern": {`
	`149`	`+ "classPattern": {`
`150`	`150`	`"extends": [`
`151`	`151`	`"play.mvc.Action", "play.mvc.Action.Simple"`
`152`	`152`	`]`
`153`	`153`	`},`
`154`		`- "method_pattern": {`
	`154`	`+ "methodPattern": {`
`155`	`155`	`"names": ["call"],`
`156`	`156`	`"arguments": ["play.mvc.Http.Context"]`
`157`	`157`	`}`
`@@ -162,10 +162,10 @@`
`162`	`162`	`"id": "Struts",`
`163`	`163`	`"patterns": [`
`164`	`164`	`{`
`165`		`- "class_pattern": {`
	`165`	`+ "classPattern": {`
`166`	`166`	`"extends": ["com.opensymphony.xwork2.ActionSupport"]`
`167`	`167`	`},`
`168`		`- "method_pattern": {`
	`168`	`+ "methodPattern": {`
`169`	`169`	`"names": ["execute"],`
`170`	`170`	`"returns": ["java.lang.String"]`
`171`	`171`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class detected_entry_pointst`
`20`	`20`	`class json_namest`
`21`	`21`	`{`
`22`	`22`	`public:`
`23`		`- static constexpr const char *entry_points = "entry_points";`
	`23`	`+ static constexpr const char *entry_points = "entryPoints";`
`24`	`24`	`};`
`25`	`25`	`};`
`26`	`26`