Merge pull request #18 from singularityhub/add/run

adding run command

Author: vsoch

CHANGELOG.md

@@ -14,6 +14,7 @@ and **Merged pull requests**. Critical items to know are:
 The versions coincide with releases on pypi.
 
 ## [0.0.x](https://github.com/singularityhub/singularity-compose/tree/master) (0.0.x)
+ - adding run command (0.0.15)
  - ensuring that builds are streamed (0.0.14)
  - adding more build options to build as build-flags (0.0.13)
  - when not using sudo, need to set --network=none, and catching exec error (0.0.12)

docs/commands.md

@@ -94,6 +94,19 @@ usr
 var
 ```
 
+## Run
+
+If a container has a `%runscript` section (or a Docker entrypoint/cmd that 
+was converted to one), you can run that script easily:
+
+```bash
+$ singularity-compose run app
+```
+
+If your container didn't have any kind of runscript, the startscript
+will be used instead.
+
+
 ## Down
 
 You can bring one or more instances down (meaning, stopping them) by doing:

scompose/client/__init__.py

@@ -109,6 +109,9 @@ def get_parser():
     execute = subparsers.add_parser("exec",
                                     help="execute a command to an instance")
 
+    run = subparsers.add_parser("run",
+                                help="run an instance runscript.")
+
     shell = subparsers.add_parser("shell",
                                    help="shell into an instance")
 
@@ -134,7 +137,7 @@ def get_parser():
                           help='the names of the instances to target')
 
     # Only one name allowed
-    for sub in [shell, execute]:
+    for sub in [shell, execute, run]:
         sub.add_argument('name', nargs=1,
                          help='the name of the instance to target')
 
@@ -195,6 +198,8 @@ def show_help(return_code=0):
         from .ps import main
     elif args.command == "restart": 
         from .restart import main
+    elif args.command == "run": 
+        from .run import main
     elif args.command == "shell":
         from .shell import main
     elif args.command == "up": 

scompose/client/run.py

@@ -0,0 +1,30 @@
+'''
+
+Copyright (C) 2019 Vanessa Sochat.
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
+License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+'''
+
+from scompose.project import Project
+
+def main(args, parser, extra):
+    '''execute a command to an instance.
+    '''
+    # Initialize the project
+    project = Project(filename=args.file,
+                      name=args.project_name,
+                      env_file=args.env_file)
+
+    project.run(args.name[0])

scompose/project/project.py

@@ -129,6 +129,22 @@ def iter_instances(self, names):
             yield self.instances.get(name)
 
 
+    def get_instance(self, name):
+        '''get a specifically named instance. We first check that the 
+           client has instances defined, and that the name we are looking
+           for is also included. If not found, we return None.
+
+           Parameters
+           ==========
+           names: the name of instances to get. Must be valid
+        '''
+        instance = None
+        if self.instances:
+            if name in self.instances:
+                instance = self.instances[name]
+        return instance
+        
+
 # Loading Functions
 
     def load(self):
@@ -249,11 +265,34 @@ def shell(self, name):
            ==========
            name: the name of the instance to shell into
         '''
-        if self.instances:
-            if name in self.instances:
-                instance = self.instances[name]
-                if instance.exists():
-                    self.client.shell(instance.instance.get_uri(), sudo=self.sudo)
+        instance = self.get_instance(name)
+        if not instance:
+            bot.exit('Cannot find %s, is it up?' % name)
+
+        if instance.exists():
+            self.client.shell(instance.instance.get_uri(), sudo=self.sudo)
+
+
+    def run(self, name):
+        '''if an instance exists, run it.
+
+           Parameters
+           ==========
+           name: the name of the instance to run
+        '''
+        instance = self.get_instance(name)
+        if not instance:
+            bot.exit('Cannot find %s, is it up?' % name)
+
+        if instance.exists():
+            self.client.quiet = True
+            result = self.client.run(instance.instance.get_uri(), 
+                                     sudo=self.sudo,
+                                     return_result=True)
+
+            if result['return_code'] != 0:
+                bot.exit("Return code %s" % result['return_code'])
+            print(''.join([x for x in result['message'] if x]))
 
 
     def execute(self, name, commands):
@@ -264,18 +303,20 @@ def execute(self, name, commands):
            name: the name of the instance to exec to
            commands: a list of commands to issue
         '''
-        if self.instances:
-            if name in self.instances:
-                instance = self.instances[name]
-                if instance.exists():
-                    try:
-                        for line in self.client.execute(instance.instance.get_uri(), 
-                                                        command=commands,
-                                                        stream=True,
-                                                        sudo=self.sudo):
-                            print(line, end='')
-                    except subprocess.CalledProcessError:
-                        bot.exit('Command had non zero exit status.')
+        instance = self.get_instance(name)
+        if not instance:
+            bot.exit('Cannot find %s, is it up?' % name)
+
+        if instance.exists():
+            try:
+                for line in self.client.execute(instance.instance.get_uri(), 
+                                                command=commands,
+                                                stream=True,
+                                                sudo=self.sudo):
+                    print(line, end='')
+            except subprocess.CalledProcessError:
+                bot.exit('Command had non zero exit status.')
+
 
 # Logs
 

scompose/version.py

@@ -17,7 +17,7 @@
 
 '''
 
-__version__ = "0.0.14"
+__version__ = "0.0.15"
 AUTHOR = 'Vanessa Sochat'
 AUTHOR_EMAIL = '[email protected]'
 NAME = 'singularity-compose'