Using Timex in a unit test

ollien

I run my unit tests with mix test --no-start, as I don’t want my application to start when I run my unit tests. However, I also want to test some code that uses Timex for a calculation. If I naively attempt to use Timex in my test, I get the following

    test "can get next instance of time in a trivial instance" do
      next_occurrence =
        Util.Time.get_next_occurrence_of_time(~D[2022-01-01], ~T[13:37:00], "America/New_York")

      assert next_occurrence == Timex.to_datetime({{2022, 1, 1}, {13, 37, 0}}, "America/New_York")
    end

  1) test get_next_occurrence_of_time can get next instance of time in a trivial instance (PillminderTest.Util.Time)
     test/pillminder/util/time_test.exs:8
     ** (ArgumentError) errors were found at the given arguments:
     
       * 1st argument: the table identifier does not refer to an existing ETS table
     
     code: assert next_occurrence == Timex.to_datetime({{2022, 1, 1}, {13, 37, 0}}, "America/New_York")
     stacktrace:
       (stdlib 3.17.2.1) :ets.lookup(:tzdata_current_release, :release_version)
       (tzdata 1.1.1) lib/tzdata/release_reader.ex:74: Tzdata.ReleaseReader.current_release_from_table/0
       (tzdata 1.1.1) lib/tzdata/release_reader.ex:17: Tzdata.ReleaseReader.simple_lookup/1
       (tzdata 1.1.1) lib/tzdata/release_reader.ex:9: Tzdata.ReleaseReader.zone_and_link_list/0
       (tzdata 1.1.1) lib/tzdata.ex:61: Tzdata.zone_exists?/1
       (timex 3.7.9) lib/timezone/timezone.ex:230: Timex.Timezone.name_of/1
       (timex 3.7.9) lib/timezone/timezone.ex:262: Timex.Timezone.get/2
       (timex 3.7.9) lib/timezone/timezone.ex:585: Timex.Timezone.convert/2
       (timex 3.7.9) lib/datetime/erlang.ex:46: Timex.Protocol.Tuple.to_datetime/2
       test/pillminder/util/time_test.exs:12: (test)

I can understand why this might be; tzdata likely needs to be started in order to read from this ETS table. I’m not sure the best way to fix this, because

If I remove --no-start, my application will start, which has side effects I don’t want to produce just by running my unit tests.
Even if I somehow prevent my application from running (is there a way?), but allow Timex to run tzdata, I’m still going to have side effects in my tests, Timex will need to update the timezone database before running my tests; I try to keep my unit tests free of network calls wherever I can.

How can I best deal with this? Is perhaps there some way I can “mock” the tzdata, or somehow pre-seed it for my unit tests?

Thanks!

3 comments

#timex

0 900 3

2022-11-14 17:53:08 UTC

First 3 of 3 Posts

trisolaran

Hi @ollien and welcome!

You should be able to turn off tzdata automatic updates in your tests by setting:

config :tzdata, :autoupdate, :disabled

in your test.exs config (GitHub - lau/tzdata: tzdata for Elixir. Born from the Calendar library. · GitHub)

Btw: you can now do time zone conversions directly in Elixir with the tzdata library without Timex: GitHub - lau/tzdata: tzdata for Elixir. Born from the Calendar library. · GitHub

Post #1

Marcus

Welcome @ollien

You could try to start timex in your test/test_helper.exs with Application.ensure_all_started(:timex).

Post #2

ollien

Thanks for the suggestions! Looking at the tzdata docs it turns out you can also store the ets table locally, so I checked that into a testdata directory (originally in ./deps/tzdata/priv) and then added the following to test.exs

import Config

config :tzdata,
  data_dir: "./test/testdata/tzdata",
  autoupdate: :disabled,
  # Definitely a hack, but tzdata uses this key to determine which http client it uses, so if it
  # actually tries to use hackney, it will get an error
  http_client: nil

and made added Application.ensure_all_started(:tzdata) to my test setup.

Post #3

— All posts loaded —