add support for --search-filename and --terse

Author: boegel

easybuild/main.py

@@ -178,7 +178,7 @@ def main(args=None, logfile=None, do_build=None, testing=False):
 
     # initialise logging for main
     global _log
-    _log, logfile = init_logging(logfile, logtostdout=options.logtostdout, silent=testing or options.last_log)
+    _log, logfile = init_logging(logfile, logtostdout=options.logtostdout, silent=testing or options.terse)
 
     # disallow running EasyBuild as root
     if os.getuid() == 0:
@@ -223,22 +223,13 @@ def main(args=None, logfile=None, do_build=None, testing=False):
         # print location to last log file, and exit
         last_log = find_last_log(logfile) or '(none)'
         print_msg(last_log, log=_log, prefix=False)
-        cleanup(logfile, eb_tmpdir, testing, silent=True)
-        sys.exit(0)
 
     # check whether packaging is supported when it's being used
     if options.package:
         check_pkg_support()
     else:
         _log.debug("Packaging not enabled, so not checking for packaging support.")
 
-    # update session state
-    eb_config = eb_go.generate_cmd_line(add_default=True)
-    modlist = session_module_list(testing=testing)  # build options must be initialized first before 'module list' works
-    init_session_state.update({'easybuild_configuration': eb_config})
-    init_session_state.update({'module_list': modlist})
-    _log.debug("Initial session state: %s" % init_session_state)
-
     # GitHub integration
     if options.review_pr or options.new_pr or options.update_pr:
         if options.review_pr:
@@ -254,18 +245,31 @@ def main(args=None, logfile=None, do_build=None, testing=False):
         sys.exit(0)
 
     # search for easyconfigs, if a query is specified
-    query = options.search or options.search_short
+    query = options.search or options.search_filename or options.search_short
     if query:
-        search_easyconfigs(query, short=not options.search)
+        search_easyconfigs(query, short=options.search_short, filename_only=options.search_filename,
+                           terse=options.terse)
+
+    # non-verbose cleanup and exit after printing terse info
+    if options.terse:
+        cleanup(logfile, eb_tmpdir, testing, silent=True)
+        sys.exit(0)
+
+    # update session state
+    eb_config = eb_go.generate_cmd_line(add_default=True)
+    modlist = session_module_list(testing=testing)  # build options must be initialized first before 'module list' works
+    init_session_state.update({'easybuild_configuration': eb_config})
+    init_session_state.update({'module_list': modlist})
+    _log.debug("Initial session state: %s" % init_session_state)
 
     # determine easybuild-easyconfigs package install path
     easyconfigs_pkg_paths = get_paths_for(subdir=EASYCONFIGS_PKG_SUBDIR)
     if not easyconfigs_pkg_paths:
         _log.warning("Failed to determine install path for easybuild-easyconfigs package.")
 
     # command line options that do not require any easyconfigs to be specified
-    no_ec_opts = [options.aggregate_regtest, options.new_pr, options.review_pr, options.search, options.search_short,
-                  options.regtest, options.update_pr]
+    no_ec_opts = [options.aggregate_regtest, options.new_pr, options.review_pr, options.search,
+                  options.search_filename, options.search_short, options.regtest, options.update_pr]
 
     # determine paths to easyconfigs
     paths = det_easyconfig_paths(orig_paths)

easybuild/tools/filetools.py

@@ -320,7 +320,7 @@ def find_easyconfigs(path, ignore_dirs=None):
     return files
 
 
-def search_file(paths, query, short=False, ignore_dirs=None, silent=False):
+def search_file(paths, query, short=False, ignore_dirs=None, silent=False, filename_only=False, terse=False):
     """
     Search for a particular file (only prints)
     """
@@ -340,7 +340,8 @@ def search_file(paths, query, short=False, ignore_dirs=None, silent=False):
     for path in paths:
         hits = []
         hit_in_path = False
-        print_msg("Searching (case-insensitive) for '%s' in %s " % (query.pattern, path), log=_log, silent=silent)
+        if not terse:
+            print_msg("Searching (case-insensitive) for '%s' in %s " % (query.pattern, path), log=_log, silent=silent)
 
         for (dirpath, dirnames, filenames) in os.walk(path, topdown=True):
             for filename in filenames:
@@ -349,7 +350,10 @@ def search_file(paths, query, short=False, ignore_dirs=None, silent=False):
                         var = "CFGS%d" % var_index
                         var_index += 1
                         hit_in_path = True
-                    hits.append(os.path.join(dirpath, filename))
+                    if filename_only:
+                        hits.append(filename)
+                    else:
+                        hits.append(os.path.join(dirpath, filename))
 
             # do not consider (certain) hidden directories
             # note: we still need to consider e.g., .local !
@@ -359,16 +363,20 @@ def search_file(paths, query, short=False, ignore_dirs=None, silent=False):
 
         hits = sorted(hits)
 
-        if hits:
+        if hits and not terse:
             common_prefix = det_common_path_prefix(hits)
             if short and common_prefix is not None and len(common_prefix) > len(var) * 2:
                 var_lines.append("%s=%s" % (var, common_prefix))
                 hit_lines.extend([" * %s" % os.path.join('$%s' % var, fn[len(common_prefix) + 1:]) for fn in hits])
             else:
                 hit_lines.extend([" * %s" % fn for fn in hits])
 
-    for line in var_lines + hit_lines:
-        print_msg(line, log=_log, silent=silent, prefix=False)
+    if terse:
+        for line in hits:
+            print line
+    else:
+        for line in var_lines + hit_lines:
+            print_msg(line, log=_log, silent=silent, prefix=False)
 
 
 def compute_checksum(path, checksum_type=DEFAULT_CHECKSUM):

easybuild/tools/options.py

@@ -362,13 +362,16 @@ def informative_options(self):
                                 'choice', 'store_or_None', 'simple', ['simple', 'detailed']),
             'list-toolchains': ("Show list of known toolchains",
                                 None, 'store_true', False),
-            'search': ("Search for easyconfig files in the robot directory, print full paths",
-                       None, 'store', None, {'metavar': 'STR'}),
-            'search-short': ("Search for easyconfig files in the robot directory, print short paths",
-                             None, 'store', None, 'S', {'metavar': 'STR'}),
+            'search': ("Search for easyconfig files in the robot search path, print full paths",
+                       None, 'store', None, {'metavar': 'REGEX'}),
+            'search-filename': ("Search for easyconfig files in the robot search path, print only filenames",
+                                None, 'store', None, {'metavar': 'REGEX'}),
+            'search-short': ("Search for easyconfig files in the robot search path, print short paths",
+                             None, 'store', None, 'S', {'metavar': 'REGEX'}),
             'show-default-configfiles': ("Show list of default config files", None, 'store_true', False),
             'show-default-moduleclasses': ("Show default module classes with description",
                                            None, 'store_true', False),
+            'terse': ("Terse output (machine-readable)", None, 'store_true', False),
         })
 
         self.log.debug("informative_options: descr %s opts %s" % (descr, opts))
@@ -566,6 +569,10 @@ def postprocess(self):
             if not HAVE_AUTOPEP8:
                 raise EasyBuildError("Python 'autopep8' module required to reformat dumped easyconfigs as requested")
 
+        # some options imply enabling --terse
+        if self.options.last_log:
+            self.options.terse = True
+
         self._postprocess_external_modules_metadata()
 
         self._postprocess_config()

easybuild/tools/robot.py

@@ -258,7 +258,7 @@ def resolve_dependencies(easyconfigs, retain_all_deps=False, minimal_toolchains=
     return ordered_ecs
 
 
-def search_easyconfigs(query, short=False):
+def search_easyconfigs(query, short=False, filename_only=False, terse=False):
     """Search for easyconfigs, if a query is provided."""
     robot_path = build_option('robot_path')
     if robot_path:
@@ -267,4 +267,5 @@ def search_easyconfigs(query, short=False):
         search_path = [os.getcwd()]
     ignore_dirs = build_option('ignore_dirs')
     silent = build_option('silent')
-    search_file(search_path, query, short=short, ignore_dirs=ignore_dirs, silent=silent)
+    search_file(search_path, query, short=short, ignore_dirs=ignore_dirs, silent=silent, filename_only=filename_only,
+                terse=terse)