Easy VRT

Easy VRT is a GitHub Action that simplifies visual regression testing by providing a workflow template.

How it works

Easy VRT consists of the following sequences:

graph LR;
    prepare-->expected
    prepare-->actual
    expected-->compare
    actual-->compare

Loading

Usage

Example workflow:

name: vrt

run-name: visual regression test

on: pull_request

permissions:
  contents: read

jobs:
  prepare:
    runs-on: ubuntu-latest
    outputs:
      actual-sha: ${{ steps.prepare.outputs.actual-sha }}
      actual-cache-hit: ${{ steps.prepare.outputs.actual-cache-hit }}
      expected-sha: ${{ steps.prepare.outputs.expected-sha }}
      expected-cache-hit: ${{ steps.prepare.outputs.expected-cache-hit }}
    steps:
      - uses: yorifuji/easy-vrt/prepare@v2
        id: prepare

  expected:
    if: ${{ !cancelled() && !failure() && needs.prepare.outputs.expected-cache-hit != 'true' }}
    needs: prepare
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ needs.prepare.outputs.expected-sha }}

      # >>> add step to create expected image

      # <<< add step to create expected image

      - uses: yorifuji/easy-vrt/expected@v2
        with:
          expected-dir: your-expected-image-dir # set the directory where the expected image is stored
          expected-cache-key: ${{ needs.prepare.outputs.expected-sha }}

  actual:
    if: ${{ !cancelled() && !failure() && needs.prepare.outputs.actual-cache-hit != 'true' }}
    needs: prepare
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ needs.prepare.outputs.actual-sha }}

      # >>> add step to create actual image

      # <<< add step to create actual image

      - uses: yorifuji/easy-vrt/actual@v2
        with:
          actual-dir: your-actual-image-dir # set the directory where the actual image is stored
          actual-cache-key: ${{ needs.prepare.outputs.actual-sha }}

  compare:
    if: ${{ !cancelled() && !failure() }}
    needs: [prepare, expected, actual]
    runs-on: ubuntu-latest
    steps:
      - uses: yorifuji/easy-vrt/compare@v2
        with:
          expected-cache-key: ${{ needs.prepare.outputs.expected-sha }}
          actual-cache-key: ${{ needs.prepare.outputs.actual-sha }}

Example for Flutter Applications

This section demonstrates how to adapt Easy VRT for Flutter applications, highlighting necessary changes in the workflow.

expected

-      # >>> add step to create expected image
+      - uses: subosito/flutter-action@v2

-      # <<< add step to create expected image
+      - run: |
+          flutter pub get
+          flutter test --update-goldens --tags=golden

       - uses: yorifuji/easy-vrt@v2
         with:
-          expected-dir: your-expected-image-dir # set the directory where the expected image is stored
+          expected-dir: test/golden_test/goldens
           expected-cache-key: ${{ needs.prepare.outputs.expected-sha }}

actual

-      # >>> add step to create actual image
+      - uses: subosito/flutter-action@v2

-      # <<< add step to create actual image
+      - run: |
+          flutter pub get
+          flutter test --update-goldens --tags=golden

       - uses: yorifuji/easy-vrt@v2
         with:
-          actual-dir: your-actual-image-dir # set the directory where the actual image is stored
+          actual-dir: test/golden_test/goldens
           actual-cache-key: ${{ needs.prepare.outputs.actual-sha }}

Actions

yorifuji/easy-vrt/prepare

outputs:
  actual-sha:
    description: "Actual SHA"
    value: ${{ steps.lookup-sha.outputs.actual-sha }}
  actual-cache-hit:
    description: "Whether the actual cache was found"
    value: ${{ steps.lookup-actual-cache.outputs.cache-hit }}
  expected-sha:
    description: "Expected SHA"
    value: ${{ steps.lookup-sha.outputs.expected-sha }}
  expected-cache-hit:
    description: "Whether the expected cache was found"
    value: ${{ steps.lookup-expected-cache.outputs.cache-hit }}

yorifuji/easy-vrt/expected

inputs:
  expected-dir:
    description: "Expected directory"
    required: true
  expected-cache-key:
    description: "Cache key for expected"
    required: true

yorifuji/easy-vrt/actual

inputs:
  actual-dir:
    description: "Actual directory"
    required: true
  actual-cache-key:
    description: "Cache key for actual"
    required: true

yorifuji/easy-vrt/comapre

inputs:
  expected-cache-key:
    description: "Cache key for expected"
    required: true
  actual-cache-key:
    description: "Cache key for actual"
    required: true
  summary-comment:
    description: "If true, add a summary comment on workflow summary"
    required: false
    default: false
  review-comment:
    description: "If true, add a review comment on PR review (pull-requests permissions required)"
    required: false
    default: false

Outputs

Artifact

Report(In Artifact)

Summary(Optional)

Pull Request Review Comment(Optional)

License

reg-cli

The MIT License (MIT)

Copyright (c) 2017 bokuweb

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Easy VRT

MIT License