Refactored test setup into real-world fixes

.iex.exs

@@ -22,7 +22,4 @@ alias Pinchflat.Metadata.MetadataFileHelpers
 
 alias Pinchflat.SlowIndexing.FileFollowerServer
 
-# TODO: remove
-alias Pinchflat.KilledWorker
-
 Pinchflat.Release.check_file_permissions()

lib/pinchflat/killed_worker.ex

@@ -1,58 +0,0 @@
-defmodule Pinchflat.KilledWorker do
-  @moduledoc false
-
-  use Oban.Worker,
-    queue: :default
-
-  import Ecto.Query, warn: false
-
-  require Logger
-
-  alias __MODULE__
-  alias Pinchflat.Repo
-
-  def kickoff(job_args \\ %{}, opts \\ []) do
-    job_args
-    |> KilledWorker.new(opts)
-    |> Repo.insert_unique_job()
-
-    :ok
-  end
-
-  def cancel do
-    Oban.Job
-    |> where(worker: "Pinchflat.KilledWorker")
-    |> Oban.cancel_all_jobs()
-  end
-
-  def start_stop do
-    kickoff()
-    Process.sleep(2000)
-    cancel()
-  end
-
-  @impl Oban.Worker
-  def perform(%Oban.Job{}) do
-    # case System.cmd("/app/wrapper.sh", ["/app/slow.sh"]) do
-    args = [
-      "/usr/local/bin/yt-dlp",
-      "https://www.youtube.com/@OverSimplified",
-      "--simulate",
-      "--print",
-      "%(title)s"
-    ]
-
-    case System.cmd("/app/wrapper.sh", args) do
-      {output, 0} ->
-        Logger.warning("KilledWorker: #{output}")
-        {:ok, output}
-
-      {output, _} ->
-        Logger.error("KilledWorker: #{output}")
-        {:error, output}
-    end
-
-    Logger.warning("KilledWorker: done")
-    :ok
-  end
-end

lib/pinchflat/notifications/command_runner.ex

@@ -45,7 +45,7 @@ defmodule Pinchflat.Notifications.CommandRunner do
   """
   @impl AppriseCommandRunner
   def version do
-    case System.cmd(backend_executable(), ["--version"]) do
+    case CliUtils.wrap_cmd(backend_executable(), ["--version"]) do
       {output, 0} ->
         output
         |> String.split(~r{\r?\n})

lib/pinchflat/utils/cli_utils.ex

@@ -5,6 +5,23 @@ defmodule Pinchflat.Utils.CliUtils do
 
   alias Pinchflat.Utils.StringUtils
 
+  @doc """
+  Wraps a command in a shell script that will terminate
+  the command if stdin is closed. Useful for stopping
+  commands if the job runner is cancelled.
+
+  Delegates to `System.cmd/3` and any options/output
+  are passed through.
+
+  Returns {binary(), integer()}
+  """
+  def wrap_cmd(command, args, opts \\ []) do
+    wrapper_command = Path.join(:code.priv_dir(:pinchflat), "cmd_wrapper.sh")
+    actual_command = [command] ++ args
+
+    System.cmd(wrapper_command, actual_command, opts)
+  end
+
   @doc """
   Parses a list of command options into a list of strings suitable for passing to
   `System.cmd/3`.

lib/pinchflat/yt_dlp/command_runner.ex

@@ -37,7 +37,7 @@ defmodule Pinchflat.YtDlp.CommandRunner do
     formatted_command_opts = [url] ++ CliUtils.parse_options(all_opts)
     Logger.info("[yt-dlp] called with: #{Enum.join(formatted_command_opts, " ")}")
 
-    case System.cmd(command, formatted_command_opts, stderr_to_stdout: true) do
+    case CliUtils.wrap_cmd(command, formatted_command_opts, stderr_to_stdout: true) do
       {_, 0} ->
         # IDEA: consider deleting the file after reading it. It's in the tmp dir, so it's not
         # a huge deal, but it's still a good idea to clean up after ourselves.

priv/cmd_wrapper.sh

@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+# This script is a wrapper for other programs
+# that ensures they are killed when stdin closes
+# (eg: a job terminates)
+
 # Start the program in the background
 exec "$@" &
 pid1=$!

slow.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-
-# Runs for N seconds
-for i in {1..15}; do
-  echo "Slow script running for $i seconds"
-  sleep 1
-done
-echo "Slow script done"

test/pinchflat/utils/cli_utils_test.exs

@@ -3,6 +3,12 @@ defmodule Pinchflat.Utils.CliUtilsTest do
 
   alias Pinchflat.Utils.CliUtils
 
+  describe "wrap_cmd/3" do
+    test "delegates to System.cmd/3" do
+      assert {"output\n", 0} = CliUtils.wrap_cmd("echo", ["output"])
+    end
+  end
+
   describe "parse_options/1" do
     test "it converts symbol k-v arg keys to kebab case" do
       assert ["--buffer-size", "1024"] = CliUtils.parse_options(buffer_size: 1024)