Add commandline argument parsing (#14)

Added commandline argument parsing, in addition to testing of the CLI tool on Travis, and

Author: juliusgeo

pymongoexplain/__main__.py

@@ -13,16 +13,20 @@
 # limitations under the License.
 
 
+"""This script is intended to provide an easy method to run explain on all
+commands in a script. Find more documentation at
+https://github.com/mongodb-labs/pymongoexplain/"
+"""
+
 from pymongo.collection import Collection
 from .explainable_collection import ExplainCollection
 
 import sys
 import logging
+import argparse
+
 
 
-'''This module allows for pymongo scripts to run with with pymongoexplain, 
-explaining each command as it occurs.
-'''
 
 
 FORMAT = '%(asctime)s %(levelname)s %(module)s %(message)s'
@@ -48,6 +52,18 @@ def new_func(self: Collection, *args, **kwargs):
     setattr(Collection, old_func_name, make_func(old_func, old_func_name))
 
 if __name__ == '__main__':
-    for file in sys.argv[1:]:
-        with open(file) as f:
-            exec(f.read())
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument(
+        "input_script", nargs=1,help="The script that you "
+                                     "wish to run explain on.")
+    parser.add_argument(
+        "arguments", metavar="script_arguments", help="add arguments to "
+                                                       "explained script",
+                                                        nargs="?")
+
+    args = parser.parse_args()
+    file = args.input_script[0]
+    with open(file) as f:
+        sys.argv = [file]+args.arguments if args.arguments is not None else\
+                    [file]
+        exec(f.read())

test/test_cli_tool_script.py

@@ -0,0 +1,11 @@
+"""Script to test CLI functionality of pymongoexplain"""
+
+
+import pymongo
+
+import sys
+
+
+client = pymongo.MongoClient(serverSelectionTimeoutMS=1000)
+collection = client.db.get_collection("products")
+collection.update_one({"quantity": 1057, "category": "apparel"},{"$set": {"reorder": True}})

test/test_collection.py

@@ -12,7 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 import unittest
+import subprocess
+import os
 
 from pymongo import MongoClient
 from pymongo import monitoring
@@ -182,6 +185,18 @@ def test_estimated_document_count(self):
         last_cmd_payload = self.explain.last_cmd_payload
         self._compare_command_dicts(last_cmd_payload, last_logger_payload)
 
+    def test_cli_tool(self):
+        script_path = os.path.join(os.path.dirname(os.path.realpath(
+            __file__)), "test_cli_tool_script.py")
+        res = subprocess.run(["python3",  "-m", "pymongoexplain",
+                              script_path], stdout = subprocess.PIPE)
+        self.assertTrue(res.returncode == 0)
+        self.assertNotEqual(res.stdout, "")
+
+        res = subprocess.run(["python3",  "-m", "pymongoexplain",
+                              script_path, "-h"], stdout = subprocess.PIPE)
+        self.assertNotEqual(res.stdout, "")
+        self.assertTrue(res.returncode == 0)
 
 if __name__ == '__main__':
     unittest.main()