cfengine 0.12.0__tar.gz → 0.12.2__tar.gz

{cfengine-0.12.0 → cfengine-0.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfengine
-Version: 0.12.0
+Version: 0.12.2
 Summary: Human-oriented CLI for interacting with CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -749,6 +749,23 @@ cfengine format
 cfengine lint
 ```
 
+You can also specify filenames or folders;
+
+```bash
+cfengine lint main.cf
+```
+
+When it finds a mistake, it points out where the problem is like this;
+
+```
+    "Hello, CFEngine"
+      ifvarclass => "cfengine";
+      ^--------^
+Deprecation: Use 'if' instead of 'ifvarclass' at main.cf:5:7
+FAIL: main.cf (1 errors)
+Failure, 1 errors in total.
+```
+
 Note that since we use a different parser than `cf-agent` / `cf-promises`, they are not 100% in sync.
 `cf-agent` could point out something as a syntax error, while `cfengine lint` does not and vice versa.
 We aim to make the tree-sitter parser (used in this tool) more strict in general, so that when `cfengine lint` is happy with your policy, `cf-agent` will also accept it.

{cfengine-0.12.0 → cfengine-0.12.2}/README.md

@@ -47,6 +47,23 @@ cfengine format
 cfengine lint
 ```
 
+You can also specify filenames or folders;
+
+```bash
+cfengine lint main.cf
+```
+
+When it finds a mistake, it points out where the problem is like this;
+
+```
+    "Hello, CFEngine"
+      ifvarclass => "cfengine";
+      ^--------^
+Deprecation: Use 'if' instead of 'ifvarclass' at main.cf:5:7
+FAIL: main.cf (1 errors)
+Failure, 1 errors in total.
+```
+
 Note that since we use a different parser than `cf-agent` / `cf-promises`, they are not 100% in sync.
 `cf-agent` could point out something as a syntax error, while `cfengine lint` does not and vice versa.
 We aim to make the tree-sitter parser (used in this tool) more strict in general, so that when `cfengine lint` is happy with your policy, `cf-agent` will also accept it.

{cfengine-0.12.0 → cfengine-0.12.2}/src/cfengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfengine
-Version: 0.12.0
+Version: 0.12.2
 Summary: Human-oriented CLI for interacting with CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -749,6 +749,23 @@ cfengine format
 cfengine lint
 ```
 
+You can also specify filenames or folders;
+
+```bash
+cfengine lint main.cf
+```
+
+When it finds a mistake, it points out where the problem is like this;
+
+```
+    "Hello, CFEngine"
+      ifvarclass => "cfengine";
+      ^--------^
+Deprecation: Use 'if' instead of 'ifvarclass' at main.cf:5:7
+FAIL: main.cf (1 errors)
+Failure, 1 errors in total.
+```
+
 Note that since we use a different parser than `cf-agent` / `cf-promises`, they are not 100% in sync.
 `cf-agent` could point out something as a syntax error, while `cfengine lint` does not and vice versa.
 We aim to make the tree-sitter parser (used in this tool) more strict in general, so that when `cfengine lint` is happy with your policy, `cf-agent` will also accept it.

{cfengine-0.12.0 → cfengine-0.12.2}/src/cfengine_cli/lint.py

@@ -14,6 +14,7 @@ import os
 import json
 import itertools
 import tree_sitter_cfengine as tscfengine
+from dataclasses import dataclass
 from tree_sitter import Language, Parser
 from cfbs.validate import validate_config
 from cfbs.cfbs_config import CFBSConfig
@@ -26,6 +27,39 @@ from cfengine_cli.policy_language import (
 )
 
 
+@dataclass
+class _State:
+    block_type: str | None = None  # "bundle" | "body" | "promise" | None
+    promise_type: str | None = None  # "vars" | "files" | "classes" | ... | None
+    attribute_name: str | None = None  # "if" | "string" | "slist" | ... | None
+
+    def update(self, node) -> "_State":
+        """Updates and returns the state that should apply to the children of `node`."""
+        if node.type == "bundle_block":
+            return _State(block_type="bundle")
+        if node.type == "body_block":
+            return _State(block_type="body")
+        if node.type == "promise_block":
+            return _State(block_type="promise")
+        if node.type == "bundle_section":
+            for child in node.children:
+                if child.type == "promise_guard":
+                    return _State(
+                        block_type=self.block_type,
+                        promise_type=_text(child)[:-1],  # strip trailing ':'
+                    )
+            return _State(block_type=self.block_type)
+        if node.type == "attribute":
+            for child in node.children:
+                if child.type == "attribute_name":
+                    return _State(
+                        block_type=self.block_type,
+                        promise_type=self.promise_type,
+                        attribute_name=_text(child),
+                    )
+        return self
+
+
 def lint_cfbs_json(filename) -> int:
     assert os.path.isfile(filename)
     assert filename.endswith("cfbs.json")
@@ -93,16 +127,9 @@ def _find_node_type(filename, lines, node, node_type):
     return matches
 
 
-def _find_nodes(filename, lines, node):
-    matches = []
-    visitor = lambda x: matches.append(x)
-    _walk_generic(filename, lines, node, visitor)
-    return matches
-
-
-def _single_node_checks(filename, lines, node, user_definition, strict):
-    """Things which can be checked by only looking at one node,
-    not needing to recurse into children."""
+def _node_checks(filename, lines, node, user_definition, strict, state: _State):
+    """Checks we run on each node in the syntax tree,
+    utilizes state for checks which require context."""
     line = node.range.start_point[0] + 1
     column = node.range.start_point[1] + 1
     if node.type == "attribute_name" and _text(node) == "ifvarclass":
@@ -133,7 +160,6 @@ def _single_node_checks(filename, lines, node, user_definition, strict):
                 f"Error: Undefined promise type '{promise_type}' at {filename}:{line}:{column}"
             )
             return 1
-
     if node.type == "bundle_block_name":
         if _text(node) != _text(node).lower():
             _highlight_range(node, lines)
@@ -156,6 +182,16 @@ def _single_node_checks(filename, lines, node, user_definition, strict):
             )
             return 1
     if node.type == "calling_identifier":
+        if (
+            strict
+            and _text(node) in user_definition.get("all_bundle_names", set())
+            and state.promise_type in user_definition.get("custom_promise_types", set())
+        ):
+            _highlight_range(node, lines)
+            print(
+                f"Error: Call to bundle '{_text(node)}' inside custom promise: '{state.promise_type}' at {filename}:{line}:{column}"
+            )
+            return 1
         if strict and (
             _text(node)
             not in BUILTIN_FUNCTIONS.union(
@@ -171,6 +207,22 @@ def _single_node_checks(filename, lines, node, user_definition, strict):
     return 0
 
 
+def _stateful_walk(
+    filename, lines, node, user_definition, strict, state: _State | None = None
+) -> int:
+    if state is None:
+        state = _State()
+
+    errors = _node_checks(filename, lines, node, user_definition, strict, state)
+
+    child_state = state.update(node)
+    for child in node.children:
+        errors += _stateful_walk(
+            filename, lines, child, user_definition, strict, child_state
+        )
+    return errors
+
+
 def _walk(filename, lines, node, user_definition=None, strict=True) -> int:
     if user_definition is None:
         user_definition = {}
@@ -187,11 +239,7 @@ def _walk(filename, lines, node, user_definition=None, strict=True) -> int:
     line = node.range.start_point[0] + 1
     column = node.range.start_point[1] + 1
 
-    errors = 0
-    for node in _find_nodes(filename, lines, node):
-        errors += _single_node_checks(filename, lines, node, user_definition, strict)
-
-    return errors
+    return _stateful_walk(filename, lines, node, user_definition, strict)
 
 
 def _parse_user_definition(filename, lines, root_node):
@@ -348,4 +396,4 @@ def lint_single_arg(arg, strict=True):
         return lint_folder(arg, strict)
     assert os.path.isfile(arg)
 
-    return lint_single_file(arg, strict)
+    return lint_single_file(arg, strict=strict)