andym

andym

Elixir unit tests next to the source file

i prefer to have my unit tests next to the source file instead of a separate folder. when i run mix test it runs the tests only within the test folder. if i remove the test folder, move the test files, and the give the following configuration in the mix.exs configuration

      test_paths: ".",
      exclude: "deps",
      test_pattern: "*_test.exs",

then it seems to do something different and fails with the following error

(Protocol.UndefinedError) protocol Enumerable not implemented for "." of type BitString. This protocol is implemented for the following type(s): DBConnection.PrepareStream, DBConnection.Stream, Date.Range, Ecto.Adapters.SQL.Stream, File.Stream, Floki.HTMLTree, Function, GenEvent.Stream, HashDict, HashSet, IO.Stream, Jason.OrderedObject, List, Map, MapSet, Range, Stream, Timex.Interval
    (elixir 1.14.3) lib/enum.ex:1: Enumerable.impl_for!/1
    (elixir 1.14.3) lib/enum.ex:166: Enumerable.reduce/3
    (elixir 1.14.3) lib/enum.ex:4307: Enum.each/2
    (mix 1.14.3) lib/mix/tasks/test.ex:529: Mix.Tasks.Test.do_run/3
    (mix 1.14.3) lib/mix/task.ex:421: anonymous fn/3 in Mix.Task.run_task/4
    (mix 1.14.3) lib/mix/cli.ex:84: Mix.CLI.run_task/2

i also tried using tag filters

  @tag mustexec: true
  test "test1" do
  end

and then running ix test --only mustexec but i still get the same error

Most Liked

namxam

namxam

I completely agree with you. And I would add another point. Having them next to the module which is tested, has three more advantages:

  1. I use tests as a documentation tool. They are nice code examples and often better transfer meaning than words. When a library does not have extended documentation, but a good test suite, it helps to check it out.

  2. Code / test navigation is much easier, as you do not have to switch between deeply nested folders.

  3. When remove obsolete modules, with colocated tests, you only have two remove 2 files or a folder. No need to search in multiple places.

The only thing which is bugging me, that for integration or e2e tests, you still need a test folder or something similar to it.

Right now, I stay with elixirs / phoenix default structure and put all tests in the test folder. But I would still prefer to have them colocated :slight_smile:

sodapopcan

sodapopcan

This must be a people who use tree-explorers for navigation versus those who don’t. Any semi-decent modern editor is going to have a “jump to test file and back” hotkey so finding 1:1 tests is a non-issue. I do use a tree-explorer but it’s primarily for getting an overview of module structure so I find it so noisy with file names doubled-up most of the time.

I could bikeshed on this forever so I’ll leave it at that :upside_down_face:

ericdouglas

ericdouglas

Also not sure why you want to break with the convention as it makes it hard for other people to find your test and understand your project.

It is much easier to find the test files in that way since it is colocated with the file containing the implementation.

Ex:

lib/
    module/
        file.ex
        file_test.exs
        another_file.ex

Another advantage is that it becomes super clear which files have tests and which don’t.

Where Next?

Popular in Questions Top

skosch
To my knowledge, put_in, Map.update etc. all have the one limitation of not automatically creating intermediate keys when needed (for exa...
New
pmjoe
I have a relationship of love and hate with Elixir. Lots of things are just absolutely right, but there are some things that are kind of ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
Emily
I have VueJS GUIs with the project generated using Webpack. I have Elixir modules that will need to be used by the VueJS GUIs. I forese...
New
LegitStack
I’m trying to make a websocket server in Phoenix or raw Elixir. I heard about gun, I think I could use cowboy, but since I’m not that sma...
New
dblack
I’ve got an issue with an app and I’ve no idea of how to troubleshoot it. I’m hoping someone here might have seen something similar. I p...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
shijith.k
I am trying to start a new phoenix project with elixir 1.9, but mix phx.new does not work. It says that ** (Mix) The task "phx.new" could...
New
jononomo
For some reason my phoenix channels are working for me in my local dev environment, but as soon as I deploy via Docker, I get a 403 error...
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New

Other popular topics Top

JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 53690 245
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New
johnnyicon
Hi all, I’ve just started learning Elixir and Phoenix Framework, so please pardon my n00bness at this stage. I’m trying to use Postgres...
New
stefanluptak
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
New
gausby
I asked this very same question on twitter and got some interesting feedback, but I thought it would be a good question to ask here as we...
1207 39297 209
New
saif
Hello everyone, Long time lurker first time poster here. I’ve recently begun working on Elixir full-time again! :raised_hands: It’s been...
New
marick
I had some trouble figuring out how to make many-to-many associations work. Once I got it working, I wrote a blog post. Because I’m a nov...
New
openscript
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New

We're in Beta

About us Mission Statement