Introduce Mix Task

kevin-johnson-shopify · kevin-johnson-shopify · commit 8bd228f77e84 · 2020-07-25T00:05:28.000-04:00
In order for Cucumber to be runnable from a client application, a mix
task has been created to facilitate accordingly.

In addition to that, a few minor matters came to light when using in a
client application:
  * Config was referring to wrong directory for where to find
  gherkin-languages and feature files
  * Introduction of report concept became important in connection to the
  mix task
  * Address a variety of warnings generated by cucumber_expressions
diff --git a/apps/cucumber_expressions/lib/cucumber_expressions/matcher.ex b/apps/cucumber_expressions/lib/cucumber_expressions/matcher.ex
@@ -216,7 +216,7 @@ defmodule CucumberExpressions.Matcher do
             parse_tree.params[param_key]
             |> Map.put(:params, [{param_key, match} | params])
 
-          q ->
+          _ ->
             parse_tree.params[param_key]
             |> Map.put(:params, [{param_key, Utils.strip_leading_space(current_word)} | params])
         end
@@ -240,7 +240,7 @@ defmodule CucumberExpressions.Matcher do
          next_keys,
          rest,
          parameter_types,
-         m = matcher(current_word: current_word, ctx: ctx),
+         m = matcher(ctx: ctx),
          parse_tree
        ) do
     next_keys
@@ -325,7 +325,7 @@ defmodule CucumberExpressions.Matcher do
           parameter_types
         )
         |> case do
-          {:error, operation, error} ->
+          {:error, _, _} ->
             Failure.raise(
               ctx,
               %{param_key: current_key, value: to_be_matched},
@@ -342,8 +342,7 @@ defmodule CucumberExpressions.Matcher do
 
   defp potential_param_to_value_match(
          potential_match,
-         m =
-           matcher(current_word: current_word, params: params, parameter_types: parameter_types),
+         m = matcher(),
          parse_tree
        ) do
     potential_match
diff --git a/apps/cucumber_expressions/lib/cucumber_expressions/matcher/submatcher.ex b/apps/cucumber_expressions/lib/cucumber_expressions/matcher/submatcher.ex
@@ -42,7 +42,6 @@ defmodule CucumberExpressions.Matcher.Submatcher do
              potential_submatches: potential_submatches,
              previous_subsentence: previous_subsentence,
              current_word: current_word,
-             parameter_types: parameter_types,
              only_spaces_so_far?: false
            ),
          remainder_sentence = <<" ", rest::binary>>
