Fix audit errors

Author: gaggle

lib/command_line.ex

@@ -1,34 +1,59 @@
 defmodule ElixirScript.CommandLine do
+  @moduledoc """
+  Main entrypoint for ElixirScript.
+  Manages the parsing of command-line arguments, configures logger, and delegates work into sub-systems.
+  """
+
   alias ElixirScript.Core
   alias ElixirScript.CustomLogger, as: Logger
   alias ElixirScript.ScriptRunner
 
-  def main(args \\ []) do
-    Logger.debug("Running in debug mode")
+  defmodule ParsedArgs do
+    @moduledoc """
+    Struct for parsed args
+    """
+    defstruct debug?: false, help?: false, script: nil
+  end
+
+  def main(args, opts \\ []) do
+    parsed_args = parse_args!(args)
+    log_level = if parsed_args.debug?, do: :debug, else: :info
+    Logger.configure(level: log_level)
 
-    Logger.debug(
-      "All Environment Variables: #{inspect(System.get_env(), limit: :infinity, printable_limit: :infinity)}"
-    )
+    runner = Keyword.get(opts, :runner, &ScriptRunner.run/1)
+    Logger.debug("Running in debug mode, using runner: #{inspect(runner)}")
 
-    {opts, _, _} = OptionParser.parse(args, strict: [help: :boolean])
-    Logger.debug("Parsed options: #{inspect(opts, limit: :infinity, printable_limit: :infinity)}")
+    Logger.debug("Environment Variables: #{inf_inspect(System.get_env())}")
 
-    if opts[:help] do
+    Logger.debug("Parsed args: #{inf_inspect(parsed_args)}")
+
+    if parsed_args.help? do
       print_help()
+      System.halt(0)
     else
-      result = ScriptRunner.run(get_script())
+      Logger.debug("Script input: #{inf_inspect(parsed_args.script)}")
+      result = runner.(parsed_args.script)
       Core.set_output(result, "result")
-
-      Logger.debug(
-        "Result output: #{inspect(result, limit: :infinity, printable_limit: :infinity)}"
-      )
+      Logger.debug("Result output: #{inspect(result, pretty: true)}")
     end
   end
 
-  defp get_script do
-    script = Core.get_env_input("script", required: true)
-    Logger.debug("Script input: #{inspect(script, limit: :infinity, printable_limit: :infinity)}")
-    script
+  def parse_args!(args) do
+    {parsed, _remaining_args} =
+      OptionParser.parse!(args,
+        strict: [script: :string, debug: :boolean, help: :boolean],
+        aliases: [debug: :d, help: :h, script: :s]
+      )
+
+    debug? = Keyword.get(parsed, :debug, System.get_env("INPUT_DEBUG") == "true")
+    script = Keyword.get(parsed, :script, System.get_env("INPUT_SCRIPT"))
+    help? = Keyword.get(parsed, :help, false)
+
+    %ParsedArgs{
+      debug?: debug?,
+      help?: help?,
+      script: script
+    }
   end
 
   defp print_help do
@@ -37,10 +62,16 @@ defmodule ElixirScript.CommandLine do
       script [OPTIONS]
 
     Options:
-      --help          Show this help message and exit.
+      --script,-s       Specifies the script to run [INPUT_SCRIPT]
+      --debug, -d       Enables debug mode [INPUT_DEBUG]
+      --help, -h        Show this help message and exit
 
     Example:
