adding ability to specify debug for build

Author: vsoch

singularity/build/google.py

@@ -163,6 +163,12 @@ def run_build(build_dir=None,spec_file=None,repo_url=None,token=None,size=None,b
     if go == None:
         sys.exit(0)
 
+    # If the user wants debug, this will be set
+    debug = True
+    enable_debug = get_build_metadata(key='debug')
+        if enable_debug == None:
+            debug = False
+
     # If no build directory is specified, make a temporary one
     if build_dir == None:
         build_dir = tempfile.mkdtemp()
@@ -171,23 +177,23 @@ def run_build(build_dir=None,spec_file=None,repo_url=None,token=None,size=None,b
         bot.logger.info('Build directory set to %s', build_dir)
 
     # Get variables from the instance metadata API
-    metadata = [{'key': 'repo_url', 'value': repo_url, 'return_text': False },
-                {'key': 'repo_id', 'value': repo_id, 'return_text': True },
-                {'key': 'response_url', 'value': response_url, 'return_text': True },
-                {'key': 'bucket_name', 'value': bucket_name, 'return_text': True },
-                {'key': 'token', 'value': token, 'return_text': False },
-                {'key': 'commit', 'value': commit, 'return_text': True },
-                {'key': 'secret', 'value': secret, 'return_text': True },
-                {'key': 'size', 'value': size, 'return_text': True },
-                {'key': 'branch', 'value': branch, 'return_text': True },
-                {'key': 'spec_file', 'value': spec_file, 'return_text': True },
-                {'key': 'padding', 'value': padding, 'return_text': True },
-                {'key': 'logging_url', 'value': logging_url, 'return_text': True },
-                {'key': 'logfile', 'value': logfile, 'return_text': True }]
-
+    metadata = [{'key': 'repo_url', 'value': repo_url },
+                {'key': 'repo_id', 'value': repo_id },
+                {'key': 'response_url', 'value': response_url},
+                {'key': 'bucket_name', 'value': bucket_name },
+                {'key': 'token', 'value': token },
+                {'key': 'commit', 'value': commit },
+                {'key': 'secret', 'value': secret},
+                {'key': 'size', 'value': size },
+                {'key': 'branch', 'value': branch },
+                {'key': 'spec_file', 'value': spec_file},
+                {'key': 'padding', 'value': padding },
+                {'key': 'logging_url', 'value': logging_url },
+                {'key': 'logfile', 'value': logfile }]
 
     # Obtain values from build
     params = get_build_params(metadata)
+    params['debug'] = debug
 
     # Default spec file is Singularity
     if params['spec_file'] == None:
@@ -311,8 +317,7 @@ def finish_build(verbose=True):
 
 def get_build_metadata(key):
     '''get_build_metadata will return metadata about an instance from within it.
-    :param key: the key to look upu
-    :param return_text: return text (appropriate for one value, or if needs custom parsing. Otherwise, will return json
+    :param key: the key to look up
     '''
     headers = {"Metadata-Flavor":"Google"}
     url = "http://metadata.google.internal/computeMetadata/v1/instance/attributes/%s" %(key)        
@@ -332,12 +337,12 @@ def get_build_metadata(key):
 def get_build_params(metadata):
     '''get_build_params uses get_build_metadata to retrieve corresponding meta data values for a build
     :param metadata: a list, each item a dictionary of metadata, in format:
-    metadata = [{'key': 'repo_url', 'value': repo_url, 'return_text': False },
-                {'key': 'repo_id', 'value': repo_id, 'return_text': True },
-                {'key': 'credential', 'value': credential, 'return_text': True },
-                {'key': 'response_url', 'value': response_url, 'return_text': True },
-                {'key': 'token', 'value': token, 'return_text': False },
-                {'key': 'commit', 'value': commit, 'return_text': True }]
+    metadata = [{'key': 'repo_url', 'value': repo_url },
+                {'key': 'repo_id', 'value': repo_id },
+                {'key': 'credential', 'value': credential },
+                {'key': 'response_url', 'value': response_url },
+                {'key': 'token', 'value': token},
+                {'key': 'commit', 'value': commit }]
 
     '''
     params = dict()

singularity/build/scripts/singularity-build-latest.sh

@@ -13,7 +13,6 @@ sudo apt-get -y install git \
 sudo pip3 install --upgrade pip &&
 sudo pip3 install --upgrade google-api-python-client &&
 sudo pip3 install --upgrade google &&
-sudo pip3 install gitpython &&
 sudo pip3 install singularity --upgrade &&
 sudo pip3 install oauth2client==3.0.0
 

singularity/cli.py

@@ -27,7 +27,7 @@
 
 class Singularity:
 
-    def __init__(self,sudo=True,verbose=False,sudopw=None):
+    def __init__(self,sudo=True,verbose=False,sudopw=None,debug=False):
        '''upon init, store user password to not ask for it again'''
 
        self.sudopw = sudopw
@@ -85,7 +85,10 @@ def create(self,image_path,size=None):
         if size == None:
             size=1024
 
-        cmd = ['singularity','create','--size',str(size),image_path]
+        if self.debug == True:
+            cmd = ['singularity','--debug','create','--size',str(size),image_path]
+        else:
+            cmd = ['singularity','create','--size',str(size),image_path]
         self.run_command(cmd,sudo=True)
 
 
@@ -94,9 +97,11 @@ def bootstrap(self,image_path,spec_path):
         '''create will bootstrap an image using a spec
         :param image_path: full path to image
         :param spec_path: full path to the spec file (Singularity)
-        '''        
-
-        cmd = ['singularity','bootstrap',image_path,spec_path]
+        ''' 
+        if self.debug == True:
+            cmd = ['singularity','--debug','bootstrap',image_path,spec_path]
+        else:
+            cmd = ['singularity','bootstrap',image_path,spec_path]
         return self.run_command(cmd,sudo=True)
 
 
@@ -111,7 +116,11 @@ def execute(self,image_path,command,writable=False,contain=False):
         :param verbose: add --verbose option (default is false) 
         '''
         sudo = False    
-        cmd = ["singularity","exec"]
+        if self.debug == True:
+            cmd = ["singularity",'--debug',"exec"]
+        else:
+            cmd = ["singularity","exec"]
+
         cmd = self.add_flags(cmd,writable=writable,contain=contain)
 
         # Needing sudo?
@@ -251,7 +260,7 @@ def add_flags(self,cmd,writable,contain):
 # HELPER FUNCTIONS
 ######################################################################################################
 
-def get_image(image,return_existed=False,sudopw=None,size=None):
+def get_image(image,return_existed=False,sudopw=None,size=None,debug=False):
     '''get_image will return the file, if it exists, or if it's docker or
     shub, will use the Singularity command line tool to generate a temporary image
     :param image: the image file or path (eg, docker://)
@@ -268,9 +277,9 @@ def get_image(image,return_existed=False,sudopw=None,size=None):
             sudopw = os.environ.get('pancakes',None)
 
         if sudopw != None:
-            cli = Singularity(sudopw=sudopw)
+            cli = Singularity(sudopw=sudopw,debug=debug)
         else:
-            cli = Singularity() # This command will ask the user for sudo
+            cli = Singularity(debug=debug) # This command will ask the user for sudo
 
         tmpdir = tempfile.mkdtemp()
         image_name = "%s.img" %image.replace("docker://","") 

singularity/package.py

@@ -48,13 +48,14 @@ def estimate_image_size(spec_file,sudopw=None,padding=None):
     return padded_size
 
 
-def build_from_spec(spec_file=None,build_dir=None,size=None,sudopw=None,build_folder=False):
+def build_from_spec(spec_file=None,build_dir=None,size=None,sudopw=None,build_folder=False,debug=False):
     '''build_from_spec will build a "spec" file in a "build_dir" and return the directory
     :param spec_file: the spec file, called "Singuarity"
     :param sudopw: the sudopw for Singularity, root should provide ''
     :param build_dir: the directory to build in. If not defined, will use tmpdir.
     :param size: the size of the image
     :param build_folder: "build" the image into a folder instead. Default False
+    :param debug: ask for verbose output from builder
     '''
     if spec_file == None:
         spec_file = "Singularity"
@@ -77,9 +78,9 @@ def build_from_spec(spec_file=None,build_dir=None,size=None,sudopw=None,build_fo
 
     # Run create image and bootstrap with Singularity command line tool.
     if sudopw != None:
-        cli = Singularity(sudopw=sudopw)
+        cli = Singularity(sudopw=sudopw,debug=debug)
     else:
-        cli = Singularity() # This command will ask the user for sudo
+        cli = Singularity(debug=debug) # This command will ask the user for sudo
 
     print("\nCreating and boostrapping image...")
 

singularity/version.py

@@ -1,4 +1,4 @@
-__version__ = "0.96"
+__version__ = "0.97"
 AUTHOR = 'Vanessa Sochat'
 AUTHOR_EMAIL = '[email protected]'
 NAME = 'singularity'