Packages
credo
1.7.3
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/check/design/skip_test_without_comment.ex
defmodule Credo.Check.Design.SkipTestWithoutComment do
use Credo.Check,
id: "EX2003",
base_priority: :normal,
explanations: [
check: """
Skipped tests should have a comment documenting why the test is skipped.
Tests are often skipped using `@tag :skip` when some issue arises that renders
the test temporarily broken or unable to run. This temporary skip often becomes
a permanent one because the reason for the test being skipped is not documented.
A comment should exist on the line prior to the skip tag describing why the test is
skipped.
Example:
# john: skipping this since our credentials expired, working on getting new ones
@tag :skip
test "vendor api returns data" do
# ...
end
While the pure existence of a comment does not change anything per se, a thoughtful
comment can improve the odds for future iteration on the issue.
"""
],
param_defaults: [included: ["test/**/*_test.exs"]]
@tag_skip_regex ~r/^\s*\@tag :skip\s*$/
@comment_regex ~r/^\s*\#.*$/
@doc false
@impl true
def run(source_file, params) do
issue_meta = IssueMeta.for(source_file, params)
source_file
|> Credo.Code.clean_charlists_strings_and_sigils()
|> String.split("\n")
|> Enum.with_index(1)
|> Enum.map(&transform_line/1)
|> check_lines([], issue_meta)
end
defp transform_line({line, line_number}) do
cond do
line =~ @tag_skip_regex -> {:tag_skip, line_number}
line =~ @comment_regex -> {:comment, line_number}
true -> {line, line_number}
end
end
defp check_lines([{:tag_skip, line_number} | rest], issues, issue_meta) do
check_lines(rest, [issue_for(issue_meta, line_number) | issues], issue_meta)
end
defp check_lines([{:comment, _}, {:tag_skip, _} | rest], issues, issue_meta) do
check_lines(rest, issues, issue_meta)
end
defp check_lines([_hd | tl], issues, issue_meta), do: check_lines(tl, issues, issue_meta)
defp check_lines([], issues, _issue_meta), do: issues
defp issue_for(issue_meta, line_no) do
format_issue(
issue_meta,
message: "Tests tagged to be skipped should have a comment preceding the `@tag :skip`",
trigger: "@tag :skip",
line_no: line_no
)
end
end