-      INPUT_SCRIPT="IO.puts('Hello, world!')" script
+      script --script "IO.puts('Hello, world!')"
     """)
   end
+
+  def inf_inspect(exec) do
+    inspect(exec, pretty: true, limit: :infinity, printable_limit: :infinity)
+  end
 end

lib/context.ex

@@ -1,6 +1,10 @@
 defmodule ElixirScript.Context do
+  @moduledoc """
+  Constructs a structured context of the GitHub Actions environment variables, for use within ElixirScript.
+  """
   alias __MODULE__
 
+  @derive Jason.Encoder
   defstruct [
     :payload,
     :event_name,
@@ -17,44 +21,45 @@ defmodule ElixirScript.Context do
     :graphql_url
   ]
 
-  defimpl Jason.Encoder, for: Context do
-    def encode(%Context{} = context, opts) do
-      Map.from_struct(context) |> Jason.Encode.map(opts)
-    end
+  def from_github_environment do
+    %Context{
+      payload: read_payload(),
+      event_name: fetch_env("GITHUB_EVENT_NAME", ""),
+      sha: fetch_env("GITHUB_SHA", ""),
+      ref: fetch_env("GITHUB_REF", ""),
+      workflow: fetch_env("GITHUB_WORKFLOW", ""),
+      action: fetch_env("GITHUB_ACTION", ""),
+      actor: fetch_env("GITHUB_ACTOR", ""),
+      job: fetch_env("GITHUB_JOB", ""),
+      run_number: fetch_env("GITHUB_RUN_NUMBER"),
+      run_id: fetch_env("GITHUB_RUN_ID") |> parse_int(),
+      api_url: fetch_env("GITHUB_API_URL", "https://api.github.com"),
+      server_url: fetch_env("GITHUB_SERVER_URL", "https://github.com"),
+      graphql_url: fetch_env("GITHUB_GRAPHQL_URL", "https://api.github.com/graphql")
+    }
   end
 
-  def from_github_environment() do
-    payload =
-      if System.get_env("GITHUB_EVENT_PATH") do
-        path = System.get_env("GITHUB_EVENT_PATH")
-
-        if File.exists?(path) do
-          File.read!(path) |> Jason.decode!()
-        else
-          IO.puts("GITHUB_EVENT_PATH #{path} does not exist")
-          %{}
-        end
-      else
-        %{}
-      end
+  defp read_payload do
+    fetch_env("GITHUB_EVENT_PATH")
+    |> maybe_read_file()
+  end
 
-    %Context{
-      payload: payload,
-      event_name: System.get_env("GITHUB_EVENT_NAME") || "",
-      sha: System.get_env("GITHUB_SHA") || "",
-      ref: System.get_env("GITHUB_REF") || "",
-      workflow: System.get_env("GITHUB_WORKFLOW") || "",
-      action: System.get_env("GITHUB_ACTION") || "",
-      actor: System.get_env("GITHUB_ACTOR") || "",
-      job: System.get_env("GITHUB_JOB") || "",
-      run_number: System.get_env("GITHUB_RUN_NUMBER") |> parse_int(),
-      run_id: System.get_env("GITHUB_RUN_ID") |> parse_int(),
-      api_url: System.get_env("GITHUB_API_URL") || "https://api.github.com",
-      server_url: System.get_env("GITHUB_SERVER_URL") || "https://github.com",
-      graphql_url: System.get_env("GITHUB_GRAPHQL_URL") || "https://api.github.com/graphql"
-    }
+  defp maybe_read_file(nil), do: %{}
+
+  defp maybe_read_file(path) do
+    case File.read(path) do
+      {:ok, contents} ->
+        contents |> Jason.decode!()
+
+      {:error, _reason} ->
+        IO.puts("Error reading GITHUB_EVENT_PATH #{path}")
+        %{}
+    end
   end
 
+  defp fetch_env(var), do: System.get_env(var)
+  defp fetch_env(var, default), do: fetch_env(var) || default
+
   defp parse_int(nil), do: nil
   defp parse_int(value), do: String.to_integer(value)
 end

lib/core.ex

@@ -1,17 +1,12 @@
 defmodule ElixirScript.Core do
-  alias ElixirScript.GitHubActions.Command
-  alias ElixirScript.GitHubActions.CommandUtils
-  alias ElixirScript.GitHubActions.EnvironmentFileCommand
-
-  def parse_args(args) do
-    aliases = [script: :s, debug: :d]
-    parsed = OptionParser.parse(args, aliases: aliases)
+  @moduledoc """
+  Provides core functionalities for ElixirScript,
+  handling the retrieval and sanitization of GitHub Actions environment inputs and outputs.
+  """
 
-    case parsed do
-      {opts, _remaining_args, _invalid_opts} ->
-        %{script: Map.get(opts, :script), debug: Map.get(opts, :debug)}
-    end
-  end
+  alias ElixirScript.GitHubActions.EnvironmentFileCommand
+  alias ElixirScript.GitHubActions.WorkflowCommand
+  alias ElixirScript.GitHubActions.WorkflowCommandUtils
 
   def get_env_input(name, opts \\ []) do
     required = Keyword.get(opts, :required, false)
@@ -38,11 +33,15 @@ defmodule ElixirScript.Core do
         "OUTPUT",
         EnvironmentFileCommand.prepare_key_value_message(
           name,
-          CommandUtils.to_command_value(value)
+          WorkflowCommandUtils.to_command_value(value)
         )
       )
     else
-      Command.issue_command(~c"set-output", name, CommandUtils.to_command_value(value))
+      WorkflowCommand.issue_command(
+        ~c"set-output",
+        name,
+        WorkflowCommandUtils.to_command_value(value)
+      )
     end
   end
 

lib/custom_logger.ex

@@ -7,8 +7,13 @@ defmodule ElixirScript.CustomLogger do
     if debug_mode?(), do: log(:debug, message)
   end
 
-  defp debug_mode?() do
-    System.get_env("INPUT_DEBUG") == "true"
+  def configure(opts \\ []) do
+    level = Keyword.get(opts, :level, :info)
+    Application.put_env(:elixir_script, :log_level, level)
+  end
+
+  defp debug_mode? do
+    Application.get_env(:elixir_script, :log_level, :info) == :debug
   end
 
   defp log(level, message) do

lib/e2e.ex

@@ -7,6 +7,10 @@ defmodule ElixirScript.E2e.Entry do
 end
 
 defmodule ElixirScript.E2e do
+  @moduledoc """
+  Provides functionality for reading and processing end-to-end (E2E) test data,
+  transforming the data into Entry structs that can be consumed in different contexts.
+  """
   alias ElixirScript.E2e.Entry
 
   def read_test_file(file_path \\ "test/e2e_data.exs") do
@@ -24,7 +28,7 @@ defmodule ElixirScript.E2e do
     file = Map.get(entry, :file)
     expected = Map.get(entry, :expected)
 
-    if(!script && !file) do
+    if !script && !file do
       raise(KeyError, "key :script or :file not found in: #{inspect(entry)}")
     end
 

lib/github_actions/environment_file_command.ex

@@ -4,7 +4,7 @@ defmodule ElixirScript.GitHubActions.EnvironmentFileCommand do
 
   This module is designed to interact with GitHub Actions by issuing
   workflow commands to environment files as specified in the GitHub Actions documentation:
-  [Workflow Commands for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#environment-files).
+  [Workflow Environment File Commands for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#environment-files).
   """
 
   def issue_file_command(command, command_value) do

