cfengine 0.7.0__tar.gz → 0.7.2__tar.gz

{cfengine-0.7.0 → cfengine-0.7.2}/.github/workflows/pypi-publish.yml

@@ -51,4 +51,4 @@ jobs:
           name: release-dists
           path: dist/
       - name: Publish release distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.12.4
+        uses: pypa/gh-action-pypi-publish@v1.13.0

{cfengine-0.7.0 → cfengine-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfengine
-Version: 0.7.0
+Version: 0.7.2
 Summary: Human-oriented CLI for interacting with CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -692,12 +692,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: cf-remote>=0.6.4
 Requires-Dist: cfbs>=4.4.3
-Requires-Dist: tree-sitter-cfengine>=1.0.8
-Requires-Dist: tree-sitter>=0.23
+Requires-Dist: tree-sitter-cfengine>=1.0.11
+Requires-Dist: tree-sitter>=0.25
 Requires-Dist: markdown-it-py>=3.0.0
 
 # CFEngine command line interface (CLI)

{cfengine-0.7.0 → cfengine-0.7.2}/pyproject.toml

@@ -8,12 +8,12 @@ dynamic = ["version"]
 description = "Human-oriented CLI for interacting with CFEngine tools"
 readme = "README.md"
 license = {file = "LICENSE"}
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 dependencies = [
     "cf-remote>=0.6.4",
     "cfbs>=4.4.3",
-    "tree-sitter-cfengine>=1.0.8",
-    "tree-sitter>=0.23",
+    "tree-sitter-cfengine>=1.0.11",
+    "tree-sitter>=0.25",
     "markdown-it-py>=3.0.0",
 ]
 classifiers = [

{cfengine-0.7.0 → cfengine-0.7.2}/src/cfengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfengine
-Version: 0.7.0
+Version: 0.7.2
 Summary: Human-oriented CLI for interacting with CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -692,12 +692,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: cf-remote>=0.6.4
 Requires-Dist: cfbs>=4.4.3
-Requires-Dist: tree-sitter-cfengine>=1.0.8
-Requires-Dist: tree-sitter>=0.23
+Requires-Dist: tree-sitter-cfengine>=1.0.11
+Requires-Dist: tree-sitter>=0.25
 Requires-Dist: markdown-it-py>=3.0.0
 
 # CFEngine command line interface (CLI)

{cfengine-0.7.0 → cfengine-0.7.2}/src/cfengine.egg-info/SOURCES.txt

@@ -28,7 +28,6 @@ src/cfengine_cli/docs.py
 src/cfengine_cli/format.py
 src/cfengine_cli/lint.py
 src/cfengine_cli/main.py
-src/cfengine_cli/markdowner.py
 src/cfengine_cli/paths.py
 src/cfengine_cli/shell.py
 src/cfengine_cli/utils.py
@@ -49,4 +48,5 @@ tests/format/003_wrapping.input.cf
 tests/format/004_comments.expected.cf
 tests/format/004_comments.input.cf
 tests/shell/001-help.sh
-tests/shell/002-version.sh
+tests/shell/002-version.sh
+tests/shell/003-format.sh

{cfengine-0.7.0 → cfengine-0.7.2}/src/cfengine.egg-info/requires.txt

@@ -1,5 +1,5 @@
 cf-remote>=0.6.4
 cfbs>=4.4.3
-tree-sitter-cfengine>=1.0.8
-tree-sitter>=0.23
+tree-sitter-cfengine>=1.0.11
+tree-sitter>=0.25
 markdown-it-py>=3.0.0

{cfengine-0.7.0 → cfengine-0.7.2}/src/cfengine_cli/commands.py

@@ -47,46 +47,46 @@ def deploy() -> int:
     return r
 
 
-def _format_filename(filename):
+def _format_filename(filename, line_length):
     if filename.startswith("./."):
         return
     if filename.endswith(".json"):
         format_json_file(filename)
         return
     if filename.endswith(".cf"):
-        format_policy_file(filename)
+        format_policy_file(filename, line_length)
         return
     raise UserError(f"Unrecognized file format: {filename}")
 
 
-def _format_dirname(directory):
+def _format_dirname(directory, line_length):
     for filename in find(directory, extension=".json"):
-        _format_filename(filename)
+        _format_filename(filename, line_length)
     for filename in find(directory, extension=".cf"):
-        _format_filename(filename)
+        _format_filename(filename, line_length)
 
 
-def format(args) -> int:
-    if not args:
-        _format_dirname(".")
+def format(names, line_length) -> int:
+    if not names:
+        _format_dirname(".", line_length)
         return 0
-    if len(args) == 1 and args[0] == "-":
+    if len(names) == 1 and names[0] == "-":
         # Special case, format policy file from stdin to stdout
-        format_policy_fin_fout(sys.stdin, sys.stdout)
+        format_policy_fin_fout(sys.stdin, sys.stdout, line_length)
         return 0
 
-    for arg in args:
-        if arg == "-":
+    for name in names:
+        if name == "-":
             raise UserError(
                 "The - argument has a special meaning and cannot be combined with other paths"
             )
-        if not os.path.exists(arg):
-            raise UserError(f"{arg} does not exist")
-        if os.path.isfile(arg):
-            _format_filename(arg)
+        if not os.path.exists(name):
+            raise UserError(f"{name} does not exist")
+        if os.path.isfile(name):
+            _format_filename(name, line_length)
             continue
-        if os.path.isdir(arg):
-            _format_dirname(arg)
+        if os.path.isdir(name):
+            _format_dirname(name, line_length)
             continue
     return 0
 

{cfengine-0.7.0 → cfengine-0.7.2}/src/cfengine_cli/docs.py

@@ -10,13 +10,12 @@ TODO: This code needs several adjustments to better fit into
 
 import os
 import json
-from shutil import which
 import subprocess
 
 import markdown_it
 from cfbs.pretty import pretty_file
 
-from cfengine_cli.markdowner import markdown_prettify
+from cfengine_cli.lint import lint_policy_file
 from cfengine_cli.utils import UserError
 
 
@@ -110,7 +109,9 @@ def fn_extract(origin_path, snippet_path, _language, first_line, last_line):
         raise UserError(f"Couldn't open '{origin_path}' or '{snippet_path}'")
 
 
-def fn_check_syntax(origin_path, snippet_path, language, first_line, _last_line):
+def fn_check_syntax(
+    origin_path, snippet_path, language, first_line, _last_line, snippet_number
+):
     snippet_abs_path = os.path.abspath(snippet_path)
 
     if not os.path.exists(snippet_path):
@@ -120,25 +121,11 @@ def fn_check_syntax(origin_path, snippet_path, language, first_line, _last_line)
 
     match language:
         case "cf":
-            try:
-                p = subprocess.run(
-                    ["/var/cfengine/bin/cf-promises", snippet_abs_path],
-                    capture_output=True,
-                    text=True,
-                )
-                err = p.stderr
-
-                if err:
-                    err = err.replace(snippet_abs_path, f"{origin_path}:{first_line}")
-                    print(err)
-            except OSError:
-                raise UserError(f"'{snippet_abs_path}' doesn't exist")
-            except ValueError:
-                raise UserError("Invalid subprocess arguments")
-            except subprocess.CalledProcessError:
-                raise UserError(f"Couldn't run cf-promises on '{snippet_abs_path}'")
-            except subprocess.TimeoutExpired:
-                raise UserError("Timed out")
+            r = lint_policy_file(
+                snippet_abs_path, origin_path, first_line + 1, snippet_number
+            )
+            if r != 0:
+                raise UserError(f"Error when checking '{origin_path}'")
         case "json":
             try:
                 with open(snippet_abs_path, "r") as f:
@@ -200,25 +187,35 @@ def fn_autoformat(_origin_path, snippet_path, language, _first_line, _last_line)
                 raise UserError(f"Invalid json in '{snippet_path}'")
 
 
-def _markdown_code_checker(
-    path, syntax_check, extract, replace, autoformat, languages, output_check, cleanup
-):
-    supported_languages = {"cf3": "cf", "json": "json", "yaml": "yml"}
+def _translate_language(x):
+    if x == "cf3" or x == "cfengine3":
+        return "cf"
+    if x == "yaml":
+        return "yml"
+    return x
+
 
+SUPPORTED_LANGUAGES = ["cf", "cfengine3", "cf3", "json", "yml", "yaml"]
+
+
+def _process_markdown_code_blocks(
+    path, languages, extract, syntax_check, output_check, autoformat, replace, cleanup
+):
     if not os.path.exists(path):
         raise UserError("This path doesn't exist")
 
-    if (
-        syntax_check
-        and "cf3" in languages
-        and not which("/var/cfengine/bin/cf-promises")
-    ):
-        raise UserError("cf-promises is not installed")
-
+    languages = set(languages)
+    if "cf3" in languages or "cf" in languages or "cfengine3" in languages:
+        languages.add("cf3")
+        languages.add("cfengine3")
+        languages.add("cf")
+    if "yaml" in languages or "yml" in languages:
+        languages.add("yml")
+        languages.add("yaml")
     for language in languages:
-        if language not in supported_languages:
+        if language not in SUPPORTED_LANGUAGES:
             raise UserError(
-                f"Unsupported language '{language}'. The supported languages are: {", ".join(supported_languages.keys())}"
+                f"Unsupported language '{language}'. The supported languages are: {", ".join(SUPPORTED_LANGUAGES)}"
             )
 
     parsed_markdowns = get_markdown_files(path, languages)
@@ -234,8 +231,9 @@ def _markdown_code_checker(
                 cb["first_line"] += offset
                 cb["last_line"] += offset
 
-            language = supported_languages[code_block["language"]]
-            snippet_path = f"{origin_path}.snippet-{i + 1}.{language}"
+            language = _translate_language(code_block["language"])
+            snippet_number = i + 1
+            snippet_path = f"{origin_path}.snippet-{snippet_number}.{language}"
 
             flags = code_block["flags"]
             if "noextract" in flags or "skip" in flags:
@@ -258,12 +256,16 @@ def _markdown_code_checker(
                         language,
                         code_block["first_line"],
                         code_block["last_line"],
+                        snippet_number,
                     )
                 except Exception as e:
                     if cleanup:
                         os.remove(snippet_path)
                     raise e
 
+            if output_check and "noexecute" not in code_block["flags"]:
+                fn_check_output()
+
             if autoformat and "noautoformat" not in code_block["flags"]:
                 fn_autoformat(
                     origin_path,
@@ -273,9 +275,6 @@ def _markdown_code_checker(
                     code_block["last_line"],
                 )
 
-            if output_check and "noexecute" not in code_block["flags"]:
-                fn_check_output()
-
             if replace and "noreplace" not in code_block["flags"]:
                 offset = fn_replace(
                     origin_path,
@@ -287,45 +286,86 @@ def _markdown_code_checker(
                 )
             if cleanup:
                 os.remove(snippet_path)
-        if autoformat:
-            markdown_prettify(origin_path)
+
+
+def _run_black():
+    path = "."
+    assert os.path.isdir(path)
+    try:
+        subprocess.run(
+            ["black", path],
+            capture_output=True,
+            text=True,
+            check=True,
+            cwd=path,
+        )
+    except:
+        raise UserError(
+            "Encountered an error running black\nInstall: pipx install black"
+        )
+
+
+def _run_prettier():
+    path = "."
+    assert os.path.isdir(path)
+    try:
+        subprocess.run(
+            ["prettier", "--write", "**.markdown", "**.md"],
+            capture_output=True,
+            text=True,
+            check=True,
+            cwd=path,
+        )
+    except:
+        raise UserError(
+            "Encountered an error running prettier\nInstall: npm install --global prettier"
+        )
 
 
 def update_docs() -> int:
     """
-    Iterate through entire docs repo (.), autoformatting all JSONs.
-
-    Will be expanded to more types of formatting in the future.
+    Iterate through entire docs repo (.), autoformatting as much as possible:
+    - python code with black
+    - markdown files with prettier
+    - code blocks inside markdown files are formatted for the formats supported by prettier
+    - JSON code blocks are re-formatted by cfbs pretty (we plan to expand this to CFEngine code blocks)
 
     Run by the command:
     cfengine dev docs-format
     """
-    _markdown_code_checker(
+    print("Formatting python files with black...")
+    _run_black()
+    print("Formatting markdown files with prettier...")
+    _run_prettier()
+    print("Formatting markdown code blocks according to our rules...")
+    _process_markdown_code_blocks(
         path=".",
-        syntax_check=False,
+        languages=["json"],  # TODO: Add cfengine3 here
         extract=True,
-        replace=True,
-        autoformat=True,
-        languages=["json"],
+        syntax_check=False,
         output_check=False,
+        autoformat=True,
+        replace=True,
         cleanup=True,
     )
     return 0
 
 
 def check_docs() -> int:
-    """Entry point to be called by other files
+    """
+    Run checks / tests on docs.
+    Currently only JSON syntax checking.
 
     Run by the command:
-    cfengine dev docs-checking"""
-    _markdown_code_checker(
+    cfengine dev docs-check"""
+    _process_markdown_code_blocks(
         path=".",
-        syntax_check=True,
+        languages=["json", "cf3"],
         extract=True,
-        replace=False,
-        autoformat=False,
-        languages=["json"],
+        syntax_check=True,
         output_check=False,
+        autoformat=False,
+        replace=False,
         cleanup=True,
     )
     return 0

{cfengine-0.7.0 → cfengine-0.7.2}/src/cfengine_cli/format.py

@@ -80,14 +80,14 @@ def split_generic_value(node, indent):
     return [stringify_single_line(node)]
 
 
-def split_generic_list(middle, indent):
+def split_generic_list(middle, indent, line_length):
     elements = []
     for element in middle:
         if elements and element.type == ",":
             elements[-1] = elements[-1] + ","
             continue
         line = " " * indent + stringify_single_line(element)
-        if len(line) < 80:
+        if len(line) < line_length:
             elements.append(line)
         else:
             lines = split_generic_value(element, indent)
@@ -96,50 +96,50 @@ def split_generic_list(middle, indent):
     return elements
 
 
-def maybe_split_generic_list(nodes, indent):
+def maybe_split_generic_list(nodes, indent, line_length):
     string = " " * indent + stringify_children(nodes)
-    if len(string) < 80:
+    if len(string) < line_length:
         return [string]
-    return split_generic_list(nodes, indent)
+    return split_generic_list(nodes, indent, line_length)
 
 
-def split_rval_list(node, indent):
+def split_rval_list(node, indent, line_length):
     assert node.type == "list"
     assert node.children[0].type == "{"
     first = text(node.children[0])
     last = " " * indent + text(node.children[-1])
     middle = node.children[1:-1]
-    elements = maybe_split_generic_list(middle, indent + 2)
+    elements = maybe_split_generic_list(middle, indent + 2, line_length)
     return [first, *elements, last]
 
 
-def split_rval_call(node, indent):
+def split_rval_call(node, indent, line_length):
     assert node.type == "call"
     assert node.children[0].type == "calling_identifier"
     assert node.children[1].type == "("
     first = text(node.children[0]) + "("
     last = " " * indent + text(node.children[-1])
     middle = node.children[2:-1]
-    elements = maybe_split_generic_list(middle, indent + 2)
+    elements = maybe_split_generic_list(middle, indent + 2, line_length)
     return [first, *elements, last]
 
 
-def split_rval(node, indent):
+def split_rval(node, indent, line_length):
     if node.type == "list":
-        return split_rval_list(node, indent)
+        return split_rval_list(node, indent, line_length)
     if node.type == "call":
-        return split_rval_call(node, indent)
+        return split_rval_call(node, indent, line_length)
     return [stringify_single_line(node)]
 
 
-def maybe_split_rval(node, indent, offset):
+def maybe_split_rval(node, indent, offset, line_length):
     line = stringify_single_line(node)
-    if len(line) + offset < 80:
+    if len(line) + offset < line_length:
         return [line]
-    return split_rval(node, indent)
+    return split_rval(node, indent, line_length)
 
 
-def attempt_split_attribute(node, indent):
+def attempt_split_attribute(node, indent, line_length):
     assert len(node.children) == 3
     lval = node.children[0]
     arrow = node.children[1]
@@ -148,22 +148,22 @@ def attempt_split_attribute(node, indent):
     if rval.type == "list" or rval.type == "call":
         prefix = " " * indent + text(lval) + " " + text(arrow) + " "
         offset = len(prefix)
-        lines = maybe_split_rval(rval, indent, offset)
+        lines = maybe_split_rval(rval, indent, offset, line_length)
         lines[0] = prefix + lines[0]
         return lines
     return [stringify_single_line(node)]
 
 
-def stringify(node, indent):
+def stringify(node, indent, line_length):
     single_line = " " * indent + stringify_single_line(node)
-    if len(single_line) < 80:
+    if len(single_line) < line_length:
         return [single_line]
     if node.type == "attribute":
-        return attempt_split_attribute(node, indent)
+        return attempt_split_attribute(node, indent, line_length)
     return [single_line]
 
 
-def autoformat(node, fmt, macro_indent, indent=0):
+def autoformat(node, fmt, line_length, macro_indent, indent=0):
     previous = fmt.update_previous(node)
     if previous and previous.type == "macro" and text(previous).startswith("@else"):
         indent = macro_indent
@@ -190,12 +190,12 @@ def autoformat(node, fmt, macro_indent, indent=0):
     ]:
         indent += 2
     if node.type == "attribute":
-        lines = stringify(node, indent)
+        lines = stringify(node, indent, line_length)
         fmt.print_lines(lines, indent=0)
         return
     if children:
         for child in children:
-            autoformat(child, fmt, macro_indent, indent)
+            autoformat(child, fmt, line_length, macro_indent, indent)
         return
     if node.type in [",", ";"]:
         fmt.print_same_line(node)
@@ -203,7 +203,7 @@ def autoformat(node, fmt, macro_indent, indent=0):
     fmt.print(node, indent)
 
 
-def format_policy_file(filename):
+def format_policy_file(filename, line_length):
     assert filename.endswith(".cf")
     PY_LANGUAGE = Language(tscfengine.language())
     parser = Parser(PY_LANGUAGE)
@@ -216,7 +216,7 @@ def format_policy_file(filename):
 
     root_node = tree.root_node
     assert root_node.type == "source_file"
-    autoformat(root_node, fmt, macro_indent)
+    autoformat(root_node, fmt, line_length, macro_indent)
 
     new_data = fmt.buffer + "\n"
     if new_data != original_data.decode("utf-8"):
@@ -225,7 +225,7 @@ def format_policy_file(filename):
         print(f"Policy file '{filename}' was reformatted")
 
 
-def format_policy_fin_fout(fin, fout):
+def format_policy_fin_fout(fin, fout, line_length):
     PY_LANGUAGE = Language(tscfengine.language())
     parser = Parser(PY_LANGUAGE)
 
@@ -236,7 +236,7 @@ def format_policy_fin_fout(fin, fout):
 
     root_node = tree.root_node
     assert root_node.type == "source_file"
-    autoformat(root_node, fmt, macro_indent)
+    autoformat(root_node, fmt, line_length, macro_indent)
 
     new_data = fmt.buffer + "\n"
     fout.write(new_data)

{cfengine-0.7.0 → cfengine-0.7.2}/src/cfengine_cli/lint.py

@@ -97,9 +97,22 @@ def _walk(filename, lines, node) -> int:
     return errors
 
 
-def lint_policy_file(filename):
+def lint_policy_file(
+    filename, original_filename=None, original_line=None, snippet=None
+):
+    assert original_filename is None or type(original_filename) is str
+    assert original_line is None or type(original_line) is int
+    assert snippet is None or type(snippet) is int
+    if (
+        original_filename is not None
+        or original_line is not None
+        or snippet is not None
+    ):
+        assert original_filename and os.path.isfile(original_filename)
+        assert original_line and original_line > 0
+        assert snippet and snippet > 0
     assert os.path.isfile(filename)
-    assert filename.endswith(".cf")
+    assert filename.endswith((".cf", ".cfengine3", ".cf3", ".cf.sub"))
     PY_LANGUAGE = Language(tscfengine.language())
     parser = Parser(PY_LANGUAGE)
 
@@ -112,12 +125,26 @@ def lint_policy_file(filename):
     assert root_node.type == "source_file"
     errors = 0
     if not root_node.children:
-        print(f"Error: Empty policy file '{filename}'")
+        if snippet:
+            assert original_filename and original_line
+            print(
+                f"Error: Empty policy snippet {snippet} at '{original_filename}:{original_line}'"
+            )
+        else:
+            print(f"Error: Empty policy file '{filename}'")
         errors += 1
     errors += _walk(filename, lines, root_node)
     if errors == 0:
-        print(f"PASS: {filename}")
+        if snippet:
+            assert original_filename and original_line
+            print(f"PASS: Snippet {snippet} at '{original_filename}:{original_line}'")
+        else:
+            print(f"PASS: {filename}")
         return 0
 
-    print(f"FAIL: {filename} ({errors} error{'s' if errors > 0 else ''})")
+    if snippet:
+        assert original_filename and original_line
+        print(f"FAIL: Snippet {snippet} at '{original_filename}:{original_line}'")
+    else:
+        print(f"FAIL: {filename} ({errors} error{'s' if errors > 0 else ''})")
     return errors

{cfengine-0.7.0 → cfengine-0.7.2}/src/cfengine_cli/main.py

@@ -43,6 +43,7 @@ def _get_arg_parser():
     subp.add_parser("deploy", help="Deploy a built policy set")
     fmt = subp.add_parser("format", help="Autoformat .json and .cf files")
     fmt.add_argument("files", nargs="*", help="Files to format")
+    fmt.add_argument("--line-length", default=80, type=int, help="Maximum line length")
     subp.add_parser(
         "lint",
         help="Look for syntax errors and other simple mistakes",
@@ -86,7 +87,7 @@ def run_command_with_args(args) -> int:
     if args.command == "deploy":
         return commands.deploy()
     if args.command == "format":
-        return commands.format(args.files)
+        return commands.format(args.files, args.line_length)
     if args.command == "lint":
         return commands.lint()
     if args.command == "report":