adding build options to support fakeroot, remote, etc.

Signed-off-by: Vanessa Sochat <[email protected]>

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 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)
  - pyaml version should be for newer kind, and still check for attribute (0.0.11)
  - alpha release with simple (single container) working example (0.0.1)

docs/spec/spec-1.0.md

@@ -111,6 +111,7 @@ field (not defined above).|
 |build| a section to define how and where to build the base container from.|
 |build.context| the folder with the Singularity file (and other relevant files). Must exist.
 |build.recipe| the Singularity recipe in the build context folder. It defaults to `Singularity`|
+|build.options| a list of one or more options (single strings for boolean, or key value pairs for arguments) to provide to build. |
 |image| is looked for after a build entry. It can be a unique resource identifier, or container binary. |
 |volumes| one or more files or files to bind to the instance when it's started.|
 |volumes_from| shared volumes that are defined for other instances|

scompose/project/instance.py

@@ -281,11 +281,18 @@ def build(self, working_dir):
             if not os.path.exists(self.recipe):
                 bot.exit('%s not found for build' % self.recipe)
 
-            # This will require sudo
+            # This will likely require sudo, unless --remote or --fakeroot in options
             try:
+                options = self.get_build_options()
+
+                # If remote or fakeroot included, don't need sudo
+                sudo = not ("--fakeroot" in options or "--remote" in options)
+
                 bot.info('Building %s' % self.name)
                 self.client.build(image=sif_binary,
-                                  recipe=self.recipe)
+                                  recipe=self.recipe,
+                                  options=options,
+                                  sudo=sudo)
 
             except:
                 build = "sudo singularity build %s %s" % (os.path.basename(sif_binary),
@@ -299,6 +306,32 @@ def build(self, working_dir):
         else:
             bot.exit("neither image and build defined for %s" % self.name)
 
+    def get_build_options(self):
+        ''''get build options will parse through params, and return build
+            options (if they exist)
+        '''
+        options = []
+
+        if "build" in self.params:
+            if "options" in self.params['build']:
+                for option in self.params['build']['options']:
+
+                    # if the option is a string, it's a boolean flag
+                    if isinstance(option, str):
+                        options.append('--%s' % option)
+
+                    # Otherwise, the user set a boolean with a value or an arg
+                    elif isinstance(option, dict):
+                        for key, val in option.items():
+                            if val is True:
+                                options.append('--%s' % key)
+                            elif val is False:
+                                continue
+                            else:
+                                options += ['--%s' % key, val]
+
+        return options
+
 # State
 
     def exists(self):

scompose/version.py

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