adding work for today, still needs fixing up of tests

Author: vsoch

spython/image/__init__.py

@@ -56,7 +56,6 @@ def remove_uri(self, image):
         image = image or ''
         uri = self.get_uri(image) or ''
         image = image.replace('%s://' %uri,'', 1)
-        print(image)
         return image.strip('-').strip('/')
 
 

spython/instance/__init__.py

@@ -17,6 +17,7 @@
 
 
 from spython.image import ImageBase
+import os
 
 class Instance(ImageBase):
 
@@ -33,9 +34,66 @@ def __init__(self, image, start=True, **kwargs):
        '''
        super(ImageBase, self).__init__()
        self.parse_image_name(image)
-       self.status = 'stopped'
+
+       # Update metadats from arguments
+       self._update_metadata(kwargs)
+       self.options = []
+       self.cmd = []
 
        # Start the instance
        if start is True:
-           self.start(**kwargs)
+           self._start(**kwargs)
+
+# Unique resource identifier
+
+    def parse_image_name(self, image):
+        '''
+            simply split the uri from the image. Singularity handles
+            parsing of registry, namespace, image.
+            
+            Parameters
+            ==========
+            image: the complete image uri to load (e.g., docker://ubuntu) 
+
+        '''
+        self._image = image
+        self.uri = 'instance://'
+
+
+    def get_uri(self):
+        '''return the image uri (instance://) along with it's name
+        '''
+        return self.__str__()
+
+# Metadata
+
+    def _update_metadata(self, kwargs=None):
+        '''Extract any additional attributes to hold with the instance
+           from kwargs
+        '''
+
+        # If not given metadata, use instance.list to get it for container
+        if kwargs is None:
+            kwargs = self._list(self.name, quiet=True, return_json=True)
+
+        # Add acceptable arguments
+        for arg in ['pid', 'name']:
+
+           # Skip over non-iterables:
+           if arg in kwargs:
+               setattr(self, arg, kwargs[arg])
+       
+        if "image" in kwargs:
+            self._image = kwargs['image']
+        elif "container_image" in kwargs:
+            self._image = kwargs['container_image']
+
+
+    def __str__(self):
+        if hasattr(self, 'uri'):
+            if self.uri:
+                return "%s%s" %(self.uri, self.name)
+        return os.path.basename(self._image)
 
+    def __repr__(self):
+        return self.__str__()

spython/main/__init__.py

@@ -39,7 +39,7 @@ def get_client(quiet=False, debug=False):
     from .execute import execute 
     from .help import help
     from .inspect import inspect
-    from .instances import instances
+    from .instances import ( instances, stopall ) # global instance commands
     from .run import run
     from .pull import pull
 
@@ -53,12 +53,16 @@ def get_client(quiet=False, debug=False):
     Client.run = run
     Client.pull = pull
 
-    # Command Groups
+    # Command Groups, Images
     from spython.image.cmd import image_group        # deprecated image commands
-    from spython.instance.cmd import instance_group  # returns Instance objects
     Client.image = image_group
-    Client.image.check_install = Client.check_install
+    Client.image._check_install = Client._check_install
+
+    # Commands Groups, Instances
+    from spython.instance.cmd import instance_group  # instance level commands
     Client.instance = instance_group
+    Client.instance._check_install = Client._check_install
+    Client.instance_stopall = stopall
 
     # Initialize
     cli = Client()

spython/main/apps.py

@@ -32,7 +32,7 @@ def apps(self, image=None, full_path=False, root=''):
        image_path: full path to the image
 
     '''
-    self.check_install()
+    self._check_install()
 
     # No image provided, default to use the client's loaded image
     if image is None:

spython/main/base/__init__.py

@@ -65,7 +65,7 @@ def version(self):
             return version
 
 
-    def check_install(self):
+    def _check_install(self):
         '''ensure that singularity is installed, and exit if not.
         '''
         if check_install() is not True:

spython/main/build.py

@@ -56,7 +56,7 @@ def build(self, recipe=None,
        sudo: give sudo to the command (or not) default is True for build
     
     '''
-    self.check_install()
+    self._check_install()
     cmd = self._init_command('build')
 
     # No image provided, default to use the client's loaded image

spython/main/execute.py

@@ -48,9 +48,8 @@ def execute(self,
              directories within your container using bind mounts
 
     '''
-
     cmd = self._init_command('exec')
-    self.check_install()
+    self._check_install()
 
     # If the image is given as a list, it's probably the command
     if isinstance(image, list):
@@ -62,6 +61,11 @@ def execute(self,
         # No image provided, default to use the client's loaded image
         if image is None:
             image = self._get_uri()
+            self.quiet = True
+
+        # If an instance is provided, grab it's name
+        if isinstance(image, self.instance):
+            image = image.get_uri()
 
         # Does the user want to use bind paths option?
         if bind is not None:

spython/main/help.py

@@ -33,7 +33,7 @@ def help(self, command=None):
         command: the command to get help for, if none, prints general help
 
     '''
-    self.check_install()
+    self._check_install()
 
     cmd = ['singularity','--help']
     if command != None:

spython/main/inspect.py

@@ -30,7 +30,7 @@ def inspect(self,image=None, json=True, app=None):
        app: if defined, return help in context of an app
 
     '''
-    self.check_install()
+    self._check_install()
 
     # No image provided, default to use the client's loaded image
     if image is None:

spython/main/instances.py

@@ -18,10 +18,9 @@
 
 
 from spython.logger import bot
-from spython.utils import run_command
+from spython.utils import run_command, check_install
 
-
-def instances(self):
+def instances(self, name=None, return_json=False, quiet=False):
     '''list instances. For Singularity, this is provided as a command sub
        group.
 
@@ -30,33 +29,92 @@ def instances(self):
        Return codes provided are different from standard linux:
        see https://github.com/singularityware/singularity/issues/1706
 
+       Parameters
+       ==========
+       return_json: return a json list of instances instead of objects (False)
+       name: if defined, return the list for just one instance (used to ged pid)
+
        Return Code  --   Reason
        0 -- Instances Found
        1 -- No Instances, libexecdir value not found, functions file not found
        255 -- Couldn't get UID
 
     '''
+    from spython.instance.cmd.iutils import parse_table
+    self._check_install()
+    cmd = self._init_command('instance.list')
 
-    self.check_install()
+    # If the user has provided a name, we want to see a particular instance
+    if name is not None:
+        cmd.append(name)
 
-    cmd = self._init_command('instance.list')
     output = run_command(cmd, quiet=True)
     instances = None
 
     # Success, we have instances
 
     if output['return_code'] == 0:
-        print(''.join(output['message']))
-        instances = output['message'][1:]
+
+        # Only print the table if we are returning json
+        if quiet is False:
+            print(''.join(output['message']))
+
+        # Prepare json result from table
+
+        header = ['daemon_name','pid','container_image']
+        instances = parse_table(output['message'][0], header)
+
+        # Does the user want instance objects instead?
+        listing = []
+        if return_json is False:
+            for i in instances:
+                
+                new_instance = self.instance(pid=i['pid'],
+                                             name=i['daemon_name'],
+                                             image=i['container_image'],
+                                             start=False)
+
+                listing.append(new_instance)
+            instances = listing
 
     # Couldn't get UID
 
     elif output['return_code'] == 255:
         bot.error("Couldn't get UID")
 
-
     # Return code of 0
     else:
         bot.info('No instances found.')
 
+    # If we are given a name, return just one
+    if name is not None and instances is not None:
+        if len(instances) == 1:
+            instances = instances[0]
+
     return instances
+
+
+def stopall(self, sudo=False, quiet=True):
+    '''stop ALL instances. This command is only added to the command group
+       as it doesn't make sense to call from a single instance
+
+       Parameters
+       ==========
+       sudo: if the command should be done with sudo (exposes different set of
+             instances)
+
+    '''
+    from spython.utils import run_command, check_install
+    check_install()
+
+    cmd = self._init_command('instance.stop')
+    cmd = cmd + ['--all']
+    output = run_command(cmd, sudo=sudo, quiet=quiet)
+
+    if output['return_code'] != 0:
+        message = '%s : return code %s' %(output['message'], 
+                                          output['return_code'])
+        bot.error(message)
+        return output['return_code']
+
+    return output['return_code']