cfengine 0.18.0__tar.gz → 0.19.0__tar.gz

{cfengine-0.18.0 → cfengine-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfengine
-Version: 0.18.0
+Version: 0.19.0
 Summary: Human-oriented CLI for interacting with CFEngine policy language, projects, and other CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007

{cfengine-0.18.0 → cfengine-0.19.0}/src/cfengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfengine
-Version: 0.18.0
+Version: 0.19.0
 Summary: Human-oriented CLI for interacting with CFEngine policy language, projects, and other CFEngine tools
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007

{cfengine-0.18.0 → cfengine-0.19.0}/src/cfengine.egg-info/SOURCES.txt

@@ -46,6 +46,10 @@ src/cfengine_cli/up.py
 src/cfengine_cli/utils.py
 src/cfengine_cli/validate.py
 src/cfengine_cli/version.py
+src/cfengine_cli/cfengine_wrapper/__init__.py
+src/cfengine_cli/cfengine_wrapper/cfengine_commands.py
+src/cfengine_cli/cfengine_wrapper/cfengine_objects.py
+src/cfengine_cli/cfengine_wrapper/cfengine_utils.py
 src/cfengine_cli/masterfiles/__init__.py
 src/cfengine_cli/masterfiles/analyze.py
 src/cfengine_cli/masterfiles/check_download_matches_git.py
@@ -137,6 +141,10 @@ 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/lint/020_missing_braces.expected.txt
+tests/lint/020_missing_braces.x.cf
+tests/lint/020_missing_semicolon.expected.txt
+tests/lint/020_missing_semicolon.x.cf
 tests/shell/001-help.sh
 tests/shell/002-version.sh
 tests/shell/003-format.sh

{cfengine-0.18.0 → cfengine-0.19.0}/src/cfengine.egg-info/scm_file_list.json

@@ -31,6 +31,10 @@
     "src/cfengine_cli/__main__.py",
     "src/cfengine_cli/paths.py",
     "src/cfengine_cli/dev.py",
+    "src/cfengine_cli/cfengine_wrapper/cfengine_commands.py",
+    "src/cfengine_cli/cfengine_wrapper/cfengine_objects.py",
+    "src/cfengine_cli/cfengine_wrapper/cfengine_utils.py",
+    "src/cfengine_cli/cfengine_wrapper/__init__.py",
     "src/cfengine_cli/masterfiles/check_download_matches_git.py",
     "src/cfengine_cli/masterfiles/generate_vcf_git_checkout.py",
     "src/cfengine_cli/masterfiles/__init__.py",
@@ -49,6 +53,7 @@
     "tests/run-format-tests.sh",
     "tests/lint/015_macro_multi_def_bundle.cf",
     "tests/lint/010_mutually_exclusive_types_vars.cf",
+    "tests/lint/020_missing_semicolon.x.cf",
     "tests/lint/010_mutually_exclusive_types_vars.x.cf",
     "tests/lint/013_num_args_body.expected.txt",
     "tests/lint/007_namespace.x.cf",
@@ -59,7 +64,9 @@
     "tests/lint/009_unknown_function_inside_vars.cf",
     "tests/lint/008_bundle_shadows_function.expected.txt",
     "tests/lint/013_num_args_bundle.x.cf",
+    "tests/lint/020_missing_semicolon.expected.txt",
     "tests/lint/017_implies_body.cf",
+    "tests/lint/020_missing_braces.expected.txt",
     "tests/lint/017_implies_body.expected.txt",
     "tests/lint/008_bundle_shadows_function.cf",
     "tests/lint/003_name_lowercase.x.cf",
@@ -83,6 +90,7 @@
     "tests/lint/011_invalid_attributes.x.cf",
     "tests/lint/018_nested_calls.cf",
     "tests/lint/014_variadic_func_arg_count.cf",
+    "tests/lint/020_missing_braces.x.cf",
     "tests/lint/017_implies_body.x.cf",
     "tests/lint/012_function_call_arg_count.x.cf",
     "tests/lint/007_namespace.expected.txt",

cfengine-0.19.0/src/cfengine.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.19.0",
+  "distance": 0,
+  "node": "gef5f6e5f16cb63fc1fab7cec47207a9bb839a9d5",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-07-15"
+}

cfengine-0.19.0/src/cfengine_cli/cfengine_wrapper/cfengine_commands.py

