commit b5320bf29a61527e52a4fd1be78d69c3844db558 Author: ManInDark <61268856+ManInDark@users.noreply.github.com> Date: Fri Jan 30 22:44:32 2026 +0100 almost empty diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..8ee9eaf --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +version: 2 +updates: + - package-ecosystem: "gomod" + directory: "/" + schedule: + interval: "weekly" + open-pull-requests-limit: 5 + + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + open-pull-requests-limit: 5 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..c570e84 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,198 @@ +name: CI + +on: + push: + branches: [main] + pull_request: + branches: [main] + schedule: + - cron: '0 3 * * *' # Nightly at 3 AM UTC + workflow_dispatch: + inputs: + run_conformance: + description: 'Run conformance tests' + required: false + default: 'false' + type: boolean + formae_version: + description: 'Formae version to test against (default: latest)' + required: false + default: 'latest' + type: string + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.25" + + - name: Set up Pkl + uses: pkl-community/setup-pkl@v0 + with: + pkl-version: 0.30.0 + + - name: Build + run: make build + + - name: Test + run: make test-unit + + lint: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.25" + + - name: golangci-lint + uses: golangci/golangci-lint-action@v8.0.0 + with: + version: latest + + pkl-validate: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Pkl + uses: pkl-community/setup-pkl@v0 + with: + pkl-version: 0.30.0 + + - name: Validate Pkl schemas + run: | + pkl eval formae-plugin.pkl --format json > /dev/null + echo "Manifest validated successfully" + + # Integration tests run against real infrastructure. + # This job is disabled by default - enable it after configuring credentials. + integration-tests: + needs: [build, lint] + runs-on: ubuntu-latest + # Disabled by default - remove this condition after configuring credentials + if: false + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.25" + + - name: Set up Pkl + uses: pkl-community/setup-pkl@v0 + with: + pkl-version: 0.30.0 + + # Configure credentials for your infrastructure here + # Example: + # env: + # MY_API_KEY: ${{ secrets.MY_API_KEY }} + + - name: Run integration tests + run: make test-integration + + # Conformance tests run against real cloud resources. + # This job is disabled by default - enable it after configuring credentials. + # + # To enable: + # 1. Configure credentials for your cloud provider (see below) + # 2. Implement scripts/ci/setup-credentials.sh for local credential verification + # 3. Implement scripts/ci/clean-environment.sh for test resource cleanup + # 4. Change the 'if' condition to enable the job + conformance-tests: + needs: [build, lint, pkl-validate] + runs-on: ubuntu-latest + # Disabled by default - change condition after configuring credentials: + # if: github.event_name == 'schedule' || github.event_name == 'push' || github.event.inputs.run_conformance == 'true' + if: ${{ github.event.inputs.run_conformance == 'true' }} + timeout-minutes: 60 + + strategy: + fail-fast: false + matrix: + # Test against these formae versions. Expand as needed: + # formae_version: ['0.78.0', '0.79.0', 'latest'] + formae_version: ['latest'] + + # Uncomment and configure for your cloud provider: + # permissions: + # id-token: write # Required for OIDC + # contents: read + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.25" + + - name: Set up Pkl + uses: pkl-community/setup-pkl@v0 + with: + pkl-version: 0.30.0 + + # ================================================================= + # CREDENTIAL SETUP - Uncomment and configure for your provider + # ================================================================= + + # AWS (OIDC - recommended) + # - name: Configure AWS Credentials + # uses: aws-actions/configure-aws-credentials@v4 + # with: + # aws-region: us-east-1 + # role-to-assume: arn:aws:iam::ACCOUNT_ID:role/ROLE_NAME + # role-session-name: ConformanceTests + + # Azure (OIDC - recommended) + # - name: Configure Azure Credentials + # uses: azure/login@v2 + # with: + # client-id: ${{ secrets.AZURE_CLIENT_ID }} + # tenant-id: ${{ secrets.AZURE_TENANT_ID }} + # subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} + + # GCP (OIDC - recommended) + # - name: Configure GCP Credentials + # uses: google-github-actions/auth@v2 + # with: + # workload_identity_provider: projects/PROJECT_ID/locations/global/workloadIdentityPools/POOL/providers/PROVIDER + # service_account: SA_NAME@PROJECT_ID.iam.gserviceaccount.com + + # OpenStack (secrets-based) + # - name: Configure OpenStack Credentials + # run: | + # echo "OS_AUTH_URL=${{ secrets.OS_AUTH_URL }}" >> $GITHUB_ENV + # echo "OS_USERNAME=${{ secrets.OS_USERNAME }}" >> $GITHUB_ENV + # echo "OS_PASSWORD=${{ secrets.OS_PASSWORD }}" >> $GITHUB_ENV + # echo "OS_PROJECT_ID=${{ secrets.OS_PROJECT_ID }}" >> $GITHUB_ENV + + # ================================================================= + + - name: Install plugin + run: make install + + - name: Run conformance tests + env: + FORMAE_TEST_RUN_ID: ${{ github.run_id }}-${{ github.run_attempt }} + run: | + # Use input version if provided, otherwise use matrix version + VERSION="${{ inputs.formae_version }}" + if [ "$VERSION" = "" ] || [ "$VERSION" = "latest" ]; then + VERSION="${{ matrix.formae_version }}" + fi + make conformance-test VERSION="$VERSION" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..12d0650 --- /dev/null +++ b/.gitignore @@ -0,0 +1,34 @@ +# Binaries +bin/ +dist/ +*.so +*.exe + +# Go +vendor/ + +# IDE +.idea/ +.vscode/ +*.swp +*.swo + +# OS +.DS_Store +Thumbs.db + +# Test coverage +coverage.out +coverage.html + +# GoReleaser +dist/ + +# Pkl +.pkl-cache/ +*.pkl-expected.pcf +PklProject.deps.json + +# Claude Code +CLAUDE.md +.claude/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..91c3cc3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to the Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2026 ManInDark + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..46e9462 --- /dev/null +++ b/Makefile @@ -0,0 +1,121 @@ +# Formae Plugin Makefile +# +# Targets: +# build - Build the plugin binary +# test - Run tests +# lint - Run linter +# clean - Remove build artifacts +# install - Build and install plugin locally (binary + schema + manifest) + +# Plugin metadata - extracted from formae-plugin.pkl +PLUGIN_NAME := $(shell pkl eval -x 'name' formae-plugin.pkl 2>/dev/null || echo "example") +PLUGIN_VERSION := $(shell pkl eval -x 'version' formae-plugin.pkl 2>/dev/null || echo "0.0.0") +PLUGIN_NAMESPACE := $(shell pkl eval -x 'namespace' formae-plugin.pkl 2>/dev/null || echo "EXAMPLE") + +# Build settings +GO := go +GOFLAGS := -trimpath +BINARY := $(PLUGIN_NAME) + +# Installation paths +# Plugin discovery expects lowercase directory names matching the plugin name +PLUGIN_BASE_DIR := $(HOME)/.pel/formae/plugins +INSTALL_DIR := $(PLUGIN_BASE_DIR)/$(PLUGIN_NAME)/v$(PLUGIN_VERSION) + +.PHONY: all build test test-unit test-integration lint verify-schema clean install help clean-environment conformance-test conformance-test-crud conformance-test-discovery + +all: build + +## build: Build the plugin binary +build: + $(GO) build $(GOFLAGS) -o bin/$(BINARY) . + +## test: Run all tests +test: + $(GO) test -v ./... + +## test-unit: Run unit tests only (tests with //go:build unit tag) +test-unit: + $(GO) test -v -tags=unit ./... + +## test-integration: Run integration tests (requires cloud credentials) +## Add tests with //go:build integration tag +test-integration: + $(GO) test -v -tags=integration ./... + +## lint: Run golangci-lint +lint: + golangci-lint run + +## verify-schema: Validate PKL schema files +## Checks that schema files are well-formed and follow formae conventions. +verify-schema: + $(GO) run github.com/platform-engineering-labs/formae/pkg/plugin/testutil/cmd/verify-schema --namespace $(PLUGIN_NAMESPACE) ./schema/pkl + +## clean: Remove build artifacts +clean: + rm -rf bin/ dist/ + +## install: Build and install plugin locally (binary + schema + manifest) +## Installs to ~/.pel/formae/plugins//v/ +## Removes any existing versions of the plugin first to ensure clean state. +install: build + @echo "Installing $(PLUGIN_NAME) v$(PLUGIN_VERSION) (namespace: $(PLUGIN_NAMESPACE))..." + @rm -rf $(PLUGIN_BASE_DIR)/$(PLUGIN_NAME) + @mkdir -p $(INSTALL_DIR)/schema/pkl + @cp bin/$(BINARY) $(INSTALL_DIR)/$(BINARY) + @cp -r schema/pkl/* $(INSTALL_DIR)/schema/pkl/ + @cp formae-plugin.pkl $(INSTALL_DIR)/ + @echo "Installed to $(INSTALL_DIR)" + @echo " - Binary: $(INSTALL_DIR)/$(BINARY)" + @echo " - Schema: $(INSTALL_DIR)/schema/pkl/" + @echo " - Manifest: $(INSTALL_DIR)/formae-plugin.pkl" + +## help: Show this help message +help: + @echo "Available targets:" + @grep -E '^## ' $(MAKEFILE_LIST) | sed 's/## / /' + +## clean-environment: Clean up test resources in cloud environment +## Called before and after conformance tests. Edit scripts/ci/clean-environment.sh +## to configure for your provider. +clean-environment: + @./scripts/ci/clean-environment.sh + +## conformance-test: Run all conformance tests (CRUD + discovery) +## Usage: make conformance-test [VERSION=0.80.0] [TEST=s3-bucket] +## Downloads the specified formae version (or latest) and runs conformance tests. +## Calls clean-environment before and after tests. +## +## Parameters: +## VERSION - Formae version to test against (default: latest) +## TEST - Filter tests by name pattern (e.g., TEST=s3-bucket) +conformance-test: conformance-test-crud conformance-test-discovery + +## conformance-test-crud: Run only CRUD lifecycle tests +## Usage: make conformance-test-crud [VERSION=0.80.0] [TEST=s3-bucket] +conformance-test-crud: install + @echo "Pre-test cleanup..." + @./scripts/ci/clean-environment.sh || true + @echo "" + @echo "Running CRUD conformance tests..." + @FORMAE_TEST_FILTER="$(TEST)" FORMAE_TEST_TYPE=crud ./scripts/run-conformance-tests.sh $(VERSION); \ + TEST_EXIT=$$?; \ + echo ""; \ + echo "Post-test cleanup..."; \ + ./scripts/ci/clean-environment.sh || true; \ + exit $$TEST_EXIT + +## conformance-test-discovery: Run only discovery tests +## Usage: make conformance-test-discovery [VERSION=0.80.0] [TEST=s3-bucket] +conformance-test-discovery: install + @echo "Pre-test cleanup..." + @./scripts/ci/clean-environment.sh || true + @echo "" + @echo "Running discovery conformance tests..." + @FORMAE_TEST_FILTER="$(TEST)" FORMAE_TEST_TYPE=discovery ./scripts/run-conformance-tests.sh $(VERSION); \ + TEST_EXIT=$$?; \ + echo ""; \ + echo "Post-test cleanup..."; \ + ./scripts/ci/clean-environment.sh || true; \ + exit $$TEST_EXIT diff --git a/README.md b/README.md new file mode 100644 index 0000000..9724e4d --- /dev/null +++ b/README.md @@ -0,0 +1,134 @@ +> **⚠️ Do not clone this repository directly!** +> +> Use `formae plugin init` to create your plugin. This command scaffolds a new +> plugin from this template with proper naming and configuration. +> +> ```bash +> formae plugin init my-plugin +> ``` + +--- + +## Setup Checklist + +*Remove this section and the warning above after completing setup.* + +After creating your plugin with `formae plugin init`, complete these steps: + +- [X] Update `formae-plugin.pkl` with your plugin metadata (name, namespace, description) +- [X] Define your resource types in `schema/pkl/*.pkl` +- [ ] Implement CRUD operations in `plugin.go` +- [ ] Update test fixtures in `testdata/*.pkl` to use your resources +- [ ] Update this README (replace title, description, resources table, etc.) +- [ ] Set up local credentials for testing +- [ ] Run conformance tests locally: `make conformance-test` +- [ ] Configure CI credentials in `.github/workflows/ci.yml` (optional) +- [ ] Remove this checklist section and the warning box above + +For detailed guidance, see the [Plugin SDK Documentation](https://docs.formae.io/plugin-sdk). + +--- + +# Example Plugin for formae + +*TODO: Update title and description for your plugin* + +Example Formae plugin template - replace this with a description of what your plugin manages. + +## Installation + +```bash +# Install the plugin +make install +``` + +## Supported Resources + +*TODO: Document your supported resource types* + +| Resource Type | Description | +| ------------------------------ | ----------------------------------------------------- | +| `PROXMOX::Service::Resource` | Example resource (replace with your actual resources) | + +## Configuration + +Configure a target in your Forma file: + +```pkl +new formae.Target { + label = "my-target" + namespace = "PROXMOX" // TODO: Update with your namespace + config = new Mapping { + ["region"] = "us-east-1" + // TODO: Add your provider-specific configuration + } +} +``` + +## Examples + +See the [examples/](examples/) directory for usage examples. + +```bash +# Evaluate an example +formae eval examples/basic/main.pkl + +# Apply resources +formae apply --mode reconcile --watch examples/basic/main.pkl +``` + +## Development + +### Prerequisites + +- Go 1.25+ +- [Pkl CLI](https://pkl-lang.org/main/current/pkl-cli/index.html) +- Cloud provider credentials (for conformance testing) + +### Building + +```bash +make build # Build plugin binary +make test # Run unit tests +make lint # Run linter +make install # Build + install locally +``` + +### Local Testing + +```bash +# Install plugin locally +make install + +# Start formae agent +formae agent start + +# Apply example resources +formae apply --mode reconcile --watch examples/basic/main.pkl +``` + +### Conformance Testing + +Conformance tests validate your plugin's CRUD lifecycle using the test fixtures in `testdata/`: + +| File | Purpose | +| ------------------------ | -------------------------------- | +| `resource.pkl` | Initial resource creation | +| `resource-update.pkl` | In-place update (mutable fields) | +| `resource-replace.pkl` | Replacement (createOnly fields) | + +The test harness sets `FORMAE_TEST_RUN_ID` for unique resource naming between runs. + +```bash +make conformance-test # Latest formae version +make conformance-test VERSION=0.80.0 # Specific version +``` + +The `scripts/ci/clean-environment.sh` script cleans up test resources. It runs before and after conformance tests and should be idempotent. + +## Licensing + +Plugins are independent works and may be licensed under any license of the author’s choosing. + +See the formae plugin policy: +