[ci-jobs] Add support for github event and include HPOS disabled e2e tests in ci #46922

adimoldovan · 2024-04-25T14:01:17Z

Submission Review Guidelines:

I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have reviewed my code for security best practices.

Changes proposed in this Pull Request:

Closes #46925
Closes #46924

Adds support for Github events in ci-jobs, so we can only run jobs for specific events, like only for push.

Added a new option in job configuration: events as an array of strings, which should contain a list of events for which the job should run. If no events list is defined or the list is empty the job will run for any event.
Added a new argument for the ci-jobs cli: --event or -e. If no argument is passed the tool will consider all jobs and do not filter by event.
Moved the HPOS disabled e2e tests into ci.yml by configuring a new project with events: [push] configuration. This should only run for push events and not run for pull_request
Deprecated 2 workflows for HPOS disabled e2e tests: one for push to trunk and one for daily runs (did not even know this existed until now).
Improved the HPOS disabled env setup. Because you cannot set environment variables in the job's run command I had to update the env:test:non-hpos command and the test env setup script to disable the HPOS feature. Also added a print for the HPOS value in the global setup to easily spot if the expected value is set.

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

Run pnpm utils ci-jobs with different arguments and check the output.

pnpm utils ci-jobs --event push should return all configured jobs, including the HPOS disabled ones (5 e2e and 1 API)
pnpm utils ci-jobs --event pull_request should return all configured jobs without the 5 shards of "Core e2e tests - HPOS disabled" and without the Core API tests - HPOS disabled
pnpm utils ci-jobs should return all configured jobs including the HPOS disabled ones.

Check CI, the Build Matrix step should call pnpm utils ci-jobs with the right event argument.
Tested in CI that HPOS tests having the pull_request event configured were triggered: https://github.com/woocommerce/woocommerce/actions/runs/8838048787?pr=46922
Tested with e2e set to push event only (default value) and they were not triggered: https://github.com/woocommerce/woocommerce/actions/runs/8838873869/job/24271155448?pr=46922

…d-support-for-events-in-ci-jobs

github-actions · 2024-04-25T20:48:27Z

Hi @rrennick, @woocommerce/vortex

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

…d-support-for-events-in-ci-jobs # Conflicts: # tools/monorepo-utils/dist/index.js

rrennick

pnpm utils ci-jobs should return all configured jobs without the 5 shards of "Core e2e tests - HPOS disabled"

The response includes the 5 HPOS disabled tests for me. Also, this PR only includes @woocommerce/plugin-woocommerce - Core API tests - HPOS disabled when the other HPOS disabled tests are included. The PR testing instructions should be updated to reflect that.

I'm leaving this as a comment to not hang the PR on my review as I'll be AFK next week.

rrennick · 2024-04-26T16:07:05Z

tools/monorepo-utils/src/ci-jobs/index.ts

@@ -23,11 +23,24 @@ const program = new Command( 'ci-jobs' )
 		'Base ref to compare the current ref against for change detection. If not specified, all projects will be considered changed.',
 		''
 	)
