co0lsky

co0lsky

Greetings! I am relatively new to property-based testing. I am practicing writing property tests and hoping for a code review if any practitioner has any comments or suggestions on the test.

defmodule Academy.UserPropTest do
  alias Academy.UserShim

  use Academy.TestCase, async: true
  use PropCheck
  use PropCheck.StateM

  require ExUnitProperties

  # Generators
  def first_name() do
    StreamData.string(:alphanumeric, length: 10..20)
  end

  def email() do
    StreamData.string(:alphanumeric, length: 10)
  end

  def email(s) do
    attrs = Map.get(s, :existing)
    StreamData.constant(attrs.email)
  end

  def uid() do
    StreamData.string(:alphanumeric, length: 10)
  end

  def uid(s) do
    attrs = Map.get(s, :existing)
    StreamData.constant(attrs.uid)
  end

  def role() do
    StreamData.member_of(["admin", "editor", "tester", "support", "user"])
  end

  def profile() do
    StreamData.nonempty(StreamData.map_of(StreamData.constant("lang"), StreamData.string(:ascii)))
  end

  def attrs() do
    Enum.take(
      StreamData.fixed_map(%{
        first_name: first_name(),
        email: email(),
        uid: uid(),
        role: role(),
        profile: profile()
      }),
      1
    )
  end

  def attrs(s) do
    Enum.take(
      StreamData.fixed_map(%{
        first_name: first_name(),
        email: email(s),
        uid: uid(),
        role: role(),
        profile: profile()
      }),
      1
    )
  end

  # Helpers
  def like_email(map, email) do
    Enum.any?(
      Map.values(map),
      fn attrs -> attrs.email == email end
    )
  end

  property "user stateful operations", [:verbose] do
    forall cmds <- commands(__MODULE__) do
      {history, state, result} = run_commands(__MODULE__, cmds)

      (result == :ok)
      |> aggregate(command_names(cmds))
      |> when_fail(
        IO.puts("""
        History: #{inspect(history)}
        State: #{inspect(state)}
        Result: #{inspect(result)}
        """)
      )
    end
  end

  # initial model value at system start. Should be deterministic.
  def initial_state(), do: %{}

  def command(state) do
    always_possible = [
      {:call, UserShim, :create, attrs()}
    ]

    relies_on_state =
      case Map.equal?(state, %{}) do
        # no values yet
        true ->
          []

        # values from which to work
        false ->
          s = state

          [
            {:call, UserShim, :create_existing, attrs(s)}
          ]
      end

    oneof(always_possible ++ relies_on_state)
  end

  # Picks whether a command should be valid under the current state.
  def precondition(s, {:call, _, :create, [attrs | _]}) do
    not like_email(s, attrs.email)
  end

  # - all calls with known emails
  def precondition(s, {:call, _mod, _fun, [attrs | _]}) do
    like_email(s, attrs.email)
  end

  # Given the state *prior* to the call {:call, mod, fun, args},
  # determine whether the result (coming from the actual system)
  # makes sense.
  def postcondition(_state, {_, _mod, :create, _args}, {:ok, _}) do
    true
  end

  def postcondition(_state, {_, _mod, :create_existing, _args}, {:error, _}) do
    true
  end

  # Assuming the postcondition for a call was true, update the model
  # accordingly for the test to proceed
  def next_state(
        state,
        _,
        {:call, _, :create, [attrs]}
      ) do
    Map.put(state, :existing, attrs)
  end

  def next_state(state, _res, {:call, _mod, _fun, _args}) do
    new_state = state
    new_state
  end
end
defmodule Academy.UserShim do
  def create(attrs) do
    Academy.User.create(attrs)
  end

  def create_existing(attrs) do
    Academy.User.create(attrs)
  end
end

Showing Posts 1 to 2

dimitarvp

dimitarvp

Nothing really wrong pokes me in the eye. Do you want to add to this code but are not able to? That second module is a bit strange though, what’s its purpose?

co0lsky

co0lsky OP

This is my first time writing a property test. I hope to know if the test has some bad practices.

The second module is a Shim. In my case, I would like to test a different scenario, such as create a user who already exists in the system. By using the shim, I have :create and :create_existing to indicate different scenarios. So, if calling :create_existing, an error is expecting instead of success.

— All posts loaded —

Where Next? Top

Trending in Questions Top

water
I’m aware of 2 such projects, are there others? git: GitHub - team-alembic/realworld: A fullstack Phoenix LiveView application with back...
New
katta
I having some trouble figuring out if I have set myself too strict of standards for my production server. Currently I can handle 75% of r...
New
peck
Hi everyone. My team and I have been working on a fairly modest app based around video streaming and chat, but we’ve landed a customer t...
New
bradley
I really like the adapter patterns that ecto, nebulex, waffle, etc. use and would love find something similar for a key management servic...
New
unaware8150
Hello folks! So at work, we are seeing some situations where we have to define some “fixed” strings that are used across the codebase in...
New
Alvinkariuki
How Can I Optimise Compile Time Dependencies I have been building an elixir application for about 2 years now. Many modules and files ha...
New

Other Trending Topics Top

budgie
A little off-topic, but I feel like people here have a good head on their shoulders. I used to be quite good at making software. Was luc...
New
KristerV
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
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
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New
budgie
I love Elixir. It’s one of 2 programming languages I’ve ever fallen in love with. But I don’t use it anymore. Serverless was the promis...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews