Merge lp:~ted/snapcraft/status into lp:~snappy-dev/snapcraft/core

[Ted Gould]

Add status command to query parts

Small 'status' command to find the state of the parts. Working with snapcraft and kept feeling I needed this to figure out what was going on.

[Leo Arias (elopio)]

Please use logger.info instead of print.
Also for consistency it would be nice if you use single quotes. The code in snapcraft uses single and double quotes, so it would be nice to start changing this practice.

You didn't change this line, but you probably should:

47 except Exception:

I think that what you want to catch in there is the OSError.

And you are missing the tests in this branch. At least for some states it should be easy to write the tests. For some you might need to fake the state, which shouldn't be hard either. Ping me if you need a hand here.

review: Needs Fixing

Unmerged revisions

133. By Ted Gould on 2015-08-12

Fix tests'

132. By Ted Gould on 2015-08-12

Add a small status command to get the status of parts

=== modified file 'snapcraft/cmds.py'
--- snapcraft/cmds.py	2015-08-05 14:38:33 +0000
+++ snapcraft/cmds.py	2015-08-12 19:00:32 +0000
@@ -53,6 +53,13 @@
     sys.exit(0)
 
 
+def status(args):
+    config = snapcraft.yaml.Config()
+    print("status:")
+    for part in config.all_parts:
+        print("  {0}: {1}".format(part.plugin_name, part.state()))
+
+
 def shell(args):
     config = snapcraft.yaml.Config()
     common.env = config.stage_env()

=== modified file 'snapcraft/main.py'
--- snapcraft/main.py	2015-07-30 14:45:01 +0000
+++ snapcraft/main.py	2015-08-12 19:00:32 +0000
@@ -45,6 +45,9 @@
     parser.add_argument('userCommand', nargs=argparse.REMAINDER, metavar='cmd', help='optional command to run inside staging environment')
     parser.set_defaults(func=snapcraft.cmds.shell)
 
+    parser = subparsers.add_parser('status', help='print status of parts', parents=[cmd_parser])
+    parser.set_defaults(func=snapcraft.cmds.status)
+
     parser = subparsers.add_parser('run', help='run snap in kvm', add_help=False)
     parser.set_defaults(func=snapcraft.cmds.run)
 

=== modified file 'snapcraft/plugin.py'
--- snapcraft/plugin.py	2015-08-05 14:25:54 +0000
+++ snapcraft/plugin.py	2015-08-12 19:00:32 +0000
@@ -141,13 +141,19 @@
     def notify_stage(self, stage, hint=''):
         logger.info(stage + " " + self.part_names[0] + hint)
 
-    def is_dirty(self, stage):
+    def state(self):
         try:
             with open(self.statefile, 'r') as f:
                 lastStep = f.read()
-                return common.COMMAND_ORDER.index(stage) > common.COMMAND_ORDER.index(lastStep)
+                return lastStep
         except Exception:
+            return 'init'
+
+    def is_dirty(self, stage):
+        state = self.state()
+        if state is 'init':
             return True
+        return common.COMMAND_ORDER.index(stage) > common.COMMAND_ORDER.index(state)
 
     def should_stage_run(self, stage, force):
         if not force and not self.is_dirty(stage):