Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up wallaby and add a feature test #322

Merged
merged 1 commit into from
Feb 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ version: 2.1

description: Common jobs for testing and building phoenix applications

orbs:
browser-tools: circleci/[email protected]
node: circleci/[email protected]
executors:
builder:
docker:
Expand Down Expand Up @@ -83,7 +86,7 @@ commands:
steps:
- run:
name: Run tests
command: MIX_ENV=test mix test
command: MIX_ENV=test mix test-ci

jobs:
check-formatting:
Expand All @@ -97,6 +100,7 @@ jobs:
run-unit-tests:
executor: builder
steps:
- browser-tools/install-chromedriver
- checkout
- install-deps:
include-assets: false
Expand All @@ -113,6 +117,9 @@ jobs:
- store_artifacts:
path: cover
destination: cover
- store_artifacts:
path: screenshots
destination: screenshots

workflows:
version: 2
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ npm-debug.log
figgy-fixture-container/fixture-exports/*.binary
figgy-fixture-container/fixture-exports/*.sql
solr/conf/solr_config.zip

# wallaby screenshots
screenshots/*
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ This project is built in Elixir using Phoenix LiveView as a web framework and Br

## Project Setup for Development and Test environments

### First time setup

- `brew install asdf`
- `asdf install`
- `brew install --cask chromedriver`
- required to run feature tests

### Every time setup

Do these things every time you start new work in this project in dev or test
Expand Down
13 changes: 10 additions & 3 deletions config/test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,11 @@ config :dpul_collections, DpulCollections.FiggyRepo,
show_sensitive_data_on_connection_error: true,
pool_size: 10

# We don't run a server during test. If one is required,
# you can enable the server option below.
# Wallaby feature tests require the server to be running
config :dpul_collections, DpulCollectionsWeb.Endpoint,
http: [ip: {127, 0, 0, 1}, port: 4002],
secret_key_base: "fS76i6oeLWDlMP7AEe+nExNz3J4tHyaIZrELNhSmY3LUocagaphwGc8Ff7rAh6qS",
server: false
server: true

# In test we don't send emails.
config :dpul_collections, DpulCollections.Mailer, adapter: Swoosh.Adapters.Test
Expand Down Expand Up @@ -72,3 +71,11 @@ config :dpul_collections, :start_indexing_pipeline?, fn -> false end
config :dpul_collections, :figgy_hydrator, poll_interval: 50

config :dpul_collections, :web_connections, figgy_url: "https://figgy.example.com"

config :wallaby,
otp_app: :dpul_collections,
screenshot_on_failure: true,
chromedriver: [
# change to false if you want to see the browser in action
headless: true
]
15 changes: 13 additions & 2 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ defmodule DpulCollections.MixProject do
{:broadway, "~> 1.0"},
{:ex_doc, "~> 0.21", only: :dev, runtime: false},
{:req, "~> 0.5.0"},
{:broadway_dashboard, "~> 0.4.0"}
{:broadway_dashboard, "~> 0.4.0"},
{:wallaby, "~> 0.30", runtime: false, only: :test}
]
end

Expand All @@ -88,7 +89,17 @@ defmodule DpulCollections.MixProject do
setup: ["deps.get", "ecto.setup", "assets.setup", "assets.build"],
"ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
"ecto.reset": ["ecto.drop", "ecto.setup"],
test: ["ecto.create --quiet", "ecto.migrate --quiet", "coveralls.html"],
test: [
"ecto.create --quiet",
"ecto.migrate --quiet",
"coveralls.html"
],
"test-ci": [
"esbuild dpul_collections",
"ecto.create --quiet",
"ecto.migrate --quiet",
"coveralls.html"
],
"assets.setup": ["tailwind.install --if-missing", "esbuild.install --if-missing"],
"assets.build": ["tailwind dpul_collections", "esbuild dpul_collections"],
"assets.deploy": [
Expand Down
12 changes: 12 additions & 0 deletions mix.lock

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions test/dpul_collections_web/features/locale_test.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
defmodule DpulCollectionsWeb.Features.LocaleTest do
use ExUnit.Case, async: true
use Wallaby.Feature

import Wallaby.Query

feature "locale persists between pages", %{session: session} do
session
|> visit("/")
|> assert_has(css("h3", text: "Explore Our Digital Collections"))
|> click(button("Language"))
|> click(link("Español"))
|> assert_has(css("h3", text: "Explora nuestras colecciones"))
|> click(button("Buscar"))
|> assert_has(css("div#filters", text: "Relevancia"))
end
end
3 changes: 3 additions & 0 deletions test/test_helper.exs
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
ExUnit.start()
Ecto.Adapters.SQL.Sandbox.mode(DpulCollections.Repo, :manual)

{:ok, _} = Application.ensure_all_started(:wallaby)
Application.put_env(:wallaby, :base_url, DpulCollectionsWeb.Endpoint.url())