Merge pull request #12 from AlexanderGrooff/show-neighbours-of-direct-match

Author: AlexanderGrooff

nginx_analysis/analysis.py

@@ -92,21 +92,36 @@ def get_line_at_linenr(
     return None
 
 
-def is_direct_match(
+def is_partial_direct_match(
     line: NginxLineConfig, filters: List[DirectiveFilter]
 ) -> Optional[DirectiveFilter]:
+    """
+    Check if the line matches any of the filters. If it does, return the
+    filter. If it doesn't, return None."""
     for dfilter in filters:
         if dfilter.match(line):
-            logger.debug(f"Direct match: {line}")
+            logger.debug(f"Direct match on filter {dfilter}: {line}")
             return dfilter
     return None
 
 
 def find_matches_in_children(
     line: NginxLineConfig, filters: List[DirectiveFilter]
 ) -> Tuple[List[NginxLineConfig], List[DirectiveFilter]]:
-    matched_filter = is_direct_match(line, filters)
+    """
+    Check if the line matches filters. If it matches, return the line,
+    the line's neighbours and all children. If it doesn't match, check
+    if any of the children match the filters. If they do, return all
+    descendants of the line that match the filters, including the current
+    line.
+    We also return a list of filters that matched, so we can check if
+    all filters were matched eventually.
+    If there are no matches, return an empty list for both the matching
+    lines and the matched filters.
+    """
+    matched_filter = is_partial_direct_match(line, filters)
     if matched_filter:
+        logger.debug(f"Found match in children: {line}")
         all_matched_filters = set([matched_filter])
         # Search for remaining filters in children, as the parent
         # might still be looking for other filters
@@ -116,7 +131,9 @@ def find_matches_in_children(
                 child, remaining_filters
             )
             all_matched_filters.update(child_matched_filters)
-        return [line, *get_children_recursive(line)], list(all_matched_filters)
+        return [line, *line.neighbours, *get_children_recursive(line)], list(
+            all_matched_filters
+        )
 
     # All filters must match at least one child
     matched_filters = set()

nginx_analysis/dataclasses.py

@@ -87,6 +87,11 @@ def lineage(self) -> List[str]:
             return [self.directive]
         return self.parent.lineage + [self.directive]
 
+    @property
+    def neighbours(self) -> List["NginxLineConfig"]:
+        parent_children = self.parent.children if self.parent else []
+        return [c for c in parent_children if c != self]
+
     def __eq__(self, other: Any) -> bool:
         if not isinstance(other, NginxLineConfig):
             return False

runtests.sh

@@ -4,7 +4,13 @@ export DEBIAN_FRONTEND=noninteractive
 
 set -e
 
-NGINX_EXEC="docker-compose exec -T nginx"
+# Check if we're running in the Github Actions runner
+if [[ -z "$GITHUB_ACTIONS" ]]; then
+    NGINX_EXEC="docker-compose exec nginx"
+else
+    # Run without TTY in Github Actions
+    NGINX_EXEC="docker-compose exec -T nginx"
+fi
 
 if [[ ! $(docker-compose ps --services --filter status=running nginx | grep nginx) ]]; then
     docker-compose up -d nginx

scripts/integration_tests.sh

@@ -26,5 +26,10 @@ $NSA -d server_name -f server_name=example.com |& grep example.com || (echo "NOT
 $NSA -d server_name -f server_name=banaan.com |& grep example.com && (echo "NOT OK" && exit 1)
 # Multiple filters should show the most specific match
 $NSA -f location=/ -f server_name=example.com |& grep "/etc/nginx/servers/example.com.conf:8" || (echo "NOT OK" && exit 1)
+# Show directives next to the direct match
+$NSA -f server_name=example.com |& grep "listen" | grep -v "default_server" || (echo "NOT OK" && exit 1)
+$NSA -f server_name=testalex.hypernode.io |& grep "listen" | grep "default_server" || (echo "NOT OK" && exit 1)
+# Don't show nested children of neighbours of direct match
+$NSA -f server_name=testalex.hypernode.io -f location=/ |& grep "404" && (echo "NOT OK" && exit 1)
 
 echo "All tests passed"