adding shell

Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>

Author: vsoch

scompose/client/__init__.py

@@ -82,11 +82,19 @@ def get_parser():
     config = subparsers.add_parser("config",
                                    help="Validate and view the compose file")
 
-    # Create (assumes built already)
+    # Create (assumes built already), Up (will also build, if able)
 
     create = subparsers.add_parser("create",
                                    help="create instances")
 
+    up = subparsers.add_parser("up",
+                               help="build and start containers")
+
+    for sub in [create, up]:
+        sub.add_argument('--writable-tmpfs', dest="writable_tmpfs", 
+                         help="allow the instance to write to tmp", 
+                         default=False, action='store_true')
+
     # Down
 
     down = subparsers.add_parser("down",
@@ -95,8 +103,9 @@ def get_parser():
     execute = subparsers.add_parser("exec",
                                     help="execute a command to an instance")
 
-    images = subparsers.add_parser("images",
-                                    help="list running instances")
+    shell = subparsers.add_parser("shell",
+                                   help="shell into an instance")
+
 
     kill = subparsers.add_parser("kill",
                                  help="kill instances")
@@ -110,17 +119,16 @@ def get_parser():
     restart = subparsers.add_parser("restart",
                                      help="stop and start containers.")
 
-    rm = subparsers.add_parser("rm",
-                               help="remove non-running container images")
-
-    up = subparsers.add_parser("up",
-                               help="build and start containers")
-
     # Add list of names
     for sub in [create, down, up]:
-        sub.add_argument('names', nargs="?",
+        sub.add_argument('names', nargs="*",
                           help='the names of the instances to target')
 
+    # Only one name allowed
+    for sub in [shell, execute, kill]:
+        sub.add_argument('name', nargs=1,
+                         help='the name of the instance to target')
+
     return parser
 
 
@@ -129,7 +137,6 @@ def main():
        parser based on the command, and then import and call the appropriate 
        main.
     '''
-
     parser = get_parser()
 
     def help(return_code=0):
@@ -165,13 +172,11 @@ def help(return_code=0):
     elif args.command == "config": from .config import main
     elif args.command == "down": from .down import main
     elif args.command == "exec": from .exec import main
-    elif args.command == "images": from .images import main
     elif args.command == "kill": from .kill import main
     elif args.command == "logs": from .logs import main
     elif args.command == "ps": from .ps import main
     elif args.command == "restart": from .restart import main
-    elif args.command == "rm": from .rm import main
-    elif args.command == "stop": from .stop import main
+    elif args.command == "shell": from .shell import main
     elif args.command == "up": from .up import main
 
     # Pass on to the correct parser

scompose/client/create.py

@@ -38,4 +38,4 @@ def main(args, parser, extra):
                       env_file=args.env_file)
 
     # Create instances, and if none specified, create all
-    project.create(args.names)
+    project.create(args.names, writable_tmpfs=writable_tmpfs)

scompose/client/shell.py

@@ -0,0 +1,38 @@
+'''
+
+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
+import logging
+import json
+import sys
+import os
+
+
+log = logging.getLogger(__name__)
+
+def main(args, parser, extra):
+    '''bring one or more instances down
+    '''
+    # Initialize the project
+    project = Project(filename=args.file,
+                      name=args.project_name,
+                      env_file=args.env_file)
+
+    # Create instances, and if none specified, create all
+    project.shell(args.name[0])

scompose/client/up.py

@@ -38,4 +38,4 @@ def main(args, parser, extra):
                       env_file=args.env_file)
 
     # Create instances, and if none specified, create all
-    project.up(args.names)
+    project.up(args.names, writable_tmpfs=writable_tmpfs)

scompose/project/instance.py

@@ -36,14 +36,15 @@ class Instance(object):
                     named according to "name" is created for the image binary.
        params: all of the parameters defined in the configuration.
     '''
-    def __init__(self, name, working_dir, params=None):
+    def __init__(self, name, working_dir, sudo=False, params=None):
 
         if not params:
             params = {}
 
         self.image = None
         self.recipe = None
         self.instance = None
+        self.sudo = sudo
         self.set_name(name, params)
         self.set_context(params)
         self.set_volumes(params)
@@ -143,6 +144,19 @@ def set_ports(self, params):
         '''
         self.ports = params.get('ports', [])
 
+# Commands
+
+    def _get_network_commands(self):
+        '''take a list of ports, return the list of --network-args to
+           ensure they are bound correctly.
+        '''
+        ports = []
+        if self.ports:
+            ports.append('--net')
+            for pair in self.ports:
+                ports += ['--network-args', '"portmap=%s/tcp"' % pair]
+        return ports
+
     def _get_bind_commands(self):
         '''take a list of volumes, and return the bind commands for Singularity
         '''
@@ -266,7 +280,7 @@ def stop(self):
 
 # Create and Delete
 
-    def up(self, working_dir):
+    def up(self, working_dir, sudo=False, writable_tmpfs=False):
         '''up is the same as create, but like Docker, we build / pull instances
            first.
         '''
@@ -275,10 +289,10 @@ def up(self, working_dir):
         # Do a build if necessary
         if not os.path.exists(image):
             self.build(working_dir)
-        self.create()
+        self.create(writable_tmpfs=writable_tmpfs)
 
 
-    def create(self):
+    def create(self, sudo=False, writable_tmpfs=False):
         '''create an instance, if it doesn't exist.
         '''
         image = self.get_image()
@@ -295,7 +309,21 @@ def create(self):
         if not self.exists():
 
             bot.info("Creating %s" % self.name)
+
+            # Volumes
             binds = self._get_bind_commands()
+
+            # Ports
+            ports = self._get_network_commands()
+
+            # Hostname
+            hostname = ["--hostname", self.name]
+
+            # Writable Temporary Directory
+            if writable_tmpfs:
+                hostname += ['--writable_tmpfs']
+
             self.instance = self.client.instance(name=self.name,
-                                                 options=binds,
+                                                 sudo=self.sudo,
+                                                 options=binds + ports + hostname,
                                                  image=image)

scompose/project/project.py

@@ -40,6 +40,7 @@ def __init__(self, filename=None, name=None, env_file=None):
         self.load()
         self.parse()
         self.env_file = env_file
+        self.client = get_client()
 
 # Names
 
@@ -82,6 +83,21 @@ def set_name(self, name):
 
 # Listing
 
+    def ps(self):
+        '''ps will print a table of instances, including pids and names.
+        '''
+        instance_names = self.get_instance_names()
+        table = []
+        for instance in self.client.instances(quiet=True, sudo=self.sudo):
+            if instance.name in instance_names:
+                image = os.path.basename(instance._image)
+                table.append([instance.name.rjust(12), 
+                              instance.pid, 
+                              image])
+
+        bot.custom(prefix="INSTANCES ", message="NAME PID     IMAGE",color="CYAN")
+        bot.table(table)
+        
     def iter_instances(self, names):
         '''yield instances one at a time. If an invalid name is given,
            exit with error.
@@ -116,21 +132,42 @@ def load(self):
 
     def parse(self):
         '''parse a loaded config'''
+
+        # If a port is defined, we need root.
+        self.sudo = False
+        
         if self.config is not None:
 
+            # If any of config has ports, must use sudo for networking
+            for name in self.config.get('instances', []):
+                params = self.config['instances'][name]
+                if "ports" in params:
+                    self.sudo = True
+
             # Create each instance object
             for name in self.config.get('instances', []):
                 params = self.config['instances'][name]
 
                 # Validates params
                 self.instances[name] = Instance(name=name,
                                                 params=params,
+                                                sudo=self.sudo,
                                                 working_dir=self.working_dir)
 
             # Update volumes with volumes from
             for _, instance in self.instances.items():
                 instance.set_volumes_from(self.instances)
-            
+
+# Commands
+
+    def shell(self, name):
+        '''if an instance exists, shell into it.
+        '''
+        if self.instances:
+            if name in self.instances:
+                instance = self.instances[name]
+                if instance.exists():
+                    self.client.shell(instance.instance.get_uri())
 
 # Config
 
@@ -156,18 +193,18 @@ def down(self, names):
 
 # Create
 
-    def create(self, names):
+    def create(self, names, writable_tmpfs=False):
         '''call the create function, which defaults to the command instance.create()
         '''
-        return self._create(names)
+        return self._create(names, writable_tmpfs=writable_tmpfs)
 
-    def up(self, names):
+    def up(self, names, writable_tmpfs=False):
         '''call the up function, instance.up(), which will build before if
            a container binary does not exist.
         '''
-        return self._create(names, command="up")
+        return self._create(names, command="up", writable_tmpfs=writable_tmpfs)
 
-    def _create(self, names, command="create"):
+    def _create(self, names, command="create", writable_tmpfs=False):
         '''create one or more instances. "Command" determines the sub function
            to call for the instance, which should be "create" or "up".
            If the user provide a list of names, use them, otherwise default
@@ -177,6 +214,7 @@ def _create(self, names, command="create"):
            ==========
            names: the instance names to create
            command: one of "create" or "up"
+           writable_tmpfs: if the instances should be given writable to tmp
         '''
         # If no names provided, we create all
         if not names:
@@ -198,7 +236,7 @@ def _create(self, names, command="create"):
                         continue
 
                 # If we get here, execute command and add to list
-                getattr(instance, command)(self.working_dir)
+                getattr(instance, command)(self.working_dir, writable_tmpfs)
                 created.append(instance.name)
                 names.remove(instance.name)