lib/github_actions/workflow_command.ex

@@ -1,4 +1,12 @@
-defmodule ElixirScript.GitHubActions.Command do
+defmodule ElixirScript.GitHubActions.WorkflowCommand do
+  @moduledoc """
+  Handles GitHub Actions Workflow Commands.
+
+  This module is designed to interact with GitHub Actions by issuing
+  workflow commands as specified in the GitHub Actions documentation:
+  [Workflow Commands for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#about-workflow-commands).
+  """
+
   def issue_command(command, name, command_value) do
     IO.puts("::#{command} name=#{name}::#{command_value}")
   end

lib/github_actions/workflow_command_utils.ex

@@ -1,4 +1,9 @@
-defmodule ElixirScript.GitHubActions.CommandUtils do
+defmodule ElixirScript.GitHubActions.WorkflowCommandUtils do
+  @moduledoc """
+  Utility functions for converting a a string format compatible with GitHub Actions commands.
+  This includes handling `nil` values, binary strings, and encoding complex data types into JSON strings.
+  """
+
   def to_command_value(nil), do: ""
 
   def to_command_value(input) when is_binary(input), do: input

lib/mix/tasks/docker.ex

@@ -1,8 +1,9 @@
 defmodule Mix.Tasks.Docker do
+  @moduledoc """
+  A Mix task for managing Docker operations
+  """
   use Mix.Task
 
-  @shortdoc "Manages Docker operations for the project."
-
   def run(args) do
     case args do
       ["build"] -> build()

lib/mix/tasks/e2e/set_github_matrix.ex

@@ -1,16 +1,13 @@
 defmodule Mix.Tasks.E2e.SetGithubMatrix do
+  @moduledoc """
+  Mix task to generate matrix information from E2E test data for GitHub Actions workflows.
+  """
   use Mix.Task
 
   alias ElixirScript.Core
   alias ElixirScript.E2e
   alias ElixirScript.E2e.Entry
 
-  @moduledoc """
-  Mix task to generate matrix information from E2E test data for GitHub Actions workflows.
-  """
-
-  @shortdoc "Generates matrix information from the E2E data file, to feed into a GitHub Actions matrix."
-
   def run(args) do
     output_key = List.first(args) || "matrix"