Packages
credo
1.7.19
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.7-rc.0
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.2-rc.4
1.7.2-rc.3
1.7.2-rc.2
1.7.2-rc.1
1.7.2-rc.0
1.7.1
1.7.0
1.7.0-rc.2
1.7.0-rc.1
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.5
1.5.0-rc.4
1.5.0-rc.3
1.5.0-rc.2
1.5.0-rc.1
1.4.1
1.4.0
1.4.0-rc.2
1.4.0-rc.1
1.3.2
1.3.1
1.3.0
1.3.0-rc3
1.3.0-rc2
1.3.0-rc1
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc4
1.2.0-rc3
1.2.0-rc2
1.2.0-rc1
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc3
1.1.0-rc2
1.1.0-rc1
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.1-rc1
1.0.0
1.0.0-rc1
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.9.0-rc8
0.9.0-rc7
0.9.0-rc6
0.9.0-rc5
0.9.0-rc4
0.9.0-rc3
0.9.0-rc2
0.9.0-rc1
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.8.0-rc7
0.8.0-rc6
0.8.0-rc5
0.8.0-rc4
0.8.0-rc3
0.8.0-rc2
0.8.0-rc1
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.6.0-rc2
0.6.0-rc1
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.10-dev
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-beta5
0.4.0-beta4
0.4.0-beta3
0.4.0-beta2
0.4.0-beta1
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.3.0-dev2
0.3.0-dev
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1-dev
A static code analysis tool with a focus on code consistency and teaching.
Current section
Files
Jump to
Current section
Files
lib/credo/test/assertions.ex
defmodule Credo.Test.Assertions do
@moduledoc false
import ExUnit.Assertions
import IO.ANSI
def assert_trigger(issue, trigger)
def assert_trigger([issue], trigger), do: [assert_trigger(issue, trigger)]
def assert_trigger(issue, trigger) do
assert trigger == issue.trigger
issue
end
def refute_issues(issues) do
assert [] == issues,
"#{red()}There should be no issues, got #{Enum.count(issues)}:#{reset()}\n\n#{to_inspected(issues) |> indent(4)}"
issues
end
def assert_issue(issues, callback \\ nil) do
refute match?([], issues), "#{red()}There should be one issue, got none."
assert match?([_only_issue], issues),
"#{red()}There should be only 1 issue, got #{Enum.count(issues)}:#{reset()}\n\n#{to_inspected(issues) |> indent(4)}"
case callback do
callback when is_function(callback) ->
issues |> List.first() |> callback.()
pattern when is_map(pattern) ->
assert_issue_matches(issues, pattern)
nil ->
nil
end
issues
end
def assert_issues(issues) do
assert_issues(issues, nil)
end
def assert_issues(issues, 0) do
refute_issues(issues)
end
def assert_issues(issues, 1) do
assert_issue(issues)
end
def assert_issues(issues, count) when is_integer(count) do
assert_issues(issues, fn issues ->
assert length(issues) == count,
"#{red()}There should be #{count} issues, got #{length(issues)}."
end)
end
def assert_issues(issues, callback)
when (is_list(issues) and is_nil(callback)) or is_function(callback, 1) do
refute match?([], issues), "#{red()}There should be multiple issues, got none."
refute match?([_only_issue], issues),
"#{red()}There should be more than one issue, got:#{reset()}\n\n#{to_inspected(issues) |> indent(4)}"
if callback, do: callback.(issues)
issues
end
def assert_issues_match(issues, patterns) do
patterns
|> List.wrap()
|> Enum.each(&assert_issue_matches(issues, &1))
pattern_count = length(patterns)
issue_count = length(issues)
assert pattern_count == issue_count,
"#{red()}All patterns matched, but there are #{pattern_count} patterns and #{issue_count} issues."
issues
end
def assert_issue_matches(issues, pattern) do
assert matches_any_issue?(issues, pattern), assert_issue_matches_message(issues, pattern)
issues
end
defp assert_issue_matches_message(issues, pattern) do
non_matching_fields =
Enum.map(pattern, fn {key, value} ->
if not matches_any_issue?(issues, Map.new([{key, value}])) do
{key, value}
end
end)
|> Enum.reject(&is_nil/1)
inspected_pattern =
pattern
|> inspect(pretty: true)
|> indent(4)
|> highlight_fields_in_inspected_pattern(non_matching_fields)
"""
#{red()}
No issue found matching this pattern:
#{reset()}
#{inspected_pattern}
Issues:
#{to_inspected(issues) |> indent(4)}
"""
|> String.trim_leading()
end
defp highlight_fields_in_inspected_pattern(inspected_pattern, fields) do
Enum.reduce(fields, inspected_pattern, fn {key, _}, memo ->
String.replace(
memo,
~r/(\s*)(#{key}:)(.+)$/mi,
"\\1#{red()}\\2#{reset()}\\3#{faint()} # <-- matches no issue#{reset()}"
)
end)
end
defp matches_any_issue?(issues, pattern) do
Enum.any?(issues, &matches_issue?(&1, pattern))
end
defp matches_issue?(issue, pattern) do
{pretest?, pattern} =
case pattern[:message] do
nil -> {true, pattern}
message -> {matches_message?(issue, message), Map.drop(pattern, [:message])}
end
pretest? && Map.equal?(pattern, Map.intersect(pattern, issue))
end
defp matches_message?(issue, "" <> message) do
issue.message == message
end
defp matches_message?(issue, %Regex{} = message) do
issue.message =~ message
end
def to_inspected(value) when is_list(value) do
Enum.map_join(value, "\n", &to_inspected/1)
end
def to_inspected(%Credo.Issue{} = issue) do
inspected =
issue
|> Inspect.Algebra.to_doc(%Inspect.Opts{})
|> Inspect.Algebra.format(50)
|> IO.iodata_to_binary()
if Credo.Test.Case.test_source_files?() do
"""
#{inspected}
#{Credo.Test.Case.get_issue_inline(issue)}
"""
|> String.trim()
else
inspected
end
end
defp indent(string, count) do
string
|> String.split("\n")
|> Enum.map(&"#{String.pad_leading("", count)}#{&1}")
|> Enum.join("\n")
end
end