diff --git a/Acceptance-Tests.md b/Acceptance-Tests.md index 2302a24b..6f040a74 100644 --- a/Acceptance-Tests.md +++ b/Acceptance-Tests.md @@ -247,6 +247,63 @@ On CI, we run all the acceptance tests in production mode, so the screenshots in On the other hand, if the screenshot fails locally (in desktop environment), the screenshot `teachPage-diff.png` will be generated and stored inside a new folder `diff-snapshots` under `logged-out-user/dev-desktop-screenshots`. +### Adding Prod screenshots for Acceptance Tests +When making changes that affect a user journey tested through the acceptance tests or introduce a new feature, a contributor needs to update/add screenshots supporting their changes. +These screenshots should be obtained from the CI (not local) run, so that the environment matches future runs. To do this, you can commit a random image in the prod screenshot folder and follow these steps: +1. Go to the failing run and open the 'Uploading diff screenshots as an artifact' section: + image + +2. Then download the artifact from the artifact download url: +479966282-c2caa55f-b4f9-40cc-a47a-7ddc2de9a479 + +3. Extract the contents of the artifact. There will be a folder with an image. The image will look like this: + skillWithWorkedExamplePreview-diff + + The left side is the current reference image on the repo. The right side is the screenshot that was taken while running the test on the CI with your changes. The middle is the difference between the two. + + We want to update the current reference as it is incorrect. Generally we do not want to do this as we expect the reference screenshots to be correct. Only do this after asking a maintainer. + +4. Go to https://splitter.imageonline.co/ + +5. Upload the diff image from the artifact you extracted: +image + +6. Choose Split into pieces: +image + +7. Set rows as 3 and columns as 1: +image + +8. Click on "SPLIT IMAGE". + +9. You will get 3 split images: +image + +10. Right click on the rightmost one and use 'Save Image as...'. Choose any random name. + +11. Navigate to where you have saved the Oppia repo on your local machine and go to oppia/core/tests/puppeteer-acceptance-tests/specs + +12. The spec will be mentioned in the artifact folder you downloaded in Step 2: + +Screenshot from 2025-08-20 16-37-52 + +(The spec is curriculum-admin in this case) + +13. Navigate to the test spec folder based on the above step. + +14. Check if the failure was for desktop or mobile based on the screenshot or the subfolder in the artifact: +image + +15. Go to the prod-desktop-screenshots or prod-mobile-screenshots folder depending on your failure. + +16. Check the name of the image from the artifact. It will be {screenshot_name}-diff.png + +17. Replace the screenshot having the name {screenshot_name}-snap.png with the split image we saved in step 10. (Make sure to rename the pasted screenshot to {screenshot_name}-snap.png) + +18. Check that the correct image got replaced. + +19. Commit and push your changes! Self review your PR to verify that the correct image(s) were used. + ## Acceptance Tests for Mobile Similar to desktop, we also have acceptance tests for mobile to ensure responsiveness and uninterrupted user journeys on small screen devices. While the tests themselves remain largely the same for both desktop and mobile, there are some differences. For instance, large full menus on desktop may be converted to dropdowns, hamburger menus, or other shortcuts on mobile, requiring additional actions to complete the tests.