cfengine 0.3.0__tar.gz → 0.4.0__tar.gz

{cfengine-0.3.0 → cfengine-0.4.0}/.github/dependabot.yml

@@ -7,3 +7,11 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    prefix: "pip"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "olehermanse"
+    prefix: "GitHub Actions"

{cfengine-0.3.0 → cfengine-0.4.0}/.github/workflows/black-check.yml

@@ -9,6 +9,9 @@ on:
   pull_request:
     branches: [main]
 
+permissions:
+  contents: read
+
 jobs:
   check:
     runs-on: ubuntu-22.04

{cfengine-0.3.0 → cfengine-0.4.0}/.github/workflows/black-format.yml

@@ -1,5 +1,9 @@
 name: Automatically format with Black and submit PR
 
+permissions:
+  contents: read
+  pull-requests: write
+
 on:
   push:
     branches:

cfengine-0.4.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,60 @@
+# Taken from GH docs:
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release-build:
+    runs-on: ubuntu-24.04
+
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          git fetch --all --tags
+          python -m pip install pip
+          pip install uv
+          uv lock --check
+          uv build
+
+      - name: Upload release-dists as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  #  pre-release-tests:
+  #    runs-on: ubuntu-24.04
+  #
+  #    permissions:
+  #      contents: read
+  #
+  #    steps:
+  #      - uses: actions/checkout@v4
+  #      - uses: ./.github/workflows/tests.yml
+
+  pypi-publish:
+    runs-on: ubuntu-24.04
+    needs:
+      - release-build
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.12.4

cfengine-0.4.0/.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  all-tests:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}

{cfengine-0.3.0 → cfengine-0.4.0}/.gitignore

@@ -6,4 +6,5 @@ venv
 .venv
 __pycache__
 .DS_STORE
-.pytest_cache
+.pytest_cache
+/out/

{cfengine-0.3.0 → cfengine-0.4.0}/HACKING.md

@@ -44,8 +44,13 @@ If it does not work, click the failing GitHub Actions and try to understand what
 The process is virtually identical to using the GUI.
 Once you've determined what the version number should be, use the `gh release create`, and answer the prompts in a similar way to above:
 
+```bash
+gh release create
+```
+
+Go through the prompts:
+
 ```
-$ gh release create
 ? Choose a tag Create a new tag
 ? Tag name 0.2.0
 ? Title (optional) 0.2.0
@@ -53,7 +58,6 @@ $ gh release create
 ? Is this a prerelease? No
 ? Submit? Publish release
 https://github.com/cfengine/cfengine-cli/releases/tag/0.2.0
-$
 ```
 
 Then check that everything went well;
@@ -83,6 +87,57 @@ For simplicity's sake, we don't have a custom configuration, we use the tool's d
 
 If your editor does not do this automatically, you can run these tools from the command line:
 
-```
+```bash
 black . && prettier . --write
 ```
+
+## Running commands during development
+
+This project uses `uv`.
+This makes it easy to run commands without installing the project, for example:
+
+```bash
+uv run cfengine format
+```
+
+## Installing from source:
+
+```bash
+git fetch --all --tags
+pip3 install .
+```
+
+## Running tests
+
+Unit tests:
+
+```bash
+py.test
+```
+
+Shell tests (requires installing first):
+
+```bash
+cat tests/shell/*.sh | bash
+```
+
+## Not implemented yet / TODOs
+
+- `cfengine run`
+  - The command could automatically detect that you have CFEngine installed on a remote hub, and run it there instead (using `cf-remote`).
+  - Handle when `cf-agent` is not installed, help users install.
+  - Prompt / help users do what they meant (i.e. build and deploy and run).
+- `cfengine format`
+  - Automatically break up and indent method calls, function calls, and nested function calls.
+  - Smarter placement of comments based on context.
+  - The command should be able to take a filename as an argument, and also operate using stdin and stdout.
+    (Receive file content on stdin, file type using command line arg, output formatted file to stdout).
+  - We can add a shortcut, `cfengine fmt`, since that matches other tools, like `deno`.
+- `cfengine lint`
+  - The command should be able to take a filename as an argument, and also take file content from stdin.
+  - It would be nice if we refactored `validate_config()` in `cfbs` so it would take a simple dictionary (JSON) instead of a special CFBSConfig object.
+- Missing commands:
+  - `cfengine install` - Install CFEngine packages / binaries (Wrapping `cf-remote install`).
+  - `cfengine dev` - Subcommand for CFEngine developers / maintainers.
+    - `cfengine dev release-information` - Generate release information (Wrapping `cfbs generate-release-information`)
+    - `cfengine dev dependency-tables` - Update dependency tables in markdown files.

{cfengine-0.3.0 → cfengine-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: cfengine
-Version: 0.3.0
+Version: 0.4.0
 Summary: Human-oriented CLI for interacting with CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -691,12 +691,14 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: cf-remote>=0.6.4
-Requires-Dist: cfbs>=4.3.1
+Requires-Dist: cfbs>=4.4.2
+Requires-Dist: tree-sitter-cfengine>=1.0.8
+Requires-Dist: tree-sitter>=0.23
+Requires-Dist: markdown-it-py>=3.0.0
 
 # CFEngine command line interface (CLI)
 
@@ -711,27 +713,58 @@ Proceed with caution and excitement.
 
 Install using pip:
 
-```
+```bash
 pip install cfengine
 ```
 
 ## Usage
 
-To perform an agent run:
+### Run the CFEngine agent - evaluate and enforce policy
+
+```bash
+cfengine run
+```
+
+### CFEngine CLI help
 
+```bash
+cfengine help
 ```
+
+### Print CFEngine CLI version
+
+```bash
 cfengine run
 ```
 
-To get additional help:
+### Automatically format source code
 
+```bash
+cfengine format
 ```
-cfengine help
+
+### Check for errors in source code
+
+```bash
+cfengine lint
+```
+
+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.
+(But the opposite is not a goal, that `cfengine lint` must accept any policy `cf-agent` would find acceptable).
+
+### Build a policy set
+
+```bash
+cfengine build
 ```
 
+(This is equivalent to running `cfbs build`).
+
 ## Supported platforms and versions
 
-This tool will only support a limited number of platforms, it is not int.
+This tool will only support a limited number of platforms, it is not intended to run everywhere CFEngine runs.
 Currently we are targeting:
 
 - Officially supported versions of macOS, Ubuntu, and Fedora.

{cfengine-0.3.0 → cfengine-0.4.0}/README.md

@@ -11,27 +11,58 @@ Proceed with caution and excitement.
 
 Install using pip:
 
-```
+```bash
 pip install cfengine
 ```
 
 ## Usage
 
-To perform an agent run:
+### Run the CFEngine agent - evaluate and enforce policy
+
+```bash
+cfengine run
+```
+
+### CFEngine CLI help
 
+```bash
+cfengine help
 ```
+
+### Print CFEngine CLI version
+
+```bash
 cfengine run
 ```
 
-To get additional help:
+### Automatically format source code
 
+```bash
+cfengine format
 ```
-cfengine help
+
+### Check for errors in source code
+
+```bash
+cfengine lint
+```
+
+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.
+(But the opposite is not a goal, that `cfengine lint` must accept any policy `cf-agent` would find acceptable).
+
+### Build a policy set
+
+```bash
+cfengine build
 ```
 
+(This is equivalent to running `cfbs build`).
+
 ## Supported platforms and versions
 
-This tool will only support a limited number of platforms, it is not int.
+This tool will only support a limited number of platforms, it is not intended to run everywhere CFEngine runs.
 Currently we are targeting:
 
 - Officially supported versions of macOS, Ubuntu, and Fedora.

cfengine-0.4.0/ci/01-install.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+set -x
+
+pipx install uv

cfengine-0.4.0/ci/02-safe-tests.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -e
+set -x
+
+uv lock --check
+uv run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+uv run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+uv run pytest

cfengine-0.4.0/ci/03-unsafe-tests.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -e
+set -x
+
+uv lock --check
+uv build
+pip install .
+cfengine --version
+bash tests/docker/0*.sh
+bash tests/shell/0*.sh

{cfengine-0.3.0 → cfengine-0.4.0}/pyproject.toml

@@ -11,7 +11,10 @@ license = {file = "LICENSE"}
 requires-python = ">=3.9"
 dependencies = [
     "cf-remote>=0.6.4",
-    "cfbs>=4.3.1",
+    "cfbs>=4.4.2",
+    "tree-sitter-cfengine>=1.0.8",
+    "tree-sitter>=0.23",
+    "markdown-it-py>=3.0.0",
 ]
 classifiers = [
   "Development Status :: 3 - Alpha",
@@ -28,7 +31,6 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
-  "Programming Language :: Python :: 3.14",
   "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
 ]
 

{cfengine-0.3.0 → cfengine-0.4.0}/src/cfengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: cfengine
-Version: 0.3.0
+Version: 0.4.0
 Summary: Human-oriented CLI for interacting with CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -691,12 +691,14 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: cf-remote>=0.6.4
-Requires-Dist: cfbs>=4.3.1
+Requires-Dist: cfbs>=4.4.2
+Requires-Dist: tree-sitter-cfengine>=1.0.8
+Requires-Dist: tree-sitter>=0.23
+Requires-Dist: markdown-it-py>=3.0.0
 
 # CFEngine command line interface (CLI)
 
@@ -711,27 +713,58 @@ Proceed with caution and excitement.
 
 Install using pip:
 
-```
+```bash
 pip install cfengine
 ```
 
 ## Usage
 
-To perform an agent run:
+### Run the CFEngine agent - evaluate and enforce policy
+
+```bash
+cfengine run
+```
+
+### CFEngine CLI help
 
+```bash
+cfengine help
 ```
+
+### Print CFEngine CLI version
+
+```bash
 cfengine run
 ```
 
-To get additional help:
+### Automatically format source code
 
+```bash
+cfengine format
 ```
-cfengine help
+
+### Check for errors in source code
+
+```bash
+cfengine lint
+```
+
+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.
+(But the opposite is not a goal, that `cfengine lint` must accept any policy `cf-agent` would find acceptable).
+
+### Build a policy set
+
+```bash
+cfengine build
 ```
 
+(This is equivalent to running `cfbs build`).
+
 ## Supported platforms and versions
 
-This tool will only support a limited number of platforms, it is not int.
+This tool will only support a limited number of platforms, it is not intended to run everywhere CFEngine runs.
 Currently we are targeting:
 
 - Officially supported versions of macOS, Ubuntu, and Fedora.

{cfengine-0.3.0 → cfengine-0.4.0}/src/cfengine.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@
 HACKING.md
 LICENSE
 README.md
-main.py
 pyproject.toml
 uv.lock
 .github/dependabot.yml
@@ -11,6 +10,9 @@ uv.lock
 .github/workflows/black-format.yml
 .github/workflows/pypi-publish.yml
 .github/workflows/tests.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
@@ -20,6 +22,11 @@ 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/dependency_tables.py
+src/cfengine_cli/dev.py
+src/cfengine_cli/docs_formatting.py
+src/cfengine_cli/format.py
+src/cfengine_cli/lint.py
 src/cfengine_cli/main.py
 src/cfengine_cli/paths.py
 src/cfengine_cli/shell.py
@@ -27,6 +34,8 @@ src/cfengine_cli/utils.py
 src/cfengine_cli/version.py
 tests/__init__.py
 tests/test_deps.py
-tests/docker/001-docker-install-test.sh
-tests/docker/Dockerfile
-tests/shell/001-help.sh
+tests/test_paths.py
+tests/test_utils.py
+tests/test_version.py
+tests/shell/001-help.sh
+tests/shell/002-version.sh

cfengine-0.4.0/src/cfengine.egg-info/requires.txt

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

cfengine-0.4.0/src/cfengine_cli/commands.py

@@ -0,0 +1,96 @@
+import os
+from cfengine_cli.dev import dispatch_dev_subcommand
+from cfengine_cli.lint import lint_cfbs_json, lint_json, lint_policy_file
+from cfengine_cli.shell import user_command
+from cfengine_cli.paths import bin
+from cfengine_cli.version import cfengine_cli_version_string
+from cfengine_cli.format import format_policy_file, format_json_file
+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
+
+
+def _require_cfagent():
+    if not os.path.exists(bin("cf-agent")):
+        raise UserError(f"cf-agent not found at {bin('cf-agent')}")
+
+
+def _require_cfhub():
+    if not os.path.exists(bin("cf-hub")):
+        raise UserError(f"cf-hub not found at {bin('cf-hub')}")
+
+
+def help() -> int:
+    print("Example usage:")
+    print("cfengine run")
+    return 0
+
+
+def version() -> int:
+    print(cfengine_cli_version_string())
+    return 0
+
+
+def build() -> int:
+    r = build_command()
+    if r is None:
+        # Workaround for https://github.com/cfengine/cfbs/pull/231
+        return 0
+    return r
+
+
+def deploy() -> int:
+    r = deploy_command(None, None)
+    return r
+
+
+def format() -> int:
+    for filename in find(".", extension=".json"):
+        if filename.startswith("./."):
+            continue
+        format_json_file(filename)
+    for policy_file in find(".", extension=".cf"):
+        if policy_file.startswith("./."):
+            continue
+        format_policy_file(policy_file)
+    return 0
+
+
+def lint() -> int:
+    errors = 0
+    for filename in find(".", extension=".json"):
+        if filename.startswith(("./.", "./out/")):
+            continue
+        if filename.endswith("/cfbs.json"):
+            lint_cfbs_json(filename)
+            continue
+        errors += lint_json(filename)
+
+    for filename in find(".", extension=".cf"):
+        if filename.startswith(("./.", "./out/")):
+            continue
+        errors += lint_policy_file(filename)
+
+    if errors == 0:
+        return 0
+    return 1
+
+
+def report() -> int:
+    _require_cfhub()
+    _require_cfagent()
+    user_command(f"{bin('cf-agent')} -KIf update.cf && {bin('cf-agent')} -KI")
+    user_command(f"{bin('cf-hub')} --query rebase -H 127.0.0.1")
+    user_command(f"{bin('cf-hub')} --query delta -H 127.0.0.1")
+    return 0
+
+
+def run() -> int:
+    _require_cfagent()
+    user_command(f"{bin('cf-agent')} -KIf update.cf && {bin('cf-agent')} -KI")
+    return 0
+
+
+def dev(subcommand) -> int:
+    return dispatch_dev_subcommand(subcommand)

cfengine-0.4.0/src/cfengine_cli/dependency_tables.py

@@ -0,0 +1,2 @@
+def update_dependency_tables() -> int:
+    return 0