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

Removes Percy based visual regression tests #139252

Merged
merged 1 commit into from
Sep 12, 2022

Conversation

tylersmalley
Copy link
Contributor

@tylersmalley tylersmalley commented Aug 22, 2022

Reapplies #136359 reverted in #136437

When Percy was chosen for visual regression testing, we targeted a specific workflow that allowed these tests to run in the context of a PR and for developers to see and address failures much like any other test. That workflow was not possible; therefore, the Percy project was largely abandoned.

For three years now, these tests have not been run as part of the Kibana CI job. QA has maintained running the handful (14) of existing tests during releases. While that has been a somewhat frictionless process, the Percy dependency is deprecated, requiring many needless dependencies to be downloaded and installed for development environments.

All teams have confirmed that they do not rely on nor need these tests. With all that said, we should remove this code. A separate discussion can be started if visual testing is necessary and a priority.

closes #138629
closes #43127
closes #54149

@tylersmalley tylersmalley force-pushed the rm-percy branch 2 times, most recently from 6d09cf0 to c46799f Compare August 22, 2022 23:13
@tylersmalley tylersmalley changed the title Remove percy based visual regression tests Removes Percy based visual regression tests Aug 22, 2022
@tylersmalley tylersmalley added the Team:Operations Team label for Operations Team label Aug 23, 2022
@tylersmalley tylersmalley marked this pull request as ready for review August 23, 2022 05:04
@tylersmalley tylersmalley requested review from a team as code owners August 23, 2022 05:04
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-operations (Team:Operations)

@tylersmalley tylersmalley added the release_note:skip Skip the PR/issue when compiling release notes label Aug 23, 2022
@wayneseymour
Copy link
Member

Less code is the best code 😉

@tylersmalley
Copy link
Contributor Author

Holding off on this until a meeting we're having on Monday, August 29th.

Copy link

@LeeDr LeeDr left a comment

Choose a reason for hiding this comment

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

I'm fine with removing this now based on the small number of tests and responses from the teams that own the features of those tests. I believe the risk of missing a bug that no other automated tests or humans would find without these tests to be pretty low.

We can still review a future PR that uses the latest Percy API if someone wants to create that.

Copy link
Contributor

@liza-mae liza-mae left a comment

Choose a reason for hiding this comment

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

From our meeting last week, we agreed to remove the deprecated Percy package and existing tests from mainline. A new evaluation of Percy testing will be done per comment: #138629 (comment). If the evaluation goes well, I will put up another PR to add back a new set of visual regression tests.

@liza-mae liza-mae added v8.5.0 v8.4.0 v7.17.7 v8.4.2 auto-backport Deprecated - use backport:version if exact versions are needed and removed v8.4.0 labels Sep 7, 2022
When Percy was chosen, we targeted a specific workflow that allowed these tests to run in the context of a PR and for developers to see and address failures much like any other test. That workflow ended up not being possible therefore, the Percy project was abandoned.

QA has maintained running the handful (14) of existing tests during releases. While that has been a somewhat frictionless process, the Percy dependency is deprecated requiring many needless dependencies to be downloaded and installed for development environments.

All teams have [confirmed](elastic#138629 (comment)) that they do not rely on nor need these tests, so I feel it's best to remove this code and focus our efforts elsewhere.

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

  • 💚 Build #66623 succeeded c46799f8c8838d73c18bb7b21f5a8feeb2d84368
  • 💔 Build #66621 failed 6d09cf0beb17f61eaa909e0d1d93fceacccde44e

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@tylersmalley tylersmalley merged commit 44ab700 into elastic:main Sep 12, 2022
@tylersmalley tylersmalley deleted the rm-percy branch September 12, 2022 20:08
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
7.17 Backport failed because of merge conflicts
8.4 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 139252

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Sep 12, 2022
mistic added a commit that referenced this pull request Aug 10, 2023
This PR is a recreation of #139252
applied to 7.17

Just confirmed with @dmlemeshko that we don't need to run percy anymore
also on 7.17. \cc @legrego

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Operations Team label for Operations Team v8.5.0
Projects
None yet
9 participants