zekus

zekus

Hello all.

When writing an Escript that uses System.exit/1 Is there a way to test it?
Or is there a better way to make an Escript return the proper exit code which is testable with ExUnit?

Thanks

Showing Posts 1 to 2

mbklein

mbklein

You could invoke the script via System.shell/2, which returns a tuple containing the executed command’s output and exit status.

EDIT: Sorry, I misread the question and thought you were looking to test exit status. Better answer coming soon.

mbklein

mbklein

Assuming you’re writing this script in a full mix-based environment, I’d probably test this one (or both!) of two ways:

The first would be to make the escript itself a very thin wrapper around the actual functionality it invokes, so that functionality can be tested with more conventional unit tests. You can use Code.compile_file/2 to load and compile your .exs in the test setup, call its main function yourself from inside the test, and unload it after:

defmodule MyScriptTest do
  use ExUnit.Case

  setup do
    Code.compile_file("path/to/escript.exs")
    on_exit(fn ->
      :code.delete(MyEscriptModule)
      :code.purge(MyEscriptModule)
    end)
  end

  test "test the thing" do
    with result <- MyEscriptModule.CLI.main(args) do
      assert something_about(result)
    end
  end
end

The second would be to wrap the System.exit/1 call in its own tiny module:

defmodule MyEscriptModule do
  defmodule Terminator do
    def terminate(status), do: System.exit(status)
  end

  defmodule CLI do
    def main(args) do
      # ... do whatever your script does
      terminate(some_status)
    do

    defp terminate(status) do
      Application.get_env(:my_app, :terminator, Terminator)
      |> Kernel.apply(:terminate, [status])
    end
  end
end

Then in your test, create a mock terminator module you can spy on:

defmodule MyScriptTest do
  use ExUnit.Case

  setup do
    code =
      quote do
        def terminate(status), do: unquote(self()) |> send({:exit_code, status})
      end

    Module.create(TestTerminator, code, file: __ENV__.file)
    Application.put_env(:my_app, :terminator, TestTerminator)

    on_exit(fn ->
      Application.delete_env(:my_app, :terminator)
      :code.delete(TestTerminator)
      :code.purge(TestTerminator)
    end)
  end

  test "test the thing" do
    with result <- MyEscriptModule.CLI.main(args) do
      assert_received({:exit_code, expected_exit_status})
    end
  end
end

There’s probably a much simpler way to structure this, especially the TestTerminator, but I don’t know how you’d get the test process’ PID into the mock without constructing it that way. Someone else might have a tighter example.

— 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
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
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
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
FlyingNoodle
If a change or preparation module uses Ash.Changeset.get_argument/2 or Ash.Query.get_argument/2 (or any of the other get_argument functio...
New
ryanwinchester
apply_graft/2 doesn’t rewrite an add_many sub-workflow’s deps on an add step. Grafted jobs cancel with “upstream job was deleted” Version...
New

Other Trending Topics Top

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
garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
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
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge &amp; Solve. They are GUI (Emerge) and State management (S...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews