Improve screenshot testing with ComposablePreviewScanner

[jmartinesp]

Type of change

• Feature
• Bugfix
• Technical
• Other : Improve CI processes

Content

• Replaces Showkase for screenshot tests with ComposablePreviewScanner. Showkase is only used now for the browser in :libraries:designsystem.
• Use reflection to 'fix' the generated screenshot names with Paparazzi so we don't have any more _null_1_2_ suffixes in the screenshot filenames.
• Add a very crude 'sharding' for recording and verifying screenshots, which allows for parallelisation and should improve CI and local test times.

Motivation and context

Improve DevX. It should also fix the case where adding/removing a single preview in a module renamed every single other one.

Screenshots / GIFs

There are a few in this PR 😇 .

Tests

We should test this against the Element Gallery.

Tested devices

Checklist

• Changes have been tested on an Android device or Android emulator with API 23
• UI change has been tested on both light and dark themes
• Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
• Pull request is based on the develop branch
• Pull request title will be used in the release note, it clearly define what will change for the user
• Pull request includes screenshots or videos if containing UI changes
• Pull request includes a sign off
• You've made a self review of your PR

[github-actions]

📱 Scan the QR code below to install the build (arm64 only) for this PR.

If you can't scan the QR code you can install the build via this link: https://i.diawi.com/JLzRE2

[jmartinesp]

I also hope Showkase/KSP somehow had something to do with the OOM issues we were having in the CI and this might fix it. Although it's quite hard to test it.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.01%. Comparing base (d68ddc6) to head (c0a8025).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3125   +/-   ##
========================================
  Coverage    76.01%   76.01%           
========================================
  Files         1635     1635           
  Lines        38578    38578           
  Branches      7460     7460           
========================================
+ Hits         29325    29326    +1     
  Misses        5361     5361           
+ Partials      3892     3891    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[bmarty]

Thanks for working on this! I have spot some strange things in the recorded screenshots, but I did not check every single ones.
Also there are some formatting issue on build.gradle.kts files (I have commented them all).
Can you ensure that generating Element Gallery is still working as expected?

[bmarty]

(changing the label to PR-Build which seems more appropriate than PR-Change, let me know if you agree)

[bmarty]

Also the doc will have to be updated: https://github.com/element-hq/element-x-android/blob/develop/docs/screenshot_testing.md

[jmartinesp]

I believe with the latest changes everything should work. @bmarty can you also test the gallery locally? It seems to work for me, but having a fresh pair of eyes on it is probably a good idea.

[bmarty]

Ideally the file data.js should be updated by this PR, so that the index.html is not broken.

Also I have noticed that the Preview are not sorted by name. It should start by AboutView like here:

This was done here: https://github.com/element-hq/element-x-android/blob/develop/tools/test/generateAllScreenshots.py#L120. See more details in the comment.

[jmartinesp]

Ideally the file data.js should be updated by this PR, so that the index.html is not broken.

I think for that we need the 'Sync Localazy' flow to run since any screenshot I record in my computer will later be overridden. Maybe I should just trigger a sync as soon as this PR is merged?

The latest changes should fix the issues.

[jmartinesp]

Well, there goes my theory about the OOM errors maybe being caused by KSP/Showkase 🫤 : https://github.com/element-hq/element-x-android/actions/runs/9772948574/attempts/1

[bmarty]

The latest changes should fix the issues.

Let me check! I'll commit the change on data.js on the branch

[bmarty]

OK, I have updated the file data.js.
I think we can merge the PR and trigger a Localazy sync just after to ensure that DE screenshots will be correctly recorded and the Gallery correctly rendered.
Thanks for all the updates!

[sonarcloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud