setup and test scripts

README.md

@@ -9,19 +9,31 @@
   - Brew may ask you to upgrade your database upon installation: `brew postgresql-upgrade-database`
   - Start Postgres with `brew services start postgresql`
   - If this is the first time you've used it, you may need to create a database. Run `createdb`
-- asdf: `brew install asdf`
-- `asdf install`
-  - You may need to run `asdf plugin add` some of `erlang`, `elixir`, or `nodejs` first.
+- `mise` or `asdf`:
+  - `mise`:
+    - `curl https://mise.run | sh` or `brew install mise`
+    - `mise install`
+  - `asdf`:
+    - `brew install asdf`
+    - You may need to run `asdf plugin add` some of `erlang`, `elixir`, or `nodejs`.
+    - `asdf install`
 
 ## Set up
 
-- `asdf install`
-- `mix setup`
+- `bin/setup` (rerun after any dependencies are updated)
 
 Run the server with `mix phx.server`.
 
 Now you can visit [`localhost:4001`](http://localhost:4001) from your browser.
 
+## Tests
+
+Run `bin/test` to run all backend and frontend test suites.
+
+Run `mix test test/path/to/file_test.exs` or `npm run test:jest -- js/path/to/file.test.ts` to run a specific unit test.
+
+See [`bin/test`](bin/test), [`mix.exs`](mix.exs), and [`package.json`](package.json) for other test commands.
+
 ## Docker
 
 To run the Docker container locally, run `docker compose up --build`.

bin/setup

@@ -0,0 +1,39 @@
+#!/usr/bin/env sh
+
+# Exit if any subcommand fails
+set -e
+
+runtime_manager=$(command -v mise || command -v asdf)
+
+echo "# asdf/mise install"
+$runtime_manager install
+echo ""
+
+echo "# mix local.hex and local.rebar"
+mix local.hex --force
+mix local.rebar --force
+echo ""
+
+echo "# mix deps.get"
+mix deps.get
+echo ""
+
+echo "# mix deps.compile (dev)"
+mix deps.compile
+echo ""
+
+echo "# mix ecto.setup (dev)"
+mix ecto.setup
+echo ""
+
+echo "# mix deps.compile (test)"
+env MIX_ENV=test mix deps.compile
+echo ""
+
+echo "# mix ecto.setup (test)"
+env MIX_ENV=test mix ecto.setup
+echo ""
+
+echo "# npm ci"
+npm ci
+echo ""

bin/test

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+
+set -ex
+
+mix test_all
+# dialyzer isn't included in `test_all` because it has to run in MIX_ENV=dev
+mix dialyzer
+npm test

mix.exs

@@ -9,6 +9,9 @@ defmodule Orbit.MixProject do
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,
       aliases: aliases(),
+      preferred_cli_env: [
+        test_all: :test
+      ],
       deps: deps(),
       dialzyer: [
         plt_add_apps: [:mix]
@@ -74,11 +77,37 @@ defmodule Orbit.MixProject do
   # See the documentation for `Mix` for more info on aliases.
   defp aliases do
     [
-      setup: ["deps.get", "ecto.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", "test", "credo"],
-      sobelow: ["sobelow --config"]
+      "ecto.setup": [
+        "ecto.create",
+        "ecto.migrate",
+        # only run seeds.exs in dev,
+        if Mix.env() == :dev do
+          "run priv/repo/seeds.exs"
+        else
+          # noop
+          fn _args -> :ok end
+        end
+      ],
+      "ecto.reset": [
+        "ecto.drop",
+        "ecto.setup"
+      ],
+      test: [
+        "ecto.create --quiet",
+        "ecto.migrate --quiet",
+        "test"
+      ],
+      sobelow: ["sobelow --config"],
+      # Must be separate from `test` so that you can pass args to `test`,
+      # and only run `test` on those files and not `credo` on all files.
+      # runs in MIX_ENV=test because of preferred_cli_env above
+      test_all: [
+        "test",
+        "credo",
+        "format --check-formatted",
+        "sobelow"
+        # dialyzer for some reason has to be in MIX_ENV=dev, so run it separately.
+      ]
     ]
   end
 end