feat: add OnePiece.TestSupport package

yordis · yordis · commit 6b2361111984 · 2023-04-28T02:51:26.000-04:00
diff --git a/README.md b/README.md
@@ -7,3 +7,4 @@
 - [OnePiece.GracefulShutdown](./apps/one_piece_graceful_shutdown/README.md) Catches `SIGTERM` signal to gracefully stop
   the system.
 - [OnePiece.Result](./apps/one_piece_result/README.md) Handles ok-error tuple responses.
+- [OnePiece.TestSupport](./apps/one_piece_test_support/README.md) A Swiss Army Knife for the Testing.
diff --git a/apps/one_piece_test_support/.formatter.exs b/apps/one_piece_test_support/.formatter.exs
@@ -0,0 +1,4 @@
+[
+  line_length: 120,
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]
diff --git a/apps/one_piece_test_support/.gitignore b/apps/one_piece_test_support/.gitignore
@@ -0,0 +1,26 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+one_piece_commanded-*.tar
+
+# Temporary files for e.g. tests
+/tmp
diff --git a/apps/one_piece_test_support/CHANGELOG.md b/apps/one_piece_test_support/CHANGELOG.md
@@ -0,0 +1,7 @@
+# Changelog
+
+## Unreleased
+
+## v0.1.0 - 2023-04-28
+
+- Initial release
diff --git a/apps/one_piece_test_support/LICENSE b/apps/one_piece_test_support/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-Present Straw Hat, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/apps/one_piece_test_support/README.md b/apps/one_piece_test_support/README.md
@@ -0,0 +1,9 @@
+# OnePiece.TestSupport
+
+A Swiss Army Knife for the Testing.
+
+## Documentation
+
+### References
+
+- [API Reference](api-reference.html)
diff --git a/apps/one_piece_test_support/coveralls.json b/apps/one_piece_test_support/coveralls.json
@@ -0,0 +1,5 @@
+{
+  "coverage_options": {
+    "treat_no_relevant_lines_as_covered": true
+  }
+}
diff --git a/apps/one_piece_test_support/lib/one_piece/test_support.ex b/apps/one_piece_test_support/lib/one_piece/test_support.ex
@@ -0,0 +1,5 @@
+defmodule OnePiece.TestSupport do
+  @moduledoc """
+  A Swiss Army Knife for the Testing.
+  """
+end
diff --git a/apps/one_piece_test_support/lib/one_piece/test_support/mocks.ex b/apps/one_piece_test_support/lib/one_piece/test_support/mocks.ex
@@ -0,0 +1,15 @@
+if Code.ensure_loaded?(Mox) do
+  Mox.defmock(OnePiece.TestSupport.Mox.Task, for: OnePiece.TestSupport.Task)
+
+  if Code.ensure_loaded?(OnePiece.Clock) do
+    Mox.defmock(OnePiece.TestSupport.Mox.Clock, for: OnePiece.Clock)
+  end
+
+  if Code.ensure_loaded?(OnePiece.Commanded.Id) do
+    Mox.defmock(OnePiece.TestSupport.Mox.Commanded.Id, for: OnePiece.Commanded.Id)
+  end
+
+  if Code.ensure_loaded?(Commanded.Application) do
+    Mox.defmock(OnePiece.TestSupport.Mox.Commanded.Application, for: Commanded.Application)
+  end
+end
diff --git a/apps/one_piece_test_support/lib/one_piece/test_support/task.ex b/apps/one_piece_test_support/lib/one_piece/test_support/task.ex
@@ -0,0 +1,7 @@
+defmodule OnePiece.TestSupport.Task do
+  @moduledoc """
+  A Swiss Army Knife for `Task` around.
+  """
+
+  @callback async(func :: (() -> any())) :: Task.t()
+end
diff --git a/apps/one_piece_test_support/mix.exs b/apps/one_piece_test_support/mix.exs
@@ -0,0 +1,115 @@
+defmodule OnePiece.TestSupport.MixProject do
+  use Mix.Project
+
+  @app :one_piece_test_support
+  @version "0.1.0"
+  @elixir_version "~> 1.13"
+  @source_url "https://github.com/straw-hat-team/beam-monorepo"
+
+  def project do
+    [
+      build_path: "../../_build",
+      config_path: "../../config/config.exs",
+      deps_path: "../../deps",
+      lockfile: "../../mix.lock",
+      name: "OnePiece.TestSupport",
+      description: "A Swiss Army Knife for the Testing",
+      app: @app,
+      version: @version,
+      elixir: @elixir_version,
+      elixirc_paths: elixirc_paths(Mix.env()),
+      start_permanent: Mix.env() == :prod,
+      deps: deps(),
+      aliases: aliases(),
+      test_coverage: test_coverage(),
+      preferred_cli_env: preferred_cli_env(),
+      package: package(),
+      docs: docs(),
+      dialyzer: dialyzer()
+    ]
+  end
+
+  def application do
+    [
+      extra_applications: [:logger]
+    ]
+  end
+
+  defp deps do
+    [
+      {:mox, ">= 0.0.0", optional: true},
+      {:ex_machina, ">= 0.0.0", optional: true},
+      {:one_piece_clock, ">= 0.0.0", optional: true},
+      {:one_piece_commanded, ">= 0.0.0", optional: true},
+      {:commanded, ">= 0.0.0", optional: true},
+
+      # Tools
+      {:dialyxir, ">= 0.0.0", only: [:dev], runtime: false},
+      {:credo, ">= 0.0.0", only: [:dev, :test], runtime: false},
+      {:excoveralls, ">= 0.0.0", only: [:test], runtime: false},
+      {:ex_doc, ">= 0.0.0", only: [:dev], runtime: false}
+    ]
+  end
+
+  defp elixirc_paths(:test), do: ["lib", "test/support"]
+  defp elixirc_paths(_), do: ["lib"]
+
+  defp aliases do
+    [
+      test: ["test --trace"]
+    ]
+  end
+
+  defp test_coverage do
+    [tool: ExCoveralls]
+  end
+
+  defp preferred_cli_env do
+    [
+      "coveralls.html": :test,
+      "coveralls.json": :test,
+      coveralls: :test
+    ]
+  end
+
+  defp dialyzer do
+    [
+      plt_core_path: "priv/plts"
+    ]
+  end
+
+  defp package do
+    [
+      name: @app,
+      files: [
+        ".formatter.exs",
+        "lib",
+        "mix.exs",
+        "README*",
+        "LICENSE*"
+      ],
+      maintainers: ["Yordis Prieto"],
+      licenses: ["MIT"],
+      links: %{
+        "GitHub" => @source_url
+      }
+    ]
+  end
+
+  defp docs do
+    [
+      main: "readme",
+      homepage_url: @source_url,
+      source_url_pattern: "#{@source_url}/blob/#{@app}@v#{@version}/apps/#{@app}/%{path}#L%{line}",
+      extras: [
+        "README.md",
+        "CHANGELOG.md"
+      ],
+      groups_for_extras: [
+        "How-to": ~r/docs\/how-to\/.?/,
+        Explanations: ~r/docs\/explanations\/.?/,
+        References: ~r/docs\/references\/.?/
+      ]
+    ]
+  end
+end
diff --git a/apps/one_piece_test_support/priv/plts/.gitignore b/apps/one_piece_test_support/priv/plts/.gitignore
@@ -0,0 +1 @@
+*
diff --git a/apps/one_piece_test_support/test/test_helper.exs b/apps/one_piece_test_support/test/test_helper.exs
@@ -0,0 +1 @@
+ExUnit.start()

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +[
 +  line_length: 120,
 +  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
 +]