diff --git a/.github/workflows/qa.yml b/.github/workflows/qa.yml index fa169d0..fb2b98b 100644 --- a/.github/workflows/qa.yml +++ b/.github/workflows/qa.yml @@ -150,6 +150,7 @@ jobs: with: php-version: "8.1" tools: composer + coverage: pcov - name: Get composer cache directory id: composer-cache @@ -176,7 +177,10 @@ jobs: curl -sL https://raw.githubusercontent.com/wp-cli/scaffold-command/main/templates/install-wp-tests.sh -o /tmp/install-wp-tests.sh bash /tmp/install-wp-tests.sh wordpress_test root root 127.0.0.1 latest - - name: Run PHPUnit + - name: Run PHPUnit with coverage gate env: WP_TESTS_DIR: /tmp/wordpress-tests-lib - run: vendor/bin/phpunit --configuration phpunit.xml.dist + MIN_LINE_COVERAGE: "80" + run: | + chmod +x scripts/check-plugin-coverage.sh + ./scripts/check-plugin-coverage.sh diff --git a/CHANGELOG.md b/CHANGELOG.md index b0443ac..416d4aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,9 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- PHPUnit pcov coverage gate (80% line coverage on `rank-math-api-manager.php`) in QA workflow. +- Risk-based integration tests: REST permissions, telemetry privacy, uninstall cleanup, GitHub updater validation, meta auth. + ### Changed - Align GitHub updater `tested` metadata with plugin header and `readme.txt` (7.1). +- TASK-005: Main plugin file included in PHPCS ruleset after WPCS cleanup. ### Fixed diff --git a/docs/architecture/long-run-state.md b/docs/architecture/long-run-state.md index 932f010..0596063 100644 --- a/docs/architecture/long-run-state.md +++ b/docs/architecture/long-run-state.md @@ -1,4 +1,4 @@ -# Long-run mission state — v1.0.9.2 verification closeout +# Long-run mission state — coverage + PHPCS quality **Last updated:** 2026-11-05 @@ -6,62 +6,46 @@ ## Mission -- **Goal:** Execute the approved v1.0.9.2 upgrade plan (icons, page support, CI/QA, packaging alignment, verification docs). Re-verify against `main` before changing product code; land only gaps found during verification. +- **Goal:** PHPCS on main plugin file (TASK-005) + PHPUnit coverage gate (80% lines on `rank-math-api-manager.php`) with risk-based integration tests. - **execution_mode:** `long-run` -- **Success signals:** All plan acceptance criteria evidenced on branch; local QA green; GitHub QA workflow green on PR; honest mission gate when product work was already shipped as `v1.0.9.2`. -- **Notes:** Parent-orchestrated in this chat (no nested `parent-orchestrator` subagent). Product features and release tag `v1.0.9.2` already exist on `main`; this run focuses on reconciliation, PHPCS hygiene, and MAT artifact closeout. - -## Scope / hard constraints / non-goals - -- **Hard constraints:** No force-push; no secrets in git; do not re-release `v1.0.9.2` without operator GO; preserve GitHub-only updater behavior. -- **Non-goals:** Re-implementing icons/pages/CI from scratch; TASK-005 main-file PHPCS baseline; unrelated MAT env-ignore work. +- **Branch:** `feat/coverage-phpcs-quality-mission` +- **Spec:** `specs/plugin-coverage-phpcs-mission.md` ## Slice preflight decision (active) - **execution_mode:** `builder_plus_verifier` -- **execution_rationale:** Small PHPCS fix plus documentation/MAT state updates; builder implements, verifier read-only checks. +- **execution_rationale:** PHPCS mass-format plus new tests and CI; builder implements, verifier validates read-only. ## Ordered slice queue -| # | Slice id | Summary | execution_mode | Status | -|---|----------|---------|----------------|--------| -| 1 | `v1092-verify-reconcile` | Re-verify plan vs tree; fix PHPCS in `TextdomainLoadingTest`; align updater `tested` with readme `7.1` if drift | `builder_plus_verifier` | `done` | -| 2 | `v1092-mat-closeout` | Update `docs/current-plan.md`, session summary, serialize verify/build handoffs | `inline` | `done` | +| # | Slice id | Summary | Status | +|---|----------|---------|--------| +| 1 | `task-005-phpcs` | phpcbf + WPCS fixes; remove PHPCS exclude; green PHPCS | `in_progress` | +| 2 | `coverage-ci-tests` | pcov, coverage script, integration tests, qa.yml gate | `pending` | ## Active slice -- **Slice id:** _(none — mission complete)_ -- **Pointer:** `docs/session-summary.md` - -## Completed slices - -| Slice id | Outcome | Notes | -|----------|---------|-------| -| `v1092-verify-reconcile` | PASS | PR #8 merged `56042d9` | -| _(product v1.0.9.2)_ | Shipped on `main` | Tag `v1.0.9.2`, PR #4 merged 2026-06-24 | +- **Slice id:** `task-005-phpcs` +- **Pointer:** `docs/current-plan.md` ## Continuation policy -- After slice 1 PASS and PR merge (if code changes), run slice 2 MAT closeout and classify `mission_complete`. +- After slice 1: commit, PR, merge when CI green. +- After slice 2: commit, PR, merge when CI green including coverage. ## Stop-reason policy | Stop reason | Meaning | |-------------|---------| -| `mission_complete` | Verification done; gaps fixed or documented; PR merged when required. | -| `hard_blocker` | CI/env cannot run; tests fail without root cause. | -| `approval_needed` | New release or scope beyond verification. | -| `planning_gap` | — | -| `unexpected_termination` | Abnormal end. | - ---- +| `mission_complete` | Both slices merged; QA green | +| `hard_blocker` | Cannot run tests or CI | +| `approval_needed` | Scope beyond spec | -## Parent mission gate compliance (per verifier PASS) +## Parent mission gate compliance -- [x] Gate questions answered or one explicit stop reason recorded. -- [x] Slice PASS is not mislabeled as mission success while slice 2 remains. +- [ ] Slice 1 PASS not labeled as full mission complete while slice 2 pending. -## Current stop / continuation (living) +## Current stop / continuation -- **Last classified stop reason:** `mission_complete` -- **Continue:** `no` +- **Continue:** `yes` +- **Last classified stop reason:** _(none — mission active)_ diff --git a/docs/current-plan.md b/docs/current-plan.md index f39a058..66f284b 100644 --- a/docs/current-plan.md +++ b/docs/current-plan.md @@ -1,54 +1,27 @@ -# Current plan — v1.0.9.2 verification reconcile (slice 1) +# Current plan — slice `coverage-ci-tests` -**Status:** Active orchestration slice -**Tier:** standard (execution projection) -**Contract:** v0.1 — [`.mat/docs/plan-contract.md`](../.mat/docs/plan-contract.md) -**Preflight:** `builder_plus_verifier` -**Last updated:** 2026-11-05 -**Branch:** `chore/v1.0.9.2-mat-verification-closeout` -**Mission:** `docs/architecture/long-run-state.md` slice `v1092-verify-reconcile` +**Tier:** standard +**Branch:** `feat/coverage-phpcs-quality-mission` +**Spec:** `specs/plugin-coverage-phpcs-mission.md` ---- +## Goal -## Task - -Re-verify the approved v1.0.9.2 plan against `main`. Product scope (icons, pages, QA workflow, packaging script, integration tests, verification matrix) is **already shipped** at tag `v1.0.9.2`. This slice lands only verified gaps: - -1. PHPCS doc-comment capitalization in `tests/integration/TextdomainLoadingTest.php` (local `vendor/bin/phpcs` currently fails). -2. Align GitHub updater `tested` metadata with plugin header / `readme.txt` (`7.1`, not `6.9.3`). - -## Context - -| Anchor | Role | -|--------|------| -| Approved user plan | Icons, page, CI, packaging, docs | -| `main` @ `62029d8` | Contains 1.0.9.2 product code; release published | -| `scripts/run-phpunit-local.sh` | Local PHPUnit mirror of `qa.yml` | -| `.github/workflows/qa.yml` | Authoritative CI gate | +Add pcov coverage gate (80% lines on main file), risk-based integration tests, and CI enforcement in `qa.yml`. ## Implementation steps -- [wip] **Step 1 — Fix PHPCS in textdomain integration test** - - Capitalize short descriptions on affected `@` docblocks in `tests/integration/TextdomainLoadingTest.php`. - -- [] **Step 2 — Align updater tested version** - - Set `'tested' => '7.1'` in `check_for_update()` and `plugin_info()` response arrays in `rank-math-api-manager.php`. - -- [] **Step 3 — Validation** - - `vendor/bin/phpcs --standard=phpcs.xml.dist` - - `./scripts/run-phpunit-local.sh` - - `./scripts/package-plugin.sh` (confirm icons in ZIP) - - `bash scripts/phase1-verify.sh` - -- [] **Step 4 — Handoff** - - `build-result.md` per workflow artifact contract. +- [x] Configure `phpunit.xml.dist` coverage include for `rank-math-api-manager.php` +- [x] Add `scripts/check-plugin-coverage.sh` threshold script +- [x] Extend `qa.yml` PHPUnit job with pcov + coverage gate +- [x] Add integration tests (permissions, telemetry, uninstall, updater, meta auth, admin notices smoke) +- [x] PHPCS on new test files ## Acceptance criteria -- [] **AC-1:** PHPCS exits 0 on the repository standard (`phpcs.xml.dist`). -- [] **AC-2:** PHPUnit integration suite passes (WooCommerce skip allowed). -- [] **AC-3:** Updater `tested` fields match `7.1` in both update transient and plugin info paths. -- [] **AC-4:** Re-verification documents that icons, page support, QA workflow, and packaging script already satisfy the approved v1.0.9.2 plan on `main` (no duplicate feature work). +- [x] `./scripts/run-phpunit-local.sh` passes (25 tests, 1 skipped WC) +- [ ] `./scripts/check-plugin-coverage.sh` ≥80% (CI authoritative when local pcov absent) +- [x] `vendor/bin/phpcs --standard=phpcs.xml.dist` passes +- [ ] GitHub QA workflow green on PR ## Verification plan @@ -56,21 +29,16 @@ Re-verify the approved v1.0.9.2 plan against `main`. Product scope (icons, pages | Phase | Command | Loop until pass | |-------|---------|-----------------| -| PHPCS | `vendor/bin/phpcs --standard=phpcs.xml.dist` | Fix until exit 0 | -| PHPUnit | `./scripts/run-phpunit-local.sh` | Fix until exit 0 | -| Package | `./scripts/package-plugin.sh` && unzip -l rank-math-api-manager.zip \| grep icon | Icons present | -| Phase1 | `bash scripts/phase1-verify.sh` | Exit 0 | +| PHPUnit | `./scripts/run-phpunit-local.sh` | Loop until pass | +| PHPCS | `vendor/bin/phpcs --standard=phpcs.xml.dist` | Loop until pass | +| Coverage | `./scripts/check-plugin-coverage.sh` | Loop until pass in CI | ### Global validation commands (before handoff) -1. `bash scripts/doctor.sh` -2. `bash scripts/phase1-verify.sh` -3. `gh act -j phpcs --container-architecture linux/amd64` (optional pre-push if Docker healthy) +1. `vendor/bin/phpcs --standard=phpcs.xml.dist` +2. `./scripts/run-phpunit-local.sh` +3. GitHub `gh pr checks` on PR ## Amendments -- 2026-11-05T10:05:00Z — orchestrator — Slice scoped to verification gaps after confirming v1.0.9.2 already released on GitHub. - -## Recommended Next Command - -After build handoff: `/mat-review` (verifier) with `docs/current-plan.md` and `build-result.md`. +- 2026-11-05T12:00:00Z — orchestrator — Slice 2 plan projected after TASK-005 commit. diff --git a/phpcs.xml.dist b/phpcs.xml.dist index 17b1241..89873cb 100644 --- a/phpcs.xml.dist +++ b/phpcs.xml.dist @@ -4,8 +4,6 @@ . - - rank-math-api-manager\.php */vendor/* */.git/* */.github/* diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 5f56578..3981f31 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -15,4 +15,12 @@ tests/integration + + + rank-math-api-manager.php + + + + + diff --git a/rank-math-api-manager.php b/rank-math-api-manager.php index ca06ac0..57ce239 100644 --- a/rank-math-api-manager.php +++ b/rank-math-api-manager.php @@ -13,6 +13,9 @@ * Requires at least: 5.0 * Tested up to: 7.1 * Requires PHP: 7.4 + * + * @package Rank_Math_API_Manager + * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or @@ -28,11 +31,11 @@ exit; } -// Define plugin constants -define('RANK_MATH_API_VERSION', '1.0.9.2'); -define('RANK_MATH_API_PLUGIN_FILE', __FILE__); -define('RANK_MATH_API_PLUGIN_DIR', plugin_dir_path(__FILE__)); -define('RANK_MATH_API_PLUGIN_URL', plugin_dir_url(__FILE__)); +// Define plugin constants. +define( 'RANK_MATH_API_VERSION', '1.0.9.2' ); +define( 'RANK_MATH_API_PLUGIN_FILE', __FILE__ ); +define( 'RANK_MATH_API_PLUGIN_DIR', plugin_dir_path( __FILE__ ) ); +define( 'RANK_MATH_API_PLUGIN_URL', plugin_dir_url( __FILE__ ) ); /** * Main Plugin Class @@ -40,7 +43,7 @@ * @since 1.0.7 */ class Rank_Math_API_Manager_Extended { - + /** * Plugin instance * @@ -61,9 +64,9 @@ class Rank_Math_API_Manager_Extended { * @var array */ private $github_repo = array( - 'owner' => 'devora-as', - 'repo' => 'rank-math-api-manager', - 'api_url' => 'https://api.github.com/repos/devora-as/rank-math-api-manager/releases/latest' + 'owner' => 'devora-as', + 'repo' => 'rank-math-api-manager', + 'api_url' => 'https://api.github.com/repos/devora-as/rank-math-api-manager/releases/latest', ); /** @@ -79,7 +82,7 @@ class Rank_Math_API_Manager_Extended { * @return Rank_Math_API_Manager_Extended */ public static function get_instance() { - if (null === self::$instance) { + if ( null === self::$instance ) { self::$instance = new self(); } return self::$instance; @@ -102,13 +105,13 @@ private function init_plugin_data() { if ( ! function_exists( 'get_plugin_data' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin.php'; } - + $this->plugin_data = get_plugin_data( RANK_MATH_API_PLUGIN_FILE, false, false ); if ( ! is_array( $this->plugin_data ) ) { $this->plugin_data = array(); } - - // Initialize GitHub token for higher rate limits + + // Initialize GitHub token for higher rate limits. $this->init_github_auth(); } @@ -118,10 +121,10 @@ private function init_plugin_data() { * @since 1.0.8 */ private function init_github_auth() { - // Check for GitHub token in WordPress options (secure storage) + // Check for GitHub token in WordPress options (secure storage). $this->github_token = get_option( 'rank_math_api_github_token' ); - - // If no token, check for environment variable + + // If no token, check for environment variable. if ( ! $this->github_token && defined( 'RANK_MATH_GITHUB_TOKEN' ) ) { $this->github_token = RANK_MATH_GITHUB_TOKEN; } @@ -131,31 +134,31 @@ private function init_github_auth() { * Initialize WordPress hooks */ private function init_hooks() { - add_action( 'init', [ $this, 'load_textdomain' ], 0 ); - - // Check dependencies first - add_action( 'plugins_loaded', [ $this, 'check_dependencies' ], 5 ); - - // Monitor plugin activation/deactivation - add_action( 'activated_plugin', [ $this, 'on_plugin_activated' ] ); - add_action( 'deactivated_plugin', [ $this, 'on_plugin_deactivated' ] ); - add_action( 'admin_init', [ $this, 'handle_notice_actions' ] ); - add_action( 'admin_init', [ $this, 'register_plugin_settings' ] ); - add_action( 'rank_math_api_telemetry_heartbeat', [ $this, 'send_scheduled_telemetry' ] ); - - // Auto-update system hooks - add_filter( 'pre_set_site_transient_update_plugins', [ $this, 'check_for_update' ] ); - add_filter( 'plugins_api', [ $this, 'plugin_info' ], 10, 3 ); - - // Only register core functionality hooks if dependencies are met + add_action( 'init', array( $this, 'load_textdomain' ), 0 ); + + // Check dependencies first. + add_action( 'plugins_loaded', array( $this, 'check_dependencies' ), 5 ); + + // Monitor plugin activation/deactivation. + add_action( 'activated_plugin', array( $this, 'on_plugin_activated' ) ); + add_action( 'deactivated_plugin', array( $this, 'on_plugin_deactivated' ) ); + add_action( 'admin_init', array( $this, 'handle_notice_actions' ) ); + add_action( 'admin_init', array( $this, 'register_plugin_settings' ) ); + add_action( 'rank_math_api_telemetry_heartbeat', array( $this, 'send_scheduled_telemetry' ) ); + + // Auto-update system hooks. + add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_for_update' ) ); + add_filter( 'plugins_api', array( $this, 'plugin_info' ), 10, 3 ); + + // Only register core functionality hooks if dependencies are met. if ( $this->are_dependencies_met() ) { - add_action( 'rest_api_init', [ $this, 'register_meta_fields' ] ); - add_action( 'rest_api_init', [ $this, 'register_api_routes' ] ); - add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_admin_scripts' ] ); + add_action( 'rest_api_init', array( $this, 'register_meta_fields' ) ); + add_action( 'rest_api_init', array( $this, 'register_api_routes' ) ); + add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); } - + // Admin notices and operator actions. - add_action( 'admin_notices', [ $this, 'render_admin_notices' ] ); + add_action( 'admin_notices', array( $this, 'render_admin_notices' ) ); } /** @@ -191,12 +194,12 @@ public function are_dependencies_met() { private function get_required_plugins() { return array( array( - 'name' => 'Rank Math SEO', - 'file' => 'seo-by-rank-math/rank-math.php', - 'version' => '1.0.0', - 'url' => 'https://wordpress.org/plugins/seo-by-rank-math/', - 'description' => 'Required for SEO metadata management' - ) + 'name' => 'Rank Math SEO', + 'file' => 'seo-by-rank-math/rank-math.php', + 'version' => '1.0.0', + 'url' => 'https://wordpress.org/plugins/seo-by-rank-math/', + 'description' => 'Required for SEO metadata management', + ), ); } @@ -309,14 +312,14 @@ public function sanitize_rank_math_focus_keyword( $value ) { * Check if a specific plugin is active * * @since 1.0.7 - * @param string $plugin_file Plugin file path + * @param string $plugin_file Plugin file path. * @return bool True if plugin is active */ private function is_plugin_active( $plugin_file ) { if ( ! function_exists( 'is_plugin_active' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin.php'; } - + return is_plugin_active( $plugin_file ); } @@ -327,9 +330,9 @@ private function is_plugin_active( $plugin_file ) { */ public function check_dependencies() { $dependencies_met = $this->are_dependencies_met(); - $current_status = get_option( 'rank_math_api_dependencies_status', false ); - - // Update status if it changed + $current_status = get_option( 'rank_math_api_dependencies_status', false ); + + // Update status if it changed. if ( $current_status !== $dependencies_met ) { update_option( 'rank_math_api_dependencies_status', $dependencies_met, false ); } @@ -840,7 +843,7 @@ private function render_admin_notice( array $notice ) { echo '
'; // Allow details/summary for expandable content (e.g. folder reinstall steps); WP 5.0 post list does not include them. - $allowed = wp_kses_allowed_html( 'post' ); + $allowed = wp_kses_allowed_html( 'post' ); $allowed['details'] = array( 'class' => true ); $allowed['summary'] = array(); $allowed['div'] = array_merge( isset( $allowed['div'] ) ? $allowed['div'] : array(), array( 'class' => true ) ); @@ -940,17 +943,17 @@ private function get_folder_name_notice_markup() { $current_directory = $this->get_plugin_directory_slug(); $releases_url = 'https://github.com/Devora-AS/rank-math-api-manager/releases'; - $summary = esc_html__( 'Show reinstall steps', 'rank-math-api-manager' ); - $step1 = esc_html__( 'Deactivate the plugin.', 'rank-math-api-manager' ); - $step2 = esc_html__( 'Delete it (Plugins → Deactivate → Delete).', 'rank-math-api-manager' ); - $step3 = sprintf( + $summary = esc_html__( 'Show reinstall steps', 'rank-math-api-manager' ); + $step1 = esc_html__( 'Deactivate the plugin.', 'rank-math-api-manager' ); + $step2 = esc_html__( 'Delete it (Plugins → Deactivate → Delete).', 'rank-math-api-manager' ); + $step3 = sprintf( /* translators: %s: link to GitHub Releases */ esc_html__( 'Download the latest rank-math-api-manager.zip from %s.', 'rank-math-api-manager' ), '' . esc_html__( 'GitHub Releases', 'rank-math-api-manager' ) . '' ); - $step4 = esc_html__( 'Plugins → Add New → Upload Plugin → choose the ZIP → Install Now → Activate.', 'rank-math-api-manager' ); + $step4 = esc_html__( 'Plugins → Add New → Upload Plugin → choose the ZIP → Install Now → Activate.', 'rank-math-api-manager' ); // Escape translatable parts so translations cannot inject HTML (translation safety). - $after = esc_html( __( 'The plugin will then be in wp-content/plugins/', 'rank-math-api-manager' ) ) + $after = esc_html( __( 'The plugin will then be in wp-content/plugins/', 'rank-math-api-manager' ) ) . 'rank-math-api-manager' . esc_html( __( '/.', 'rank-math-api-manager' ) ); @@ -1003,7 +1006,7 @@ private function get_telemetry_notice_markup() { * Check if a plugin is installed (but not necessarily active) * * @since 1.0.7 - * @param string $plugin_file Plugin file path + * @param string $plugin_file Plugin file path. * @return bool True if plugin is installed */ private function is_plugin_installed( $plugin_file ) { @@ -1019,13 +1022,13 @@ private function is_plugin_installed( $plugin_file ) { */ private function is_rank_math_configured() { // Basic check: if Rank Math class exists and function is available, consider it configured - // This is more lenient and should work for most Rank Math installations + // This is more lenient and should work for most Rank Math installations. if ( class_exists( 'RankMath' ) && function_exists( 'rank_math' ) ) { return true; } - + // Fallback: check if Rank Math meta fields are registered - // This indicates Rank Math has been initialized + // This indicates Rank Math has been initialized. global $wp_meta_keys; if ( isset( $wp_meta_keys ) && is_array( $wp_meta_keys ) ) { foreach ( $wp_meta_keys as $post_type => $meta_keys ) { @@ -1034,7 +1037,7 @@ private function is_rank_math_configured() { } } } - + return false; } @@ -1046,46 +1049,46 @@ private function is_rank_math_configured() { */ public function get_dependency_status() { $status = array( - 'dependencies_met' => false, - 'missing_plugins' => array(), + 'dependencies_met' => false, + 'missing_plugins' => array(), 'configuration_issues' => array(), - 'recommendations' => array(), - 'debug_info' => array() + 'recommendations' => array(), + 'debug_info' => array(), ); - + $dependencies = $this->get_required_plugins(); - + foreach ( $dependencies as $plugin ) { if ( ! $this->is_plugin_active( $plugin['file'] ) ) { $status['missing_plugins'][] = $plugin; } } - - // Check Rank Math configuration with detailed debugging + + // Check Rank Math configuration with detailed debugging. if ( $this->is_plugin_active( 'seo-by-rank-math/rank-math.php' ) ) { - $rank_math_debug = $this->get_rank_math_debug_info(); + $rank_math_debug = $this->get_rank_math_debug_info(); $status['debug_info']['rank_math'] = $rank_math_debug; - + if ( ! $this->is_rank_math_configured() ) { $status['configuration_issues'][] = array( 'plugin' => 'Rank Math SEO', - 'issue' => 'Plugin is active but not properly configured', - 'debug' => $rank_math_debug + 'issue' => 'Plugin is active but not properly configured', + 'debug' => $rank_math_debug, ); } } - + $status['dependencies_met'] = empty( $status['missing_plugins'] ) && empty( $status['configuration_issues'] ); - - // Add recommendations + + // Add recommendations. if ( ! empty( $status['missing_plugins'] ) ) { $status['recommendations'][] = 'Install and activate all required plugins'; } - + if ( ! empty( $status['configuration_issues'] ) ) { $status['recommendations'][] = 'Configure Rank Math SEO plugin properly'; } - + return $status; } @@ -1097,34 +1100,34 @@ public function get_dependency_status() { */ private function get_rank_math_debug_info() { $debug = array(); - - // Check if RankMath class exists + + // Check if RankMath class exists. $debug['class_exists'] = class_exists( 'RankMath' ); - - // Check if rank_math function exists + + // Check if rank_math function exists. $debug['function_exists'] = function_exists( 'rank_math' ); - - // Try to get Rank Math instance + + // Try to get Rank Math instance. if ( $debug['function_exists'] ) { try { - $rank_math = rank_math(); + $rank_math = rank_math(); $debug['instance_created'] = is_object( $rank_math ); - $debug['instance_type'] = get_class( $rank_math ); - + $debug['instance_type'] = get_class( $rank_math ); + if ( is_object( $rank_math ) ) { $debug['has_get_settings'] = method_exists( $rank_math, 'get_settings' ); - $debug['has_get_helper'] = method_exists( $rank_math, 'get_helper' ); - $debug['has_get_admin'] = method_exists( $rank_math, 'get_admin' ); + $debug['has_get_helper'] = method_exists( $rank_math, 'get_helper' ); + $debug['has_get_admin'] = method_exists( $rank_math, 'get_admin' ); } } catch ( Throwable $e ) { $debug['exception'] = $e->getMessage(); } } - - // Check if Rank Math is in the global scope + + // Check if Rank Math is in the global scope. global $rank_math; $debug['global_exists'] = isset( $rank_math ); - + return $debug; } @@ -1132,25 +1135,28 @@ private function get_rank_math_debug_info() { * Handle plugin activation * * @since 1.0.7 - * @param string $plugin_file Activated plugin file + * @param string $plugin_file Activated plugin file. */ public function on_plugin_activated( $plugin_file ) { - // Check if the activated plugin is one of our dependencies - $dependencies = $this->get_required_plugins(); + // Check if the activated plugin is one of our dependencies. + $dependencies = $this->get_required_plugins(); $is_dependency = false; - + foreach ( $dependencies as $dependency ) { if ( $dependency['file'] === $plugin_file ) { $is_dependency = true; break; } } - + if ( $is_dependency ) { - // Re-check dependencies after a short delay - add_action( 'admin_init', function() { - $this->check_dependencies(); - }); + // Re-check dependencies after a short delay. + add_action( + 'admin_init', + function () { + $this->check_dependencies(); + } + ); $this->queue_notice_event( 'dependency_restored' ); } @@ -1160,22 +1166,22 @@ public function on_plugin_activated( $plugin_file ) { * Handle plugin deactivation * * @since 1.0.7 - * @param string $plugin_file Deactivated plugin file + * @param string $plugin_file Deactivated plugin file. */ public function on_plugin_deactivated( $plugin_file ) { - // Check if the deactivated plugin is one of our dependencies - $dependencies = $this->get_required_plugins(); + // Check if the deactivated plugin is one of our dependencies. + $dependencies = $this->get_required_plugins(); $is_dependency = false; - + foreach ( $dependencies as $dependency ) { if ( $dependency['file'] === $plugin_file ) { $is_dependency = true; break; } } - + if ( $is_dependency ) { - // Re-check dependencies + // Re-check dependencies. $this->check_dependencies(); $this->queue_notice_event( 'dependency_deactivated' ); @@ -1184,8 +1190,11 @@ public function on_plugin_deactivated( $plugin_file ) { /** * Enqueue admin scripts and styles + * + * @since 1.0.7 + * @param string $hook Current admin page hook suffix. */ - public function enqueue_admin_scripts($hook) { + public function enqueue_admin_scripts( $hook ) { $allowed_hooks = array( 'plugins.php', 'index.php' ); if ( false === strpos( $hook, 'rank-math-api' ) && ! in_array( $hook, $allowed_hooks, true ) ) { @@ -1195,7 +1204,7 @@ public function enqueue_admin_scripts($hook) { wp_enqueue_script( 'rank-math-api-admin', RANK_MATH_API_PLUGIN_URL . 'assets/js/admin.js', - array('jquery'), + array( 'jquery' ), RANK_MATH_API_VERSION, true ); @@ -1344,12 +1353,12 @@ public function register_meta_fields() { foreach ( $this->get_allowed_post_types() as $post_type ) { foreach ( $this->get_supported_meta_fields() as $meta_key => $field_config ) { $args = array( - 'show_in_rest' => true, - 'single' => true, - 'type' => 'string', - 'description' => $field_config['description'], - 'auth_callback' => array( $this, 'check_meta_auth_permission' ), - 'sanitize_callback' => $field_config['sanitize_callback'], + 'show_in_rest' => true, + 'single' => true, + 'type' => 'string', + 'description' => $field_config['description'], + 'auth_callback' => array( $this, 'check_meta_auth_permission' ), + 'sanitize_callback' => $field_config['sanitize_callback'], ); register_post_meta( $post_type, $meta_key, $args ); @@ -1361,50 +1370,67 @@ public function register_meta_fields() { * Register REST API routes */ public function register_api_routes() { - register_rest_route( 'rank-math-api/v1', '/update-meta', [ - 'methods' => 'POST', - 'callback' => [ $this, 'update_rank_math_meta' ], - 'permission_callback' => [ $this, 'check_update_permission' ], - 'args' => [ - 'post_id' => [ - 'type' => 'integer', - 'required' => true, - 'sanitize_callback' => 'absint', - 'validate_callback' => function ( $param ) { - return absint( $param ) > 0; - }, - ], - 'rank_math_title' => [ 'type' => 'string', 'sanitize_callback' => [ $this, 'sanitize_rank_math_text_field' ] ], - 'rank_math_description' => [ 'type' => 'string', 'sanitize_callback' => [ $this, 'sanitize_rank_math_text_field' ] ], - 'rank_math_canonical_url' => [ 'type' => 'string', 'sanitize_callback' => [ $this, 'sanitize_rank_math_canonical_url' ] ], - 'rank_math_focus_keyword' => [ 'type' => 'string', 'sanitize_callback' => [ $this, 'sanitize_rank_math_focus_keyword' ] ], - ], - ] ); + register_rest_route( + 'rank-math-api/v1', + '/update-meta', + array( + 'methods' => 'POST', + 'callback' => array( $this, 'update_rank_math_meta' ), + 'permission_callback' => array( $this, 'check_update_permission' ), + 'args' => array( + 'post_id' => array( + 'type' => 'integer', + 'required' => true, + 'sanitize_callback' => 'absint', + 'validate_callback' => function ( $param ) { + return absint( $param ) > 0; + }, + ), + 'rank_math_title' => array( + 'type' => 'string', + 'sanitize_callback' => array( $this, 'sanitize_rank_math_text_field' ), + ), + 'rank_math_description' => array( + 'type' => 'string', + 'sanitize_callback' => array( $this, 'sanitize_rank_math_text_field' ), + ), + 'rank_math_canonical_url' => array( + 'type' => 'string', + 'sanitize_callback' => array( $this, 'sanitize_rank_math_canonical_url' ), + ), + 'rank_math_focus_keyword' => array( + 'type' => 'string', + 'sanitize_callback' => array( $this, 'sanitize_rank_math_focus_keyword' ), + ), + ), + ) + ); } /** * Update Rank Math meta data * - * @param WP_REST_Request $request Request object + * @param WP_REST_Request $request Request object. * @return WP_REST_Response|WP_Error Response object */ public function update_rank_math_meta( WP_REST_Request $request ) { $post_id = absint( $request->get_param( 'post_id' ) ); $fields = $this->get_supported_meta_fields(); - $result = []; + $result = array(); if ( ! $post_id || ! $this->is_supported_post_target( $post_id ) ) { - return new WP_Error( 'invalid_post_id', 'A supported post, page, or product ID is required', [ 'status' => 400 ] ); + return new WP_Error( 'invalid_post_id', 'A supported post, page, or product ID is required', array( 'status' => 400 ) ); } + // phpcs:ignore WordPress.NamingConventions.ValidHookName -- Rank Math core hook name. do_action( 'rank_math/pre_update_metadata', $post_id, get_post_type( $post_id ), get_post_field( 'post_content', $post_id ) ); foreach ( $fields as $field => $field_config ) { $value = $request->get_param( $field ); - if ( $value !== null ) { - $value = call_user_func( $field_config['sanitize_callback'], $value ); + if ( null !== $value ) { + $value = call_user_func( $field_config['sanitize_callback'], $value ); $current_value = get_post_meta( $post_id, $field, true ); if ( (string) $current_value === (string) $value ) { @@ -1412,13 +1438,13 @@ public function update_rank_math_meta( WP_REST_Request $request ) { continue; } - $update_result = update_post_meta( $post_id, $field, $value ); + $update_result = update_post_meta( $post_id, $field, $value ); $result[ $field ] = $update_result ? 'updated' : 'failed'; } } if ( empty( $result ) ) { - return new WP_Error( 'no_update', 'No metadata was updated', [ 'status' => 400 ] ); + return new WP_Error( 'no_update', 'No metadata was updated', array( 'status' => 400 ) ); } return new WP_REST_Response( $result, 200 ); @@ -1437,7 +1463,7 @@ public function check_update_permission( WP_REST_Request $request ) { return new WP_Error( 'rest_forbidden', __( 'Authentication required.', 'rank-math-api-manager' ), - [ 'status' => 401 ] + array( 'status' => 401 ) ); } @@ -1445,7 +1471,7 @@ public function check_update_permission( WP_REST_Request $request ) { return new WP_Error( 'invalid_post_id', __( 'A valid post ID is required.', 'rank-math-api-manager' ), - [ 'status' => 400 ] + array( 'status' => 400 ) ); } @@ -1453,7 +1479,7 @@ public function check_update_permission( WP_REST_Request $request ) { return new WP_Error( 'invalid_post_id', __( 'A supported post, page, or product ID is required.', 'rank-math-api-manager' ), - [ 'status' => 400 ] + array( 'status' => 400 ) ); } @@ -1461,7 +1487,7 @@ public function check_update_permission( WP_REST_Request $request ) { return new WP_Error( 'rest_forbidden', __( 'You cannot edit this post.', 'rank-math-api-manager' ), - [ 'status' => 403 ] + array( 'status' => 403 ) ); } @@ -1503,7 +1529,7 @@ public function get_version() { * Log debug messages * * @since 1.0.7 - * @param string $message Debug message to log + * @param string $message Debug message to log. */ private function log_debug( $message ) { if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) { @@ -1516,41 +1542,41 @@ private function log_debug( $message ) { * Check for plugin updates from GitHub * * @since 1.0.7 - * @param object $transient WordPress update transient + * @param object $transient WordPress update transient. * @return object Modified transient */ public function check_for_update( $transient ) { $this->log_debug( 'check_for_update called' ); - - // Ensure we have a valid transient object + + // Ensure we have a valid transient object. if ( ! is_object( $transient ) || empty( $transient->checked ) || ! is_array( $transient->checked ) ) { $this->log_debug( 'Transient checked is empty, returning early' ); return $transient; } - // Get plugin basename + // Get plugin basename. $plugin_slug = plugin_basename( RANK_MATH_API_PLUGIN_FILE ); - - // Only check if our plugin is in the checked list + + // Only check if our plugin is in the checked list. if ( ! isset( $transient->checked[ $plugin_slug ] ) ) { $this->log_debug( 'Plugin not in checked list: ' . $plugin_slug ); return $transient; } - + $this->log_debug( 'Plugin found in checked list, proceeding with update check' ); - // Get current version + // Get current version. $current_version = isset( $this->plugin_data['Version'] ) ? $this->plugin_data['Version'] : RANK_MATH_API_VERSION; - // Check for cached release data first - $cache_key = 'rank_math_api_github_release'; + // Check for cached release data first. + $cache_key = 'rank_math_api_github_release'; $release_data = get_transient( $cache_key ); if ( false === $release_data ) { $this->log_debug( 'No cached release data, fetching from GitHub API' ); - // Get latest release from GitHub with rate limiting + // Get latest release from GitHub with rate limiting. $release_data = $this->get_latest_github_release(); - + if ( is_wp_error( $release_data ) ) { $this->log_debug( 'GitHub API error: ' . $release_data->get_error_message() ); return $transient; @@ -1569,10 +1595,10 @@ public function check_for_update( $transient ) { $this->log_debug( 'Comparing versions: Current=' . $current_version . ', Remote=' . $release_data['version'] ); - // Compare versions + // Compare versions. if ( version_compare( $release_data['version'], $current_version, '>' ) ) { $this->log_debug( 'Update available! Adding to transient' ); - // Update available - add to response + // Update available - add to response. $plugin_data = (object) array( 'slug' => dirname( $plugin_slug ), 'plugin' => $plugin_slug, @@ -1607,9 +1633,9 @@ public function check_for_update( $transient ) { */ private function get_latest_github_release() { $this->log_debug( 'Starting GitHub API request' ); - - // Rate limiting check - $last_check = get_option( 'rank_math_api_last_github_check', 0 ); + + // Rate limiting check. + $last_check = get_option( 'rank_math_api_last_github_check', 0 ); $check_interval = 300; // 5 minutes minimum between checks if ( time() - $last_check < $check_interval ) { @@ -1617,13 +1643,13 @@ private function get_latest_github_release() { return new WP_Error( 'rate_limited', 'Rate limited: too many requests' ); } - // Prepare headers with optional authentication + // Prepare headers with optional authentication. $headers = array( 'Accept' => 'application/vnd.github.v3+json', - 'User-Agent' => 'WordPress/' . get_bloginfo( 'version' ) . '; ' . get_bloginfo( 'url' ) + 'User-Agent' => 'WordPress/' . get_bloginfo( 'version' ) . '; ' . get_bloginfo( 'url' ), ); - // Add authentication header if token is available + // Add authentication header if token is available. if ( $this->github_token ) { $headers['Authorization'] = 'token ' . $this->github_token; $this->log_debug( 'Using authenticated GitHub API request (5000/hour limit)' ); @@ -1631,13 +1657,16 @@ private function get_latest_github_release() { $this->log_debug( 'Using unauthenticated GitHub API request (60/hour limit)' ); } - // Make API request - $response = wp_remote_get( $this->github_repo['api_url'], array( - 'timeout' => 15, - 'headers' => $headers - ) ); + // Make API request. + $response = wp_remote_get( + $this->github_repo['api_url'], + array( + 'timeout' => 15, + 'headers' => $headers, + ) + ); - // Update last check time + // Update last check time. update_option( 'rank_math_api_last_github_check', time() ); if ( is_wp_error( $response ) ) { @@ -1647,7 +1676,7 @@ private function get_latest_github_release() { $response_code = wp_remote_retrieve_response_code( $response ); $this->log_debug( 'GitHub API response code: ' . $response_code ); - + if ( 200 !== $response_code ) { $this->log_debug( 'GitHub API error - status: ' . $response_code ); return new WP_Error( 'api_error', 'GitHub API returned status: ' . $response_code ); @@ -1661,7 +1690,7 @@ private function get_latest_github_release() { return new WP_Error( 'invalid_response', 'Invalid GitHub API response' ); } - // Parse version from tag (remove 'v' prefix if present) + // Parse version from tag (remove 'v' prefix if present). $version = ltrim( $data['tag_name'], 'v' ); $this->log_debug( 'Found GitHub release version: ' . $version ); @@ -1669,7 +1698,7 @@ private function get_latest_github_release() { $download_url = null; $assets_count = isset( $data['assets'] ) ? count( $data['assets'] ) : 0; $this->log_debug( 'Release has ' . $assets_count . ' assets' ); - + if ( isset( $data['assets'] ) && is_array( $data['assets'] ) ) { foreach ( $data['assets'] as $asset ) { if ( empty( $asset['name'] ) || empty( $asset['browser_download_url'] ) ) { @@ -1703,26 +1732,26 @@ private function get_latest_github_release() { * Provide plugin information for the "View Details" modal * * @since 1.0.7 - * @param object $res Plugin information result - * @param string $action Action being performed - * @param object $args Additional arguments + * @param object $res Plugin information result. + * @param string $action Action being performed. + * @param object $args Additional arguments. * @return object|false Modified result or false */ public function plugin_info( $res, $action, $args ) { $slug = ( is_object( $args ) && isset( $args->slug ) ) ? $args->slug : ''; - // Only handle plugin_information requests for our plugin + // Only handle plugin_information requests for our plugin. if ( 'plugin_information' !== $action || 'rank-math-api-manager' !== $slug ) { return false; } - // Get cached release data - $cache_key = 'rank_math_api_github_release'; + // Get cached release data. + $cache_key = 'rank_math_api_github_release'; $release_data = get_transient( $cache_key ); if ( false === $release_data ) { $release_data = $this->get_latest_github_release(); - + if ( is_wp_error( $release_data ) ) { return false; } @@ -1734,30 +1763,30 @@ public function plugin_info( $res, $action, $args ) { return false; } - // Format changelog + // Format changelog. $changelog = ''; if ( ! empty( $release_data['description'] ) ) { $changelog = wp_kses_post( nl2br( $release_data['description'] ) ); } - // Return plugin information object + // Return plugin information object. return (object) array( - 'name' => isset( $this->plugin_data['Name'] ) ? $this->plugin_data['Name'] : 'Rank Math API Manager', - 'slug' => 'rank-math-api-manager', - 'version' => $release_data['version'], - 'author' => '' . esc_html( isset( $this->plugin_data['AuthorName'] ) ? $this->plugin_data['AuthorName'] : 'Devora AS' ) . '', - 'homepage' => isset( $this->plugin_data['PluginURI'] ) ? $this->plugin_data['PluginURI'] : '', - 'requires' => '5.0', - 'tested' => '7.1', - 'requires_php' => '7.4', - 'last_updated' => $release_data['published_at'], - 'download_link' => $release_data['download_url'], - 'icons' => array( + 'name' => isset( $this->plugin_data['Name'] ) ? $this->plugin_data['Name'] : 'Rank Math API Manager', + 'slug' => 'rank-math-api-manager', + 'version' => $release_data['version'], + 'author' => '' . esc_html( isset( $this->plugin_data['AuthorName'] ) ? $this->plugin_data['AuthorName'] : 'Devora AS' ) . '', + 'homepage' => isset( $this->plugin_data['PluginURI'] ) ? $this->plugin_data['PluginURI'] : '', + 'requires' => '5.0', + 'tested' => '7.1', + 'requires_php' => '7.4', + 'last_updated' => $release_data['published_at'], + 'download_link' => $release_data['download_url'], + 'icons' => array( '1x' => RANK_MATH_API_PLUGIN_URL . 'assets/images/icon-128x128.png', '2x' => RANK_MATH_API_PLUGIN_URL . 'assets/images/icon-256x256.png', 'default' => RANK_MATH_API_PLUGIN_URL . 'assets/images/icon-128x128.png', ), - 'sections' => array( + 'sections' => array( 'description' => '

' . esc_html( isset( $this->plugin_data['Description'] ) ? $this->plugin_data['Description'] : '' ) . '

', 'changelog' => $changelog, ), @@ -1789,34 +1818,41 @@ private function is_valid_release_download_url( $download_url ) { } } -// Initialize the plugin +// phpcs:disable Universal.Files.SeparateFunctionsFromOO -- WordPress bootstrap pattern in main plugin file. + +/** + * Bootstrap plugin singleton. + * + * @since 1.0.0 + * @return Rank_Math_API_Manager_Extended Plugin instance. + */ function rank_math_api_manager_init() { return Rank_Math_API_Manager_Extended::get_instance(); } -// Start the plugin -add_action('plugins_loaded', 'rank_math_api_manager_init'); +// Start the plugin. +add_action( 'plugins_loaded', 'rank_math_api_manager_init' ); /** * Plugin activation function - * + * * Sets up necessary directories and options when the plugin is activated - * + * * @since 1.0.0 */ function rank_math_api_manager_activate() { - // Create necessary directories + // Create necessary directories. $upload_dir = wp_upload_dir(); $plugin_dir = $upload_dir['basedir'] . '/rank-math-api-manager'; - - if (!file_exists($plugin_dir)) { - wp_mkdir_p($plugin_dir); - } - - // Add activation timestamp - update_option('rank_math_api_activated', current_time('mysql')); - - // Check dependencies on activation + + if ( ! file_exists( $plugin_dir ) ) { + wp_mkdir_p( $plugin_dir ); + } + + // Add activation timestamp. + update_option( 'rank_math_api_activated', current_time( 'mysql' ) ); + + // Check dependencies on activation. $plugin_instance = Rank_Math_API_Manager_Extended::get_instance(); if ( method_exists( $plugin_instance, 'check_dependencies' ) ) { $plugin_instance->check_dependencies(); @@ -1829,9 +1865,9 @@ function rank_math_api_manager_activate() { /** * Plugin deactivation function - * + * * Cleans up scheduled events and caches when the plugin is deactivated - * + * * @since 1.0.0 */ function rank_math_api_manager_deactivate() { @@ -1841,44 +1877,44 @@ function rank_math_api_manager_deactivate() { $plugin_instance->handle_plugin_deactivation_cleanup(); } - // Clear scheduled events - wp_clear_scheduled_hook('rank_math_api_update_check'); - - // Clear update-related caches - delete_transient('rank_math_api_github_release'); - delete_option('rank_math_api_last_github_check'); + // Clear scheduled events. + wp_clear_scheduled_hook( 'rank_math_api_update_check' ); + + // Clear update-related caches. + delete_transient( 'rank_math_api_github_release' ); + delete_option( 'rank_math_api_last_github_check' ); } -// Activation hook -register_activation_hook(__FILE__, 'rank_math_api_manager_activate'); +// Activation hook. +register_activation_hook( __FILE__, 'rank_math_api_manager_activate' ); -// Deactivation hook -register_deactivation_hook(__FILE__, 'rank_math_api_manager_deactivate'); +// Deactivation hook. +register_deactivation_hook( __FILE__, 'rank_math_api_manager_deactivate' ); /** * Plugin uninstall function - * + * * Removes all plugin data when the plugin is uninstalled - * + * * @since 1.0.0 */ function rank_math_api_manager_uninstall() { - // Remove all plugin options - delete_option('rank_math_api_activated'); - delete_option('rank_math_api_dependencies_status'); - delete_option('rank_math_api_dismissed_notices'); - delete_option('rank_math_api_notice_events'); - delete_option('rank_math_api_last_github_check'); - delete_option('rank_math_api_github_token'); - delete_option('rank_math_api_telemetry_settings'); - delete_option('rank_math_api_heartbeat_last_run'); - - // Remove transients - delete_transient('rank_math_api_github_release'); - - // Clear any scheduled events - wp_clear_scheduled_hook('rank_math_api_update_check'); - wp_clear_scheduled_hook('rank_math_api_telemetry_heartbeat'); + // Remove all plugin options. + delete_option( 'rank_math_api_activated' ); + delete_option( 'rank_math_api_dependencies_status' ); + delete_option( 'rank_math_api_dismissed_notices' ); + delete_option( 'rank_math_api_notice_events' ); + delete_option( 'rank_math_api_last_github_check' ); + delete_option( 'rank_math_api_github_token' ); + delete_option( 'rank_math_api_telemetry_settings' ); + delete_option( 'rank_math_api_heartbeat_last_run' ); + + // Remove transients. + delete_transient( 'rank_math_api_github_release' ); + + // Clear any scheduled events. + wp_clear_scheduled_hook( 'rank_math_api_update_check' ); + wp_clear_scheduled_hook( 'rank_math_api_telemetry_heartbeat' ); global $wpdb; @@ -1894,5 +1930,5 @@ function rank_math_api_manager_uninstall() { } } -// Uninstall hook -register_uninstall_hook(__FILE__, 'rank_math_api_manager_uninstall'); +// Uninstall hook. +register_uninstall_hook( __FILE__, 'rank_math_api_manager_uninstall' ); diff --git a/scripts/check-plugin-coverage.sh b/scripts/check-plugin-coverage.sh new file mode 100755 index 0000000..7356a9b --- /dev/null +++ b/scripts/check-plugin-coverage.sh @@ -0,0 +1,84 @@ +#!/usr/bin/env bash +# Enforce minimum line coverage on rank-math-api-manager.php (default 80%). +# Requires pcov or xdebug. Usage: ./scripts/check-plugin-coverage.sh +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +cd "$ROOT" + +MIN_LINE="${MIN_LINE_COVERAGE:-80}" +CLOVER="${CLOVER_PATH:-build/coverage/clover.xml}" +WP_TESTS_DIR="${WP_TESTS_DIR:-/tmp/wordpress-tests-lib}" + +die() { + echo "check-plugin-coverage: $*" >&2 + exit 1 +} + +if ! php -m 2>/dev/null | grep -qiE '^(pcov|xdebug)$'; then + die "pcov or xdebug PHP extension required for coverage (install via setup-php in CI)." +fi + +if [ ! -d "$WP_TESTS_DIR" ]; then + die "WP_TESTS_DIR not ready ($WP_TESTS_DIR). Run ./scripts/run-phpunit-local.sh once to install the test suite." +fi + +mkdir -p build/coverage + +export WP_TESTS_DIR +export MIN_LINE_COVERAGE="$MIN_LINE" +export CLOVER_PATH="$CLOVER" +vendor/bin/phpunit --configuration phpunit.xml.dist --coverage-clover "$CLOVER" "$@" + +php <<'PHP' +project->file as $file) { + $name = (string) $file['name']; + if (substr($name, -strlen($target)) === $target) { + $metrics = $file->metrics; + break; + } +} +if (null === $metrics) { + fwrite(STDERR, "check-plugin-coverage: {$target} not found in clover report\n"); + exit(1); +} +$statements = (int) $metrics['statements']; +$covered = (int) $metrics['coveredstatements']; +if ($statements <= 0) { + fwrite(STDERR, "check-plugin-coverage: zero statements measured\n"); + exit(1); +} +$pct = ( $covered / $statements ) * 100; +printf( + "Coverage for %s: %.2f%% (%d/%d statements)\n", + $target, + $pct, + $covered, + $statements +); +if ($pct + 0.0001 < $min) { + fwrite(STDERR, sprintf("check-plugin-coverage: FAIL (minimum %.2f%%)\n", $min)); + exit(1); +} +fwrite(STDERR, sprintf("check-plugin-coverage: PASS (minimum %.2f%%)\n", $min)); +PHP diff --git a/specs/plugin-coverage-phpcs-mission.md b/specs/plugin-coverage-phpcs-mission.md new file mode 100644 index 0000000..93ff5c2 --- /dev/null +++ b/specs/plugin-coverage-phpcs-mission.md @@ -0,0 +1,102 @@ +# Spec: Plugin coverage gate + PHPCS main file (TASK-005) + +**Preflight classification:** `ready_for_execution_handoff` + +**Task type:** `enhancement` +**Complexity:** `complex` + +## Task Description + +Enable PHPUnit line coverage for `rank-math-api-manager.php` with pcov in CI (initial gate 80%), expand risk-based integration tests (REST permissions, updater, telemetry privacy, uninstall), and bring the main plugin file under PHPCS by removing the `phpcs.xml.dist` exclude after WPCS fixes. + +## Objective + +Production-quality hygiene: green PHPCS including main file, measurable coverage with CI enforcement, and regression tests for security-sensitive paths. + +## Scope + +- PHPCS: `phpcbf`, manual WPCS fixes, remove exclude pattern, green `qa.yml` PHPCS job. +- Coverage: `phpunit.xml.dist` coverage include, `scripts/check-plugin-coverage.sh`, extend `qa.yml` PHPUnit job with pcov + threshold. +- Tests: new integration tests under `tests/integration/` for permissions, telemetry opt-out, uninstall cleanup, updater edge paths, sanitizers. + +## Assumptions + +- MySQL-backed WP test suite remains the integration harness (`tests/bootstrap.php`). +- WooCommerce product test may remain skipped without WC in CI unless a follow-up adds WC install. +- 80% line coverage applies to `rank-math-api-manager.php` only (not `.mat/` or scripts). + +## Non-Goals + +- 100% line coverage on every branch in one slice. +- Refactoring plugin into multiple PHP files. +- Playwright E2E of wp-admin notices. + +## Problem Statement + +Main file was excluded from PHPCS; coverage is unmeasured; critical paths (permissions, telemetry, uninstall) lack dedicated regression tests. + +## Solution Approach + +Two ordered long-run slices: (1) PHPCS TASK-005, (2) coverage tooling + risk-based tests + CI gate. Each slice: plan → build → verify → commit → PR → merge when green. + +## Relevant Files / Areas + +- [existing] `rank-math-api-manager.php` — PHPCS fixes and coverage target +- [existing] `phpcs.xml.dist` — remove main-file exclude +- [existing] `phpunit.xml.dist` — coverage configuration +- [existing] `.github/workflows/qa.yml` — pcov + coverage check +- [new] `scripts/check-plugin-coverage.sh` — threshold enforcement +- [new] `tests/integration/*Test.php` — permissions, telemetry, uninstall, updater + +## Task Traceability + +| Task | Requirement | +|------|-------------| +| PHPCS slice | Main file in ruleset; `vendor/bin/phpcs --standard=phpcs.xml.dist` exit 0 | +| Coverage slice | pcov in CI; ≥80% lines on main file | +| REST/security tests | Map to permission callbacks and REST routes | +| Telemetry tests | Opt-out sends no HTTP; enabled uses validated endpoint only | +| Uninstall tests | Options cleared after uninstall hook | + +## Testing Strategy + +Risk-based integration tests first; coverage gate validates aggregate line coverage on the main file. TDD for new test files (red → green where behavior already exists). + +### Per-phase validation loops (loop until pass) + +| Phase | Command | Loop until pass | +|-------|---------|-----------------| +| PHPCS | `vendor/bin/phpcs --standard=phpcs.xml.dist` | Re-run after fixes until exit 0 | +| PHPUnit | `./scripts/run-phpunit-local.sh` | Re-run until green | +| Coverage | `./scripts/check-plugin-coverage.sh` | Re-run after adding tests until threshold met | +| Package | `./scripts/package-plugin.sh` | Once per slice closeout | + +### Global validation commands (before handoff) + +1. `vendor/bin/phpcs --standard=phpcs.xml.dist` +2. `./scripts/run-phpunit-local.sh` +3. `./scripts/check-plugin-coverage.sh` +4. `bash scripts/phase1-verify.sh` (if MAT gates apply) + +Hard orchestration gates remain `build-result.md` / `verify-result.md`. + +## Acceptance Criteria + +- [ ] `phpcs.xml.dist` does not exclude `rank-math-api-manager.php` and PHPCS passes. +- [ ] CI PHPCS job passes on PR. +- [ ] PHPUnit reports ≥80% line coverage for `rank-math-api-manager.php`. +- [ ] New integration tests cover REST permission denial, telemetry opt-out, and uninstall option cleanup. +- [ ] PR merged to `main` with green QA workflow. + +## Risks and Open Questions + +- Hitting 80% may require additional tests for admin notices/GitHub HTTP paths. +- Local pcov may be absent; CI is authoritative for coverage gate. + +## Amendments + +- 2026-11-05T10:30:00Z — orchestrator — Initial spec for coverage + PHPCS mission. + +## Recommended Next Command + +Project into `docs/current-plan.md` and run `/mat-long-run` with slice queue `task-005-phpcs` then `coverage-ci-tests`. diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 5c74c22..74be780 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -127,6 +127,35 @@ function rank_math() { // phpcs:ignore WordPress.NamingConventions.PrefixAllGlob } } + if ( ! class_exists( 'WooCommerce', false ) ) { + /** + * Minimal WooCommerce class stub for product post-type coverage in integration tests. + * + * @phpcs:disable Generic.Classes.DuplicateClassName.Found + */ + class WooCommerce { + } + } + + if ( ! function_exists( 'wc_get_product' ) ) { + /** + * Minimal wc_get_product() stub for product REST tests without full WooCommerce. + * + * @param int $product_id Product post ID. + * @return object|false + */ + function wc_get_product( $product_id ) { // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound -- stub mimics WooCommerce API. + $post = get_post( $product_id ); + if ( ! $post || 'product' !== $post->post_type ) { + return false; + } + + return (object) array( + 'id' => (int) $product_id, + ); + } + } + add_filter( 'option_active_plugins', 'rank_math_api_manager_tests_active_plugins' ); $plugin_file = rank_math_api_manager_tests_plugin_file(); diff --git a/tests/integration/AdditionalCoverageIntegrationTest.php b/tests/integration/AdditionalCoverageIntegrationTest.php new file mode 100644 index 0000000..2052ecc --- /dev/null +++ b/tests/integration/AdditionalCoverageIntegrationTest.php @@ -0,0 +1,206 @@ +plugin = Rank_Math_API_Manager_Extended::get_instance(); + $this->user_id = $this->factory->user->create( array( 'role' => 'editor' ) ); + } + + /** + * Attachment post type is rejected by update-meta endpoint. + */ + public function test_update_meta_rejects_attachment_post_type() { + wp_set_current_user( $this->user_id ); + $attachment_id = $this->factory->post->create( + array( + 'post_type' => 'attachment', + 'post_status' => 'inherit', + ) + ); + + $request = new WP_REST_Request( 'POST', '/rank-math-api/v1/update-meta' ); + $request->set_param( 'post_id', $attachment_id ); + $request->set_param( 'rank_math_title', 'Should Fail' ); + $response = rest_do_request( $request ); + + $this->assertSame( 400, $response->get_status() ); + } + + /** + * Update all supported SEO fields in one request. + */ + public function test_update_meta_sets_all_supported_fields() { + wp_set_current_user( $this->user_id ); + $post_id = $this->factory->post->create( + array( + 'post_type' => 'post', + 'post_status' => 'publish', + ) + ); + + $request = new WP_REST_Request( 'POST', '/rank-math-api/v1/update-meta' ); + $request->set_param( 'post_id', $post_id ); + $request->set_param( 'rank_math_title', 'All Fields Title' ); + $request->set_param( 'rank_math_description', 'All Fields Description' ); + $request->set_param( 'rank_math_canonical_url', 'https://example.com/canonical' ); + $request->set_param( 'rank_math_focus_keyword', 'all-fields' ); + $response = rest_do_request( $request ); + + $this->assertSame( 200, $response->get_status() ); + $this->assertSame( 'All Fields Title', get_post_meta( $post_id, 'rank_math_title', true ) ); + $this->assertSame( 'All Fields Description', get_post_meta( $post_id, 'rank_math_description', true ) ); + } + + /** + * GitHub API non-200 response does not populate update response. + */ + public function test_github_api_http_error_does_not_add_update() { + delete_transient( 'rank_math_api_github_release' ); + update_option( 'rank_math_api_last_github_check', 0, false ); + + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'api.github.com' ) ) { + return array( + 'response' => array( 'code' => 500 ), + 'body' => 'error', + ); + } + return $preempt; + }, + 10, + 3 + ); + + $basename = plugin_basename( RANK_MATH_API_PLUGIN_FILE ); + $transient = (object) array( + 'checked' => array( + $basename => '1.0.0', + ), + 'response' => array(), + ); + + $filtered = apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + $this->assertEmpty( $filtered->response ); + } + + /** + * Deactivation cleanup sends telemetry when enabled. + */ + public function test_handle_plugin_deactivation_cleanup_with_telemetry_enabled() { + update_option( + 'rank_math_api_telemetry_settings', + array( + 'enabled' => true, + ), + false + ); + + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'updates.devora.no' ) ) { + return array( + 'response' => array( 'code' => 204 ), + 'body' => '', + ); + } + return $preempt; + }, + 10, + 3 + ); + + $this->plugin->handle_plugin_deactivation_cleanup(); + $this->assertFalse( wp_next_scheduled( 'rank_math_api_telemetry_heartbeat' ) ); + } + + /** + * on_plugin_deactivated for dependency queues deactivation notice path. + */ + public function test_on_plugin_deactivated_for_rank_math_dependency() { + $this->plugin->on_plugin_deactivated( 'seo-by-rank-math/rank-math.php' ); + $events = get_option( 'rank_math_api_notice_events', array() ); + $this->assertArrayHasKey( 'dependency_deactivated', $events ); + } + + /** + * Render bundled notice events on plugins screen. + */ + public function test_render_admin_notices_with_multiple_queued_events() { + $admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) ); + wp_set_current_user( $admin_id ); + set_current_screen( 'plugins' ); + + $this->plugin->queue_notice_event( 'dependency_restored' ); + $this->plugin->queue_notice_event( 'dependency_deactivated' ); + $this->plugin->queue_notice_event( 'telemetry_enabled' ); + $this->plugin->queue_notice_event( 'telemetry_disabled' ); + + ob_start(); + $this->plugin->render_admin_notices(); + $output = ob_get_clean(); + + $this->assertStringContainsString( 'Rank Math API Manager', $output ); + } + + /** + * Plugin version accessor returns constant value. + */ + public function test_get_version_returns_plugin_constant() { + $this->assertSame( RANK_MATH_API_VERSION, $this->plugin->get_version() ); + } + + /** + * check_for_update ignores unrelated plugins in checked list. + */ + public function test_check_for_update_ignores_when_plugin_not_in_checked_list() { + $transient = (object) array( + 'checked' => array( + 'hello.php' => '1.7.2', + ), + 'response' => array(), + ); + + $filtered = apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + $this->assertSame( $transient, $filtered ); + } + + /** + * Invalid update transient shape returns early without errors. + */ + public function test_check_for_update_returns_early_for_invalid_transient() { + $filtered = apply_filters( 'pre_set_site_transient_update_plugins', 'not-an-object' ); + $this->assertSame( 'not-an-object', $filtered ); + } +} diff --git a/tests/integration/AdminNoticesSmokeTest.php b/tests/integration/AdminNoticesSmokeTest.php new file mode 100644 index 0000000..9106ee2 --- /dev/null +++ b/tests/integration/AdminNoticesSmokeTest.php @@ -0,0 +1,51 @@ +plugin = Rank_Math_API_Manager_Extended::get_instance(); + $this->admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) ); + } + + /** + * Queued notice events render without fatal errors on plugins screen. + */ + public function test_render_admin_notices_outputs_markup_for_queued_event() { + wp_set_current_user( $this->admin_id ); + set_current_screen( 'plugins' ); + + $this->plugin->queue_notice_event( 'dependency_restored' ); + + ob_start(); + $this->plugin->render_admin_notices(); + $output = ob_get_clean(); + + $this->assertIsString( $output ); + } +} diff --git a/tests/integration/CoverageBoosterIntegrationTest.php b/tests/integration/CoverageBoosterIntegrationTest.php new file mode 100644 index 0000000..463fb66 --- /dev/null +++ b/tests/integration/CoverageBoosterIntegrationTest.php @@ -0,0 +1,221 @@ +plugin = Rank_Math_API_Manager_Extended::get_instance(); + } + + /** + * Bootstrap function returns singleton instance. + */ + public function test_rank_math_api_manager_init_returns_instance() { + $instance = rank_math_api_manager_init(); + $this->assertInstanceOf( Rank_Math_API_Manager_Extended::class, $instance ); + } + + /** + * Folder notice markup includes expandable reinstall instructions. + */ + public function test_folder_name_notice_markup_contains_reinstall_summary() { + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'get_folder_name_notice_markup' ); + $markup = $method->invoke( $this->plugin ); + $this->assertStringContainsString( 'Show reinstall steps', $markup ); + } + + /** + * Admin notice renderer outputs folder notice when WP admin context is active. + */ + public function test_render_admin_notices_outputs_queued_success_notice() { + if ( ! defined( 'WP_ADMIN' ) ) { + define( 'WP_ADMIN', true ); + } + + $admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) ); + wp_set_current_user( $admin_id ); + set_current_screen( 'plugins' ); + + $this->plugin->queue_notice_event( 'telemetry_disabled' ); + + ob_start(); + $this->plugin->render_admin_notices(); + $output = ob_get_clean(); + + $this->assertStringContainsString( 'telemetry has been disabled', strtolower( $output ) ); + } + + /** + * GitHub updater uses Authorization header when token is configured on the instance. + */ + public function test_github_request_includes_auth_header_when_token_configured() { + update_option( 'rank_math_api_last_github_check', 0, false ); + delete_transient( 'rank_math_api_github_release' ); + + $reflection = new ReflectionClass( $this->plugin ); + $property = $reflection->getProperty( 'github_token' ); + $property->setValue( $this->plugin, 'test-token-value' ); + + $auth_seen = false; + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) use ( &$auth_seen ) { + unset( $preempt ); + if ( false !== strpos( $url, 'api.github.com' ) ) { + if ( ! empty( $args['headers']['Authorization'] ) ) { + $auth_seen = true; + } + return array( + 'response' => array( 'code' => 404 ), + 'body' => '', + ); + } + return $preempt; + }, + 10, + 3 + ); + + $basename = plugin_basename( RANK_MATH_API_PLUGIN_FILE ); + $transient = (object) array( + 'checked' => array( + $basename => '1.0.0', + ), + 'response' => array(), + ); + + apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + + $this->assertTrue( $auth_seen ); + } + + /** + * Scheduled telemetry heartbeat updates last-run when send succeeds. + */ + public function test_scheduled_telemetry_updates_last_run_on_success() { + update_option( 'rank_math_api_heartbeat_last_run', 0, false ); + update_option( + 'rank_math_api_telemetry_settings', + array( + 'enabled' => true, + ), + false + ); + + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'updates.devora.no' ) ) { + return array( + 'response' => array( 'code' => 204 ), + 'body' => '', + ); + } + return $preempt; + }, + 10, + 3 + ); + + $this->plugin->send_scheduled_telemetry(); + + $this->assertGreaterThan( 0, (int) get_option( 'rank_math_api_heartbeat_last_run', 0 ) ); + } + + /** + * check_dependencies persists updated dependency status flag. + */ + public function test_check_dependencies_updates_status_option() { + update_option( 'rank_math_api_dependencies_status', false, false ); + $this->plugin->check_dependencies(); + $this->assertTrue( (bool) get_option( 'rank_math_api_dependencies_status', false ) ); + } + + /** + * plugins_api returns false for non-plugin_information actions. + */ + public function test_plugins_api_ignores_non_information_action() { + $args = (object) array( 'slug' => 'rank-math-api-manager' ); + $result = apply_filters( 'plugins_api', false, 'query_plugins', $args ); + $this->assertFalse( $result ); + } + + /** + * prepare_plugin_activation ensures telemetry site id option exists. + */ + public function test_prepare_plugin_activation_ensures_site_id() { + delete_option( 'rank_math_api_telemetry_settings' ); + $this->plugin->prepare_plugin_activation(); + $settings = get_option( 'rank_math_api_telemetry_settings', array() ); + $this->assertNotEmpty( $settings['site_id'] ); + } + + /** + * plugin_info returns structured data when release transient is populated. + */ + public function test_plugin_info_returns_release_object_from_cache() { + set_transient( + 'rank_math_api_github_release', + array( + 'version' => '9.9.9', + 'download_url' => 'https://github.com/devora-as/rank-math-api-manager/releases/download/v9.9.9/rank-math-api-manager.zip', + 'published_at' => gmdate( 'c' ), + 'description' => 'Changelog line', + ), + HOUR_IN_SECONDS + ); + + $args = (object) array( 'slug' => 'rank-math-api-manager' ); + $result = $this->plugin->plugin_info( false, 'plugin_information', $args ); + + $this->assertIsObject( $result ); + $this->assertSame( '9.9.9', $result->version ); + $this->assertStringContainsString( 'Changelog line', $result->sections['changelog'] ); + } + + /** + * enqueue_admin_scripts registers assets on plugins screen hook. + */ + public function test_enqueue_admin_scripts_loads_assets_on_plugins_screen() { + $this->plugin->enqueue_admin_scripts( 'plugins.php' ); + $this->assertTrue( wp_script_is( 'rank-math-api-admin', 'enqueued' ) ); + $this->assertTrue( wp_style_is( 'rank-math-api-admin', 'enqueued' ) ); + } + + /** + * send_telemetry_event rejects unknown event types. + */ + public function test_send_telemetry_event_rejects_unknown_event_type() { + $this->assertFalse( $this->plugin->send_telemetry_event( 'not-a-real-event' ) ); + } + + /** + * Telemetry privacy notice markup is built for the settings UI copy. + */ + public function test_telemetry_notice_markup_contains_opt_out_language() { + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'get_telemetry_notice_markup' ); + $markup = $method->invoke( $this->plugin ); + $this->assertStringContainsString( 'telemetry', strtolower( $markup ) ); + } +} diff --git a/tests/integration/CoverageGapIntegrationTest.php b/tests/integration/CoverageGapIntegrationTest.php new file mode 100644 index 0000000..4352541 --- /dev/null +++ b/tests/integration/CoverageGapIntegrationTest.php @@ -0,0 +1,253 @@ +plugin = Rank_Math_API_Manager_Extended::get_instance(); + } + + /** + * sanitize_telemetry_settings normalizes enabled flag and preserves site id. + */ + public function test_sanitize_telemetry_settings_normalizes_payload() { + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'sanitize_telemetry_settings' ); + $result = $method->invoke( + $this->plugin, + array( + 'enabled' => 1, + 'site_id' => 'abc-123', + ) + ); + + $this->assertTrue( $result['enabled'] ); + $this->assertNotEmpty( $result['site_id'] ); + } + + /** + * send_telemetry_event sends activate payload when telemetry is enabled. + */ + public function test_send_telemetry_event_activate_when_enabled() { + update_option( + 'rank_math_api_telemetry_settings', + array( + 'enabled' => true, + 'site_id' => 'test-site-id', + ), + false + ); + + $seen = false; + $method_s = null; + $event_t = null; + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) use ( &$seen, &$method_s, &$event_t ) { + unset( $preempt ); + if ( false !== strpos( $url, 'updates.devora.no' ) ) { + $seen = true; + $method_s = isset( $args['method'] ) ? $args['method'] : ''; + $body = json_decode( $args['body'], true ); + $event_t = isset( $body['event_type'] ) ? $body['event_type'] : ''; + return array( + 'response' => array( 'code' => 204 ), + 'body' => '', + ); + } + return $preempt; + }, + 10, + 3 + ); + + $this->assertTrue( $this->plugin->send_telemetry_event( 'activate' ) ); + $this->assertTrue( $seen ); + $this->assertSame( 'POST', $method_s ); + $this->assertSame( 'activate', $event_t ); + } + + /** + * handle_plugin_deactivation_cleanup clears scheduled telemetry hook. + */ + public function test_handle_plugin_deactivation_cleanup_clears_schedule() { + wp_schedule_event( time() + HOUR_IN_SECONDS, 'daily', 'rank_math_api_telemetry_heartbeat' ); + $this->plugin->handle_plugin_deactivation_cleanup(); + $this->assertFalse( wp_next_scheduled( 'rank_math_api_telemetry_heartbeat' ) ); + } + + /** + * on_plugin_activated queues dependency restored notice for Rank Math. + */ + public function test_on_plugin_activated_queues_dependency_restored_for_rank_math() { + $this->plugin->on_plugin_activated( 'seo-by-rank-math/rank-math.php' ); + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'has_notice_event' ); + $this->assertTrue( $method->invoke( $this->plugin, 'dependency_restored' ) ); + } + + /** + * on_plugin_deactivated queues dependency warning when Rank Math is deactivated. + */ + public function test_on_plugin_deactivated_queues_dependency_deactivated_for_rank_math() { + $this->plugin->on_plugin_deactivated( 'seo-by-rank-math/rank-math.php' ); + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'has_notice_event' ); + $this->assertTrue( $method->invoke( $this->plugin, 'dependency_deactivated' ) ); + } + + /** + * is_valid_release_download_url rejects non-GitHub hosts. + */ + public function test_is_valid_release_download_url_rejects_invalid_host() { + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'is_valid_release_download_url' ); + $this->assertFalse( + $method->invoke( $this->plugin, 'https://evil.example/not-a-release.zip' ) + ); + } + + /** + * get_latest_github_release returns WP_Error when HTTP transport fails. + */ + public function test_get_latest_github_release_surfaces_transport_errors() { + update_option( 'rank_math_api_last_github_check', 0, false ); + + add_filter( + 'pre_http_request', + function () { + return new WP_Error( 'http_fail', 'Transport failed' ); + }, + 10, + 3 + ); + + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'get_latest_github_release' ); + $result = $method->invoke( $this->plugin ); + $this->assertWPError( $result ); + $this->assertSame( 'api_error', $result->get_error_code() ); + } + + /** + * render_admin_notice outputs action buttons when actions are present. + */ + public function test_render_admin_notice_outputs_action_links() { + if ( ! defined( 'WP_ADMIN' ) ) { + define( 'WP_ADMIN', true ); + } + + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'render_admin_notice' ); + ob_start(); + $method->invoke( + $this->plugin, + array( + 'type' => 'info', + 'message' => '

Test notice body

', + 'actions' => array( + array( + 'label' => 'Action label', + 'url' => 'https://example.com/action', + 'class' => 'button', + ), + ), + ) + ); + $output = ob_get_clean(); + $this->assertStringContainsString( 'Action label', $output ); + $this->assertStringContainsString( 'https://example.com/action', $output ); + } + + /** + * check_for_update skips when plugin is not in the checked list. + */ + public function test_check_for_update_skips_when_plugin_not_in_checked_list() { + $transient = (object) array( + 'checked' => array(), + 'response' => array(), + ); + + $result = $this->plugin->check_for_update( $transient ); + $this->assertSame( $transient, $result ); + } + + /** + * register_plugin_settings registers telemetry option with sanitize callback. + */ + public function test_register_plugin_settings_registers_telemetry_option() { + $this->plugin->register_plugin_settings(); + $this->assertArrayHasKey( 'rank_math_api_telemetry_settings', $GLOBALS['wp_registered_settings'] ); + } + + /** + * load_textdomain runs without fatal when languages directory is absent. + */ + public function test_load_textdomain_is_safe_without_mo_files() { + $this->plugin->load_textdomain(); + $this->assertTrue( true ); + } + + /** + * Site-level notice dismissals persist in options. + */ + public function test_dismiss_notice_for_site_persists_flag() { + $reflection = new ReflectionClass( $this->plugin ); + $dismiss = $reflection->getMethod( 'dismiss_notice_for_site' ); + $is_dismissed = $reflection->getMethod( 'is_notice_dismissed_for_site' ); + $dismiss->invoke( $this->plugin, 'telemetry_privacy_notice' ); + $this->assertTrue( $is_dismissed->invoke( $this->plugin, 'telemetry_privacy_notice' ) ); + } + + /** + * get_rank_math_debug_info returns diagnostic string for support. + */ + public function test_get_rank_math_debug_info_returns_diagnostics_array() { + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'get_rank_math_debug_info' ); + $info = $method->invoke( $this->plugin ); + $this->assertIsArray( $info ); + $this->assertTrue( $info['class_exists'] ); + } + + /** + * log_debug writes when WP_DEBUG is enabled. + */ + public function test_log_debug_runs_under_wp_debug() { + if ( ! defined( 'WP_DEBUG' ) ) { + define( 'WP_DEBUG', true ); + } + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'log_debug' ); + $method->invoke( $this->plugin, 'coverage gate debug probe' ); + $this->assertTrue( true ); + } + + /** + * get_dependency_notice_markup includes dependency guidance HTML. + */ + public function test_get_dependency_notice_markup_is_non_empty() { + $reflection = new ReflectionClass( $this->plugin ); + $method = $reflection->getMethod( 'get_dependency_notice_markup' ); + $markup = $method->invoke( $this->plugin ); + $this->assertStringContainsString( 'Rank Math', $markup ); + } +} diff --git a/tests/integration/DependencyStatusTest.php b/tests/integration/DependencyStatusTest.php new file mode 100644 index 0000000..2e000a0 --- /dev/null +++ b/tests/integration/DependencyStatusTest.php @@ -0,0 +1,25 @@ +get_dependency_status(); + + $this->assertIsArray( $status ); + $this->assertArrayHasKey( 'dependencies_met', $status ); + $this->assertTrue( $status['dependencies_met'] ); + $this->assertArrayHasKey( 'missing_plugins', $status ); + } +} diff --git a/tests/integration/GithubInvalidPayloadTest.php b/tests/integration/GithubInvalidPayloadTest.php new file mode 100644 index 0000000..3dbd619 --- /dev/null +++ b/tests/integration/GithubInvalidPayloadTest.php @@ -0,0 +1,82 @@ + array( 'code' => 200 ), + 'body' => 'not-json', + ); + } + return $preempt; + }, + 10, + 3 + ); + + $basename = plugin_basename( RANK_MATH_API_PLUGIN_FILE ); + $transient = (object) array( + 'checked' => array( + $basename => '1.0.0', + ), + 'response' => array(), + ); + + $filtered = apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + $this->assertEmpty( $filtered->response ); + } + + /** + * JSON without tag_name is rejected. + */ + public function test_github_missing_tag_name_is_handled() { + delete_transient( 'rank_math_api_github_release' ); + update_option( 'rank_math_api_last_github_check', 0, false ); + + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'api.github.com' ) ) { + return array( + 'response' => array( 'code' => 200 ), + 'body' => wp_json_encode( array( 'assets' => array() ) ), + ); + } + return $preempt; + }, + 10, + 3 + ); + + $basename = plugin_basename( RANK_MATH_API_PLUGIN_FILE ); + $transient = (object) array( + 'checked' => array( + $basename => '1.0.0', + ), + 'response' => array(), + ); + + $filtered = apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + $this->assertEmpty( $filtered->response ); + } +} diff --git a/tests/integration/GithubUpdaterTest.php b/tests/integration/GithubUpdaterTest.php new file mode 100644 index 0000000..1cf5c36 --- /dev/null +++ b/tests/integration/GithubUpdaterTest.php @@ -0,0 +1,127 @@ +plugin_basename = plugin_basename( RANK_MATH_API_PLUGIN_FILE ); + delete_transient( 'rank_math_api_github_release' ); + delete_option( 'rank_math_api_last_github_check' ); + } + + /** + * Mock GitHub API response populates release transient with validated download URL. + */ + public function test_github_release_fetch_caches_valid_release() { + $release_json = wp_json_encode( + array( + 'tag_name' => 'v2.0.0', + 'html_url' => 'https://github.com/devora-as/rank-math-api-manager/releases/tag/v2.0.0', + 'published_at' => gmdate( 'c' ), + 'body' => 'Release notes', + 'assets' => array( + array( + 'name' => 'rank-math-api-manager.zip', + 'browser_download_url' => 'https://github.com/devora-as/rank-math-api-manager/releases/download/v2.0.0/rank-math-api-manager.zip', + ), + ), + ) + ); + + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) use ( $release_json ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'api.github.com/repos/devora-as/rank-math-api-manager/releases/latest' ) ) { + return array( + 'response' => array( 'code' => 200 ), + 'body' => $release_json, + ); + } + return $preempt; + }, + 10, + 3 + ); + + $transient = (object) array( + 'checked' => array( + $this->plugin_basename => RANK_MATH_API_VERSION, + ), + 'response' => array(), + ); + + $filtered = apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + + $cached = get_transient( 'rank_math_api_github_release' ); + $this->assertIsArray( $cached ); + $this->assertSame( '2.0.0', $cached['version'] ); + $this->assertStringContainsString( 'releases/download/v2.0.0/', $cached['download_url'] ); + $this->assertObjectHasProperty( 'response', $filtered ); + $this->assertArrayHasKey( $this->plugin_basename, $filtered->response ); + } + + /** + * Release with invalid download path must not populate update response. + */ + public function test_github_release_with_invalid_asset_is_ignored() { + $release_json = wp_json_encode( + array( + 'tag_name' => 'v3.0.0', + 'html_url' => 'https://github.com/evil/example/releases/tag/v3.0.0', + 'published_at' => gmdate( 'c' ), + 'assets' => array( + array( + 'name' => 'evil.zip', + 'browser_download_url' => 'https://evil.example/download.zip', + ), + ), + ) + ); + + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) use ( $release_json ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'api.github.com' ) ) { + return array( + 'response' => array( 'code' => 200 ), + 'body' => $release_json, + ); + } + return $preempt; + }, + 10, + 3 + ); + + $transient = (object) array( + 'checked' => array( + $this->plugin_basename => '1.0.0', + ), + 'response' => array(), + ); + + $filtered = apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + + $this->assertEmpty( $filtered->response ); + } +} diff --git a/tests/integration/MetaAuthPermissionTest.php b/tests/integration/MetaAuthPermissionTest.php new file mode 100644 index 0000000..07b324a --- /dev/null +++ b/tests/integration/MetaAuthPermissionTest.php @@ -0,0 +1,70 @@ +plugin = Rank_Math_API_Manager_Extended::get_instance(); + $this->post_id = $this->factory->post->create( + array( + 'post_type' => 'post', + 'post_status' => 'publish', + ) + ); + $this->user_id = $this->factory->user->create( array( 'role' => 'editor' ) ); + } + + /** + * Meta auth callback allows editors to update supported meta keys. + */ + public function test_meta_auth_allows_editor_for_supported_post() { + wp_set_current_user( $this->user_id ); + + $allowed = $this->plugin->check_meta_auth_permission( false, 'rank_math_title', $this->post_id, $this->user_id, 'edit_post', array() ); + + $this->assertTrue( $allowed ); + } + + /** + * Meta auth callback denies unsupported post targets. + */ + public function test_meta_auth_denies_invalid_post_target() { + wp_set_current_user( $this->user_id ); + + $allowed = $this->plugin->check_meta_auth_permission( false, 'rank_math_title', 0, $this->user_id, 'edit_post', array() ); + + $this->assertFalse( $allowed ); + } +} diff --git a/tests/integration/PluginIntegrationCoverageTest.php b/tests/integration/PluginIntegrationCoverageTest.php new file mode 100644 index 0000000..897e095 --- /dev/null +++ b/tests/integration/PluginIntegrationCoverageTest.php @@ -0,0 +1,243 @@ +plugin = Rank_Math_API_Manager_Extended::get_instance(); + $this->admin_id = $this->factory->user->create( array( 'role' => 'administrator' ) ); + } + + /** + * Activation and deactivation hooks run without error. + */ + public function test_plugin_activate_and_deactivate_hooks() { + rank_math_api_manager_activate(); + $this->assertNotFalse( get_option( 'rank_math_api_activated', false ) ); + + rank_math_api_manager_deactivate(); + $this->assertFalse( wp_next_scheduled( 'rank_math_api_update_check' ) ); + } + + /** + * Telemetry settings sanitizer normalizes enabled flag. + */ + public function test_sanitize_telemetry_settings_normalizes_enabled_boolean() { + $sanitized = $this->plugin->sanitize_telemetry_settings( + array( + 'enabled' => 'yes', + ) + ); + + $this->assertIsArray( $sanitized ); + $this->assertTrue( $sanitized['enabled'] ); + } + + /** + * Admin scripts enqueue on plugins screen hook. + */ + public function test_enqueue_admin_scripts_on_plugins_screen() { + wp_set_current_user( $this->admin_id ); + $this->plugin->enqueue_admin_scripts( 'plugins.php' ); + $this->assertTrue( wp_script_is( 'rank-math-api-admin', 'enqueued' ) ); + $this->assertTrue( wp_style_is( 'rank-math-api-admin', 'enqueued' ) ); + } + + /** + * plugins_api filter returns plugin info with icons when release cached. + */ + public function test_plugins_api_returns_info_with_icons() { + set_transient( + 'rank_math_api_github_release', + array( + 'version' => RANK_MATH_API_VERSION, + 'download_url' => 'https://github.com/devora-as/rank-math-api-manager/releases/download/v1.0.9.2/rank-math-api-manager.zip', + 'published_at' => gmdate( 'c' ), + 'description' => 'Notes', + ), + 3600 + ); + + $args = (object) array( + 'slug' => 'rank-math-api-manager', + ); + + $result = apply_filters( 'plugins_api', false, 'plugin_information', $args ); + + $this->assertIsObject( $result ); + $this->assertObjectHasProperty( 'icons', $result ); + $this->assertNotEmpty( $result->icons ); + } + + /** + * Update check skips adding response when remote version matches current. + */ + public function test_check_for_update_skips_when_versions_match() { + $basename = plugin_basename( RANK_MATH_API_PLUGIN_FILE ); + set_transient( + 'rank_math_api_github_release', + array( + 'version' => RANK_MATH_API_VERSION, + 'download_url' => 'https://github.com/devora-as/rank-math-api-manager/releases/download/v' . RANK_MATH_API_VERSION . '/rank-math-api-manager.zip', + ), + 3600 + ); + + $transient = (object) array( + 'checked' => array( + $basename => RANK_MATH_API_VERSION, + ), + 'response' => array(), + ); + + $filtered = apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + + $this->assertEmpty( $filtered->response ); + } + + /** + * GitHub rate limit path returns WP_Error without HTTP when checked recently. + */ + public function test_github_rate_limit_blocks_rapid_release_fetch() { + update_option( 'rank_math_api_last_github_check', time(), false ); + delete_transient( 'rank_math_api_github_release' ); + + $basename = plugin_basename( RANK_MATH_API_PLUGIN_FILE ); + $transient = (object) array( + 'checked' => array( + $basename => '1.0.0', + ), + 'response' => array(), + ); + + $http_called = false; + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) use ( &$http_called ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'api.github.com' ) ) { + $http_called = true; + } + return $preempt; + }, + 10, + 3 + ); + + apply_filters( 'pre_set_site_transient_update_plugins', $transient ); + + $this->assertFalse( $http_called, 'Rate limit should prevent GitHub HTTP fetch.' ); + } + + /** + * Missing dependency renders dependency admin notice markup. + */ + public function test_dependency_missing_renders_error_notice() { + wp_set_current_user( $this->admin_id ); + set_current_screen( 'plugins' ); + + add_filter( + 'option_active_plugins', + function ( $plugins ) { + if ( ! is_array( $plugins ) ) { + return $plugins; + } + return array_values( + array_diff( $plugins, array( 'seo-by-rank-math/rank-math.php' ) ) + ); + } + ); + + ob_start(); + $this->plugin->render_admin_notices(); + $output = ob_get_clean(); + + $this->assertStringContainsString( 'Rank Math API Manager', $output ); + } + + /** + * Telemetry privacy notice markup renders when enabled and not dismissed. + */ + public function test_telemetry_privacy_notice_renders_when_enabled() { + wp_set_current_user( $this->admin_id ); + set_current_screen( 'plugins' ); + update_option( + 'rank_math_api_telemetry_settings', + array( + 'enabled' => true, + ), + false + ); + delete_option( 'rank_math_api_dismissed_notices' ); + + ob_start(); + $this->plugin->render_admin_notices(); + $output = ob_get_clean(); + + $this->assertStringContainsString( 'Telemetry', $output ); + } + + /** + * Scheduled telemetry heartbeat respects opt-out. + */ + public function test_scheduled_telemetry_respects_opt_out() { + update_option( + 'rank_math_api_telemetry_settings', + array( + 'enabled' => false, + ), + false + ); + + $http_called = false; + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) use ( &$http_called ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'updates.devora.no' ) ) { + $http_called = true; + } + return $preempt; + }, + 10, + 3 + ); + + $this->plugin->send_scheduled_telemetry(); + + $this->assertFalse( $http_called ); + } + + /** + * on_plugin_activated rechecks dependencies when Rank Math is activated. + */ + public function test_on_plugin_activated_for_dependency_triggers_recheck() { + $this->plugin->on_plugin_activated( 'seo-by-rank-math/rank-math.php' ); + $this->assertTrue( (bool) get_option( 'rank_math_api_dependencies_status', false ) ); + } +} diff --git a/tests/integration/RestPermissionTest.php b/tests/integration/RestPermissionTest.php new file mode 100644 index 0000000..e9e6ab3 --- /dev/null +++ b/tests/integration/RestPermissionTest.php @@ -0,0 +1,89 @@ +post_id = $this->factory->post->create( + array( + 'post_type' => 'post', + 'post_status' => 'publish', + ) + ); + $this->editor_id = $this->factory->user->create( array( 'role' => 'editor' ) ); + $this->subscriber_id = $this->factory->user->create( array( 'role' => 'subscriber' ) ); + } + + /** + * Logged-out requests receive 401. + */ + public function test_update_meta_requires_authentication() { + wp_set_current_user( 0 ); + + $request = new WP_REST_Request( 'POST', '/rank-math-api/v1/update-meta' ); + $request->set_param( 'post_id', $this->post_id ); + $response = rest_do_request( $request ); + + $this->assertSame( 401, $response->get_status() ); + } + + /** + * Users without edit_post capability receive 403. + */ + public function test_update_meta_denies_user_without_edit_post_cap() { + wp_set_current_user( $this->subscriber_id ); + + $request = new WP_REST_Request( 'POST', '/rank-math-api/v1/update-meta' ); + $request->set_param( 'post_id', $this->post_id ); + $request->set_param( 'rank_math_title', 'Denied Title' ); + $response = rest_do_request( $request ); + + $this->assertSame( 403, $response->get_status() ); + } + + /** + * Editor can update own editable post. + */ + public function test_update_meta_allows_editor_with_capability() { + wp_set_current_user( $this->editor_id ); + + $request = new WP_REST_Request( 'POST', '/rank-math-api/v1/update-meta' ); + $request->set_param( 'post_id', $this->post_id ); + $request->set_param( 'rank_math_title', 'Allowed Title' ); + $response = rest_do_request( $request ); + + $this->assertSame( 200, $response->get_status() ); + } +} diff --git a/tests/integration/SanitizersIntegrationTest.php b/tests/integration/SanitizersIntegrationTest.php new file mode 100644 index 0000000..344eb3a --- /dev/null +++ b/tests/integration/SanitizersIntegrationTest.php @@ -0,0 +1,48 @@ +plugin = Rank_Math_API_Manager_Extended::get_instance(); + } + + /** + * Non-scalar text values sanitize to empty string. + */ + public function test_sanitize_rank_math_text_field_rejects_non_scalar() { + $this->assertSame( '', $this->plugin->sanitize_rank_math_text_field( array( 'x' ) ) ); + } + + /** + * Non-scalar canonical values sanitize to empty string. + */ + public function test_sanitize_rank_math_canonical_url_rejects_non_scalar() { + $this->assertSame( '', $this->plugin->sanitize_rank_math_canonical_url( new stdClass() ) ); + } + + /** + * Non-scalar focus keyword values sanitize to empty string. + */ + public function test_sanitize_rank_math_focus_keyword_rejects_non_scalar() { + $this->assertSame( '', $this->plugin->sanitize_rank_math_focus_keyword( null ) ); + } +} diff --git a/tests/integration/TelemetryPrivacyTest.php b/tests/integration/TelemetryPrivacyTest.php new file mode 100644 index 0000000..0c8176c --- /dev/null +++ b/tests/integration/TelemetryPrivacyTest.php @@ -0,0 +1,113 @@ +plugin = Rank_Math_API_Manager_Extended::get_instance(); + } + + /** + * Telemetry disabled must not send HTTP requests. + */ + public function test_telemetry_disabled_does_not_send_http() { + update_option( + 'rank_math_api_telemetry_settings', + array( + 'enabled' => false, + ), + false + ); + + $http_called = false; + add_filter( + 'pre_http_request', + function ( $preempt, $args, $url ) use ( &$http_called ) { + unset( $preempt, $args ); + if ( false !== strpos( $url, 'updates.devora.no' ) ) { + $http_called = true; + } + return $preempt; + }, + 10, + 3 + ); + + $result = $this->plugin->send_telemetry_event( 'heartbeat' ); + + $this->assertFalse( $result ); + $this->assertFalse( $http_called, 'Telemetry HTTP must not run when disabled.' ); + } + + /** + * Invalid event types are rejected without HTTP. + */ + public function test_telemetry_rejects_unknown_event_type() { + update_option( + 'rank_math_api_telemetry_settings', + array( + 'enabled' => true, + ), + false + ); + + $this->assertFalse( $this->plugin->send_telemetry_event( 'invalid_event' ) ); + } + + /** + * Enabled telemetry posts JSON to the fixed Devora endpoint. + */ + public function test_telemetry_enabled_sends_to_devora_endpoint() { + update_option( + 'rank_math_api_telemetry_settings', + array( + 'enabled' => true, + ), + false + ); + + $captured_url = ''; + $captured_body = ''; + $filter_callback = function ( $preempt, $args, $url ) use ( &$captured_url, &$captured_body ) { + unset( $preempt ); + $captured_url = $url; + $captured_body = isset( $args['body'] ) ? $args['body'] : ''; + return array( + 'response' => array( 'code' => 204 ), + 'body' => '', + ); + }; + add_filter( 'pre_http_request', $filter_callback, 10, 3 ); + + $result = $this->plugin->send_telemetry_event( 'activate' ); + + remove_filter( 'pre_http_request', $filter_callback, 10 ); + + $this->assertTrue( $result ); + $this->assertSame( 'https://updates.devora.no/v1/telemetry', $captured_url ); + $decoded = json_decode( $captured_body, true ); + $this->assertIsArray( $decoded ); + $this->assertSame( 'activate', $decoded['event_type'] ); + $this->assertSame( 'rank-math-api-manager', $decoded['plugin_slug'] ); + $this->assertArrayNotHasKey( 'admin_email', $decoded ); + $this->assertArrayNotHasKey( 'site_url', $decoded ); + } +} diff --git a/tests/integration/UninstallCleanupTest.php b/tests/integration/UninstallCleanupTest.php new file mode 100644 index 0000000..49c5eb9 --- /dev/null +++ b/tests/integration/UninstallCleanupTest.php @@ -0,0 +1,38 @@ + true, + 'site_id' => 'test-site-id', + ), + false + ); + set_transient( 'rank_math_api_github_release', array( 'version' => '9.9.9' ), 3600 ); + + rank_math_api_manager_uninstall(); + + $this->assertFalse( get_option( 'rank_math_api_activated', false ) ); + $this->assertFalse( get_option( 'rank_math_api_dependencies_status', false ) ); + $this->assertFalse( get_option( 'rank_math_api_github_token', false ) ); + $this->assertFalse( get_option( 'rank_math_api_telemetry_settings', false ) ); + $this->assertFalse( get_transient( 'rank_math_api_github_release' ) ); + } +} diff --git a/tests/integration/UpdateMetaEdgeCasesTest.php b/tests/integration/UpdateMetaEdgeCasesTest.php new file mode 100644 index 0000000..9ade263 --- /dev/null +++ b/tests/integration/UpdateMetaEdgeCasesTest.php @@ -0,0 +1,93 @@ +post_id = $this->factory->post->create( + array( + 'post_type' => 'post', + 'post_status' => 'publish', + ) + ); + $this->user_id = $this->factory->user->create( array( 'role' => 'editor' ) ); + } + + /** + * Unchanged meta values return status unchanged in response data. + */ + public function test_update_meta_reports_unchanged_when_value_matches() { + wp_set_current_user( $this->user_id ); + update_post_meta( $this->post_id, 'rank_math_title', 'Existing Title' ); + + $request = new WP_REST_Request( 'POST', '/rank-math-api/v1/update-meta' ); + $request->set_param( 'post_id', $this->post_id ); + $request->set_param( 'rank_math_title', 'Existing Title' ); + $response = rest_do_request( $request ); + + $this->assertSame( 200, $response->get_status() ); + $data = $response->get_data(); + $this->assertIsArray( $data ); + $this->assertArrayHasKey( 'rank_math_title', $data ); + $this->assertSame( 'unchanged', $data['rank_math_title'] ); + } + + /** + * Canonical URL is sanitized to a safe URL string. + */ + public function test_update_meta_sanitizes_canonical_url() { + wp_set_current_user( $this->user_id ); + + $request = new WP_REST_Request( 'POST', '/rank-math-api/v1/update-meta' ); + $request->set_param( 'post_id', $this->post_id ); + $request->set_param( 'rank_math_canonical_url', 'https://example.com/path/?q=1' ); + $response = rest_do_request( $request ); + + $this->assertSame( 200, $response->get_status() ); + $this->assertSame( + 'https://example.com/path/?q=1', + get_post_meta( $this->post_id, 'rank_math_canonical_url', true ) + ); + } + + /** + * Invalid canonical URL is rejected or emptied by sanitizer. + */ + public function test_update_meta_rejects_invalid_canonical_url() { + wp_set_current_user( $this->user_id ); + + $request = new WP_REST_Request( 'POST', '/rank-math-api/v1/update-meta' ); + $request->set_param( 'post_id', $this->post_id ); + $request->set_param( 'rank_math_canonical_url', 'javascript:alert(1)' ); + $response = rest_do_request( $request ); + + $this->assertSame( 200, $response->get_status() ); + $stored = get_post_meta( $this->post_id, 'rank_math_canonical_url', true ); + $this->assertSame( '', $stored ); + } +} diff --git a/tests/integration/UpdateMetaProductTest.php b/tests/integration/UpdateMetaProductTest.php index 6d218be..1738b26 100644 --- a/tests/integration/UpdateMetaProductTest.php +++ b/tests/integration/UpdateMetaProductTest.php @@ -35,6 +35,18 @@ public function set_up() { return; } + if ( ! post_type_exists( 'product' ) ) { + register_post_type( + 'product', + array( + 'public' => true, + 'show_in_rest' => true, + 'capability_type' => 'post', + 'map_meta_cap' => true, + ) + ); + } + $this->product_id = $this->factory->post->create( array( 'post_type' => 'product',