[lldb][tests] Take into account all parent's categories when traverse folders upwards

[tatyana-krasnukha]

Summary

This is needed to not "re-write" parent's categories by categories of a nested folder,
e.g. commands/expression/completion specify "cmdline" category, however it still belongs
to parent's "expression" category.

[labath]

The idea seems fine, but I think that the implementation needs more refinement, per the inline comments...

packages/Python/lldbsuite/test/test_result.py

111–112 ↗

(On Diff #235348)

This part is no longer true, as we continue searching after finding the first file.

119 ↗

(On Diff #235348)

I don't think this will work on windows. I think we should stop iterating here as soon we reach the top level test folder (I don't know how to check that off-hand, but we should have that piece of information available somewhere.) That will also ensure we don't get confused by some spurious .categories file outside of the test tree.

[JDevlieghere]

packages/Python/lldbsuite/test/test_result.py

119 ↗

(On Diff #235348)

We could use the LLDB source root for this, which is already available from dotest through lldbsuite.lldb_root.

[labath]

packages/Python/lldbsuite/test/test_result.py

119 ↗

(On Diff #235348)

sounds good.

[tatyana-krasnukha]

Stop iterating when reach the top-level test folder

[labath]

lgtm

lldb/packages/Python/lldbsuite/test/test_result.py

def getDescription(self, test):
             return '\n'.join((str(test), self.indentation + doc_first_line))
         else:
             return str(test)
 
     @staticmethod
     def _getFileBasedCategories(test):
         """
         Returns the list of categories to which this test case belongs by
-        looking for a ".categories" file. We start at the folder the test is in
-        an traverse the hierarchy upwards - we guarantee a .categories to exist
-        at the top level directory so we do not end up looping endlessly.
+        collecting values of ".categories" files. We start at the folder the test is in
+        and traverse the hierarchy upwards until the test-suite root directory.
         """
         import inspect
         import os.path
         # Use test.test_filename if the test was created with
         # lldbinline.MakeInlineTest().
         if hasattr(test, 'test_filename'):
             start_path = test.test_filename
         else:
             start_path = inspect.getfile(test.__class__)
 
         folder = os.path.dirname(start_path)
-        while folder != '/':
+
+        from lldbsuite import lldb_test_root as test_root
+        if test_root != os.path.commonprefix([folder, test_root]):
+            raise Exception("The test file %s is outside the test root directory" % start_path)
+
+        categories = set()
+        while not os.path.samefile(folder, test_root):
             categories_file_name = os.path.join(folder, ".categories")
             if os.path.exists(categories_file_name):
                 categories_file = open(categories_file_name, 'r')
-                categories = categories_file.readline()
+                categories_str = categories_file.readline().strip()
                 categories_file.close()
-                categories = str.replace(categories, '\n', '')
-                categories = str.replace(categories, '\r', '')
-                return categories.split(',')
-            else:
-                folder = os.path.dirname(folder)
-                continue
-        raise Exception("Did not find a .categories file, starting at: %s" % start_path)
+                categories.update(categories_str.split(','))
 
+        return list(categories)
 
     def getCategoriesForTest(self, test):
         """
         Gets all the categories for the currently running test method in test case
         """
         test_categories = []
         test_method = getattr(test, test._testMethodName)
         if test_method is not None and hasattr(test_method, "categories"):