Improve tests (#16)

* Ensure smoke test doctests are valid doctests * Test that integer formats are kept * Reorganize formatter tests * Fix smoke test results * Format * Make integer test elixir-version agnostic
angelikatyborska · Mar 29, 2024 · 7915b2b · 7915b2b
1 parent 26b491a
commit 7915b2b
Show file tree

Hide file tree

Showing 17 changed files with 312 additions and 284 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,2 @@
+[*.diff]
+trim_trailing_whitespace=false
diff --git a/bin/smoke_test.exs b/bin/smoke_test.exs
@@ -42,12 +42,11 @@ Enum.each(projects, fn project ->
     {_, 0} = System.cmd("mix", ["compile"], cd: project_path)
   end
 
+  {_, 0} = System.cmd("mix", ["test"], cd: project_path)
   {_, 0} = System.cmd("mix", ["format"], cd: project_path)
   {diff, 0} = System.cmd("git", ["diff"], cd: project_path)
 
-  Code.eval_file("#{project_path}/expected_diff.ex")
-
-  expected_diff = ExpectedDiff.diff()
+  expected_diff = File.read!("#{project_path}/expected_diff.diff")
 
   :code.delete(ExpectedDiff)
   :code.purge(ExpectedDiff)

diff --git a/smoke_test_data/elixir-1-13/project_with_formatted_code/expected_diff.diff b/smoke_test_data/elixir-1-13/project_with_formatted_code/expected_diff.diff
diff --git a/smoke_test_data/elixir-1-13/project_with_formatted_code/expected_diff.ex b/smoke_test_data/elixir-1-13/project_with_formatted_code/expected_diff.ex
diff --git a/smoke_test_data/elixir-1-13/project_with_formatted_code/lib/project_with_formatted_code.ex b/smoke_test_data/elixir-1-13/project_with_formatted_code/lib/project_with_formatted_code.ex
@@ -18,7 +18,7 @@ defmodule ProjectWithFormattedCode do
       ...> |> ProjectWithFormattedCode.add(2)
       3
 
-      iex> 3 + "3"
+      iex> ProjectWithFormattedCode.add(3, "3")
       ** (ArithmeticError) bad argument in arithmetic expression
 
   """

diff --git a/smoke_test_data/elixir-1-13/project_with_unformatted_code/expected_diff.diff b/smoke_test_data/elixir-1-13/project_with_unformatted_code/expected_diff.diff
@@ -0,0 +1,54 @@
+diff --git a/smoke_test_data/elixir-1-13/project_with_unformatted_code/lib/project_with_unformatted_code.ex b/smoke_test_data/elixir-1-13/project_with_unformatted_code/lib/project_with_unformatted_code.ex
+index 5b65e4d..98f817c 100644
+--- a/smoke_test_data/elixir-1-13/project_with_unformatted_code/lib/project_with_unformatted_code.ex
++++ b/smoke_test_data/elixir-1-13/project_with_unformatted_code/lib/project_with_unformatted_code.ex
+@@ -2,7 +2,7 @@ defmodule ProjectWithUnformattedCode do
+   @moduledoc """
+   Documentation for `ProjectWithUnformattedCode`.
+
+-  iex> ProjectWithUnformattedCode.add(5,5)
++  iex> ProjectWithUnformattedCode.add(5, 5)
+   10
+   """
+
+@@ -15,7 +15,7 @@ defmodule ProjectWithUnformattedCode do
+       3
+
+       iex> 1
+-      ...>   |> ProjectWithUnformattedCode.add(2)
++      ...> |> ProjectWithUnformattedCode.add(2)
+       3
+
+   """
+@@ -24,12 +24,28 @@ defmodule ProjectWithUnformattedCode do
+   end
+
+   @doc """
+-  iex>   ProjectWithUnformattedCode.subtract( 5, 4 )
++  iex> ProjectWithUnformattedCode.subtract(5, 4)
+   1
+
+-  iex> [100_000_000_000, 200_000_000_000, 300_000_000_000, 400_000_000_000, 500_000_000_000, 600_000_000_000, 700_000_000_000]
++  iex> [
++  ...>   100_000_000_000,
++  ...>   200_000_000_000,
++  ...>   300_000_000_000,
++  ...>   400_000_000_000,
++  ...>   500_000_000_000,
++  ...>   600_000_000_000,
++  ...>   700_000_000_000
++  ...> ]
+   ...> |> Enum.map(&ProjectWithUnformattedCode.subtract(&1, 100_000_000_000))
+-  [0, 100_000_000_000, 200_000_000_000, 300_000_000_000, 400_000_000_000, 500_000_000_000, 600_000_000_000]
++  [
++    0,
++    100_000_000_000,
++    200_000_000_000,
++    300_000_000_000,
++    400_000_000_000,
++    500_000_000_000,
++    600_000_000_000
++  ]
+   """
+   def subtract(a, b) do
+     a - b
diff --git a/smoke_test_data/elixir-1-13/project_with_unformatted_code/expected_diff.ex b/smoke_test_data/elixir-1-13/project_with_unformatted_code/expected_diff.ex
diff --git a/..._test_data/elixir-1-13/project_with_unformatted_code/lib/project_with_unformatted_code.ex b/..._test_data/elixir-1-13/project_with_unformatted_code/lib/project_with_unformatted_code.ex
@@ -2,7 +2,7 @@ defmodule ProjectWithUnformattedCode do
   @moduledoc """
   Documentation for `ProjectWithUnformattedCode`.
 
-  iex> ProjectWithFormattedCode.add(5,5)
+  iex> ProjectWithUnformattedCode.add(5,5)
   10
   """
 
@@ -16,7 +16,7 @@ defmodule ProjectWithUnformattedCode do
 
       iex> 1
       ...>   |> ProjectWithUnformattedCode.add(2)
-          3
+      3
 
   """
   def add(a, b) do

diff --git a/...ata/elixir-1-13/project_with_unformatted_code/test/project_with_unformatted_code_test.exs b/...ata/elixir-1-13/project_with_unformatted_code/test/project_with_unformatted_code_test.exs
@@ -1,8 +1,4 @@
 defmodule ProjectWithUnformattedCodeTest do
   use ExUnit.Case
   doctest ProjectWithUnformattedCode
-
-  test "greets the world" do
-    assert ProjectWithUnformattedCode.hello() == :world
-  end
 end
diff --git a/smoke_test_data/project_with_formatted_code/expected_diff.diff b/smoke_test_data/project_with_formatted_code/expected_diff.diff
diff --git a/smoke_test_data/project_with_formatted_code/expected_diff.ex b/smoke_test_data/project_with_formatted_code/expected_diff.ex
diff --git a/smoke_test_data/project_with_formatted_code/lib/project_with_formatted_code.ex b/smoke_test_data/project_with_formatted_code/lib/project_with_formatted_code.ex
@@ -18,7 +18,7 @@ defmodule ProjectWithFormattedCode do
       ...> |> ProjectWithFormattedCode.add(2)
       3
 
-      iex> 3 + "3"
+      iex> ProjectWithFormattedCode.add(3, "3")
       ** (ArithmeticError) bad argument in arithmetic expression
 
   """

diff --git a/smoke_test_data/project_with_unformatted_code/expected_diff.diff b/smoke_test_data/project_with_unformatted_code/expected_diff.diff
@@ -0,0 +1,54 @@
+diff --git a/smoke_test_data/project_with_unformatted_code/lib/project_with_unformatted_code.ex b/smoke_test_data/project_with_unformatted_code/lib/project_with_unformatted_code.ex
+index 5b65e4d..98f817c 100644
+--- a/smoke_test_data/project_with_unformatted_code/lib/project_with_unformatted_code.ex
++++ b/smoke_test_data/project_with_unformatted_code/lib/project_with_unformatted_code.ex
+@@ -2,7 +2,7 @@ defmodule ProjectWithUnformattedCode do
+   @moduledoc """
+   Documentation for `ProjectWithUnformattedCode`.
+
+-  iex> ProjectWithUnformattedCode.add(5,5)
++  iex> ProjectWithUnformattedCode.add(5, 5)
+   10
+   """
+
+@@ -15,7 +15,7 @@ defmodule ProjectWithUnformattedCode do
+       3
+
+       iex> 1
+-      ...>   |> ProjectWithUnformattedCode.add(2)
++      ...> |> ProjectWithUnformattedCode.add(2)
+       3
+
+   """
+@@ -24,12 +24,28 @@ defmodule ProjectWithUnformattedCode do
+   end
+
+   @doc """
+-  iex>   ProjectWithUnformattedCode.subtract( 5, 4 )
++  iex> ProjectWithUnformattedCode.subtract(5, 4)
+   1
+
+-  iex> [100_000_000_000, 200_000_000_000, 300_000_000_000, 400_000_000_000, 500_000_000_000, 600_000_000_000, 700_000_000_000]
++  iex> [
++  ...>   100_000_000_000,
++  ...>   200_000_000_000,
++  ...>   300_000_000_000,
++  ...>   400_000_000_000,
++  ...>   500_000_000_000,
++  ...>   600_000_000_000,
++  ...>   700_000_000_000
++  ...> ]
+   ...> |> Enum.map(&ProjectWithUnformattedCode.subtract(&1, 100_000_000_000))
+-  [0, 100_000_000_000, 200_000_000_000, 300_000_000_000, 400_000_000_000, 500_000_000_000, 600_000_000_000]
++  [
++    0,
++    100_000_000_000,
++    200_000_000_000,
++    300_000_000_000,
++    400_000_000_000,
++    500_000_000_000,
++    600_000_000_000
++  ]
+   """
+   def subtract(a, b) do
+     a - b
diff --git a/smoke_test_data/project_with_unformatted_code/expected_diff.ex b/smoke_test_data/project_with_unformatted_code/expected_diff.ex
diff --git a/smoke_test_data/project_with_unformatted_code/lib/project_with_unformatted_code.ex b/smoke_test_data/project_with_unformatted_code/lib/project_with_unformatted_code.ex
@@ -2,7 +2,7 @@ defmodule ProjectWithUnformattedCode do
   @moduledoc """
   Documentation for `ProjectWithUnformattedCode`.
 
-  iex> ProjectWithFormattedCode.add(5,5)
+  iex> ProjectWithUnformattedCode.add(5,5)
   10
   """
 
@@ -16,7 +16,7 @@ defmodule ProjectWithUnformattedCode do
 
       iex> 1
       ...>   |> ProjectWithUnformattedCode.add(2)
-          3
+      3
 
   """
   def add(a, b) do

diff --git a/smoke_test_data/project_with_unformatted_code/test/project_with_unformatted_code_test.exs b/smoke_test_data/project_with_unformatted_code/test/project_with_unformatted_code_test.exs
@@ -1,8 +1,4 @@
 defmodule ProjectWithUnformattedCodeTest do
   use ExUnit.Case
   doctest ProjectWithUnformattedCode
-
-  test "greets the world" do
-    assert ProjectWithUnformattedCode.hello() == :world
-  end
 end