@@ -0,0 +1,44 @@
+from cfbs.commands import build_command
+from cf_remote.commands import deploy as deploy_command
+from cf_remote.commands import install as install_command
+from cf_remote.commands import destroy as destroy_command
+
+from cfengine_cli.cfengine_wrapper.cfengine_utils import (
+    require_executable,
+    require_installation,
+)
+
+
+def report(target: str | None = None) -> int:  # TODO? ENT-14122
+    installation = require_installation(target)
+    rc = installation.agent.run("-KIf update.cf", "-KI")
+    if rc != 0:
+        return rc
+    return installation.hub.run(
+        "--query rebase -H 127.0.0.1", "--query delta -H 127.0.0.1"
+    )
+
+
+def run(*args, target: str | None = None) -> int:
+    agent = require_executable("cf-agent", target)
+    if args:
+        return agent.run(*args)
+    return agent.run("-KIf update.cf", "-KI")
+
+
+def install() -> int:  # TODO ENT-14117
+    return install_command(None, None)
+
+
+def destroy(groupname, del_all=False) -> int:
+    if del_all:
+        return destroy_command(None)
+    return destroy_command(groupname)
+
+
+def build() -> int:  # TODO ENT-14119
+    return build_command()
+
+
+def deploy() -> int:  # TODO ENT-14119
+    return deploy_command(None, None)

cfengine-0.19.0/src/cfengine_cli/cfengine_wrapper/cfengine_objects.py

@@ -0,0 +1,120 @@
+from dataclasses import dataclass
+from cf_remote.remote import run_command
+import subprocess
+import logging
+import os
+
+
+def _ensure_default_agent_flags(command: str) -> str:
+    """
+    cf-agent needs -K (no-lock), -I (inform), and -f (specify
+    file) to actually run against a policy file the way people expect.
+    If `command` has no flags at all -- e.g. someone just ran
+    `cfengine run mypolicy.cf` -- prepend "-KIf" so a bare filename works.
+
+    Deliberately does NOT try to detect and fill in individual missing
+    letters (e.g. leaving -f out of "-KI somefile.cf")
+    If any flag is present at all, we assume the invocation was deliberate and
+    leave it exactly as given.
+    """
+    tokens = command.split()
+    has_flags = any(t.startswith("-") for t in tokens)
+    if has_flags:
+        return command
+    return f"-KIf {command}".strip()
+
+
+class Executable:
+    """
+    A single binary (cf-agent or cf-hub) at a known location -- either
+    "local" or a remote host identifier ("user@ip"). Knows its own path
+    and how to run a command against itself, whether that means a local
+    subprocess or an SSH call via cf-remote.
+    """
+
+    def __init__(self, name: str, location: str, path: str, aliases=None) -> None:
+        self.name = name  # "cf-agent" / "cf-hub"
+        self.location = location  # "local" or "user@ip"
+        self.path = path  # absolute path to the binary at that location
+        self.aliases = (
+            aliases or []
+        )  # friendly names from cf-remote's saved state, e.g. "hub", "local", "remote"
+
+    @property
+    def is_local(self) -> bool:
+        return self.location == "local"
+
+    @property
+    def label(self) -> str:
+        """Best human-facing identifier: a friendly alias if we have one, else the location."""
+        if self.aliases:
+            return f"{self.aliases[0]} ({self.location})"
+        return self.location
+
+    def run(self, *commands) -> int:
+        rc = 0
+        for command in commands:
+            rc = self._run_one(command)
+            if rc != 0:
+                return rc
+        return rc
+
+    def _run_one(self, command: str) -> int:
+        if self.name == "cf-agent":
+            command = _ensure_default_agent_flags(command)
+
+        if self.is_local:
+            args = [self.path] + command.split()
+            # cf-agent picks its workdir based on privilege: as root it uses
+            # /var/cfengine/inputs (where policy actually lives); as a
+            # regular user it falls back to ~/.cfagent/inputs instead,
+            # which won't have update.cf. Elevate to match the remote path,
+            # which already runs everything via sudo.
+            if os.geteuid() != 0:
+                args = ["sudo"] + args
+            result = subprocess.run(args)
+            return result.returncode
+
+        full_command = f"{self.path} {command}"
+        logging.warning(f"Executing command {full_command} on {self.location}")
+        output = run_command(self.location, full_command, sudo=True)
+        if (
+            output is None
+        ):  # TODO: Test this, I've had some policy failing but returning output instead or error-code (I think)
+            # Error already logged in run_command
+            return 1
+        if output:
+            print(output)
+        return 0
+
+    def __repr__(self) -> str:
+        return f"<Executable {self.name} @ {self.location}>"
+
+
+@dataclass
+class Installation:
+    """
+    One coherent system that has BOTH cf-agent and cf-hub, so callers
+    that need both (e.g. report()) can pick one location and get a
+    matched pair, rather than resolving each binary independently.
+    """
+
+    location: str
+    agent: Executable
+    hub: Executable
+
+    @property
+    def is_local(self) -> bool:
+        return self.location == "local"
+
+    @property
+    def aliases(self) -> list:
+        # agent and hub are always built from the same alias list for a
+        # given host (see _find_all_paired), so either would do here.
+        return self.agent.aliases
+
+    @property
+    def label(self) -> str:
+        if self.aliases:
+            return f"{self.aliases[0]} ({self.location})"
+        return self.location

cfengine-0.19.0/src/cfengine_cli/cfengine_wrapper/cfengine_utils.py

@@ -0,0 +1,191 @@
+import os
+import shutil
+import logging
+import sys
+
+from collections.abc import Iterator
+from cfengine_cli.paths import bin
+from cfengine_cli.utils import UserError
+from cfengine_cli.cfengine_wrapper.cfengine_objects import Executable, Installation
+from cf_remote.remote import get_info
+from cf_remote.paths import CLOUD_STATE_FPATH
+from cf_remote.utils import read_json
+
+
+def _find_local_path(binary_name: str) -> str | None:
+    candidate = bin(binary_name)
+    if os.path.isfile(candidate) and os.access(candidate, os.X_OK):
+        return candidate
+    return shutil.which(binary_name)
+
+
+def _known_hosts(role_filter=None) -> Iterator[tuple[str, list[str]]]:
+    """
+    Yields (host_id, aliases) from cf-remote's saved/spawned VM state --
+    host_id is "user@ip" (same source _get_hubs() in cf_remote.commands
+    reads from); aliases are the friendly names cf-remote knows this host
+    by: the group name it was saved/spawned under (e.g. "hub", "hub2")
+    and its per-host key within that group. Optionally filter by
+    vm["role"] (e.g. "hub" or "client").
+    """
+    if not os.path.exists(CLOUD_STATE_FPATH):
+        return
+    vms_info = read_json(CLOUD_STATE_FPATH)
+    if not vms_info:
+        return
+    for group_name, group in vms_info.items():
+        alias_group = group_name.lstrip("@")
+        for host_key, vm in group.items():
+            if host_key == "meta":
+                continue
+            if role_filter and vm.get("role") != role_filter:
+                continue
+            host_id = "{}@{}".format(vm["user"], vm["public_ips"][0])
+            aliases = [alias_group]
+            if host_key != alias_group:
+                aliases.append(host_key)
+            yield host_id, aliases
+
+
+def _find_all(binary_name: str) -> list[Executable]:
+    """Every location -- local, plus every matching remote host -- with `binary_name` installed."""
+    executables = []
+
+    local_path = _find_local_path(binary_name)
+    if local_path:
+        executables.append(Executable(binary_name, "local", local_path))
+
+    role_filter = "hub" if binary_name == "cf-hub" else None
+    key = "agent" if binary_name == "cf-agent" else "hub"
+    for host, aliases in _known_hosts(role_filter=role_filter):
+        try:
+            data = get_info(host)
+        except (Exception, SystemExit) as e:
+            """Need to catch SystemExit as cf-remote's get_info() will SystemExit if
+            any ssh-connections does not work, for our case we still want to fetch
+            the ones that are up in case the user wants to use a different host"""
+            logging.warning(f"Skipping {host}: {e}")
+            continue
+        if not data:
+            continue
+        binary_path = data.get(key)
+        if binary_path:
+            executables.append(
+                Executable(binary_name, host, binary_path, aliases=aliases)
+            )
+
+    return executables
+
+
+def _find_all_paired() -> list[Installation]:
+    """Every location -- local or remote -- that has BOTH cf-agent and cf-hub."""
+    installations = []
+
+    local_agent_path = _find_local_path("cf-agent")
+    local_hub_path = _find_local_path("cf-hub")
+    if local_agent_path and local_hub_path:
+        installations.append(
+            Installation(
+                location="local",
+                agent=Executable("cf-agent", "local", local_agent_path),
+                hub=Executable("cf-hub", "local", local_hub_path),
+            )
+        )
+
+    for host, aliases in _known_hosts(role_filter="hub"):
+        try:
+            data = get_info(host)
+        except Exception:
+            continue
+        if not data:
+            continue
+        agent_path = data.get("agent")
+        hub_path = data.get("hub")
+        if agent_path and hub_path:
+            installations.append(
+                Installation(
+                    location=host,
+                    agent=Executable("cf-agent", host, agent_path, aliases=aliases),
+                    hub=Executable("cf-hub", host, hub_path, aliases=aliases),
+                )
+            )
+
+    return installations
+
+
+def _prompt_choice(candidates, description):
+    if not sys.stdin.isatty():
+        labels = ", ".join(c.label for c in candidates)
+        raise UserError(
+            f"Multiple installations of {description} found ({labels}) "
+            f"and no terminal to prompt on. Specify one with --host."
+        )
+    print(f"Multiple installations of {description} found:")
+    for i, c in enumerate(candidates, 1):
+        print(f"  {i}) {c.label}")
+    while True:
+        choice = input(f"Select which to use [1-{len(candidates)}]: ").strip()
+        if choice.isdigit() and 1 <= int(choice) <= len(candidates):
+            return candidates[int(choice) - 1]
+        print("Invalid selection, try again.")
+
+
+def _exact_match(candidate, target: str) -> bool:
+    return target == candidate.location or target in candidate.aliases
+
+
+def _loose_match(candidate, target: str) -> bool:
+    """Substring match, for when nothing matched exactly."""
+    if target in candidate.location:
+        return True
+    return any(target in alias for alias in candidate.aliases)
+
+
+def _select(candidates, description, target: str | None = None):
+    """
+    Picks one candidate (an Executable or Installation) out of a list:
+    - none found -> UserError
+    - `target` given -> match against location OR any alias (exact, or
+      substring -- an IP, username, or friendly name like "hub"),
+      UserError on no match
+    - exactly one -> use it, no prompt
+    - multiple, no target -> interactive prompt
+    """
+    if not candidates:
+        raise UserError(
+            f"Could not find {description} locally or on any configured remote host."
+        )
+
+    if target:
+        matches = [c for c in candidates if _exact_match(c, target)]
+        if not matches:
+            matches = [c for c in candidates if _loose_match(c, target)]
+        if not matches:
+            available = ", ".join(c.label for c in candidates)
+            raise UserError(
+                f"No installation of {description} matches '{target}'. Available: {available}"
+            )
+        if len(matches) == 1:
+            return matches[0]
+        return _prompt_choice(matches, description)
+
+    if len(candidates) == 1:
+        return candidates[0]
+
+    return _prompt_choice(candidates, description)
+
+
+def require_executable(name: str, target: str | None = None) -> Executable:
+    chosen = _select(_find_all(name), name, target)
+    logging.warning(
+        f"Using {'local' if chosen.is_local else 'remote'} installation of {name} ({chosen.label})"
+    )
+    return chosen
+
+
+def require_installation(target: str | None = None) -> Installation:
+    chosen = _select(_find_all_paired(), "cf-agent + cf-hub", target)
+    logging.warning(
+        f"Using {'local' if chosen.is_local else 'remote'} installation of cf-agent and cf-hub ({chosen.label})"
+    )
+    return chosen

{cfengine-0.18.0 → cfengine-0.19.0}/src/cfengine_cli/commands.py

@@ -5,28 +5,14 @@ import yaml
 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.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_paths
 from cfengine_cli.utils import UserError
 from cfengine_cli.up import validate_config, up_do, resolve_templates
-from cfbs.commands import build_command
-from cf_remote.commands import deploy as deploy_command
 from cf_remote.paths import cf_remote_dir
 from pydantic import ValidationError
 
 
-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")
@@ -38,16 +24,6 @@ def version() -> int:
     return 0
 
 
-def build() -> int:
-    r = build_command()
-    return r
-
-
-def deploy() -> int:
-    r = deploy_command(None, None)
-    return r
-
-
 def format(names, line_length, check) -> int:
     return format_paths(names, line_length, check)
 
@@ -69,21 +45,6 @@ def lint(files, strict, syntax_path) -> int:
     return errors
 
 
-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, args) -> int:
     return dispatch_dev_subcommand(subcommand, args)
 

{cfengine-0.18.0 → cfengine-0.19.0}/src/cfengine_cli/deptool.py

@@ -29,6 +29,7 @@ HUMAN_NAME = {
     "zlib": "zlib",
     "librsync": "librsync",
     "leech": "leech",
+    "leech2": "leech2",
     "apache": "Apache",
     "apr": "APR",
     "apr-util": "apr-util",
@@ -60,6 +61,7 @@ HOME_URL = {
     "zlib": "https://www.zlib.net/",
     "librsync": "https://github.com/librsync/librsync/releases",
     "leech": "https://github.com/larsewi/leech/releases",
+    "leech2": "https://github.com/larsewi/leech2/releases",
     "apache": "https://httpd.apache.org/",
     "apr": "https://apr.apache.org/",
     "apr-util": "https://apr.apache.org/",

{cfengine-0.18.0 → cfengine-0.19.0}/src/cfengine_cli/docs.py

@@ -11,6 +11,7 @@ TODO: This code needs several adjustments to better fit into
 import os
 import json
 import subprocess
+import textwrap
 
 import markdown_it
 from cfbs.pretty import pretty_file
@@ -375,8 +376,11 @@ def _run_formatter(tool, args, cwd, install_hint):
             check=True,
             cwd=cwd,
         )
-    except:
-        raise UserError(f"Encountered an error running {tool}\nInstall: {install_hint}")
+    except FileNotFoundError:
+        raise UserError(f"'{tool}' not found. Install it with: {install_hint}")
+    except subprocess.CalledProcessError as e:
+        error_msg = textwrap.indent(str(e.stderr).strip(), "> ")
+        raise UserError(f"Encountered an error running {tool}:\n{error_msg}")
     return result
 
 

{cfengine-0.18.0 → cfengine-0.19.0}/src/cfengine_cli/lint.py

@@ -493,14 +493,26 @@ class State:
             return
 
 
+def _last_real_sibling_before(node: Node) -> Node | None:
+    """Walk backwards from node through its preceding siblings, skipping
+    comments and macros, to find the last real (content) sibling."""
+    sib = node.prev_sibling
+    while sib is not None and sib.type in ("comment", "macro"):
+        sib = sib.prev_sibling
+    return sib
+
+
 def _check_syntax(policy_file: PolicyFile, state: State) -> int:
-    """Iterate over a syntax tree and print errors if it is empty or has syntax
-    errors.
+    """Iterate over a syntax tree and print errors if it is empty, has syntax
+    errors, or is missing expected tokens (e.g. a dropped ';').
 
     Notably, printing syntax errors _does not happen during parsing_.
 
     Tree sitter has already fully parsed the policy, we iterate over the result
-    and see if it has inserted any "ERROR" nodes.
+    and see if it has inserted any "ERROR" nodes, or any "MISSING" nodes
+    (tree-sitter's error recovery can silently insert a synthetic token,
+    e.g. a missing ';' right before a closing '}', without ever producing
+    an ERROR node.
 
     Stops at first error. Returns number of errors, always 0 or 1 in this case.
     """
@@ -522,15 +534,26 @@ def _check_syntax(policy_file: PolicyFile, state: State) -> int:
     state.start_file(policy_file)
     for node in policy_file.nodes:
         state.navigate(node)
-        if node.type != "ERROR":
-            continue
         line = node.range.start_point[0] + 1
         column = node.range.start_point[1] + 1
-        _highlight_range(node, lines)
-        location = state.get_location_extended(line, column)
-        print(f"Error: Syntax error {location}")
-        state.end_file()
-        return 1
+        if node.type == "ERROR":
+            _highlight_range(node, lines)
+            location = state.get_location_extended(line, column)
+            print(f"Error: Syntax error {location}")
+            state.end_file()
+            return 1
+        if node.is_missing:
+            # To avoid pointing at #comment/@macro -lines
+            prev = _last_real_sibling_before(node)
+            report_node = prev if prev is not None else node
+            _highlight_range(report_node, lines)
+            line = report_node.range.end_point[0] + 1
+            column = report_node.range.end_point[1] + 1
+            missing = node.type if not node.is_named else f"token: {node.type}"
+            location = state.get_location_extended(line, column)
+            print(f"Error: Missing '{missing}' {location}")
+            state.end_file()
+            return 1
     state.end_file()
     return 0