@@ -84,7 +83,7 @@ defmodule CucumberExpressions.Matcher.Submatcher do
   end
 
   defp retrieve(
-         s =
+#         s =
            submatcher(
              potential_submatches: potential_submatches,
              previous_subsentence: previous_subsentence,
diff --git a/apps/ex_cucumber/gherkin-languages.few.terms b/apps/ex_cucumber/gherkin-languages.few.terms
diff --git a/apps/ex_cucumber/lib/ex_cucumber.ex b/apps/ex_cucumber/lib/ex_cucumber.ex
@@ -2,6 +2,7 @@ defmodule ExCucumber do
   @moduledoc """
   Documentation for ExCucumber.
   """
+  @external_resource "config/config.exs"
 
   alias CucumberExpressions.ParameterType
   use ExDebugger.Manual
diff --git a/apps/ex_cucumber/lib/ex_cucumber/config.ex b/apps/ex_cucumber/lib/ex_cucumber/config.ex
@@ -1,5 +1,7 @@
 defmodule ExCucumber.Config do
   @moduledoc false
+  @external_resource "config/config.exs"
+
   @macro_styles [:def, :module]
   @error_detail_levels [:brief, :verbose]
   @all_best_practices %{
diff --git a/apps/ex_cucumber/lib/ex_cucumber/exceptions/messages/configuration_error_messages/invalid_feature_dir.ex b/apps/ex_cucumber/lib/ex_cucumber/exceptions/messages/configuration_error_messages/invalid_feature_dir.ex
@@ -9,8 +9,7 @@ defmodule ExCucumber.Exceptions.Messages.InvalidFeatureDir do
     """
   end
 
-  def render(%ConfigurationError{error_code: :invalid_feature_dir} = e, :verbose) do
-    IO.inspect(e.ctx)
+  def render(%ConfigurationError{error_code: :invalid_feature_dir}, :verbose) do
     """
     # Invalid Value For Feature Directory Specified
     ## Summary
diff --git a/apps/ex_cucumber/lib/ex_cucumber/exceptions/messages/match_failure_messages/unable_to_match.ex b/apps/ex_cucumber/lib/ex_cucumber/exceptions/messages/match_failure_messages/unable_to_match.ex
@@ -38,14 +38,6 @@ defmodule ExCucumber.Exceptions.Messages.UnableToMatch do
     }`
     * Module: `#{module_name}`
     * Cause: Missing `cucumber expression` for: #{Utils.smart_quotes(f.ctx.sentence)}
-    * extra: #{inspect(f.extra, pretty: true)}
     """
-
-    # * Gherkin Keyword: #{f.ctx.keyword}
-    # * Gherkin Keyword Token: #{f.ctx.token}
-    # * Macro: #{f.ctx.inferred.macro}
-    # * Location Feature File:
-    #   - Line: #{f.ctx.location.line}
-    #   - Column: #{f.ctx.location.column}
   end
 end
diff --git a/apps/ex_cucumber/lib/ex_cucumber/exceptions/messages/messages.ex b/apps/ex_cucumber/lib/ex_cucumber/exceptions/messages/messages.ex
@@ -56,7 +56,8 @@ defmodule ExCucumber.Exceptions.Messages do
     feature_file_not_found: {FeatureFileNotFound, @configuration_error_heading}
   }
 
-  def render(f) do
+  def render(f, exit? \\ true)
+  def render(f, exit?) when is_atom(exit?) do
     error_detail_level = ExCucumber.Config.error_detail_level()
     dd(:render)
 
@@ -65,7 +66,7 @@ defmodule ExCucumber.Exceptions.Messages do
       IO.ANSI.Docs.print_heading(heading, @default_options)
       IO.ANSI.Docs.print(body, @default_options)
 
-      exit(:shutdown)
+      if exit?, do: exit(:shutdown)
     else
       {_, body} = render(f, detail_level: :brief)
 
@@ -75,6 +76,10 @@ defmodule ExCucumber.Exceptions.Messages do
     end
   end
 
+  def render(%CompileError{} = f, detail_level: detail_level) do
+    raise f
+  end
+
   def render(%_{error_code: error_code} = f, detail_level: detail_level) do
     {module, heading} = Map.fetch!(@delegation_mappings, error_code)
 
diff --git a/apps/ex_cucumber/lib/ex_cucumber/gherkin/gherkin_keywords.ex b/apps/ex_cucumber/lib/ex_cucumber/gherkin/gherkin_keywords.ex
@@ -1,6 +1,7 @@
 defmodule ExCucumber.Gherkin.Keywords do
   @moduledoc false
-
+  @external_resource "config/config.exs"
+  
   alias ExCucumber.Gherkin.Traverser.Ctx
   alias ExCucumber.Config
 
diff --git a/apps/ex_cucumber/lib/ex_cucumber/report/report.ex b/apps/ex_cucumber/lib/ex_cucumber/report/report.ex
@@ -0,0 +1,16 @@
+defmodule ExCucumber.Report do
+  @moduledoc false
+
+  defstruct [
+    total: 0,
+    passed: 0,
+    failed: [],
+    skipped: 0
+  ]
+
+  def new, do: %__MODULE__{}
+
+  def record(%__MODULE__{} = m, :passed), do: %{m | passed: m.passed + 1} |> total()
+  def record(%__MODULE__{} = m, details), do: %{m | failed: [details | Map.fetch!(m, :failed)]} |> total()
+  def total(%__MODULE__{} = m), do: %{m | total: m.total + 1}
+end
diff --git a/apps/ex_cucumber/lib/mix/tasks/cucumber.ex b/apps/ex_cucumber/lib/mix/tasks/cucumber.ex
@@ -0,0 +1,46 @@
+defmodule Mix.Tasks.Cucumber do
+  @moduledoc """
+  Mix Task that runs cucumber framework against your feature files.
+  """
+  use Mix.Task
+  alias ExCucumber.Report
+  alias ExCucumber.Exceptions.Messages
+
+  @shortdoc "Run cucumber framework"
+  @impl Mix.Task
+  def run(opts) do
+    IEx.Helpers.r(ExCucumber.Config)
+    IEx.Helpers.r(ExCucumber)
+    IEx.Helpers.r(ExCucumber.Gherkin.Keywords)
+
+    Mix.Task.run("app.start")
+    _ = opts(opts)
+
+    report =
+      "#{ExCucumber.Config.feature_dir}/*.exs"
+      |> Path.wildcard()
+      |> Enum.reduce(Report.new, fn e, a = %Report{} ->
+        try do
+          Code.compile_file(e)
+          Report.record(a, :passed)
+        rescue
+          e in [FunctionClauseError] -> raise e
+          error -> Report.record(a, %{file: e, error: error})
+        end
+      end)
+    report.failed
+    |> Enum.each(&Messages.render(&1.error, false) |> IO.inspect)
+
+    IO.puts("""
+    Total: #{report.total}
+    Passed: #{report.passed}
+    Failed: #{Enum.count(report.failed)}
+    """)
+  end
+
+  defp opts(opts) do
+    opts
+    # |> OptionParser.parse
+
+  end
+end
diff --git a/apps/ex_cucumber/mix.exs b/apps/ex_cucumber/mix.exs
@@ -47,7 +47,8 @@ defmodule ExCucumber.MixProject do
     [
       {:cucumber_expressions, in_umbrella: true},
       #{:cucumber_expressions, "~> 0.1.0"},
-      {:ex_debugger, "0.1.3"},
+      #{:ex_debugger, "0.1.3"},
+      {:ex_debugger, path: "/Users/kevinjohnson/projects/ex_debugger", override: true},
       {:ex_gherkin, "0.1.2"}
     ]
   end
diff --git a/config/config.exs b/config/config.exs
@@ -1,13 +1,13 @@
 import Config
-
-config :ex_debugger, :debug_options_file, "#{File.cwd!()}/debug_options.exs"
+cwd = File.cwd!() |> String.split("apps") |> List.first
+config :ex_debugger, :debug_options_file, "#{cwd}/debug_options.exs"
 
 gherkin_languages = "gherkin-languages"
 
 config :ex_gherkin,
   file: %{
-    source: "#{File.cwd!()}/#{gherkin_languages}.json",
-    resource: "#{File.cwd!()}/#{gherkin_languages}.few.terms"
+    source: "#{cwd}/#{gherkin_languages}.json",
+    resource: "#{cwd}/#{gherkin_languages}.few.terms"
   },
   homonyms: ["Агар ", "* ", "अनी ", "Tha ", "Þá ", "Ða ", "Þa "],
   debug: %{
@@ -18,11 +18,9 @@ config :ex_gherkin,
     parser_raise: false
   }
 
-cwd = File.cwd!() |> String.split("apps") |> List.first
-
 config :ex_cucumber,
   feature_dir: "#{cwd}/apps/ex_cucumber/test/support/features",
-  project_root: File.cwd!(),
+  project_root: cwd,
   # [:def, :module]
   macro_style: :module,
   # [:brief, :verbose]
@@ -31,5 +29,3 @@ config :ex_cucumber,
     disallow_gherkin_token_usage_mismatch?: false
   },
   placeholder: "This is to serve as a placeholder"
-
-  IO.inspect("RUNNING")
