@johnbillion/plugin-infrastructure 2.0.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 John Blackbourn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+# Plugin Infrastructure
+
+Reusable infrastructure relating to testing, building, linting, deploying, and verifying my WordPress plugins (see the "Used by" section below).
+
+Provided without support, warranty, guarantee, backwards compatibility, fitness for purpose, resilience, safety, sanity, beauty, or support for any plugin that isn't one of mine.
+
+## Used by
+
+* [Extended CPTs](https://github.com/johnbillion/extended-cpts)
+* [Query Monitor](https://github.com/johnbillion/query-monitor)
+* [User Switching](https://github.com/johnbillion/user-switching)
+* [WP Crontrol](https://github.com/johnbillion/wp-crontrol)
+
+## Features
+
+* Acceptance testing
+* Integration testing
+* Coding standards testing
+* Static analysis
+* Workflow file linting
+* Deployment to WordPress.org
+* Build provenance attestation
+* SLSA v1.0 Build level 3 facilitation
+* Ongoing supply chain assurance
+
+Plugins that use this library all use a similar setup in their workflows:
+
+## Acceptance testing
+
+* Push to a main branch or pull request, `acceptance-tests.yml` fires
+	* Constructs a matrix of supported PHP and WordPress versions
+	* Uses `reusable-acceptance-tests.yml`
+		* Installs PHP and WordPress
+		* Runs the build
+		* Runs acceptance testing with Playwright
+
+## Integration testing
+
+* Push to a main branch or pull request, `integration-tests.yml` fires
+	* Constructs a matrix of supported PHP and WordPress versions
+	* Uses `reusable-integration-tests.yml`
+		* Installs PHP and WordPress
+		* Runs the build
+		* Runs integration testing with PHPUnit, once for:
+			* Single site
+			* Multisite
+
+## Coding standards testing
+
+* Push to a main branch or pull request, `coding-standards.yml` fires
+	* Uses `reusable-coding-standards.yml`
+		* Installs PHP
+		* Checks coding standards with PHPCS
+
+## Static analysis
+
+* Push to a main branch or pull request, `static-analysis.yml` fires
+	* Constructs a matrix of supported PHP versions
+	* Uses `reusable-static-analysis.yml`
+		* Installs PHP
+		* Runs static analysis with PHPStan
+
+## Workflow file linting
+
+* Push to a main branch or pull request, `lint-workflows.yml` fires
+	* Uses `reusable-workflow-lint.yml`
+		* Lints all GitHub Actions workflow files for correctness and security using:
+			* ActionLint
+			* Octoscan
+			* Zizmor
+			* Poutine
+		* Uploads results to GitHub Code Scanning
+
+## Deployment
+
+### WordPress.org
+
+* Push to the `release` branch, `build.yml` fires
+	* Uses `reusable-build.yml`
+		* Runs the build
+		* Reads version from `package.json`
+		* Commits built files
+		* Pushes to `release-$VERSION`
+		* Tags the new version and pushes
+		* Creates a draft release
+* Publish the release, `deploy-tag.yml` fires
+	* Uses `reusable-deploy-tag.yml`
+		* Creates a changelog entry from the release notes
+		* Uses `10up/action-wordpress-plugin-deploy`
+			* Deploys the new version to WordPress.org
+			* Generates a zip file
+		* Uses `johnbillion/action-wordpress-plugin-attestation`
+			* Fetches the zip from WordPress.org
+			* Generates a build provenance attestation if the zip contents matches the build
+
+### Packagist
+
+* Happens automatically with each release via the auto-update mechanism on Packagist.org.
+* Always identical to the version deployed to WordPress.org
+
+### GitHub
+
+* Automatically closes the completed milestone for each release
+* Automatically creates the next major, minor, and patch release milestones after each release
+
+## Supply chain assurance
+
+* Hourly scheduled workflow runs in `verify-distribution.yml`
+	* Uses `reusable-verify-distribution.yml`
+		* Verifies the provenance of the plugin on WordPress.org
+
+## Licence
+
+MIT

package/dist/acceptance/global-utils.d.ts

@@ -0,0 +1,22 @@
+export interface GlobalUtilsOptions {
+    baseURL: string;
+    pluginSlug: string;
+}
+export declare class GlobalUtils {
+    private baseURL;
+    private pluginSlug;
+    constructor(options: GlobalUtilsOptions);
+    /**
+     * Run a WP-CLI command
+     *
+     * @throws Error if the command fails
+     */
+    runWPCLICommand(command: string): string;
+    installWordPress(): void;
+    /**
+     * Check if current WordPress version meets minimum requirement
+     *
+     * @throws Error if unable to parse WordPress version
+     */
+    isWordPressVersionAtLeast(minVersion: number): boolean;
+}

package/dist/acceptance/global-utils.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GlobalUtils = void 0;
+class GlobalUtils {
+    constructor(options) {
+        this.baseURL = options.baseURL;
+        this.pluginSlug = options.pluginSlug;
+    }
+    /**
+     * Run a WP-CLI command
+     *
+     * @throws Error if the command fails
+     */
+    runWPCLICommand(command) {
+        const { execSync } = require('child_process');
+        const fullCommand = `docker compose exec --user wp_php wpcli wp --url="${this.baseURL}" ${command}`;
+        try {
+            const stdout = execSync(fullCommand, { encoding: 'utf8', cwd: process.cwd() });
+            return stdout.trim();
+        }
+        catch (error) {
+            throw new Error(`WP-CLI command failed: ${error.message}`);
+        }
+    }
+    installWordPress() {
+        // Install WordPress:
+        this.runWPCLICommand('db reset --yes');
+        this.runWPCLICommand(`core install --title="${this.pluginSlug}" --admin_user="admin" --admin_password="password" --admin_email="admin@example.com" --skip-email`);
+        // Set a predictable permalink structure:
+        this.runWPCLICommand('rewrite structure "/%postname%/"');
+        // Activate the plugin under test:
+        this.runWPCLICommand(`plugin activate ${this.pluginSlug}`);
+    }
+    /**
+     * Check if current WordPress version meets minimum requirement
+     *
+     * @throws Error if unable to parse WordPress version
+     */
+    isWordPressVersionAtLeast(minVersion) {
+        const wpVersion = this.runWPCLICommand('core version');
+        // Extract major.minor version from WordPress version string
+        // Examples: "6.2.1" -> "6.2", "6.9-alpha-60684" -> "6.9"
+        const versionMatch = wpVersion.match(/^(\d+\.\d+)/);
+        if (!versionMatch) {
+            throw new Error(`Unable to parse WordPress version: ${wpVersion}`);
+        }
+        const currentVersion = parseFloat(versionMatch[1]);
+        return currentVersion >= minVersion;
+    }
+}
+exports.GlobalUtils = GlobalUtils;

package/dist/acceptance/index.d.ts

@@ -0,0 +1 @@
+export { GlobalUtils, GlobalUtilsOptions } from './global-utils';

package/dist/acceptance/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GlobalUtils = void 0;
+var global_utils_1 = require("./global-utils");
+Object.defineProperty(exports, "GlobalUtils", { enumerable: true, get: function () { return global_utils_1.GlobalUtils; } });

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@johnbillion/plugin-infrastructure",
+	"version": "2.0.0-beta.1",
+	"description": "Shared utilities for WordPress plugin development",
+	"license": "MIT",
+	"author": "John Blackbourn",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/johnbillion/plugin-infrastructure.git"
+	},
+	"homepage": "https://github.com/johnbillion/plugin-infrastructure",
+	"exports": {
+		"./acceptance": {
+			"require": "./dist/acceptance/index.js",
+			"types": "./dist/acceptance/index.d.ts"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"engines": {
+		"node": ">=18"
+	},
+	"scripts": {
+		"build": "tsc",
+		"prepublishOnly": "npm run build"
+	},
+	"devDependencies": {
+		"@types/node": "^24.3.0",
+		"typescript": "^5.9.2"
+	}
+}