sergio

sergio

I wrote a doctest that tests that the function is returning a %Foobar.Accounts.User struct type.

  1) test doc at Foobar.Accounts.create_user_with_email_only/1 (1) (Foobar.AccountsTest)
     test/accounts/accounts_test.exs:3
     Doctest failed
     code: Foobar.Accounts.create_user_with_email_only("test@email.com") === {:ok, %Foobar.Accounts.User{}}
     left: {:ok,
            %Foobar.Accounts.User{__meta__: #Ecto.Schema.Metadata<:loaded, "users">,
             confirmation_code: "338128", email: "test@email.com",
             email_confirmed: false, encrypted_password: nil, fullname: nil,
             id: 2306, inserted_at: ~N[2017-07-25 03:26:15.407053],
             invite_token: nil, onboarded: false, password: nil, pin: nil,
             roles: nil,
             team: #Ecto.Association.NotLoaded<association :team is not loaded>,
             team_id: nil, token: "flDJRP6Vx78pI3uSOgSVPb2HxcEZ3DYU",
             updated_at: ~N[2017-07-25 03:26:15.413361], username: nil}}
     stacktrace:
       lib/accounts/accounts.ex:15: Foobar.Accounts (module)

My doctests look like:

@doc """
Create a user with only the email field set. The user is not
associated with any team.

## Examples

    iex> Foobar.Accounts.create_user_with_email_only("test@email.com")
    {:ok, %Foobar.Accounts.User{}}

    iex> Foobar.Accounts.create_user_with_email_only("")
    {:error, "Email cannot be blank or nil."}

    iex> Foobar.Accounts.create_user_with_email_only(nil)
    {:error, "Email cannot be blank or nil."}

"""
def create_user_with_email_only(email) when byte_size(email) > 0 do

Thanks for the help!

Showing Posts 1 to 4

mudasobwa

mudasobwa

Creator of Cure

Doctest does not pattern match result, it explicitly compares it against pinned value:

iex|1 ▶ map = %{foo: 42}
%{foo: 42}
iex|2 ▶ case %{foo: 42, bar: 3.14} do
...|2 ▶ ^map -> :matched
...|2 ▶ _ -> :not_matched
...|2 ▶ end
:not_matched

That said, you should retrieve the result and assert the explicit pattern match:

iex|3 ▶ result = Foobar.Accounts.create_user_with_email_only("test@email.com")
...|3 ▶ with {:ok, %Foobar.Accounts.User{}} <- result, do: :passed
:passed
meddle

meddle

Another idea similar to the above without the use of with. But I really like the idea with with too :slight_smile:

iex> {status, %Foobar.Accounts.User{}} = Foobar.Accounts.create_user_with_email_only("test@email.com")
....> status
:ok
mudasobwa

mudasobwa

Creator of Cure

This has a drawback: is the test fails, there would be a messy message; with-approach will respond with smth like “expected :passed, got …” putting out to the screen the actual result (due to how with works.)

meddle

meddle

Ah, I see your point. And the idea with with is not really much complex or long. So yeah the with idea is better.

— All posts loaded —

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
kpanic
Hi everyone, I am toying with the idea of building a “match maker” for giving personal help to people that wants to start coding. I sta...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
asweet-confluent
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New
apz
I’m new to elixir and just tried to install the elixirLS extension for VScode(ium) and it is throwing some errors that I would like help ...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
New
JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews