cfengine 0.13.0__tar.gz → 0.15.0__tar.gz

cfengine-0.15.0/.github/workflows/lint-policy-in-other-repos.yml

@@ -0,0 +1,47 @@
+# This workflow checks that linting works on real policy in other repos
+# and ensures we fix errors in policy before merging new linting rules
+# to CFEngine CLI
+
+name: Lint policy in other repos
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+permissions:
+  contents: read
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout cfengine-cli
+        uses: actions/checkout@v4
+        with:
+          path: cfengine-cli
+      - name: Checkout masterfiles
+        uses: actions/checkout@v4
+        with:
+          repository: cfengine/masterfiles
+          path: masterfiles
+      - name: Checkout modules
+        uses: actions/checkout@v4
+        with:
+          repository: cfengine/modules
+          path: modules
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        working-directory: cfengine-cli
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install uv
+          make install
+      - name: Run cfengine lint
+        working-directory: cfengine-cli
+        run: |
+          uv run cfengine lint --strict no ../masterfiles
+          uv run cfengine lint --strict no ../modules
+        # TODO: Add documentation and core when ready

cfengine-0.15.0/.github/workflows/make-check.yml

@@ -0,0 +1,51 @@
+# This workflow installs the necessary dependencies, runs make check, and
+# checks if there are any edits. It should be very similar to what developers
+# are expected to do locally. We want to ensure that all tests pass (make
+# check succeeds) and that there is no additional formatting / untracked
+# files generated.
+#
+# Note that make check is a bit special in this repo, it has some things you
+# might not expect:
+# 1. It doesn't only run tests, it also runs formatters and linters
+# 2. It installs the CFEngine CLI, so that shell tests will work
+
+name: Run make check
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+permissions:
+  contents: read
+jobs:
+  check:
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install uv
+          sudo apt-get install npm
+          npm install --global prettier
+      - name: Set python version file for uv
+        run: |
+          echo "${{ matrix.python-version }}" > .python-version
+      - name: Run make check
+        run: |
+          make check
+      - name: Reset python version file
+        run: |
+          git restore .python-version
+      - name: See if there are changes
+        run: |
+          git diff --exit-code
+          git ls-files --other --directory --exclude-standard | sed q1

cfengine-0.15.0/.github/workflows/update-syntax-description.yml

