Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli: Rewrite test command #40175

Merged
merged 2 commits into from
Nov 14, 2024
Merged

cli: Rewrite test command #40175

merged 2 commits into from
Nov 14, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Nov 13, 2024

Proposed changes:

Bring in a few new features:

  • Ability to specify multiple projects to test, which will be run in parallel if --verbose is not used.
  • Correct handling of tests that use ARTIFACTS_DIR.
  • Correct handling of coverage tests, without having to manually set COVERAGE_DIR.
  • Coverage tests now generate an HTML report by default.

Unfortunately, there are some breaking changes here:

  • The order of the "test" and "project" arguments has changed.
  • By default the output from PHPUnit or jest will no longer be shown. Run with --verbose if you want to see it.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

None to link. In our last Garage meeting we talked about having a way to run coverage tests locally to generate an HTML report, this is what I came up with.

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • Try it out! Arrange for some tests to fail and try that too.

Bring in a few new features:

* Ability to specify multiple projects to test, which will be run in
  parallel if `--verbose` is not used.
* Correct handling of tests that use `ARTIFACTS_DIR`.
* Correct handling of coverage tests, without having to manually set
  `COVERAGE_DIR`.
* Coverage tests now generate an HTML report by default.

Unfortunately, there are some breaking changes here:

* The order of the "test" and "project" arguments has changed.
* By default the output from PHPUnit or jest will no longer be shown.
  Run with `--verbose` if you want to see it.
@anomiex anomiex added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Pri] Normal labels Nov 13, 2024
@anomiex anomiex requested a review from a team November 13, 2024 21:55
@anomiex anomiex self-assigned this Nov 13, 2024
Copy link
Contributor

github-actions bot commented Nov 13, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/cli-test-command branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/cli-test-command
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/cli-test-command
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Feature] Photon aka "Image CDN". Feature developed in the Image CDN package and shipped in multiple plugins [Package] Blaze [Package] Image CDN [Tests] Includes Tests [Tools] Development CLI The tools/cli to assist during JP development. labels Nov 13, 2024
Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the Docs label Nov 14, 2024
Copy link
Contributor

@tbradsha tbradsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After a few hiccups from my end, this seems to run as expected:

The following runs were successful:

  • Standard run: jetpack test coverage packages/codesniffer
  • Parallel run: jetpack test coverage packages/codesniffer packages/autoloader
  • Custom HTML dir: jetpack test coverage packages/codesniffer --html-dir=random_dir
  • Custom Artifacts dir: jetpack test coverage plugins/crm --artifacts-dir=random_dir

@anomiex anomiex merged commit b8f11c6 into trunk Nov 14, 2024
64 checks passed
@anomiex anomiex deleted the update/cli-test-command branch November 14, 2024 21:03
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs [Feature] Photon aka "Image CDN". Feature developed in the Image CDN package and shipped in multiple plugins [Package] Blaze [Package] Image CDN [Pri] Normal [Tests] Includes Tests [Tools] Development CLI The tools/cli to assist during JP development. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants