Merge pull request #168 from cognitive-catalyst/167_json_dialogtest_support

#167 allow JSON or TSV input files

Author: andrewrfreed

dialog_test/README.md

@@ -23,11 +23,28 @@ Check the `results` folder for test output.  If any MATCH column has a 'FALSE' v
 Additionally, each test will print a single PASS or FAIL marker to standard out upon completion.
 
 ## Building tests with configuration
-Build test files in the tests subfolder.  Each test should be a tab separated file.
+Build test files in the tests subfolder.  Each test should be a tab separated file or a JSON file.
 
-The columns are
+For a tab-separated file, the column headers are the following ("Turn number" is NOT specified as a column header)
 (Turn number) User Input      Match Output    Match Intent    Match Entity    Alternate Intents       Intents Object  Entities Object Context Variables       System Object
 
+For a JSON test file, the file contents are an array of JSON objects.  For example:
+```
+[
+  {
+    "Turn": "0",
+    "Context Variables": {
+      "user_type": "GOLD"
+    }
+  },
+  {
+    "Turn": "1",
+    "User Input": "I need to reset my password",
+    "Match Output": "I can help you reset your password"
+  }
+]
+```
+
 All fields are optional
 
 * Match Output indicates a substring that must be present in the Watson Assistant response. It is not necessary to provide the full output string. Regular Expressions can be enclosed with forward slashes (e.g. `/The reservation is for *. PM/`). `<br>` can be used to join lines when specifyig multiline ouputs (e.g. `The reservation is for 6 guests<br>What day would you like to come in?`).

dialog_test/flowtest.py

@@ -66,7 +66,11 @@ def processPath(inputPath:str):
 def processFile(flowfile:str, watsonSDKVersion:str):
     basefilename = os.path.basename(flowfile).split('.')[0]
 
-    flow = pd.read_csv(flowfile, delimiter='\t' )
+    if flowfile.endswith("json"):
+       flow = json.load(open(flowfile))
+       flow = pd.DataFrame(flow)
+    else:
+       flow = pd.read_csv(flowfile, delimiter='\t' )
 
     # This bit widens the output on screen.
     pd.set_option('display.max_columns', 10000)
@@ -89,7 +93,7 @@ def processFile(flowfile:str, watsonSDKVersion:str):
     # print()
 
     print()
-    print('Running Conversational Flow: {} ({})'.format(flowfile, flow.shape[0]))
+    print('Running Conversational Flow: {} ({})'.format(flowfile, len(flow)))
     results = ft.runFlowTest(workspace_id=workspace_id, flow=flow, show_progress=True, version=watsonSDKVersion)
     print()
     #Full esults are hard to read, instead we let step by step progress report failures as they happen