oullette

oullette

Exploring ArchUnit-like Architecture Testing for Elixir

Like most engineers these days, I’ve been thinking about the intersection of LLM driven development and using Elixir to do so. After being particular inspired by this blog post, I’ve been looking at implementing architecture testing in Elixir projects and wondering if there’s an equivalent to Java’s ArchUnit. After some research and brainstorming, I’d like to share some thoughts and potential approaches to spark a community discussion.

The Problem

In larger Elixir codebases, maintaining architectural boundaries becomes increasingly important - especially as we navigate the limitations of pumping LLM agents full of context. While Elixir’s design encourages good practices, we still need ways to codify:

  1. Enforcing domain boundaries

  2. Maintaining layered architectures

  3. Preventing unwanted dependencies / insecure patterns

  4. Ensuring architectural decisions are continually followed by the team (or even LLM coding agents)

Java developers have ArchUnit, which provides a fluent API for defining and testing architectural rules:

noClasses().that().resideInAPackage("..source..")
    .should().dependOnClassesThat().resideInAPackage("..foo..")

Now tell me that doesn’t look a lot like a functional pipeline chain…

Potential Approaches in Elixi

I see two main paths forward:

1. Custom Credo Rules

We could extend Credo with custom rules for architecture testing:

# In .credo.exs
%{
  configs: [
    %{
      name: "default",
      checks: [
        {MyProject.ArchitectureCheck.DomainBoundaries, []},
      ]
    }
  ]
}

With implementation like:

defmodule MyProject.ArchitectureCheck.DomainBoundaries do
  use Credo.Check, category: :design, base_priority: :high

  def run(%SourceFile{} = source_file, params) do
    # Parse AST and check for violations
    # Return list of issues found
  end
end

2. Custom DSL with Metaprogramming

Alternatively (and where I’m personally leaning), we could leverage Elixir’s metaprogramming to create an expressive DSL similar to ArchUnit and further leans into pipelines:

defmodule MyApp.ArchitectureTest do
  use ExUnit.Case
  use ArchElixir.DSL
  
  test "domain modules should not depend on web modules" do
    architecture_rule do
      modules_that()
      |> reside_in_namespace("MyApp.Domain")
      |> should()
      |> not_depend_on_modules_that()
      |> reside_in_namespace("MyApp.Web")
    end
  end
  
  test "layered architecture is respected" do
    architecture_rule do
      layers()
      |> define("Web", "MyApp.Web")
      |> define("Application", "MyApp.Application")
      |> define("Domain", "MyApp.Domain")
      |> where_layer("Web")
      |> may_only_access_layers(["Application"])
      |> where_layer("Application")
      |> may_only_access_layers(["Domain"])
    end
  end
end

This would require building:

  • A fluent rule builder API

  • A dependency analyzer (walking the AST similar to Credo and Sobelow)

  • A rule evaluator

  • ExUnit integration

Comparing Approaches

Custom DSL

Strengths

  • Highly expressive and readable rules

  • Flexible and extensible for complex patterns

  • Seamless ExUnit integration

  • Runtime analysis catches dynamic dependencies

  • Customized reporting

  • Paves the path for Dynamic Application Security Testing (which is worth exploring for me as a security professional)

Weaknesses

  • Significant development effort

  • Potential performance overhead

  • Limited community support

  • Complex dependency analysis

Credo Rules

Strengths

  • Integration with existing tooling

  • Static analysis benefits (speed, early feedback)

  • Community and ecosystem support

  • Lower implementation barrier

  • IDE integration

Weaknesses

  • Less expressive API

  • Limited analysis depth

  • Constrained by Credo’s design

  • Less natural for complex rules

Questions for the Community

  1. Has anyone built something like this already and I’m just not finding it in my searches?

  2. Which approach seems most promising?

  3. What architectural patterns would you want to enforce?

  4. Would this be valuable as a standalone package?

  5. Are there specific challenges in Elixir’s compilation model that would make this difficult?

  6. How could we handle dependencies across umbrella apps?

Again, I’m particularly interested in Elixir’s metaprogramming capabilities and how they could enable an elegant DSL for architecture testing. The ability to define rules that match the mental model of our architectural constraints seems valuable.

What are your thoughts? Would you even use such a tool?

Most Liked

axelson

axelson

Scenic Core Team

Not an exact fit but Boundary handles the majority of what your examples are covering (although you probably have more advanced rules in mind as well)

https://github.com/sasa1977/boundary

It supports defining what the boundaries are in a project, e.g. MyApp.Domain, MyApp.Web, and MyApp.Application could be different boundaries and you could enforce that MyApp.Domain doesn’t call into MyApp.Web, although it’s also easy to add a few exceptions, like allowing calls to MyApp.Web.Endpoint to allow creating permalinks from MyApp.Web.Endpoint.static_url.

And Boundary can also generate a graphviz graph of your boundaries which is helpful for visualizing and understanding them.

yoavgeva

yoavgeva

Boundary is great for compile-time API guards, but if you want the full ArchUnit experience — transitive dependency checks, glob-based module selection, cycle detection, naming conventions, coupling metrics — I built arch_test exactly for this.

Rules live in plain ExUnit tests, work from compiled bytecode, and require zero changes to production code:

defmodule MyApp.ArchTest do
  use ExUnit.Case
  use ArchTest

  test "services don't call repos directly" do
    modules_matching("MyApp.**.*Service")
    |> should_not_depend_on(modules_matching("MyApp.**.*Repo"))
  end

  test "no circular dependencies" do
    modules_matching("MyApp.**") |> should_be_free_of_cycles()
  end
end

It also supports layered/onion/modulith architecture patterns, Martin coupling metrics, and a violation freeze for gradual adoption on existing codebases.

Boundary and arch_test actually compose well — Boundary for hard build-time API boundaries, arch_test for everything else.

garrison

garrison

This is not really in my areas of expertise or interest, but I will note two things about the DSL you proposed:

  1. There is no metaprogramming needed as far as I can tell; you can just use functions
  2. You can just use the module names as atoms (MyApp.Domain) instead of strings

Where Next?

Popular in Discussions Top

AstonJ
If a newbie asked you about Phoenix Contexts, how would you explain the basics to them? Feel free to be as concise or in-depth as you li...
New
PragTob
Hey everyone, this has been brewing in my head some time and it came up again while reading Adopting Elixir. GenServers, supervisors et...
New
nburkley
AWS re:Invent is on at the moment with some interesting announcements. One new feature in particular is the Lambda Runtime API for AWS La...
New
Nvim
Anybody knows a comprehensive comparison of Django and Phoenix, thanks for the help. Where are they similar? Where do they differ the m...
New
AngeloChecked
What learn first? Rust or Elixir Hi Elixir community! I’m here because i want learn a new language. I’m a junior developer and mainly i ...
New
nunobernardes99
Hi there Elixir friends :vulcan_salute: In a recent task I was on, I needed to check in two dates which of them is the maximum and which...
New
shishini
I think this twitter post and youtube video didn’t get as much attention as I hoped I am still new to Elixir, so can’t really judge ...
New

Other popular topics Top

Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
New
sergio_101
I am VERY much an elixir newbie. I have taken one elixir course and one phoenix course on Udemy. During that course, I saw the instructor...
New
siddhant3030
Hi, I have to write a raw query for one of my project. But till now I have used ecto queries and don’t have much experience writing raw ...
New
sergio
Kind of like when jquery came out, it was super necessary. Existing drag and drop libraries have a bunch of baggage to support old browse...
New

We're in Beta

About us Mission Statement