rely on Pixel Eagle for mobile (#139)

mockersf · web-flow · commit 31766bd6ddcb · 2025-03-24T01:32:05.000+01:00
* format

* linter

* common project for Pixel Eagle

* fix reference to run id

* check for screenshots in correct folder

* prettier name

* quote name

* keep mobile common pixel eagle result

* remove individual pixel eagle uploads

* pixel eagle for mobile in report

* format
diff --git a/.github/workflows/report-main.yml b/.github/workflows/report-main.yml
@@ -3,7 +3,7 @@ name: Example report - main
 on:
   workflow_dispatch:
   schedule:
-    - cron:  '0 */3 * * *'
+    - cron: "0 */3 * * *"
 
 concurrency:
   group: ${{ github.repository }}-example-report
@@ -26,8 +26,8 @@ jobs:
       - name: Checkout Bevy main branch
         uses: actions/checkout@v4
         with:
-          repository: 'bevyengine/bevy'
-          ref: 'main'
+          repository: "bevyengine/bevy"
+          ref: "main"
       - name: Get Environment
         id: env
         run: |
@@ -37,8 +37,8 @@ jobs:
           echo "mobile_percy_project=dede4209/Bevy-Mobile-Example" >> $GITHUB_OUTPUT
       - uses: actions/checkout@v4
         with:
-          ref: 'results'
-          path: 'results'
+          ref: "results"
+          path: "results"
       - name: Check if current Bevy version already ran
         id: version-check
         run: |
@@ -58,7 +58,7 @@ jobs:
       repository: "bevyengine/bevy"
       per_page: "${{ needs.get-environment.outputs.per_page }}"
     secrets: inherit
-        
+
   mobile-run:
     name: Mobile
     needs: [get-environment]
@@ -92,11 +92,10 @@ jobs:
     permissions:
       contents: write
     steps:
-      
       - uses: actions/checkout@v4
         with:
-          ref: 'results'
-          path: 'results'
+          ref: "results"
+          path: "results"
 
       - name: Download all status artifacts
         uses: actions/download-artifact@v4
@@ -156,6 +155,7 @@ jobs:
           mv pixeleagle-Linux/pixeleagle-Linux.json results/${{ needs.get-environment.outputs.date }}-${{ needs.get-environment.outputs.gitref }}/Linux-pixeleagle
           mv pixeleagle-macOS/pixeleagle-macOS.json results/${{ needs.get-environment.outputs.date }}-${{ needs.get-environment.outputs.gitref }}/macOS-pixeleagle
           mv pixeleagle-Windows/pixeleagle-Windows.json results/${{ needs.get-environment.outputs.date }}-${{ needs.get-environment.outputs.gitref }}/Windows-pixeleagle
+          mv pixeleagle-mobile/pixeleagle-mobile.json results/${{ needs.get-environment.outputs.date }}-${{ needs.get-environment.outputs.gitref }}/mobile-pixeleagle
 
       - name: Store results in git
         run: |
diff --git a/.github/workflows/workflow-mobile.yml b/.github/workflows/workflow-mobile.yml
@@ -6,11 +6,11 @@ on:
       repository:
         required: true
         type: string
-        default: 'bevyengine/bevy'
+        default: "bevyengine/bevy"
       gitref:
         required: true
         type: string
-        default: 'main'
+        default: "main"
       mobile_percy_project:
         required: false
         type: string
@@ -25,23 +25,39 @@ on:
       repository:
         required: true
         type: string
-        default: 'bevyengine/bevy'
+        default: "bevyengine/bevy"
+        description: "Bevy repository to use"
       gitref:
         required: true
         type: string
-        default: 'main'
+        default: "main"
+        description: "Commit or branch name to run on"
       mobile_percy_project:
         required: false
         type: string
+        description: "Percy project to send results to"
       pixeleagle_project:
         required: true
         type: string
-        default: 'B25A040A-A980-4602-B90C-D480AB84076D'
+        default: "B25A040A-A980-4602-B90C-D480AB84076D"
+        description: "Pixel Eagle project to send results to"
       branch:
         required: true
         type: string
+        description: "Branch name to use as a tag in Pixel Eagle"
 
 jobs:
+  create-pixel-eagle-run:
+    runs-on: ubuntu-latest
+    outputs:
+      pixeleagle_run: ${{ steps.run.outputs.pixeleagle_run }}
+    steps:
+      - name: Create Run
+        id: run
+        run: |
+          run=`curl https://pixel-eagle.com/${{ inputs.pixeleagle_project }}/runs -H 'Content-Type: application/json' -d '{"os":"mobile", "gitref": "${{ inputs.gitref }}", "branch": "${{ inputs.branch }}"}' --oauth2-bearer ${{ secrets.PIXELEAGLE }} | jq '.id'`
+          echo "pixeleagle_run=$run" >> $GITHUB_OUTPUT
+
   build-for-iOS:
     runs-on: macos-latest
     timeout-minutes: 30
@@ -54,17 +70,17 @@ jobs:
       - name: Checkout patches
         uses: actions/checkout@v4
         with:
-          path: 'runner-patches'  
-  
+          path: "runner-patches"
+
       - name: Apply patches
         shell: pwsh
         run: |
-          Get-ChildItem "runner-patches/patches" -Filter *.patch | 
+          Get-ChildItem "runner-patches/patches" -Filter *.patch |
           Foreach-Object {
               Write-Output "Processing $($_.FullName)"
               git apply --ignore-whitespace $($_.FullName)
           }
-  
+
       - uses: dtolnay/rust-toolchain@stable
 
       - name: Add iOS targets
@@ -104,12 +120,12 @@ jobs:
       - name: Checkout patches
         uses: actions/checkout@v4
         with:
-          path: 'runner-patches'  
-  
+          path: "runner-patches"
+
       - name: Apply patches
         shell: pwsh
         run: |
-          Get-ChildItem "runner-patches/patches" -Filter *.patch | 
+          Get-ChildItem "runner-patches/patches" -Filter *.patch |
           Foreach-Object {
               Write-Output "Processing $($_.FullName)"
               git apply --ignore-whitespace $($_.FullName)
@@ -122,8 +138,8 @@ jobs:
       - name: Set up JDK 17
         uses: actions/setup-java@v4
         with:
-          java-version: '17'
-          distribution: 'temurin'
+          java-version: "17"
+          distribution: "temurin"
 
       - name: Install Cargo NDK
         run: cargo install --force cargo-ndk
@@ -150,7 +166,7 @@ jobs:
   take-screenshots:
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    needs: [build-for-iOS, build-for-Android]
+    needs: [build-for-iOS, build-for-Android, create-pixel-eagle-run]
     strategy:
       fail-fast: false
       max-parallel: 7
@@ -217,17 +233,17 @@ jobs:
       - name: Checkout patches
         uses: actions/checkout@v4
         with:
-          path: 'runner-patches'  
-  
+          path: "runner-patches"
+
       - name: Apply patches
         shell: pwsh
         run: |
-          Get-ChildItem "runner-patches/patches" -Filter *.patch | 
+          Get-ChildItem "runner-patches/patches" -Filter *.patch |
           Foreach-Object {
               Write-Output "Processing $($_.FullName)"
               git apply --ignore-whitespace $($_.FullName)
           }
-  
+
       - name: Set Percy Token if needed
         if: "${{ inputs.mobile_percy_project != '' }}"
         run: echo "PERCY_TOKEN=${{ secrets.PERCY_TOKEN_MOBILE }}" >> $GITHUB_ENV
@@ -247,51 +263,25 @@ jobs:
           PERCY_COMMIT: ${{ inputs.gitref }}
           PERCY_PARALLEL_NONCE: ${{ github.run_id }}
           PERCY_PARALLEL_TOTAL: ${{ strategy.job-total }}
-    
+
       - name: Save screenshots
         if: ${{ always() }}
         uses: actions/upload-artifact@v4
         with:
           name: screenshots-${{ matrix.device }}-${{ matrix.os_version }}
           path: .github/start-mobile-example/*.png
-      
+
       - name: Send to Pixel Eagle
         run: |
-          run=`curl https://pixel-eagle.com/${{ inputs.pixeleagle_project }}/runs -H 'Content-Type: application/json' -d '{"device":"${{ matrix.device }}", "os":"${{ matrix.os }}-${{ matrix.os_version }}", "adapter": "${{ matrix.adapter }}", "gitref": "${{ inputs.gitref }}", "branch": "${{ inputs.branch }}"}' --oauth2-bearer ${{ secrets.PIXELEAGLE }} | jq '.id'`
-            
-          SAVEIFS=$IFS
-          
-          IFS=$'\n'
-
           cd .github/start-mobile-example
-
-          # Build a json array of screenshots and their hashes
-          hashes='[';
           for screenshot in $(find . -type f -maxdepth 1 -name "*.png");
           do
-            name=${screenshot:2}
+            file=${screenshot:2}
+            name="${{ matrix.os }}-${{ matrix.device }}-${{ matrix.os_version }}-$file"
             echo $name
-            hash=`shasum -a 256 $screenshot | awk '{print $1}'`
-            hashes="$hashes [\"$name\",\"$hash\"],"
+            curl https://pixel-eagle.com/${{ inputs.pixeleagle_project }}/runs/${{ needs.create-pixel-eagle-run.outputs.pixeleagle_run }}/screenshots -F "data=@./$file" -F "screenshot=$name" --oauth2-bearer ${{ secrets.PIXELEAGLE }}
           done
-          hashes=`echo $hashes | rev | cut -c 2- | rev`
-          hashes="$hashes]"
-          
-          IFS=$SAVEIFS          
-
-          # Upload screenshots with unknown hashes
-          curl https://pixel-eagle.com/${{ inputs.pixeleagle_project }}/runs/$run/hashes -H 'Content-Type: application/json' -d "$hashes" --oauth2-bearer ${{ secrets.PIXELEAGLE }} | jq '.[]|[.name] | @tsv' |
-            while IFS=$'\t' read -r name; do
-              name=`echo $name | tr -d '"'`
-              echo "Uploading $name"
-              curl https://pixel-eagle.com/${{ inputs.pixeleagle_project }}/runs/$run/screenshots -F "data=@./$name" -F "screenshot=$name" --oauth2-bearer ${{ secrets.PIXELEAGLE }}
-              echo
-            done
-          
-          IFS=$SAVEIFS
 
-          curl https://pixel-eagle.com/${{ inputs.pixeleagle_project }}/runs/$run/compare/auto -H 'Content-Type: application/json' -d '{"os":"<equal>", "device":"<equal>", "branch": "main"}' --oauth2-bearer ${{ secrets.PIXELEAGLE }}
-  
   mobile-check-result:
     runs-on: ubuntu-latest
     timeout-minutes: 30
@@ -308,3 +298,24 @@ jobs:
           sleep 30
         env:
           PERCY_TOKEN: ${{ secrets.PERCY_TOKEN_MOBILE }}
+
+  mobile-check-result-pixel-eagle:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: [take-screenshots]
+    if: always()
+    steps:
+      - name: Trigger screenshots comparison
+        run: |
+          curl https://pixel-eagle.com/${{ inputs.pixeleagle_project }}/runs/${{ needs.create-pixel-eagle-run.outputs.pixeleagle_run }}/compare/auto -H 'Content-Type: application/json' -d '{"os":"<equal>", "branch": "main"}' --oauth2-bearer ${{ secrets.PIXELEAGLE }} | jq '{project_id: .project_id, from: .from, to: .to}' > pixeleagle-mobile.json
+          cat pixeleagle-mobile.json
+
+      - name: Upload Pixel Eagle status
+        uses: actions/upload-artifact@v4
+        with:
+          name: pixeleagle-mobile
+          path: pixeleagle-mobile.json
+
+      - name: Wait a bit
+        run: |
+          sleep 30
diff --git a/src/main.rs b/src/main.rs
@@ -37,8 +37,8 @@ impl Hash for Example {
 struct Run {
     date: String,
     commit: String,
-    results: HashMap<String, HashMap<String, Kind>>,
-    screenshots: HashMap<String, HashMap<String, (ImageUrl, ScreenshotState, SnapshotViewerUrl)>>,
+    results: HashMap<String, HashMap<Platform, Kind>>,
+    screenshots: HashMap<String, HashMap<Platform, (ImageUrl, ScreenshotState, SnapshotViewerUrl)>>,
     logs: HashMap<String, HashMap<String, String>>,
 }
 
@@ -184,29 +184,34 @@ fn main() {
                     run.results
                         .entry(example.name)
                         .or_insert_with(HashMap::new)
-                        .insert(platform.to_string().clone(), kind.clone());
+                        .insert(platform.clone(), kind.clone());
                 });
             }
             if [Kind::Percy, Kind::PixelEagle].contains(&kind) {
                 println!("  - {:?} / {:?}", kind, platform);
                 let content = fs::read_to_string(&path).unwrap();
                 let screenshots = match kind {
-                    Kind::Percy => percy::read_results(content),
+                    Kind::Percy => continue, //percy::read_results(content),
                     Kind::PixelEagle => pixeleagle::read_results(content),
                     _ => unreachable!(),
                 };
                 for ScreenshotData {
-                    example,
+                    mut example,
                     screenshot,
                     mut changed,
-                    tag,
+                    mut tag,
                     diff_ratio,
                     snapshot_url,
                 } in screenshots.into_iter()
                 {
                     let (category, name) = if platform == Platform::Mobile {
                         if let Some(tag) = tag.as_ref() {
                             all_mobile_platforms.insert(tag.clone());
+                        } else {
+                            let parts = example.split('-').collect::<Vec<_>>();
+                            tag = Some(format!("{} {} / {}", parts[0], parts[2], parts[1]));
+                            all_mobile_platforms.insert(tag.clone().unwrap());
+                            example = "Bevy Mobile Example".to_string();
                         }
                         (ExampleCategory("Mobile".to_string()), example)
                     } else {
@@ -227,6 +232,9 @@ fn main() {
                             flaky: true,
                             ..previous
                         });
+                    } else {
+                        let previous = all_examples.take(&example).unwrap_or(example.clone());
+                        all_examples.insert(previous);
                     }
                     if diff_ratio == 0.0 && changed == ScreenshotState::Changed {
                         println!(
@@ -238,23 +246,13 @@ fn main() {
                     let platform = tag
                         .clone()
                         .map(|tag| Platform::Tag(tag.clone()))
-                        .unwrap_or_else(|| platform.clone())
-                        .to_string();
+                        .unwrap_or_else(|| platform.clone());
                     // If there is a screenshot but no results, mark as success
                     run.results
                         .entry(example.name.clone())
                         .or_insert_with(HashMap::new)
                         .entry(platform.clone())
                         .or_insert_with(|| Kind::Successes);
-                    // Keeping Percy results over PixelEagle for now
-                    // TODO: remove
-                    if let Some(existing_screenshots) = run.screenshots.get(&example.name) {
-                        if existing_screenshots.contains_key(&platform) {
-                            if kind == Kind::PixelEagle {
-                                continue;
-                            }
-                        }
-                    }
                     run.screenshots
                         .entry(example.name)
                         .or_insert_with(HashMap::new)
@@ -285,7 +283,7 @@ fn main() {
                                 run.results
                                     .entry(example.name)
                                     .or_insert_with(HashMap::new)
-                                    .insert(rerun_platform.to_string(), Kind::NoScreenshots);
+                                    .insert(rerun_platform.clone(), Kind::NoScreenshots);
                             });
                     }
                     if kind.ends_with(".log") {
diff --git a/src/template.rs b/src/template.rs
