fix: NoFilterException is redundant, remove it

In the former version, when collecting filterable 'glob_file' specs, an unexpected "Traceback" info will be printed in the debug log. In fact, it's not necessary to add the NoFilterException, in that case, the ContentException can be leveraged, we just need to log it into the debug instead of raising it again. Signed-off-by: Xiangce Liu <[email protected]>
RedHatInsights · Aug 7, 2024 · 6fedf62 · 6fedf62
1 parent c4099a0
commit 6fedf62
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 10 deletions.
diff --git a/insights/core/exceptions.py b/insights/core/exceptions.py
@@ -80,11 +80,6 @@ class ContentException(SkipComponent):
     pass
 
 
-class NoFilterException(ContentException):
-    """ Raised whenever no filters added to a `filterable` :class:`datasource`."""
-    pass
-
-
 class InvalidContentType(InvalidArchive):
     def __init__(self, content_type):
         self.msg = 'Invalid content type: "%s"' % content_type

diff --git a/insights/core/spec_factory.py b/insights/core/spec_factory.py
@@ -17,7 +17,6 @@
 from insights.core.exceptions import (
         BlacklistedSpec,
         ContentException,
-        NoFilterException,
         SkipComponent)
 from insights.core.plugins import component, datasource, is_datasource
 from insights.core.serde import deserializer, serializer
@@ -191,7 +190,7 @@ def validate(self):
             if (self.ds and filters.ENABLED and
                     any(s.filterable for s in dr.get_registry_points(self.ds)) and
                     not filters.get_filters(self.ds)):
-                raise NoFilterException("Skipping %s due to no filters." % dr.get_name(self.ds))
+                raise ContentException("Skipping %s due to no filters." % dr.get_name(self.ds))
             # 2.2 Customer Prohibits Collection
             if not blacklist.allow_file("/" + self.relative_path):
                 log.warning("WARNING: Skipping file %s", "/" + self.relative_path)
@@ -367,7 +366,7 @@ def validate(self):
             if (self.ds and filters.ENABLED and
                     any(s.filterable for s in dr.get_registry_points(self.ds)) and
                     not filters.get_filters(self.ds)):
-                raise NoFilterException("Skipping %s due to no filters." % dr.get_name(self.ds))
+                raise ContentException("Skipping %s due to no filters." % dr.get_name(self.ds))
             # 2.2 Customer Prohibits Collection
             if not blacklist.allow_command(self.cmd):
                 log.warning("WARNING: Skipping command %s", self.cmd)
@@ -702,6 +701,8 @@ def __call__(self, broker):
                     results.append(self.kind(
                         path[len(root):], root=root, save_as=self.save_as,
                         ds=self, ctx=ctx, cleaner=cleaner))
+                except ContentException as ce:
+                    log.debug(ce)
                 except Exception:
                     log.debug(traceback.format_exc())
         if results:
@@ -770,8 +771,8 @@ def __call__(self, broker):
                 return self.kind(
                         ctx.locate_path(p), root=root, save_as=self.save_as,
                         ds=self, ctx=ctx, cleaner=cleaner)
-            except NoFilterException as nfe:
-                raise nfe
+            except ContentException as ce:
+                log.debug(ce)
             except Exception:
                 pass
         raise ContentException("None of [%s] found." % ', '.join(self.paths))