cfengine 0.2.0__tar.gz → 0.3.1__tar.gz

cfengine-0.3.1/.github/dependabot.yml

@@ -0,0 +1,17 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    prefix: "pip"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "olehermanse"
+    prefix: "GitHub Actions"

cfengine-0.3.1/.github/workflows/black-check.yml

@@ -0,0 +1,35 @@
+# 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: Check formatting with Black
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+
+    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 black
+      - name: Check formatting with black
+        run: |
+          black --check .

cfengine-0.3.1/.github/workflows/black-format.yml

@@ -0,0 +1,71 @@
+name: Automatically format with Black and submit PR
+
+permissions:
+  contents: read
+  pull-requests: write
+
+on:
+  push:
+    branches:
+      - main
+
+  workflow_dispatch:
+
+jobs:
+  format:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checks-out repository
+        uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install black
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install black
+      - name: Reformat with black
+        run: |
+          shopt -s globstar
+          black . > black_output.txt 2>&1
+      - name: Check if there are changes
+        run: |
+          git diff --exit-code || touch git_diff_exists
+          if [ -f git_diff_exists ]; then echo "Changes need to be commited"; else echo "No changes to commit"; fi
+      - name: Create commit message
+        if: hashFiles('git_diff_exists') != ''
+        run: |
+          echo "Reformatted python code using Black formatter" >> commit_message.txt
+          echo "" >> commit_message.txt
+          echo "Output from black:" >> commit_message.txt
+          echo "" >> commit_message.txt
+          echo '```' >> commit_message.txt
+          cat black_output.txt >> commit_message.txt
+          echo '```' >> commit_message.txt
+      - name: Commit changes
+        if: hashFiles('git_diff_exists') != ''
+        run: |
+          git config user.name 'GitHub'
+          git config user.email '<noreply@github.com>'
+          shopt -s globstar
+          git add cfengine_cli/*.py cfengine_cli/**/*.py tests/*.py tests/**/*.py
+          git commit -F commit_message.txt
+      - id: commit-message-from-file
+        name: Parse commit message from file into variable
+        if: hashFiles('git_diff_exists') != ''
+        run: |
+          body=$(cat commit_message.txt)
+          body="${body//$'\n'/'%0A'}"
+          echo ::set-output name=body::$body
+      - name: Create Pull Request
+        if: hashFiles('git_diff_exists') != ''
+        uses: cfengine/create-pull-request@158a28c1bf5c08c846b8e7d26d13becbd4136eda # v7.0.7a
+        with:
+          title: Reformatted python code using Black formatter
+          body: ${{ steps.commit-message-from-file.outputs.body }}
+          reviewers: |
+            olehermanse
+            larsewi
+            vpodzime
+          branch: formatting-action

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

@@ -0,0 +1,50 @@
+# 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/
+
+  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@76f52bc884231f62b9a034ebfe128415bbaabdfc

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

@@ -0,0 +1,59 @@
+# 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]
+
+permissions:
+  contents: read
+
+jobs:
+  python_version:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      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 }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install uv
+      - name: Check lockfile
+        run: |
+          uv lock --check
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          uv run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          uv run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          uv run pytest
+      - name: Install
+        run: |
+          uv lock --check
+          uv build
+          pip install .
+      - name: Sanity check
+        run: cfengine --version
+      - name: Run docker tests
+        run: |
+          bash tests/docker/0*.sh
+      - name: Run shell tests
+        run: |
+          bash tests/shell/0*.sh

cfengine-0.3.1/.gitignore

@@ -0,0 +1,9 @@
+build
+dist
+VERSION
+cfengine.egg-info
+venv
+.venv
+__pycache__
+.DS_STORE
+.pytest_cache

cfengine-0.3.1/.python-version

@@ -0,0 +1 @@
+3.13

cfengine-0.3.1/HACKING.md

@@ -0,0 +1,88 @@
+# Developing / maintaining the CFEngine CLI
+
+This document aims to have relevant information for people contributing to and maintaining the CFEngine CLI.
+It is not necessary for users of the tool to know about these processes.
+For general user information, see the [README](./README.md).
+
+## Releasing new versions
+
+Releases are [automated using a GH Action](https://github.com/cfengine/cfengine-cli/blob/main/.github/workflows/pypi-publish.yml)
+We create tags and releases through the GitHub UI.
+Go to the releases section in GitHub:
+
+https://github.com/cfengine/cfengine-cli/releases
+
+Determine the new version number according to SemVer:
+
+- Look at what is the latest released version.
+- Increase the first number if you are releasing breaking changes.
+- Or, increase the second number if there are new features (but no breaking changes).
+- Otherwise, increase the last number (only backwards compatible bugfixes).
+
+Sometimes, it's not 100% clear, so use your best judgement.
+
+Once you know the version number, proceed with making the release:
+
+1. Enter the version number into the **Choose a tag** dropdown.
+2. Click the **Create new tag on publish** alternative.
+3. Target should say **main**, don't change it.
+4. Put exactly the same version number into the **Release title** field.
+5. Click **Generate release notes**.
+   - In general, it's not necessary to edit the release notes.
+   - Sometimes you might want to add a link to a release blog post.
+   - Or, if there is a lot of noise, for example changes to docs and tests which don't affect users, you can remove those.
+6. Leave the checkboxes below as is (latest release checked, pre-release unchecked).
+7. Click **Publish release**.
+8. Watch the release happen:
+   - In GitHub Actions: https://github.com/cfengine/cfengine-cli/actions
+   - And if all is well, the new version should appear on PyPI: https://pypi.org/project/cfengine/
+
+If it does not work, click the failing GitHub Actions and try to understand what went wrong.
+
+### Releasing using GitHub CLI (gh)
+
+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:
+
+```
+$ gh release create
+? Choose a tag Create a new tag
+? Tag name 0.2.0
+? Title (optional) 0.2.0
+? Release notes Write using generated notes as template
+? 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;
+
+https://github.com/cfengine/cfengine-cli/actions
+
+https://pypi.org/project/cfengine/
+
+## Rotating secrets
+
+The GH Action shown above requires a PyPI token to have access to publish new versions to PyPI.
+Sometimes, this needs to be rotated.
+[Log in](https://pypi.org/account/login/) to PyPI (need account access) and go to account settings:
+
+https://pypi.org/manage/account/
+
+Delete the old `cfengine-cli` token and generate a new one with the same name and correct scope (only access to `cfengine` project).
+Copy the token and paste it into the GitHub Secret named `PYPI_PASSWORD`.
+`PYPI_USERNAME` should be there already, you don't have to edit it, it is simply `__token__`.
+Don't store the token anywhere else - we generate new tokens if necessary.
+
+## Code formatting
+
+We use automated code formatters to ensure consistent code style / indentation.
+Please format Python code with [black](https://pypi.org/project/black/), and YAML and markdown files with [Prettier](https://prettier.io/).
+For simplicity's sake, we don't have a custom configuration, we use the tool's defaults.
+
+If your editor does not do this automatically, you can run these tools from the command line:
+
+```
+black . && prettier . --write
+```