mcpField
E
exunit-code-review

exunit-code-review

github.com/existential-birdsTesting & quality8585 installsUpdated 11w ago
Repository

About exunit-code-review

An ExUnit test code-review guide for Elixir teams, covering test structure, external-boundary mocks, test adapters, and database isolation. It sets review gates requiring file-line evidence and verification steps.

Key features

  1. 01Check async tests and test organization
  2. 02Use Mox only at external boundaries
  3. 03Review Bypass, Swoosh, and Oban test adapters
  4. 04Check Ecto sandbox database isolation
  5. 05Verify findings in sequence and cite line numbers

Use cases

  1. 01Review an ExUnit test module
  2. 02Decide whether external dependencies need mocks
  3. 03Check async tests and shared database state
  4. 04Submit review findings with file and line evidence

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/existential-birds/beagle --skill exunit-code-review

After installing, type/exunit-code-reviewin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
exunit-patterns.md
integration-tests.md
mox-boundaries.md
test-adapters.md

Details

From the project README

ExUnit Code Review

Quick Reference

Issue TypeReference
Async tests, setup, describe, tagsreferences/exunit-patterns.md
Behavior-based mocking, expectationsreferences/mox-boundaries.md
Bypass, Swoosh, Oban testingreferences/test-adapters.md
What to mock vs real, Ecto sandboxreferences/integration-tests.md

Mock Boundary Philosophy

Mock at external boundaries:

  • HTTP clients, external APIs, third-party services
  • Slow resources: file system, email, job queues
  • Non-deterministic: DateTime.utc_now(), :rand

DO NOT mock internal code:

  • Contexts, schemas, GenServers
  • Internal modules, PubSub
  • Anything you wrote

Review Checklist

Test Structure
  • Tests are async: true unless sharing database state
  • Describe-blocks group related tests
  • Setup extracts common test data
  • Tests have clear arrange/act/assert structure
Mocking
  • Mox used for external boundaries (HTTP, APIs)
  • Behaviors defined for mockable interfaces
  • No mocking of internal modules
  • verify_on_exit! in setup for strict mocking
Test Adapters
  • Bypass for HTTP endpoint mocking
  • Swoosh.TestAdapter for email testing
  • Oban.Testing for background job assertions
Database
  • Ecto.Adapters.SQL.Sandbox for isolation
  • Async tests don't share database state
  • Fixtures/factories used consistently

Valid Patterns (Do NOT Flag)

  • Mock in unit test, real in integration - Different test levels have different needs
  • Not mocking database in integration tests - Database is internal
  • Simple inline test data - Not everything needs factories
  • Testing private functions via public API - Correct approach

Context-Sensitive Rules

IssueFlag ONLY IF
Not asyncTest actually needs shared state
Missing mockExternal call exists AND no mock/bypass
Mock internalModule being mocked is internal code

Gates (sequence)

Complete in order. Do not emit a finding until the prior step passes for that issue.

  1. Evidence from the file — Open the test module (or helper) and tie the claim to concrete lines.

    • Pass when: Each prospective finding includes [FILE:LINE] and a one-line factual description of what is on that line (or an adjacent line you name), not a generic style complaint.
  2. ExUnit false-positive veto — Check this skill’s Valid Patterns and Context-Sensitive Rules for the case.

    • Pass when: You can state “not covered by Do NOT Flag / Flag ONLY IF” in one sentence, or you drop the finding.
  3. Cross-protocol verification — Apply review-verification-protocol (e.g. read full function/block, search usages before “unused” claims) to that same finding.

    • Pass when: At least one protocol check relevant to the claim type is satisfied and would appear in your rationale if challenged.

Before Submitting Findings

Use [FILE:LINE] ISSUE_TITLE per finding after Gates (sequence) and the linked protocol are satisfied.

Comments

Markdown supported