Merge pull request #9 from datmo/snapshot-command

Connecting snapshot commands with controllers + Adding tests for snap…

datmo/cli/command/base.py

@@ -59,4 +59,5 @@ def execute(self):
                                         "cli.general.method.not_found",
                                         (self.args.command, method)))
 
-        return method(**command_args)
+        method_result = method(**command_args)
+        return method_result

datmo/cli/command/snapshot.py

@@ -1,5 +1,7 @@
 from __future__ import print_function
 
+import prettytable
+
 from datmo.util.i18n import get as _
 from datmo.cli.command.project import ProjectCommand
 from datmo.controller.snapshot import SnapshotController
@@ -20,7 +22,7 @@ def __init__(self, home, cli_helper):
                             help="Label snapshots with a category (e.g. best)")
         create.add_argument("--session-id", dest="session_id", default="", help="User given session id")
 
-        create.add_argument("--task-id", dest="task_id", default=None,
+        create.add_argument("--task-id", dest="task_id", default="",
                             help="Specify task id to pull information from")
 
         create.add_argument("--code-id", dest="code_id", default="",
@@ -29,50 +31,33 @@ def __init__(self, home, cli_helper):
         create.add_argument("--environment-def-path", dest="environment_def_path", default="",
                             help="Absolute filepath to environment definition file (e.g. /path/to/Dockerfile)")
 
-        create.add_argument("--config-filename", dest="config_filename", default=None,
+        create.add_argument("--config-filename", dest="config_filename", default="",
                             help="Filename to use to search for configuration JSON")
-        create.add_argument("--config-filepath", dest="config_filepath", default=None,
+        create.add_argument("--config-filepath", dest="config_filepath", default="",
                             help="Absolute filepath to use to search for configuration JSON")
 
-        create.add_argument("--stats-filename", dest="stats_filename", default=None,
+        create.add_argument("--stats-filename", dest="stats_filename", default="",
                             help="Filename to use to search for metrics JSON")
-        create.add_argument("--stats-filepath", dest="stats_filepath", default=None,
+        create.add_argument("--stats-filepath", dest="stats_filepath", default="",
                             help="Absolute filepath to use to search for metrics JSON")
 
         create.add_argument("--filepaths", dest="filepaths", default=[], nargs="*",
                             help="Absolute paths to files or folders to include within the files of the snapshot")
 
+        create.add_argument("--not-visible", dest="visible", action="store_false",
+                         help="Boolean if you want snapshot to not be visible")
+
         delete = subcommand_parsers.add_parser("delete", help="Delete a snapshot by id")
-        delete.add_argument("--id", dest="snapshot_id", help="snapshot id to delete")
+        delete.add_argument("--id", dest="id", help="snapshot id to delete")
 
         ls = subcommand_parsers.add_parser("ls", help="List snapshots")
         ls.add_argument("--session-id", dest="session_id", default=None, help="Session ID to filter")
         ls.add_argument("--session-name", dest="session_name", default=None, help="Session name to filter")
-        ls.add_argument("-a", dest="details", default=True, help="Show detailed SnapshotCommand information")
+        ls.add_argument("--all", "-a", dest="details", action="store_true",
+                            help="Show detailed SnapshotCommand information")
 
         checkout = subcommand_parsers.add_parser("checkout", help="Checkout a snapshot by id")
-        checkout.add_argument("--id", dest="snapshot_id", default=None, help="SnapshotCommand ID")
-
-        # home = subcommand_parsers.add_parser("home", help="Checkout/Reset back to initial state")
-
-        update = subcommand_parsers.add_parser("update", help="Update SnapshotCommand with meta information ")
-        update.add_argument("--id", dest="snapshot_id", default=None, help="SnapshotCommand id to edit")
-        update.add_argument("--message", "-m", dest="message", default=None, help="Message to describe snapshot")
-        update.add_argument("--label", "-l", dest="label", default=None,
-                            help="Label snapshots with a category (e.g. best)")
-
-        update.add_argument("--config-filename", dest="config_filename", default=None,
-                            help="Filename to use to search for configuration JSON")
-        update.add_argument("--config-filepath", dest="config_filepath", default=None,
-                            help="Absolute filepath to use to search for configuration JSON")
-
-        update.add_argument("--stats-filename", dest="stats", default=None,
-                            help="Filename to use to search for metrics JSON")
-        update.add_argument("--stats-filepath", dest="stats", default=None,
-                            help="Absolute filepath to use to search for metrics JSON")
-
-        best = subcommand_parsers.add_parser("best", help="Sets the best snapshot for a model")
-        best.add_argument("--id", dest="snapshot_id", default=None, help="SnapshotCommand ID")
+        checkout.add_argument("--id", dest="id", default=None, help="SnapshotCommand ID")
 
         self.snapshot_controller = SnapshotController(home=home,
                                                       dal_driver=self.project_controller.dal_driver)
@@ -83,26 +68,82 @@ def __init__(self, home, cli_helper):
 
     def create(self, **kwargs):
         self.cli_helper.echo(_("info", "cli.snapshot.create"))
-        self.snapshot_controller.create(**kwargs)
 
-    def delete(self, snapshot_id):
-        self.snapshot_controller.delete(snapshot_id)
+        def mutually_exclusive(dictionary, mutually_exclusive_args):
+            for arg in mutually_exclusive_args:
+                if arg in kwargs and kwargs[arg]:
+                    snapshot_dict[arg] = kwargs[arg]
+                    break
+            return dictionary
 
-    def ls(self, **kwargs):
-        print("ls", kwargs)
+        snapshot_dict = {}
 
-    def checkout(self, **kwargs):
-        print("checkout", kwargs)
+        # Code
+        mutually_exclusive_args = ["code_id", "commit_id"]
+        snapshot_dict = mutually_exclusive(snapshot_dict, mutually_exclusive_args)
+
+        # Environment
+        mutually_exclusive_args = ["environment_id", "environment_definition_filepath"]
+        snapshot_dict = mutually_exclusive(snapshot_dict, mutually_exclusive_args)
+
+        # File
+        mutually_exclusive_args = ["file_collection_id", "file_collection"]
+        snapshot_dict = mutually_exclusive(snapshot_dict, mutually_exclusive_args)
+
+        # Config
+        mutually_exclusive_args = ["config_filepath", "config_filename"]
+        snapshot_dict = mutually_exclusive(snapshot_dict, mutually_exclusive_args)
+
+        # Stats
+        mutually_exclusive_args = ["stats_filepath", "stats_filename"]
+        snapshot_dict = mutually_exclusive(snapshot_dict, mutually_exclusive_args)
 
-    def home(self, **kwargs):
-        print("home", kwargs)
+        optional_args = ["session_id", "task_id", "message", "label", "visible"]
 
-    def update(self, **kwargs):
-        print("update", kwargs)
+        for arg in optional_args:
+            if arg in kwargs and kwargs[arg]:
+                snapshot_dict[arg] = kwargs[arg]
 
-    def best(self, **kwargs):
-        print("best", kwargs)
+        snapshot_obj = self.snapshot_controller.create(snapshot_dict)
 
+        return snapshot_obj.id
+
+    def delete(self, **kwargs):
+        self.cli_helper.echo(_("info", "cli.snapshot.delete"))
+        id = kwargs.get("id", None)
+        return self.snapshot_controller.delete(id)
+
+    def ls(self, **kwargs):
+        session_id = kwargs.get('session_id',
+                                self.snapshot_controller.current_session.id)
+        # Get all snapshot meta information
+        detailed_info = kwargs.get('details', None)
+        if detailed_info:
+            header_list = ["id", "created at", "config", "stats", "message", "label", "code id",
+                           "environment id", "file collection id"]
+            t = prettytable.PrettyTable(header_list)
+            snapshot_objs = self.snapshot_controller.list(session_id)
+            for snapshot_obj in snapshot_objs:
+                t.add_row([snapshot_obj.id, snapshot_obj.created_at.strftime("%Y-%m-%d %H:%M:%S"),
+                           snapshot_obj.config, snapshot_obj.stats,
+                           snapshot_obj.message, snapshot_obj.label,
+                           snapshot_obj.code_id, snapshot_obj.environment_id,
+                           snapshot_obj.file_collection_id])
+        else:
+            header_list = ["id", "created at", "config", "stats", "message", "label"]
+            t = prettytable.PrettyTable(header_list)
+            snapshot_objs = self.snapshot_controller.list(session_id)
+            for snapshot_obj in snapshot_objs:
+                t.add_row([snapshot_obj.id, snapshot_obj.created_at.strftime("%Y-%m-%d %H:%M:%S"),
+                           snapshot_obj.config, snapshot_obj.stats,
+                           snapshot_obj.message, snapshot_obj.label])
+
+        self.cli_helper.echo(t)
+        return True
+
+    def checkout(self, **kwargs):
+        id = kwargs.get("id", None)
+        return self.snapshot_controller.checkout(id)
 
 
 

datmo/cli/command/task.py

@@ -1,5 +1,6 @@
 from __future__ import print_function
 
+import shlex
 import prettytable
 
 from datmo.util.i18n import get as _
@@ -56,6 +57,9 @@ def run(self, **kwargs):
                 kwargs['environment_definition_filepath']
         }
 
+        if type(kwargs['cmd']) is not list:
+            kwargs['cmd'] = shlex.split(kwargs['cmd'])
+
         task_dict = {
             "gpu": kwargs['gpu'],
             "ports": kwargs['ports'],
@@ -75,7 +79,7 @@ def ls(self, **kwargs):
         session_id = kwargs.get('session_id',
                                 self.task_controller.current_session.id)
         # Get all snapshot meta information
-        header_list = ["id", "command", "status", "gpu", "created_at"]
+        header_list = ["id", "command", "status", "gpu", "created at"]
         t = prettytable.PrettyTable(header_list)
         task_objs = self.task_controller.list(session_id)
         for task_obj in task_objs: