Working on refactoring plugin. Adding settings tests. Moving templates under "Templates". Refactoring iframe functionality.

Author: colinmurphy

plugins/hwp-previews/TESTING.md

@@ -55,7 +55,10 @@ The plugin provides scripts to set up a local WordPress environment for testing,
 
 ## Running Tests
 
-@TODO
+Currently the plugin has the following suite of tests
+
+1. WP Unit Tests - (Unit and Integration Tests)
+2. E2E Tests - Playright tests
 
 ### WPUnit (WordPress-aware Unit/Integration) Tests
 
@@ -69,24 +72,12 @@ sh bin/local/run-unit-tests.sh coverage
 > You can also add coverage e.g. `sh bin/local/run-unit-tests.sh coverage --coverage-html` and the output will be saved in [tests/_output/coverage/dashboard.html](tests/_output/coverage/dashboard.html)
 
 
-### Functional Tests
-
-Run functional tests (simulate web requests):
-
-```bash
-composer run test:functional
-# or
-vendor/bin/codecept run functional
-```
-
-### Acceptance Tests
+### E2WTests
 
 Run browser-based acceptance tests:
 
 ```bash
-composer run test:acceptance
-# or
-vendor/bin/codecept run acceptance
+sh bin/local/run-e2e-tests.sh coverage
 ```
 
 ### All Tests

plugins/hwp-previews/bin/local/run-e2e-tests.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+# Run Playwright E2E tests for GitHub Actions
+
+set -e
+
+# Install dependencies if needed
+npm ci
+
+# Install composer dependencies
+composer install
+
+# Install Playwright browsers
+npx playwright install --with-deps
+
+# Start wp-env
+npm run wp-env start
+
+# Run Playwright tests
+npm run test:e2e
+
+# Stop wp-env
+npm run wp-env stop

plugins/hwp-previews/codeception.dist.yml

@@ -31,6 +31,9 @@ extensions:
         - lucatume\WPBrowser\Command\MonkeyCachePath
         - lucatume\WPBrowser\Command\RunAll
         - lucatume\WPBrowser\Command\RunOriginal
+exclude:
+    - src/Templates
+    - src/Templates/*
 coverage:
     enabled: true
     remote: false
@@ -48,6 +51,7 @@ coverage:
         - /tests/*
         - /vendor-prefixed/*
         - /vendor/*
+        - /src/Templates/*
     show_only_summary: false
 modules:
     config:

plugins/hwp-previews/composer.json

@@ -128,7 +128,15 @@
 		],
 		"php:psalm": "psalm",
 		"php:psalm:info": "psalm --show-info=true",
-		"php:psalm:fix": "psalm --alter"
+		"php:psalm:fix": "psalm --alter",
+		"test": [
+			"sh bin/local/run-unit-tests.sh",
+			"sh bin/local/run-e2e-tests.sh"
+		],
+		"test:unit": "sh bin/local/run-unit-tests.sh",
+		"test:unit:coverage": "sh bin/local/run-unit-tests.sh coverage",
+		"test:unit:coverage-html": "sh bin/local/run-unit-tests.sh coverage --coverage-html",
+		"test:e2e": "sh bin/local/run-e2e-tests.sh"
 	},
 	"support": {
 		"docs": "https://github.com/wpengine/hwptoolkit/tree/main/docs",

plugins/hwp-previews/hwp-previews.php

@@ -84,11 +84,6 @@ function hwp_previews_constants(): void {
 	if ( ! defined( 'HWP_PREVIEWS_TEXT_DOMAIN' ) ) {
 		define( 'HWP_PREVIEWS_TEXT_DOMAIN', 'hwp-previews' );
 	}
-
-	// Plugin Template Directory.
-	if ( ! defined( 'HWP_PREVIEWS_TEMPLATE_DIR' ) ) {
-		define( 'HWP_PREVIEWS_TEMPLATE_DIR', trailingslashit( HWP_PREVIEWS_PLUGIN_DIR ) . '/src/Admin/Settings/Templates/' );
-	}
 }
 
 // phpcs:enable Generic.Metrics.CyclomaticComplexity.TooHigh

plugins/hwp-previews/src/Admin/Settings/Fields/Field/URL_Input_Field.php

@@ -43,7 +43,16 @@ public function get_input_type(): string {
 	 * @param string $value
 	 */
 	private function fix_url( string $value ): string {
-		// Remove HTML tags, trim, encode spaces, add protocol.
+
+
+		if ( '' === $value ) {
+			return '';
+		}
+
+		// Remove <script> tags and their content to prevent XSS.
+		$value = preg_replace( '#<script.*?>.*?</script>#is', '', $value );
+
+		// Remove HTML tags except curly braces, trim, encode spaces, add protocol.
 		$value = preg_replace( '/<(?!\{)[^>]+>/', '', $value );
 		$value = trim( str_replace( ' ', '%20', (string) $value ) );
 
@@ -55,7 +64,7 @@ private function fix_url( string $value ): string {
 		if ( $has_prootocol ) {
 			return $value;
 		}
-			$protocol = is_ssl() ? 'https://' : 'http://';
-			return $protocol . ltrim( $value, '/' );
+		$protocol = is_ssl() ? 'https://' : 'http://';
+		return $protocol . ltrim( $value, '/' );
 	}
 }

plugins/hwp-previews/src/Admin/Settings_Page.php

@@ -7,9 +7,9 @@
 use HWP\Previews\Admin\Settings\Fields\Settings_Field_Collection;
 use HWP\Previews\Admin\Settings\Menu\Menu_Page;
 use HWP\Previews\Admin\Settings\Settings_Form_Manager;
-use HWP\Previews\Post\Type\Contracts\Post_Types_Config_Interface;
-use HWP\Previews\Post\Type\Post_Types_Config_Registry;
 use HWP\Previews\Preview\Parameter\Preview_Parameter_Registry;
+use HWP\Previews\Preview\Post\Type\Contracts\Post_Types_Config_Interface;
+use HWP\Previews\Preview\Post\Type\Post_Types_Config_Registry;
 
 class Settings_Page {
 	/**
@@ -23,7 +23,7 @@ class Settings_Page {
 	protected Preview_Parameter_Registry $parameters;
 
 	/**
-	 * @var \HWP\Previews\Post\Type\Contracts\Post_Types_Config_Interface The post types available for previews.
+	 * @var \HWP\Previews\Preview\Post\Type\Contracts\Post_Types_Config_Interface The post types available for previews.
 	 */
 	protected Post_Types_Config_Interface $types_config;
 
@@ -80,7 +80,7 @@ public function register_settings_pages(): void {
 				__( 'HWP Previews Settings', 'hwp-previews' ),
 				'HWP Previews',
 				self::PLUGIN_MENU_SLUG,
-				trailingslashit( HWP_PREVIEWS_TEMPLATE_DIR ) . 'settings-page-main.php',
+				trailingslashit(HWP_PREVIEWS_PLUGIN_DIR) . 'src/Templates/admin.php',
 				[
 					'hwp_previews_main_page_config' => [
 						'tabs'        => $post_types,