View Source Klife.Testing (Klife v0.5.0)

Testing helper functions.

In order to test Kafka behaviour on tests we can have 2 approachs:

Having a running Kafka broker locally and testing against it
Mocking all external calls to the broker

Klife.Testing supports the first approach by offering helper functions in order to verify if a record with the given list of properties exists in the broker.

You can use it like this:

# on test_helper.exs
Klife.Testing.setup(MyClient)

# on your test file
Klife.Testing.all_produced(MyClient, "my_topic_a", value: "abc")

The mocks approach is not supported directly by Klife but can be achieved using some awesome community libraries such as Mimic or Mox.

Summary

Functions

all_produced(client, topic, search_opts)

Return a list of Klife.Record that match the given filters.

get_latest_offsets(leader_id, metas, client_name)

setup(client)

Setup Klife.Testing, call it on your test_helper.exs.

Functions

all_produced(client, topic, search_opts)

Return a list of Klife.Record that match the given filters.

You can search by 3 fields:

value: binary
key: binary
headers: list of maps %{key: binary, value: binary}

The semantics between all possible fields is "and". Which means we only return records that have match on all 3 filters if all 3 are available.

The semantics on the headers list is also "and". Which means we only return records that have match with all headers given on the list.

Examples

iex> val = :rand.bytes(1000)
iex> rec = %Klife.Record{value: val, topic: "my_topic_1"}
iex> {:ok, %Klife.Record{}} = MyClient.produce(rec)
iex> [%Klife.Record{}] = Klife.Testing.all_produced(MyClient, "my_topic_1", value: val)

get_latest_offsets(leader_id, metas, client_name)

setup(client)

Setup Klife.Testing, call it on your test_helper.exs.

In order to avoid big searchs on big local running Kafka topics, this setup retrieves all te current latests offsets and stores it to only search after them.