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

Added a CI job for WPCloud testing of wpcomsh. #39258

Merged
merged 38 commits into from
Jan 21, 2025
Merged

Conversation

zinigor
Copy link
Member

@zinigor zinigor commented Sep 5, 2024

Adds a new CI flow specifically for starting WPCloud test runs in case wpcomsh is modified.

@a8caustin we would need to make some changes in the WPCloud environment to properly check out and run wpcomsh using the Monorepo, can you help with that please?

Proposed changes:

  • Adds a conditional WPCloud CI run for wpcomsh.

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

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

Testing instructions:

  • Go to '..'

@zinigor zinigor requested review from a8caustin and a team September 5, 2024 17:58
@github-actions github-actions bot added the Actions GitHub actions used to automate some of the work around releases and repository management label Sep 5, 2024
Copy link
Contributor

github-actions bot commented Sep 5, 2024

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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!


Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Sep 5, 2024
Comment on lines 61 to 67
touch ~/.ssh/askpass
chmod -v 700 ~/.ssh/askpass
cat >>~/.ssh/askpass <<END
#!/bin/bash
echo "\$WPCLOUD_SSH_KEY_PASSPHRASE"
END
echo "wrote ~/.ssh/askpass"
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we could switch to a key with no password, so we could skip this. Is there an attack scenario where someone could steal the key but not also steal this file with the password?

Comment on lines 82 to 87
export SSH_ASKPASS="$HOME/.ssh/askpass"
echo "exported SSH_ASKPASS"
export SSH_ASKPASS_REQUIRE="force"
echo "exported SSH_ASKPASS_REQUIRE"
export DISPLAY=":"
echo "exported DISPLAY"
Copy link
Contributor

Choose a reason for hiding this comment

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

(this along with the comment on lines 61–67 above)

echo "::endgroup::"

echo "::group::execution"
cat ~/.ssh/stdin | setsid ssh -i ~/.ssh/id_site -l "$WPCLOUD_SSH_USER" ssh.atomicsites.net "$WPCLOUD_SSH_COMMAND" || CODE=$?
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm left wondering what's in WPCLOUD_SSH_COMMAND that we can't just put it in here.

Is whatever this runs going to work if multiple PRs run this at the same time?

END
echo "wrote ~/.ssh/stdin"
echo "::group::Installing and building wpcomsh"
pnpm jetpack build plugins/wpcomsh
Copy link
Contributor

Choose a reason for hiding this comment

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

You probably need to include --deps, and adding -v would probably be helpful in case anything fails.

Personally, I'd do the build as a separate step, if not as a separate job to make re-runs not have to re-build (cf. #32686).


- name: Restore wpcomsh build cache
id: wpcomsh-build-cache
if: needs.build.result == 'success'
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can leave out this line, it's there in the E2E workflow because the build might be skipped when it's going to run against Atomic or something.

Suggested change
if: needs.build.result == 'success'

name: Run PHPUnit on the WPCloud test site
runs-on: ubuntu-latest
needs: build
if: needs.build.changed.outputs.wpcomsh == 'true'
Copy link
Contributor

Choose a reason for hiding this comment

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

Oops, this is why it skipped this time.

Suggested change
if: needs.build.changed.outputs.wpcomsh == 'true'
if: needs.build.outputs.wpcomsh == 'true'

.github/workflows/wpcloud.yml Dismissed Show dismissed Hide dismissed
.github/workflows/wpcloud.yml Dismissed Show dismissed Hide dismissed
@zinigor zinigor requested a review from a team January 17, 2025 16:32
@zinigor zinigor added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] In Progress labels Jan 17, 2025
@github-actions github-actions bot added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Jan 17, 2025
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

A few minor things to clean up, otherwise looks reasonable to me

.github/workflows/wpcloud.yml Outdated Show resolved Hide resolved
.github/workflows/wpcloud.yml Outdated Show resolved Hide resolved
.github/workflows/wpcloud.yml Show resolved Hide resolved
zinigor and others added 2 commits January 21, 2025 20:47
Co-authored-by: Brad Jorsch <anomiex@users.noreply.github.com>
Co-authored-by: Brad Jorsch <anomiex@users.noreply.github.com>
@zinigor zinigor requested a review from anomiex January 21, 2025 17:54
@zinigor zinigor merged commit aa290bb into trunk Jan 21, 2025
59 checks passed
@zinigor zinigor deleted the add/wpcomsh-wpcloud-testing branch January 21, 2025 18:03
@github-actions github-actions bot removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 21, 2025
coder-karen pushed a commit that referenced this pull request Jan 24, 2025
* Added a CI job for WPCloud testing of wpcomsh.

* Add pnpm and install.

* Testing WPCloud on a new test site for jetpackisbestpack.

* Temporarily marking wpcomsh as always changed.

* Added transferring of tests.

* Added DB password slash escaping.

* changelog

* Added a mock for get_option_and_ensure_autoload.

* Added a missing cache expulsion function.

* Removed set -x from test installer.

* Using pnpm to not bother with linking binaries.

* Added a build step.

* Created a separate job to avoid re-building on a re-run, h/t @anomiex.

* Added cache saving and restoring, moved if to parent job.

* Added the before file.

* Trying with  instead of .

* Fixing var schema.

* Fixed the user string in SSH connection.

* Trying to create an SSH config file.

* Fixed the SSH key file name.

* Making sure to use the preset configured host.

* Moved the polyfill load to after WordPress loading.

* Removed polyfills.

* Removed null coalescing and added a short ternary.

* Removed the change detector prop.

* Added concurrency settings to make sure there can be only one.

* Added updating of source files and cleanup after that updating.

* Update .github/workflows/wpcloud.yml

Co-authored-by: Brad Jorsch <anomiex@users.noreply.github.com>

* Update .github/workflows/wpcloud.yml

Co-authored-by: Brad Jorsch <anomiex@users.noreply.github.com>

---------

Co-authored-by: Brad Jorsch <anomiex@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Actions GitHub actions used to automate some of the work around releases and repository management [Plugin] Wpcomsh [Tests] Includes Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants