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

feat(PPDSC-2273): add pr and job urls to applitools batch name #291

Merged
merged 1 commit into from
Jul 18, 2022

Conversation

mstuartf
Copy link
Contributor

PPDSC-2273

What

  1. Background - applitools issues are hard to debug
  2. What did you do
  • Use built-in CircleCI env variables to override default Applitools batchname with useful info.
  • Make sure the curl request to close Applitools batches is always sent (for docs and components). At the moment the request is not sent if any tests in the suite, so the batch would remain open. Subsequent pipeline runs for the same commit would therefore add more tests to the same batch, rather than creating a new batch. This means that we cannot remove the global 'auto close batches' setting. Currently this is what closes our batches (and is also the reason why our batches are randomly split sometimes).
  1. What does the reviewers should expect -

Batch names follow the format BRANCH_NAME:COMMIT_SHA (PR_URL, JOB_URL). E.g.:
Screenshot 2022-07-15 at 16 04 12

The Close the Applitools Batch step for doc site and component visual test jobs should run even if the test step fails.

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

After:

Who should review this PR:

How to test:

- Use built-in CircleCI env variables to override default Applitools batchname with useful info.
- Make sure the curl request to close Applitools batches is always sent (for docs and components). At the moment the request is not sent if any tests in the suite, so the batch would remain open. Subsequent pipeline runs for the same commit would therefore add more tests to the same batch, rather than creating a new batch. This means that we cannot remove the global 'auto close batches' setting. Currently this is what closes our batches (and is also the reason why our batches are randomly split sometimes).
@github-actions github-actions bot added the feature This change contains a new feature label Jul 15, 2022
@newskit-engineering
Copy link
Collaborator

@mstuartf mstuartf merged commit 3d5b7e5 into main Jul 18, 2022
@mstuartf mstuartf deleted the feat/PPDSC-2273-applitools-info branch July 18, 2022 08:46
Xin00163 pushed a commit that referenced this pull request Oct 17, 2022
- Use built-in CircleCI env variables to override default Applitools batchname with useful info.
- Make sure the curl request to close Applitools batches is always sent (for docs and components). At the moment the request is not sent if any tests in the suite, so the batch would remain open. Subsequent pipeline runs for the same commit would therefore add more tests to the same batch, rather than creating a new batch. This means that we cannot remove the global 'auto close batches' setting. Currently this is what closes our batches (and is also the reason why our batches are randomly split sometimes).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This change contains a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants