chore: DRAFT - Add test to Previews and setup test workflow for plugins #241

colinmurphy · 2025-06-04T14:28:54Z

Description

Related Issue

Dependant PRs

Type of Change

✅ Bug fix (non-breaking change which fixes an issue)
✨ New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to change)
🧹 Code refactoring (no functional changes)
📄 Example update (no functional changes)
📝 Documentation update
🔍 Performance improvement
🧪 Test update

How Has This Been Tested?

Screenshots

Checklist

I have read the CONTRIBUTING document
My code follows the project's coding standards
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation (if applicable)
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works (if applicable)
Any dependent changes have been highlighted, merged or published

github-actions · 2025-06-04T14:29:58Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T14:43:07Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T14:48:42Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T14:52:49Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T15:30:14Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T15:55:50Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T15:58:33Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T15:59:31Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T18:30:56Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T18:35:45Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T18:37:32Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T18:40:26Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T18:45:29Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T19:07:35Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T19:15:53Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T19:22:48Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-04T19:29:08Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

moonmeister · 2025-06-04T19:47:43Z

I think it may be time for some caching optimizations. You can check out how I do this with Node on the Faust repo. Basically, I install & set up Node, install dependencies, then the disk is cached under a unique hash based on the state of package-lock.json. All other checks then depend on that setup and only have to restore the cache to have Node and its dependencies. This saves about 45 seconds on each downstream task. Rerunning things is optimized cause code might change, but as long as it's the same set of dependencies, then that initial task doesn't have to rerun, but only restore from cache.

Looks like at least composer install, if not some wider PHP config, could be configured to only happen once, and then have PHPCS, tests, and artifact creation all do cache restores.

colinmurphy · 2025-06-05T05:54:50Z

Thanks @moonmeister ❤️

Thanks for the great feedback. I will have a look tomorrow at how you setup caching on Faust and look at making some optimizations.

github-actions · 2025-06-06T10:01:20Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-06T15:24:26Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-06T16:58:02Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

github-actions · 2025-06-09T17:19:34Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

…cripts.

github-actions · 2025-06-11T19:51:14Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

Copilot

Pull Request Overview

This PR introduces test enhancements and refactors the plugin’s configuration while setting up a comprehensive testing and CI/CD workflow for the HWP Previews plugin.

Refactored the plugin constant definitions to use individual conditional definitions with appropriate PHPCS disable/enable comments.
Added Docker configuration, updated composer dependencies, and introduced new GitHub Actions workflows and composite actions for Codeception tests, plugin artifact creation, and overall code quality.

Reviewed Changes

Copilot reviewed 70 out of 70 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
plugins/hwp-previews/hwp-previews.php	Refactored constant definitions and added PHPCS disable/enable comments
plugins/hwp-previews/docker-compose.yml	Introduced Docker environment configuration for testing
plugins/hwp-previews/composer.json	Updated dev dependencies and composer scripts for testing and build tasks
plugins/hwp-previews/codeception.dist.yml	Added configuration for Codeception testing environment
plugins/hwp-previews/README.md	Updated documentation to include testing instructions
plugins/hwp-previews/ACTIONS_AND_FILTERS.md	Updated developer documentation to reflect new filters
plugins/hwp-previews/.gitignore	Expanded ignore rules to cover new test directories and generated files
plugins/hwp-previews/.env.dist	Added environment variable definitions for testing
plugins/hwp-previews/.docker/ (init-docker.sh, Dockerfile, .env.ci)	Added scripts and Docker setup for seamless testing
.github/workflows/ (multiple YAML files)	Added/updated GitHub Actions workflow triggers to support PHP-only plugin changes
.github/actions/ (composite actions)	Introduced composite actions for PHP setup, Codeception tests, and plugin artifact creation

Comments suppressed due to low confidence (1)

.github/workflows/plugin-artifact-for-pr.yml:6

The workflow trigger pattern was updated to 'plugins/**.php', which restricts the trigger to PHP files only. Confirm that changes in non-PHP files (e.g. configuration or documentation) do not need to trigger artifact builds.

- 'plugins/**'

Copilot · 2025-06-11T19:52:41Z

plugins/hwp-previews/hwp-previews.php

@@ -48,25 +48,41 @@

 /**
 * Define plugin constants.
+ *
+ * phpcs:disable Generic.Metrics.CyclomaticComplexity.TooHigh


[nitpick] Consider reviewing the need to disable complexity checks in the hwp_previews_constants function; refactoring to reduce complexity could allow re-enabling these rules.

Copilot · 2025-06-11T19:52:41Z

.github/actions/codeception/action.yml

+          --env SKIP_TESTS_CLEANUP=${{ env.SKIP_TESTS_CLEANUP }} \
+          --env SUITES=acceptance \
+          $(docker compose ps -q wordpress) \
+          bash -c "cd wp-content/plugins/$(basename ${{ inputs.working-directory }}) && bin/run-codeception.sh"


[nitpick] Consider verifying that using 'basename' on the working directory consistently derives the correct plugin folder, especially when the input path may include a trailing slash.

Suggested change

bash -c "cd wp-content/plugins/$(basename ${{ inputs.working-directory }}) && bin/run-codeception.sh"

bash -c "cd wp-content/plugins/$(basename $(echo ${{ inputs.working-directory }} | sed 's:/*$::')) && bin/run-codeception.sh"

github-actions · 2025-06-11T20:06:11Z

ℹ️ Download the hwp-previews plugin artifact from this workflow run (see the 'Artifacts' section at the bottom).

colinmurphy added 4 commits June 3, 2025 13:17

Merge branch 'main' into chore-add-phpunit-tests

83ab584

Removed Post_Data_Model class as not used anymore.

b402f05

Merge branch 'main' into chore-add-phpunit-tests

77ae3dd

Initial setup of testing framework.

9ce7e07

Modified workflow to fix working directory issue.

4910d38

Moved codeception into its own action.

fd7b00c

Updated path for the codeception action.

d2417aa

Fixing action to get it working.

9c387c0

Fixed path.

f41a5fa

Added missing step to get plugin directory.

b9dc66a

Fixed variable for working directory to include plugins.

4167311

Updating action. Not complete.

f5d3b54

Updated workflow.

05e30c4

Fixed workflow.

aaa3442

Added .env.ci file

bbbc9e4

Added missing install plugins script.

00501ab

Only install npm if it exists.

e949af5

Added missing dev packages for composer.

96881aa

Fixes for tests

faebbea

Added codeception build.

75615de

colinmurphy added 2 commits June 6, 2025 10:33

Trying to cache composer vendor directory.

a5cc643

Removed cached files.

1af13c9

colinmurphy added 2 commits June 6, 2025 11:05

Updated other actions for composer.

05c017f

Fixed working directory for plugin artifact.

14587d1

colinmurphy added 2 commits June 6, 2025 17:57

Added missing file.

459461d

Merge branch 'main' into chore-add-phpunit-tests

a3f4a08

colinmurphy added 2 commits June 6, 2025 19:17

Merge branch 'main' into chore-add-phpunit-tests

df45c0a

Refactor settings to make it easier to test.

920735e

colinmurphy mentioned this pull request Jun 9, 2025

fix(previews): validate URL input #243

Open

colinmurphy requested a review from Copilot June 11, 2025 15:06

This comment was marked as outdated.

Sign in to view

Added unit tests for fields. Slight refactor. Added some local test s…

eaaa8c8

…cripts.

colinmurphy requested a review from Copilot June 11, 2025 19:51

Copilot AI reviewed Jun 11, 2025

View reviewed changes

PHPCS and PHPStan fixes.

a82a16a

	bash -c "cd wp-content/plugins/$(basename ${{ inputs.working-directory }}) && bin/run-codeception.sh"
	bash -c "cd wp-content/plugins/$(basename $(echo ${{ inputs.working-directory }} \| sed 's:/*$::')) && bin/run-codeception.sh"

chore: DRAFT - Add test to Previews and setup test workflow for plugins #241

Are you sure you want to change the base?

chore: DRAFT - Add test to Previews and setup test workflow for plugins #241

Conversation

colinmurphy commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Dependant PRs

Type of Change

How Has This Been Tested?

Screenshots

Checklist

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

moonmeister commented Jun 4, 2025

Uh oh!

colinmurphy commented Jun 5, 2025

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

github-actions bot commented Jun 9, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

github-actions bot commented Jun 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 11, 2025

Uh oh!

Uh oh!

colinmurphy commented Jun 4, 2025 •

edited

Loading