# CarlaTestHelper

## Description
This repo contains a testing library used in Carla end-to-end tests. It provides a library to describe and test conversations.

## Requirements
* Elixir - The language
* Mix - Elixir run tool (included with Elixir)
* Hex - Elixir package manage (included with Elixir)

## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `carla_test_helper` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:carla_test_helper, "~> 0.1.0"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/carla_test_helper](https://hexdocs.pm/carla_test_helper).

## Example Test Case
If we want to write a test case for the "Request Detail - request details for optima" scenario, our file would look like this:
```elixir
defmodule BotTestsTest do
  use CarlaTestHelper.Case, async: true
  import CarlaTestHelper

  describe "request.detail" do

    carlatest "optima details", do: [
      # write conversation tests here 
      # message("optima", "request.details.optima")
    ]
    
  end

end
```