Extract PallyTest into a separate package

.github/workflows/accessibility_tests.yml

@@ -33,7 +33,7 @@ jobs:
       - uses: actions/upload-artifact@v3
         with:
           name: html_files
-          path: test/axe_html/
+          path: test/excessibility/html_snapshots
 
   axe-test:
     needs: mix-test
@@ -46,18 +46,11 @@ jobs:
         uses: actions/checkout@v3
       - name: Setup App
         uses: ./.github/workflows/setup
-      - name: Generate css and js for pa11y
-        shell: bash
-        run: |
-          mix assets.deploy
-          cp -r priv/static/assets/js/ test/axe_html/assets
-          cp -r priv/static/assets/css/ test/axe_html/assets
       - name: Download html files from mix test
         uses: actions/download-artifact@v3
         with:
           name: html_files
-          path: test/axe_html/
+          path: test/excessibility/html_snapshots
       - name: Pa11y Tests
-        shell: bash
-        run: ./run_pa11y.sh
+        run: mix excessibility
 

.gitignore

@@ -40,6 +40,6 @@ npm-debug.log
 *.secret.exs
 
 # Axe test html fiels
-/test/axe_html/*.html
-/test/axe_html/assets/**/*.css*
-/test/axe_html/assets/**/*.js*
+/test/excessibility/*.html
+/test/excessibility/assets/**/*.css*
+/test/excessibility/assets/**/*.js*

assets/js/launch-cart.ts

@@ -138,7 +138,7 @@ export class LaunchCartElement extends LitElement {
       <div part="modal-header">
         <button @click=${this.closeThanks} part="close-modal" aria-label="Close Modal">✕</button>
       </div>
-      <div part="modal-body">
+      <div style="color:white!important"part="modal-body">
         <p part="cart-thank-you">Thanks for purchasing!</p>
       </div>
     </dialog>
@@ -215,4 +215,4 @@ declare global {
   interface HTMLElementEventMap {
     'checkout_redirect': CustomEvent<{ checkout_url: string }>;
   }
-}
+}

mix.exs

@@ -39,9 +39,11 @@ defmodule LaunchCart.MixProject do
       {:dart_sass, "~> 0.5", runtime: Mix.env() == :dev},
       {:ecto_sql, "~> 3.6"},
       {:esbuild, "~> 0.4", runtime: Mix.env() == :dev},
+      {:excessibility, "~> 0.1.0",
+       only: [:dev, :test], git: "https://github.com/launchscout/excessibility.git"},
       {:ex_machina, "~> 2.7.0"},
       {:faker, ">= 0.0.0"},
-      {:floki, ">= 0.30.0", only: :test},
+      {:floki, ">= 0.30.0", only: [:dev, :test]},
       {:gettext, "~> 0.18"},
       {:jason, "~> 1.2"},
       {:live_state, "~> 0.6.0"},
@@ -59,7 +61,11 @@ defmodule LaunchCart.MixProject do
       {:telemetry_metrics, "~> 0.6"},
       {:telemetry_poller, "~> 1.0"},
       {:wallaby, "~> 0.30.2",
-       git: "https://github.com/launchscout/wallaby.git", branch: "shadow-dom", runtime: false, only: :test}
+       git: "https://github.com/launchscout/wallaby.git",
+       branch: "shadow-dom",
+       override: true,
+       runtime: false,
+       only: :test}
     ]
   end
 

test/launch_cart_web/controllers/stripe_account_controller_test.exs

@@ -1,7 +1,6 @@
 defmodule LaunchCartWeb.StripeAccountControllerTest do
   use LaunchCartWeb.ConnCase
 
-  alias LaunchCartWeb.PallyTest
   alias LaunchCart.Repo
   alias LaunchCart.StripeAccounts.StripeAccount
 
@@ -17,7 +16,7 @@ defmodule LaunchCartWeb.StripeAccountControllerTest do
     test "lists all stripe_accounts", %{conn: conn} do
       conn = get(conn, Routes.stripe_account_path(conn, :index))
       assert html_response(conn, 200) =~ "Connected Stripe Accounts"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
   end
 

test/launch_cart_web/controllers/user_confirmation_controller_test.exs

@@ -16,7 +16,7 @@ defmodule LaunchCartWeb.UserConfirmationControllerTest do
       conn = get(conn, Routes.user_confirmation_path(conn, :new))
       response = html_response(conn, 200)
       assert response =~ "<h1>Resend Confirmation Instructions</h1>"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
   end
 
@@ -64,7 +64,7 @@ defmodule LaunchCartWeb.UserConfirmationControllerTest do
       response = html_response(conn, 200)
       assert response =~ "<h1>Confirm account</h1>"
 
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
 
       form_action = Routes.user_confirmation_path(conn, :update, "some-token")
       assert response =~ "action=\"#{form_action}\""

test/launch_cart_web/controllers/user_registration_controller_test.exs

@@ -12,7 +12,7 @@ defmodule LaunchCartWeb.UserRegistrationControllerTest do
       assert response =~ "Help us test Launch Elements!"
       assert response =~ "Log in</a>"
       assert response =~ "Register</a>"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
 
     test "redirects if already logged in", %{conn: conn} do
@@ -33,7 +33,7 @@ defmodule LaunchCartWeb.UserRegistrationControllerTest do
 
       response = html_response(conn, 200)
       assert response =~ "Thanks"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
   end
 end

test/launch_cart_web/controllers/user_reset_password_controller_test.exs

@@ -15,7 +15,7 @@ defmodule LaunchCartWeb.UserResetPasswordControllerTest do
       conn = get(conn, Routes.user_reset_password_path(conn, :new))
       response = html_response(conn, 200)
       assert response =~ "<h1>Forgot your password?</h1>"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
   end
 
@@ -57,7 +57,7 @@ defmodule LaunchCartWeb.UserResetPasswordControllerTest do
     test "renders reset password", %{conn: conn, token: token} do
       conn = get(conn, Routes.user_reset_password_path(conn, :edit, token))
       assert html_response(conn, 200) =~ "<h1>Reset password</h1>"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
 
     test "does not render reset password with invalid token", %{conn: conn} do
@@ -105,7 +105,7 @@ defmodule LaunchCartWeb.UserResetPasswordControllerTest do
       assert response =~ "<h1>Reset password</h1>"
       assert response =~ "should be at least 12 character(s)"
       assert response =~ "does not match password"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
 
     test "does not reset password with invalid token", %{conn: conn} do

test/launch_cart_web/controllers/user_session_controller_test.exs

@@ -15,7 +15,7 @@ defmodule LaunchCartWeb.UserSessionControllerTest do
       assert response =~ "<h1>Log in</h1>"
       assert response =~ "Register</a>"
       assert response =~ "Forgot your password?</a>"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
 
     test "redirects if already logged in", %{conn: conn, user: user} do
@@ -40,7 +40,7 @@ defmodule LaunchCartWeb.UserSessionControllerTest do
       assert response =~ user.email
       assert response =~ "settings</i>"
       assert response =~ "Log out</a>"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
 
     test "logs the user in with remember me", %{conn: conn, user: user} do
@@ -80,7 +80,7 @@ defmodule LaunchCartWeb.UserSessionControllerTest do
       response = html_response(conn, 200)
       assert response =~ "<h1>Log in</h1>"
       assert response =~ "Invalid email or password"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
   end
 

test/launch_cart_web/controllers/user_settings_controller_test.exs

@@ -12,7 +12,7 @@ defmodule LaunchCartWeb.UserSettingsControllerTest do
       conn = get(conn, Routes.user_settings_path(conn, :edit))
       response = html_response(conn, 200)
       assert response =~ "<h1>Settings</h1>"
-      PallyTest.here(conn)
+      Excessibility.html_snapshot(conn)
     end
 
     test "redirects if user is not logged in" do
@@ -59,7 +59,7 @@ defmodule LaunchCartWeb.UserSettingsControllerTest do
 
       assert get_session(old_password_conn, :user_token) == get_session(conn, :user_token)
 
-      PallyTest.here(old_password_conn)
+      Excessibility.html_snapshot(old_password_conn)
     end
   end
 

test/launch_cart_web/features/stripe_cart_test.exs

@@ -1,9 +1,8 @@
 defmodule LaunchCartWeb.Features.LaunchCartTest do
-  alias LaunchCartWeb.PallyTest
   alias LaunchCart.Test.FakeLaunch
   use ExUnit.Case, async: false
   use Wallaby.Feature
-  use LaunchCartWeb.PallyTest
+  use Excessibility
 
   import Wallaby.Query
   import LaunchCart.Factory
@@ -18,22 +17,33 @@ defmodule LaunchCartWeb.Features.LaunchCartTest do
   end
 
   feature "add item", %{session: session, store: store} do
+    session =
+      session
+      |> visit("/fake_stores/#{store.id}")
+      |> assert_text("My Store")
+
+    Excessibility.html_snapshot(session)
+
     session
-    |> visit("/fake_stores/#{store.id}")
-    |> assert_text("My Store")
     |> click(css("button#add-price_123"))
-    |> find(css("launch-cart"))
-    |> shadow_root()
-    |> assert_has(css(".cart-count", text: "1"))
-    |> click(css(".cart-count"))
-    |> assert_has(css("dialog"))
-    |> assert_has(css("table", text: "Nifty onesie"))
-
-    PallyTest.here(session)
+    |> find(css("launch-cart"), fn shadow ->
+      shadow
+      |> shadow_root()
+      |> assert_has(css(".cart-count", text: "1"))
+      |> click(css(".cart-count"))
+      |> assert_has(css("dialog"))
+      |> assert_has(css("table", text: "Nifty onesie"))
+    end)
+    |> Excessibility.html_snapshot()
 
     assert Repo.get_by(Cart, store_id: store.id)
   end
 
+  defp expand_shadow_element(element) do
+    element
+    |> Browser.execute_script('return arguments[0].shadowRoot')
+  end
+
   feature "alter quantity", %{session: session, store: store} do
     session
     |> visit("/fake_stores/#{store.id}")
@@ -50,7 +60,7 @@ defmodule LaunchCartWeb.Features.LaunchCartTest do
     |> click(css("button[part='cart-decrease-qty-button']"))
     |> assert_has(css("td[part='cart-summary-qty']", text: "1"))
 
-    PallyTest.here(session)
+    Excessibility.html_snapshot(session)
   end
 
   feature "add item and reload", %{session: session, store: store} do
@@ -68,7 +78,7 @@ defmodule LaunchCartWeb.Features.LaunchCartTest do
     |> shadow_root()
     |> assert_has(css(".cart-count", text: "1"))
 
-    PallyTest.here(session)
+    Excessibility.html_snapshot(session)
   end
 
   feature "after checkout", %{session: session, store: store} do
@@ -87,7 +97,7 @@ defmodule LaunchCartWeb.Features.LaunchCartTest do
     |> shadow_root()
     |> assert_has(css("dialog"))
 
-    PallyTest.here(session)
+    Excessibility.html_snapshot(session)
   end
 
   feature "remove item from cart", %{session: session, store: store} do
@@ -103,7 +113,7 @@ defmodule LaunchCartWeb.Features.LaunchCartTest do
     |> click(css("button#remove-item"))
     |> assert_has(css("td", text: "Nifty onesie", count: 0))
 
-    PallyTest.here(session)
+    Excessibility.html_snapshot(session)
 
     cart = Repo.get_by(Cart, store_id: store.id) |> Repo.preload(:items)
     assert Enum.count(cart.items) == 0

test/support/conn_case.ex

@@ -21,15 +21,14 @@ defmodule LaunchCartWeb.ConnCase do
   using do
     quote do
       # Use Axe Test module
-      use LaunchCartWeb.PallyTest
+      use Excessibility
 
       # Import conveniences for testing with connections
       import Plug.Conn
       import Phoenix.ConnTest
       import LaunchCartWeb.ConnCase
 
       alias LaunchCartWeb.Router.Helpers, as: Routes
-      alias LaunchCartWeb.PallyTest
 
       # The default endpoint for testing
       @endpoint LaunchCartWeb.Endpoint