Merge pull request easybuilders#2421 from boegel/fix_sorting_auto_docs

fix order in result of gen_list_easyblocks and gen_easyblocks_overview_rst

Author: wpoely86

easybuild/tools/docs.py

@@ -490,7 +490,7 @@ def add_class(classes, cls):
         children = cls.__subclasses__()
         classes.update({cls.__name__: {
             'module': cls.__module__,
-            'children': [x.__name__ for x in children]
+            'children': sorted([c.__name__ for c in children], key=lambda x: x.lower())
         }})
         for child in children:
             add_class(classes, child)
@@ -891,12 +891,14 @@ def gen_easyblock_doc_section_rst(eb_class, path_to_examples, common_params, doc
     if eb_class.extra_options():
         title = 'Extra easyconfig parameters specific to ``%s`` easyblock' % classname
         ex_opt = eb_class.extra_options()
+        keys = sorted(ex_opt.keys())
+        values = [ex_opt[k] for k in keys]
 
         table_titles = ['easyconfig parameter', 'description', 'default value']
         table_values = [
-            ['``' + key + '``' for key in ex_opt],  # parameter name
-            [val[1] for val in ex_opt.values()],  # description
-            ['``' + str(quote_str(val[0])) + '``' for val in ex_opt.values()]  # default value
+            ['``' + key + '``' for key in keys],  # parameter name
+            [val[1] for val in values],  # description
+            ['``' + str(quote_str(val[0])) + '``' for val in values]  # default value
         ]
 
         doc.extend(rst_title_and_table(title, table_titles, table_values))

test/framework/docs.py

@@ -62,6 +62,17 @@ def test_gen_easyblocks(self):
             '',
             "Dummy support for building and installing applications with configure/make/make install.",
             '',
+            "Extra easyconfig parameters specific to ``ConfigureMake`` easyblock",
+            "-------------------------------------------------------------------",
+            '',
+            "====================    ============    =============",
+            "easyconfig parameter    description     default value",
+            "====================    ============    =============",
+            '``test_123``            Test 1, 2, 3    ``""``       ',
+            "``test_bool``           Just a test     ``False``    ",
+            "``test_none``           Another test    ``None``     ",
+            "====================    ============    =============",
+            '',
             "Commonly used easyconfig parameters with ``ConfigureMake`` easyblock",
             "--------------------------------------------------------------------",
             '',
@@ -74,7 +85,7 @@ def test_gen_easyblocks(self):
             "====================    ================================================================",
         ])
 
-        self.assertTrue(check_configuremake in ebdoc)
+        self.assertTrue(check_configuremake in ebdoc, "Found '%s' in: %s" % (check_configuremake, ebdoc))
         names = []
 
         for mod in modules:

test/framework/options.py

@@ -551,14 +551,29 @@ def test_list_easyblocks(self):
             self.eb_main(args, logfile=dummylogfn)
             logtxt = read_file(self.logfile)
 
-            for pat in [
-                        r"EasyBlock\n",
-                        r"|--\s+EB_foo\n|\s+|--\s+EB_foofoo\n",
-                        r"|--\s+bar\n",
-                       ]:
-
-                msg = "Pattern '%s' is found in output of --list-easyblocks: %s" % (pat, logtxt)
-                self.assertTrue(re.search(pat, logtxt), msg)
+            expected = '\n'.join([
+                r'EasyBlock',
+                r'\|-- bar',
+                r'\|-- ConfigureMake',
+                r'\|-- EB_foo',
+                r'\|   \|-- EB_foofoo',
+                r'\|-- EB_GCC',
+                r'\|-- EB_HPL',
+                r'\|-- EB_ScaLAPACK',
+                r'\|-- EB_toy_buggy',
+                r'\|-- ExtensionEasyBlock',
+                r'\|   \|-- DummyExtension',
+                r'\|   \|-- EB_toy',
+                r'\|   \|-- Toy_Extension',
+                r'\|-- Toolchain',
+                r'Extension',
+                r'\|-- ExtensionEasyBlock',
+                r'\|   \|-- DummyExtension',
+                r'\|   \|-- EB_toy',
+                r'\|   \|-- Toy_Extension',
+            ])
+            regex = re.compile(expected, re.M)
+            self.assertTrue(regex.search(logtxt), "Pattern '%s' found in: %s" % (regex.pattern, logtxt))
 
         # clear log
         write_file(self.logfile, '')
@@ -1892,7 +1907,9 @@ def generate_cmd_line(ebopts):
         ebopts = EasyBuildOptions(go_args=args, envvar_prefix='EASYBUILD')
         self.assertEqual(generate_cmd_line(ebopts), expected)
 
-    def test_include_easyblocks(self):
+    # must be run after test for --list-easyblocks, hence the '_xxx_'
+    # cleaning up the imported easyblocks is quite difficult...
+    def test_xxx_include_easyblocks(self):
         """Test --include-easyblocks."""
         orig_local_sys_path = sys.path[:]
 
@@ -1954,7 +1971,9 @@ def test_include_easyblocks(self):
         # 'undo' import of foo easyblock
         del sys.modules['easybuild.easyblocks.foo']
 
-    def test_include_generic_easyblocks(self):
+    # must be run after test for --list-easyblocks, hence the '_xxx_'
+    # cleaning up the imported easyblocks is quite difficult...
+    def test_xxx_include_generic_easyblocks(self):
         """Test --include-easyblocks with a generic easyblock."""
         orig_local_sys_path = sys.path[:]
         fd, dummylogfn = tempfile.mkstemp(prefix='easybuild-dummy', suffix='.log')

test/framework/sandbox/easybuild/easyblocks/generic/configuremake.py

@@ -29,7 +29,18 @@
 @author: Kenneth Hoste (Ghent University)
 """
 from easybuild.framework.easyblock import EasyBlock
+from easybuild.framework.easyconfig import CUSTOM
 
 class ConfigureMake(EasyBlock):
     """Dummy support for building and installing applications with configure/make/make install."""
-    pass
+
+    @staticmethod
+    def extra_options(extra_vars=None):
+        """Extra easyconfig parameters specific to ConfigureMake."""
+        extra_vars = EasyBlock.extra_options(extra=extra_vars)
+        extra_vars.update({
+            'test_bool': [False, "Just a test", CUSTOM],
+            'test_none': [None, "Another test", CUSTOM],
+            'test_123': ['', "Test 1, 2, 3", CUSTOM],
+        })
+        return extra_vars