@@ -0,0 +1,69 @@
+name: Update syntax-description
+
+on:
+  schedule:
+    - cron: "0 7 * * 1" # Run every Monday at 7am UTC
+    #        | | | | |
+    #        | | | | day of the week (0-6) (Sunday to Saturday)
+    #        | | | month (1-12)
+    #        | | day of the month (1-31)
+    #        | hour (0-23)
+    #        minute (0-59)
+  workflow_dispatch: # Enables manual trigger
+
+jobs:
+  update_syntax_desc:
+    if: contains(fromJSON('["cfengine","mendersoftware","NorthernTechHQ"]'), github.repository_owner)
+    name: Update syntax-description
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checks-out repository
+        uses: actions/checkout@v4
+        with:
+          ref: "main"
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install cf-remote cfengine
+      - name: Install cfengine
+        run: |
+          cf-remote --version master download --edition community ubuntu24 amd64 hub
+          sudo dpkg -i ~/.cfengine/cf-remote/packages/cfengine-community*.deb
+      - name: Extract new syntax-description
+        run: |
+          (
+            sudo cf-promises --syntax-description json
+          ) > new.json
+          cfengine format new.json
+      - name: Set Git user
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+      - name: Update contents of syntax-description
+        run: |
+          if ! cmp -s new.json ./src/cfengine_cli/syntax-description.json; then
+            cat new.json > ./src/cfengine_cli/syntax-description.json
+            echo "CHANGES_DETECTED=true" >> $GITHUB_ENV
+            rm new.json
+          fi
+      - name: Create Pull Request
+        if: env.CHANGES_DETECTED == 'true'
+        uses: cfengine/create-pull-request@v6
+        with:
+          title: Updated syntax-description.json
+          body: Automated update to syntax-description.json [the `update-syntax-description` workflow](https://github.com/cfengine/cfengine-cli/tree/main/.github/workflows/update-syntax-description.yml).
+          reviewers: |
+            simonthalvorsen
+            olehermanse
+            larsewi
+            nickanderson
+            craigcomstock
+          branch: update-syntax-description
+          branch-suffix: timestamp

cfengine-0.15.0/.python-version

@@ -0,0 +1 @@
+3.14

cfengine-0.15.0/CLAUDE.md

@@ -0,0 +1,51 @@
+# CFEngine CLI information for LLMs
+
+## Fix the implementation
+
+In general, when the prompter asks you to fix the implementation, this means that they have adjusted the tests already and they want you to fix the implementation.
+Typically you should not touch the tests in this case, unless there is something obviously wrong in them, like a typo.
+The first step to identify what is necessary should be to run the tests and see which ones are failing.
+
+## Running tests
+
+In general, the main command to run for testing is:
+
+```bash
+make check
+```
+
+This will run all the test suites.
+
+## Running python tools
+
+This project uses `uv`.
+That means that you should not run `python`, `python3`, `pip`, `pip3` directly.
+Instead, run the appropriate uv command to ensure we're using the right python and the right dependencies.
+
+## Pointers for the source code
+
+When fixing issues, these are usually the files to look at:
+
+- The implementation of `cfengine format` is in `src/cfengine_cli/format.py`.
+- The implementation of `cfengine lint` is in `src/cfengine_cli/lint.py`.
+
+## Syntax trees
+
+When working on the formatter or the linter, it is often useful to look at the syntax tree of the policy file.
+There is a `dev` subcommand for this:
+
+```bash
+uv run cfengine dev syntax-tree tests/lint/001_hello_world.cf
+```
+
+The command above prints the syntax tree for `tests/lint/001_hello_world.cf` to the terminal (standard output).
+
+## Test suites
+
+As mentioned above, the `make check` command runs all the tests.
+We have different suites:
+
+- Unit tests in `tests/unit` test individual python functions.
+- Formatting tests in `tests/format` test the formatter (`cfengine format`).
+- Linting tests in `tests/lint` test the linter.
+- Shell tests in `tests/shell` tests various subcommands and the tool as a whole in an end-to-end fashion.

{cfengine-0.13.0 → cfengine-0.15.0}/HACKING.md

@@ -18,17 +18,17 @@ make format
 
 ## Installing from source:
 
-For developers working on CFEngine CLI, it is recommended to install an editable version of the tool:
+For developers working on CFEngine CLI, you can install it globally using pipx:
 
 ```bash
 make install
 ```
 
-Some of the tests require that you have the CLI installed (they run `cfengine` commands).
+This is optional — `make check` and `uv run` work without a global install.
 
 ## Running commands without installing
 
-You can also run commands without installing, using `uv`:
+You can run commands without installing globally, using `uv`:
 
 ```bash
 uv run cfengine format
@@ -46,9 +46,9 @@ Running individual test suites:
 
 ```bash
 uv run pytest
-bash tests/run-lint-tests.sh
-bash tests/run-format-tests.sh
-bash tests/run-shell-tests.sh
+uv run bash tests/run-lint-tests.sh
+uv run bash tests/run-format-tests.sh
+uv run bash tests/run-shell-tests.sh
 ```
 
 ## Releasing new versions

cfengine-0.15.0/Makefile

@@ -0,0 +1,26 @@
+.PHONY: default format lint install check venv
+
+default: check
+
+venv:
+	uv venv --clear
+	uv sync
+
+format: venv
+	uv tool run black . --target-version py310
+	prettier . --write
+
+lint: venv
+	uv tool run black --check . --fast
+	uv tool run flake8 src/ --ignore=E203,W503,E722,E731 --max-complexity=100 --max-line-length=160
+	uv tool run pyflakes src/
+	uv tool run pyright src/
+
+install:
+	pipx install --force --editable .
+
+check: venv format lint
+	uv run pytest
+	uv run bash tests/run-lint-tests.sh
+	uv run bash tests/run-format-tests.sh
+	uv run bash tests/run-shell-tests.sh

{cfengine-0.13.0 → cfengine-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfengine
-Version: 0.13.0
+Version: 0.15.0
 Summary: Human-oriented CLI for interacting with CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -696,7 +696,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: cf-remote>=0.7.3
 Requires-Dist: cfbs>=5.5.0
-Requires-Dist: tree-sitter-cfengine>=1.1.8
+Requires-Dist: tree-sitter-cfengine>=1.1.12
 Requires-Dist: tree-sitter>=0.25
 Requires-Dist: markdown-it-py>=3.0.0
 

{cfengine-0.13.0 → cfengine-0.15.0}/pyproject.toml

@@ -12,7 +12,7 @@ requires-python = ">=3.10"
 dependencies = [
     "cf-remote>=0.7.3",
     "cfbs>=5.5.0",
-    "tree-sitter-cfengine>=1.1.8",
+    "tree-sitter-cfengine>=1.1.12",
     "tree-sitter>=0.25",
     "markdown-it-py>=3.0.0",
 ]
@@ -40,6 +40,9 @@ cfengine = "cfengine_cli.main:main"
 [tool.setuptools]
 license-files = [] # Workaround bug in setuptools https://github.com/astral-sh/uv/issues/9513
 
+[tool.setuptools.package-data]
+cfengine_cli = ["*.json"] # syntax-description.json
+
 [tool.pyright]
 include = ["src"]
 venvPath = "."

{cfengine-0.13.0 → cfengine-0.15.0}/src/cfengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfengine
-Version: 0.13.0
+Version: 0.15.0
 Summary: Human-oriented CLI for interacting with CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -696,7 +696,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: cf-remote>=0.7.3
 Requires-Dist: cfbs>=5.5.0
-Requires-Dist: tree-sitter-cfengine>=1.1.8
+Requires-Dist: tree-sitter-cfengine>=1.1.12
 Requires-Dist: tree-sitter>=0.25
 Requires-Dist: markdown-it-py>=3.0.0
 

cfengine-0.15.0/src/cfengine.egg-info/SOURCES.txt

@@ -0,0 +1,141 @@
+.gitignore
+.python-version
+CLAUDE.md
+HACKING.md
+LICENSE
+Makefile
+README.md
+pyproject.toml
+uv.lock
+.github/dependabot.yml
+.github/workflows/lint-policy-in-other-repos.yml
+.github/workflows/make-check.yml
+.github/workflows/pypi-publish.yml
+.github/workflows/update-syntax-description.yml
+ci/01-install.sh
+ci/02-safe-tests.sh
+ci/03-unsafe-tests.sh
+src/cfengine.egg-info/PKG-INFO
+src/cfengine.egg-info/SOURCES.txt
+src/cfengine.egg-info/dependency_links.txt
+src/cfengine.egg-info/entry_points.txt
+src/cfengine.egg-info/requires.txt
+src/cfengine.egg-info/top_level.txt
+src/cfengine_cli/__init__.py
+src/cfengine_cli/__main__.py
+src/cfengine_cli/commands.py
+src/cfengine_cli/deptool-README.md
+src/cfengine_cli/deptool.py
+src/cfengine_cli/dev.py
+src/cfengine_cli/docs.py
+src/cfengine_cli/format.py
+src/cfengine_cli/lint.py
+src/cfengine_cli/lint_csv.py
+src/cfengine_cli/main.py
+src/cfengine_cli/paths.py
+src/cfengine_cli/profile.py
+src/cfengine_cli/shell.py
+src/cfengine_cli/syntax-description.json
+src/cfengine_cli/syntax_tree.py
+src/cfengine_cli/utils.py
+src/cfengine_cli/version.py
+src/cfengine_cli/masterfiles/__init__.py
+src/cfengine_cli/masterfiles/analyze.py
+src/cfengine_cli/masterfiles/check_download_matches_git.py
+src/cfengine_cli/masterfiles/download.py
+src/cfengine_cli/masterfiles/generate_git_tags.py
+src/cfengine_cli/masterfiles/generate_release_information.py
+src/cfengine_cli/masterfiles/generate_vcf_download.py
+src/cfengine_cli/masterfiles/generate_vcf_git_checkout.py
+tests/README.md
+tests/run-format-tests.sh
+tests/run-lint-tests.sh
+tests/run-shell-tests.sh
+tests/format/001_hello_world.expected.cf
+tests/format/001_hello_world.input.cf
+tests/format/002_basics.expected.cf
+tests/format/002_basics.input.cf
+tests/format/003_wrapping.expected.cf
+tests/format/003_wrapping.input.cf
+tests/format/004_comments.expected.cf
+tests/format/004_comments.input.cf
+tests/format/005_bundle_comments.expected.cf
+tests/format/005_bundle_comments.input.cf
+tests/format/006_remove_empty_comments.expected.cf
+tests/format/006_remove_empty_comments.input.cf
+tests/format/007_class_guarded_empty_lines.expected.cf
+tests/format/007_class_guarded_empty_lines.input.cf
+tests/format/008_long_string.expected.cf
+tests/format/008_long_string.input.cf
+tests/format/009_single_line.expected.cf
+tests/format/009_single_line.input.cf
+tests/format/010_stakeholder.expected.cf
+tests/format/010_stakeholder.input.cf
+tests/format/011_macros.expected.cf
+tests/format/011_macros.input.cf
+tests/format/011_promises.expected.cf
+tests/format/011_promises.input.cf
+tests/lint/001_hello_world.cf
+tests/lint/002_deprecations.expected.txt
+tests/lint/002_deprecations.x.cf
+tests/lint/003_name_lowercase.cf
+tests/lint/003_name_lowercase.expected.txt
+tests/lint/003_name_lowercase.x.cf
+tests/lint/004_block_type.cf
+tests/lint/004_block_type.expected.txt
+tests/lint/004_block_type.x.cf
+tests/lint/005_syntax_error.cf
+tests/lint/005_syntax_error.expected.txt
+tests/lint/005_syntax_error.x.cf
+tests/lint/006_empty_file.expected.txt
+tests/lint/006_empty_file.x.cf
+tests/lint/007_namespace.cf
+tests/lint/007_namespace.expected.txt
+tests/lint/007_namespace.x.cf
+tests/lint/008_bundle_shadows_function.cf
+tests/lint/008_bundle_shadows_function.expected.txt
+tests/lint/008_bundle_shadows_function.x.cf
+tests/lint/009_unknown_function_inside_vars.cf
+tests/lint/009_unknown_function_inside_vars.expected.txt
+tests/lint/009_unknown_function_inside_vars.x.cf
+tests/lint/010_mutually_exclusive_types_vars.cf
+tests/lint/010_mutually_exclusive_types_vars.expected.txt
+tests/lint/010_mutually_exclusive_types_vars.x.cf
+tests/lint/011_invalid_attributes.expected.txt
+tests/lint/011_invalid_attributes.x.cf
+tests/lint/012_function_call_arg_count.cf
+tests/lint/012_function_call_arg_count.expected.txt
+tests/lint/012_function_call_arg_count.x.cf
+tests/lint/013_num_args_body.expected.txt
+tests/lint/013_num_args_body.x.cf
+tests/lint/013_num_args_bundle.expected.txt
+tests/lint/013_num_args_bundle.x.cf
+tests/lint/013_num_args_bundle_body.cf
+tests/lint/014_variadic_func_arg_count.cf
+tests/lint/014_variadic_func_arg_count.expected.txt
+tests/lint/014_variadic_func_arg_count.x.cf
+tests/lint/015_macro_multi_def_bundle.cf
+tests/lint/015_macro_multi_def_bundle.expected.txt
+tests/lint/015_macro_multi_def_bundle.x.cf
+tests/lint/016_half_promises.cf
+tests/lint/016_half_promises.expected.txt
+tests/lint/016_half_promises.x.cf
+tests/lint/017_implies_body.cf
+tests/lint/017_implies_body.expected.txt
+tests/lint/017_implies_body.x.cf
+tests/lint/018_nested_calls.cf
+tests/lint/018_nested_calls.expected.txt
+tests/lint/018_nested_calls.x.cf
+tests/lint/019_bundle_name_expansion.cf
+tests/shell/001-help.sh
+tests/shell/002-version.sh
+tests/shell/003-format.sh
+tests/shell/004-format-check.sh
+tests/shell/005-lint.sh
+tests/unit/__init__.py
+tests/unit/test_deps.py
+tests/unit/test_format.py
+tests/unit/test_lint_csv.py
+tests/unit/test_paths.py
+tests/unit/test_utils.py
+tests/unit/test_version.py

{cfengine-0.13.0 → cfengine-0.15.0}/src/cfengine.egg-info/requires.txt

@@ -1,5 +1,5 @@
 cf-remote>=0.7.3
 cfbs>=5.5.0
-tree-sitter-cfengine>=1.1.8
+tree-sitter-cfengine>=1.1.12
 tree-sitter>=0.25
 markdown-it-py>=3.0.0

{cfengine-0.13.0 → cfengine-0.15.0}/src/cfengine_cli/commands.py

@@ -4,7 +4,7 @@ import re
 import json
 from cfengine_cli.profile import profile_cfengine, generate_callstack
 from cfengine_cli.dev import dispatch_dev_subcommand
-from cfengine_cli.lint import lint_args
+from cfengine_cli.lint import lint_args, PolicySyntaxError
 from cfengine_cli.shell import user_command
 from cfengine_cli.paths import bin
 from cfengine_cli.version import cfengine_cli_version_string
@@ -14,7 +14,6 @@ from cfengine_cli.format import (
     format_policy_fin_fout,
 )
 from cfengine_cli.utils import UserError
-from cfbs.utils import find
 from cfbs.commands import build_command
 from cf_remote.commands import deploy as deploy_command
 
@@ -50,34 +49,53 @@ def deploy() -> int:
     return r
 
 
-def _format_filename(filename, line_length):
-    if filename.startswith("./."):
-        return
+def _format_filename(filename: str, line_length: int, check: bool) -> int:
+    """Format a single file.
+
+    Raises PolicySyntaxError for .cf files with syntax errors."""
     if filename.endswith(".json"):
-        format_json_file(filename)
-        return
+        return format_json_file(filename, check)
     if filename.endswith(".cf"):
-        format_policy_file(filename, line_length)
-        return
+        return format_policy_file(filename, line_length, check)
     raise UserError(f"Unrecognized file format: {filename}")
 
 
-def _format_dirname(directory, line_length):
-    for filename in find(directory, extension=".json"):
-        _format_filename(filename, line_length)
-    for filename in find(directory, extension=".cf"):
-        _format_filename(filename, line_length)
-
-
-def format(names, line_length) -> int:
+def _format_dirname(directory: str, line_length: int, check: bool) -> int:
+    ret = 0
+    for root, dirs, files in os.walk(directory):
+        # Don't recurse into hidden folders
+        dirs[:] = [d for d in dirs if not d.startswith(".")]
+        for name in sorted(files):
+            if name.startswith("."):
+                continue  # Hidden files are ignored by default
+            if name.endswith(".x.cf") or name.endswith(".input.cf"):
+                continue  # Test files skipped during directory traversal
+            if name.endswith(
+                (".input.json", ".jqinput.json", ".x.json", ".expected.json")
+            ):
+                continue  # Test files skipped during directory traversal
+            filepath = os.path.join(root, name)
+            if name.endswith(".json") or name.endswith(".cf"):
+                ret |= _format_filename(filepath, line_length, check)
+    return ret
+
+
+def format(names, line_length, check) -> int:
+    try:
+        return _format_inner(names, line_length, check)
+    except PolicySyntaxError as e:
+        print(f"Error: {e}")
+        return 1
+
+
+def _format_inner(names, line_length, check) -> int:
     if not names:
-        _format_dirname(".", line_length)
-        return 0
+        return _format_dirname(".", line_length, check)
     if len(names) == 1 and names[0] == "-":
         # Special case, format policy file from stdin to stdout
-        format_policy_fin_fout(sys.stdin, sys.stdout, line_length)
-        return 0
+        return format_policy_fin_fout(sys.stdin, sys.stdout, line_length, check)
 
+    ret = 0
     for name in names:
         if name == "-":
             raise UserError(
@@ -86,11 +104,13 @@ def format(names, line_length) -> int:
         if not os.path.exists(name):
             raise UserError(f"{name} does not exist")
         if os.path.isfile(name):
-            _format_filename(name, line_length)
+            ret |= _format_filename(name, line_length, check)
             continue
         if os.path.isdir(name):
-            _format_dirname(name, line_length)
+            ret |= _format_dirname(name, line_length, check)
             continue
+    if check:
+        return ret
     return 0
 
 

{cfengine-0.13.0 → cfengine-0.15.0}/src/cfengine_cli/deptool.py

@@ -8,7 +8,7 @@ import re
 import subprocess
 import sys
 
-ACTIVE_BRANCHES = ["3.21.x", "3.24.x", "master"]
+ACTIVE_BRANCHES = ["3.24.x", "3.27.x", "master"]
 
 HUMAN_NAME = {
     "diffutils": "diffutils",
@@ -260,7 +260,7 @@ class DepsReader:
         # currently only_deps is generator of space-separated deps,
         # i.e. each item can contain several items, like this:
         # list(only_deps) = ["lcov", "pthreads-w32 libgnurx"]
-        # to "flattern" it we first join using spaces and then split on spaces
+        # to "flatten" it we first join using spaces and then split on spaces
         # in the middle we also do some clean-ups
         only_deps = " ".join(only_deps).replace("libgcc ", "").split(" ")
         # now only_deps looks like this: ["lcov", "pthreads-w32", "libgnurx"]