+	.option(
+		'-e --event <event>',
+		'Github event for which to run the jobs. If not specified, all projects will with changes be considered.',


The wording here is unclear. Do you mean If not specified, all events will be considered.? The current code already considers all packages with changes.

I was struggling to get the right wording here. Your suggestion is much better. Updated with 5008e80

…d-support-for-events-in-ci-jobs

adimoldovan · 2024-04-26T22:53:54Z

pnpm utils ci-jobs should return all configured jobs without the 5 shards of "Core e2e tests - HPOS disabled"

The response includes the 5 HPOS disabled tests for me. Also, this PR only includes @woocommerce/plugin-woocommerce - Core API tests - HPOS disabled when the other HPOS disabled tests are included. The PR testing instructions should be updated to reflect that.

I fixed the testing instructions. That command should return the HPOS disabled tests, it worked as expected.

lanej0

LGTM

…tests in ci (#46922) * Update env setup script to disable hpos * Use DISABLE_HPOS instead of ENABLE_HPOS * Log HPOS state * Configure project for core e2e with HPOS disabled * Add event argument for ci-jobs util * Add event option for test jobs * Add support for github events * Add changelog * Configure HPOS tests to run on pull_request * Fix utils tests for undefined commandVars * Added some tests for the event configuration * Revert event for HPOS e2e to push * Use matrix name in artifact name to avoid duplication * Test with pull_request event * Use job-index for unique artifacts names * Revert event for HPOS e2e to push * Add api tests for HPOS disabled * Use unique artifact name for api tests * Revert event for HPOS disabled api tests to push * Rebuild monorepo utils to fix a merge conflict * Updated wording

adimoldovan added 8 commits April 25, 2024 15:28

Update env setup script to disable hpos

c95da36

Use DISABLE_HPOS instead of ENABLE_HPOS

40fdee8

Log HPOS state

2ab4c49

Configure project for core e2e with HPOS disabled

bcb880a

Add event argument for ci-jobs util

4f3f9f9

Add event option for test jobs

4f1fab1

Add support for github events

02c903f

Add changelog

2a98402

adimoldovan self-assigned this Apr 25, 2024

github-actions bot added focus: e2e tests Issues related to e2e tests plugin: woocommerce Issues related to the WooCommerce Core plugin. focus: monorepo infrastructure Issues and PRs related to monorepo tooling. labels Apr 25, 2024

adimoldovan added 12 commits April 25, 2024 17:11

Configure HPOS tests to run on pull_request

a95bc4d

Fix utils tests for undefined commandVars

13b3a4b

Added some tests for the event configuration

f717231

Revert event for HPOS e2e to push

96016ee

Use matrix name in artifact name to avoid duplication

ba02398

Test with pull_request event

8dac4a5

Use job-index for unique artifacts names

b49fb9d

Merge branch 'trunk' of github.com:woocommerce/woocommerce into ci/ad…

8da0e36

…d-support-for-events-in-ci-jobs

Revert event for HPOS e2e to push

5a003a2

Add api tests for HPOS disabled

2985e15

Use unique artifact name for api tests

284105a

Revert event for HPOS disabled api tests to push

f3a4723

adimoldovan marked this pull request as ready for review April 25, 2024 20:47

woocommercebot requested a review from a team April 25, 2024 20:48

adimoldovan added 2 commits April 26, 2024 10:35

Merge branch 'trunk' of github.com:woocommerce/woocommerce into ci/ad…

8e9a077

…d-support-for-events-in-ci-jobs # Conflicts: # tools/monorepo-utils/dist/index.js

Rebuild monorepo utils to fix a merge conflict

40c5821

rrennick reviewed Apr 26, 2024

View reviewed changes

adimoldovan added 2 commits April 27, 2024 01:51

Updated wording

5008e80

Merge branch 'trunk' of github.com:woocommerce/woocommerce into ci/ad…

4fda09d

…d-support-for-events-in-ci-jobs

adimoldovan requested review from a team and rrennick April 27, 2024 08:24

adimoldovan added the focus: testing workflows Issues related to test related workflows (daily, release, merge to trunk etc). label Apr 29, 2024

lanej0 approved these changes May 1, 2024

View reviewed changes

lanej0 merged commit de91a08 into trunk May 1, 2024
35 checks passed

lanej0 deleted the ci/add-support-for-events-in-ci-jobs branch May 1, 2024 17:36

github-actions bot added this to the 9.0.0 milestone May 1, 2024

github-actions bot added the needs: analysis Indicates if the PR requires a PR testing scrub session. label May 1, 2024

rodelgc added status: analysis complete Indicates if a PR has been analysed by Solaris and removed needs: analysis Indicates if the PR requires a PR testing scrub session. labels May 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ci-jobs] Add support for github event and include HPOS disabled e2e tests in ci #46922

[ci-jobs] Add support for github event and include HPOS disabled e2e tests in ci #46922

adimoldovan commented Apr 25, 2024 •

edited

Loading

github-actions bot commented Apr 25, 2024 •

edited

Loading

rrennick left a comment

rrennick Apr 26, 2024

adimoldovan Apr 26, 2024

adimoldovan commented Apr 26, 2024

lanej0 left a comment

[ci-jobs] Add support for github event and include HPOS disabled e2e tests in ci #46922

[ci-jobs] Add support for github event and include HPOS disabled e2e tests in ci #46922

Conversation

adimoldovan commented Apr 25, 2024 • edited Loading

Submission Review Guidelines:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

github-actions bot commented Apr 25, 2024 • edited Loading

rrennick left a comment

Choose a reason for hiding this comment

rrennick Apr 26, 2024

Choose a reason for hiding this comment

adimoldovan Apr 26, 2024

Choose a reason for hiding this comment

adimoldovan commented Apr 26, 2024

lanej0 left a comment

Choose a reason for hiding this comment

adimoldovan commented Apr 25, 2024 •

edited

Loading

github-actions bot commented Apr 25, 2024 •

edited

Loading