Skip to content

Commit a53466a

Browse files
pmeinhardtpmeinhardt
committed
Upgrade credo config and fix issues
1 parent 7bf4238 commit a53466a

File tree

6 files changed

+169
-129
lines changed

6 files changed

+169
-129
lines changed

‎.credo.exs‎

Lines changed: 110 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
configs: [
1111
%{
1212
#
13-
# Run any exec using `mix credo -C <name>`. If no exec name is given
13+
# Run any config using `mix credo -C <name>`. If no config name is given
1414
# "default" is used.
1515
#
1616
name: "default",
@@ -20,11 +20,15 @@
2020
#
2121
# You can give explicit globs or simply directories.
2222
# In the latter case `**/*.{ex,exs}` will be used.
23-
#
24-
included: ["lib/", "src/", "web/", "apps/"],
23+
#
24+
included: ["lib/", "test/"],
2525
excluded: [~r"/_build/", ~r"/deps/"]
2626
},
2727
#
28+
# Load and configure plugins here:
29+
#
30+
plugins: [],
31+
#
2832
# If you create your own checks, you must specify the source files for
2933
# them here, so they can be loaded by Credo before running the analysis.
3034
#
@@ -35,6 +39,10 @@
3539
#
3640
strict: true,
3741
#
42+
# To modify the timeout for parsing files, change this value:
43+
#
44+
parse_timeout: 5000,
45+
#
3846
# If you want to use uncolored output by default, you can change `color`
3947
# to `false` below:
4048
#
@@ -48,96 +56,124 @@
4856
# {Credo.Check.Design.DuplicatedCode, false}
4957
#
5058
checks: [
51-
{Credo.Check.Consistency.ExceptionNames},
52-
{Credo.Check.Consistency.LineEndings},
53-
{Credo.Check.Consistency.ParameterPatternMatching},
54-
{Credo.Check.Consistency.SpaceAroundOperators},
55-
{Credo.Check.Consistency.SpaceInParentheses},
56-
{Credo.Check.Consistency.TabsOrSpaces},
57-
58-
# You can customize the priority of any check
59-
# Priority values are: `low, normal, high, higher`
6059
#
61-
{Credo.Check.Design.AliasUsage, priority: :low},
60+
## Consistency Checks
61+
#
62+
{Credo.Check.Consistency.ExceptionNames, []},
63+
{Credo.Check.Consistency.LineEndings, []},
64+
{Credo.Check.Consistency.ParameterPatternMatching, []},
65+
{Credo.Check.Consistency.SpaceAroundOperators, []},
66+
{Credo.Check.Consistency.SpaceInParentheses, []},
67+
{Credo.Check.Consistency.TabsOrSpaces, []},
6268

63-
# For some checks, you can also set other parameters
6469
#
65-
# If you don't want the `setup` and `test` macro calls in ExUnit tests
66-
# or the `schema` macro in Ecto schemas to trigger DuplicatedCode, just
67-
# set the `excluded_macros` parameter to `[:schema, :setup, :test]`.
70+
## Design Checks
6871
#
69-
{Credo.Check.Design.DuplicatedCode, excluded_macros: []},
70-
72+
# You can customize the priority of any check
73+
# Priority values are: `low, normal, high, higher`
74+
#
75+
{Credo.Check.Design.AliasUsage,
76+
[priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
7177
# You can also customize the exit_status of each check.
7278
# If you don't want TODO comments to cause `mix credo` to fail, just
7379
# set this value to 0 (zero).
7480
#
75-
{Credo.Check.Design.TagTODO, exit_status: 2},
76-
{Credo.Check.Design.TagFIXME},
81+
{Credo.Check.Design.TagTODO, [exit_status: 0]},
82+
# TODO: Reenable error exit status
83+
# {Credo.Check.Design.TagTODO, [exit_status: 2]},
84+
{Credo.Check.Design.TagFIXME, []},
7785

78-
{Credo.Check.Readability.FunctionNames},
79-
{Credo.Check.Readability.LargeNumbers},
80-
{Credo.Check.Readability.MaxLineLength, priority: :low, max_length: 120},
81-
{Credo.Check.Readability.ModuleAttributeNames},
82-
{Credo.Check.Readability.ModuleDoc},
83-
{Credo.Check.Readability.ModuleNames},
84-
{Credo.Check.Readability.ParenthesesOnZeroArityDefs},
85-
{Credo.Check.Readability.ParenthesesInCondition},
86-
{Credo.Check.Readability.PredicateFunctionNames},
87-
{Credo.Check.Readability.PreferImplicitTry},
88-
{Credo.Check.Readability.RedundantBlankLines},
89-
{Credo.Check.Readability.StringSigils},
90-
{Credo.Check.Readability.TrailingBlankLine},
91-
{Credo.Check.Readability.TrailingWhiteSpace},
92-
{Credo.Check.Readability.VariableNames},
93-
{Credo.Check.Readability.Semicolons},
94-
{Credo.Check.Readability.SpaceAfterCommas},
86+
#
87+
## Readability Checks
88+
#
89+
{Credo.Check.Readability.AliasOrder, []},
90+
{Credo.Check.Readability.FunctionNames, []},
91+
{Credo.Check.Readability.LargeNumbers, []},
92+
{Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]},
93+
{Credo.Check.Readability.ModuleAttributeNames, []},
94+
{Credo.Check.Readability.ModuleDoc, []},
95+
{Credo.Check.Readability.ModuleNames, []},
96+
{Credo.Check.Readability.ParenthesesInCondition, []},
97+
{Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
98+
{Credo.Check.Readability.PredicateFunctionNames, []},
99+
{Credo.Check.Readability.PreferImplicitTry, []},
100+
{Credo.Check.Readability.RedundantBlankLines, []},
101+
{Credo.Check.Readability.Semicolons, []},
102+
{Credo.Check.Readability.SpaceAfterCommas, []},
103+
{Credo.Check.Readability.StringSigils, []},
104+
{Credo.Check.Readability.TrailingBlankLine, []},
105+
{Credo.Check.Readability.TrailingWhiteSpace, []},
106+
{Credo.Check.Readability.UnnecessaryAliasExpansion, []},
107+
{Credo.Check.Readability.VariableNames, []},
95108

96-
{Credo.Check.Refactor.DoubleBooleanNegation},
97-
{Credo.Check.Refactor.CondStatements},
98-
{Credo.Check.Refactor.CyclomaticComplexity},
99-
{Credo.Check.Refactor.FunctionArity, max_arity: 7},
100-
{Credo.Check.Refactor.LongQuoteBlocks},
101-
{Credo.Check.Refactor.MatchInCondition},
102-
{Credo.Check.Refactor.NegatedConditionsInUnless},
103-
{Credo.Check.Refactor.NegatedConditionsWithElse},
104-
{Credo.Check.Refactor.Nesting},
105-
{Credo.Check.Refactor.PipeChainStart},
106-
{Credo.Check.Refactor.UnlessWithElse},
109+
#
110+
## Refactoring Opportunities
111+
#
112+
{Credo.Check.Refactor.CondStatements, []},
113+
{Credo.Check.Refactor.CyclomaticComplexity, []},
114+
{Credo.Check.Refactor.FunctionArity, []},
115+
{Credo.Check.Refactor.LongQuoteBlocks, []},
116+
# {Credo.Check.Refactor.MapInto, []},
117+
{Credo.Check.Refactor.MatchInCondition, []},
118+
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
119+
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
120+
{Credo.Check.Refactor.Nesting, []},
121+
{Credo.Check.Refactor.UnlessWithElse, []},
122+
{Credo.Check.Refactor.WithClauses, []},
123+
124+
#
125+
## Warnings
126+
#
127+
{Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
128+
{Credo.Check.Warning.BoolOperationOnSameValues, []},
129+
{Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
130+
{Credo.Check.Warning.IExPry, []},
131+
{Credo.Check.Warning.IoInspect, []},
132+
# {Credo.Check.Warning.LazyLogging, []},
133+
{Credo.Check.Warning.MixEnv, false},
134+
{Credo.Check.Warning.OperationOnSameValues, []},
135+
{Credo.Check.Warning.OperationWithConstantResult, []},
136+
{Credo.Check.Warning.RaiseInsideRescue, []},
137+
{Credo.Check.Warning.UnusedEnumOperation, []},
138+
{Credo.Check.Warning.UnusedFileOperation, []},
139+
{Credo.Check.Warning.UnusedKeywordOperation, []},
140+
{Credo.Check.Warning.UnusedListOperation, []},
141+
{Credo.Check.Warning.UnusedPathOperation, []},
142+
{Credo.Check.Warning.UnusedRegexOperation, []},
143+
{Credo.Check.Warning.UnusedStringOperation, []},
144+
{Credo.Check.Warning.UnusedTupleOperation, []},
145+
{Credo.Check.Warning.UnsafeExec, []},
107146

108-
{Credo.Check.Warning.BoolOperationOnSameValues},
109-
{Credo.Check.Warning.ExpensiveEmptyEnumCheck},
110-
{Credo.Check.Warning.IExPry},
111-
{Credo.Check.Warning.IoInspect},
112-
{Credo.Check.Warning.LazyLogging},
113-
{Credo.Check.Warning.OperationOnSameValues},
114-
{Credo.Check.Warning.OperationWithConstantResult},
115-
{Credo.Check.Warning.UnusedEnumOperation},
116-
{Credo.Check.Warning.UnusedFileOperation},
117-
{Credo.Check.Warning.UnusedKeywordOperation},
118-
{Credo.Check.Warning.UnusedListOperation},
119-
{Credo.Check.Warning.UnusedPathOperation},
120-
{Credo.Check.Warning.UnusedRegexOperation},
121-
{Credo.Check.Warning.UnusedStringOperation},
122-
{Credo.Check.Warning.UnusedTupleOperation},
123-
{Credo.Check.Warning.RaiseInsideRescue},
147+
#
148+
# Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`)
124149

125-
# Controversial and experimental checks (opt-in, just remove `, false`)
126150
#
151+
# Controversial and experimental checks (opt-in, just replace `false` with `[]`)
152+
#
153+
{Credo.Check.Consistency.MultiAliasImportRequireUse, false},
154+
{Credo.Check.Consistency.UnusedVariableNames, false},
155+
{Credo.Check.Design.DuplicatedCode, false},
156+
{Credo.Check.Readability.AliasAs, false},
157+
{Credo.Check.Readability.BlockPipe, false},
158+
{Credo.Check.Readability.ImplTrue, false},
159+
{Credo.Check.Readability.MultiAlias, false},
160+
{Credo.Check.Readability.SeparateAliasRequire, false},
161+
{Credo.Check.Readability.SinglePipe, false},
162+
{Credo.Check.Readability.Specs, false},
163+
{Credo.Check.Readability.StrictModuleLayout, false},
164+
{Credo.Check.Readability.WithCustomTaggedTuple, false},
127165
{Credo.Check.Refactor.ABCSize, false},
128166
{Credo.Check.Refactor.AppendSingleItem, false},
167+
{Credo.Check.Refactor.DoubleBooleanNegation, false},
168+
{Credo.Check.Refactor.ModuleDependencies, false},
169+
{Credo.Check.Refactor.NegatedIsNil, false},
170+
{Credo.Check.Refactor.PipeChainStart, false},
129171
{Credo.Check.Refactor.VariableRebinding, false},
172+
{Credo.Check.Warning.LeakyEnvironment, false},
130173
{Credo.Check.Warning.MapGetUnsafePass, false},
131-
{Credo.Check.Consistency.MultiAliasImportRequireUse, false},
174+
{Credo.Check.Warning.UnsafeToAtom, false}
132175

133-
# Deprecated checks (these will be deleted after a grace period)
134176
#
135-
{Credo.Check.Readability.Specs, false},
136-
{Credo.Check.Warning.NameRedeclarationByAssignment, false},
137-
{Credo.Check.Warning.NameRedeclarationByCase, false},
138-
{Credo.Check.Warning.NameRedeclarationByDef, false},
139-
{Credo.Check.Warning.NameRedeclarationByFn, false},
140-
141177
# Custom checks can be created using `mix credo.gen.check`.
142178
#
143179
]

‎lib/sshkit/sftp/channel.ex‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ defmodule SSHKit.SFTP.Channel do
3131
chan.impl.make_dir(chan.id, name, timeout)
3232
end
3333

34-
@spec open(t(), binary(), [:read | :write | :append | :binary | :raw], timeout()) :: {:ok, handle()} | {:error, term()}
34+
@spec open(t(), binary(), [:read | :write | :append | :binary | :raw], timeout()) ::
35+
{:ok, handle()} | {:error, term()}
3536
def open(chan, name, mode, timeout \\ :infinity) do
3637
chan.impl.open(chan.id, name, mode, timeout)
3738
end

‎lib/sshkit/upload.ex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ defmodule SSHKit.Upload do
7878
# TODO: Timeouts
7979
with {:ok, handle} <- Channel.open(chan, remote, [:write, :binary]),
8080
:ok <- write(path, chan, handle),
81-
:ok = Channel.close(chan, handle) do
81+
:ok <- Channel.close(chan, handle) do
8282
{:ok, %{upload | stack: [rest | paths]}}
8383
end
8484

‎test/support/functional_assertion_helpers.ex‎

Lines changed: 53 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,66 @@
11
defmodule SSHKit.FunctionalAssertionHelpers do
22
@moduledoc false
33

4-
import ExUnit.Assertions
4+
# TODO
55

6-
alias SSHKit.Context
7-
alias SSHKit.SSH
6+
# import ExUnit.Assertions
87

9-
def verify_transfer(conn, local, remote) do
10-
command = &"find #{&1} -type f -exec #{&2} {} \\; | sort | awk '{print $1}' | xargs"
11-
compare_command_output(conn,
12-
command.(local, SystemCommands.shasum_cmd()),
13-
command.(remote, "sha1sum")
14-
)
15-
end
8+
# alias SSHKit.Context
169

17-
def verify_mode(conn, local, remote) do
18-
command = &"find #{&1} -type f -exec ls -l {} + | awk '{print $1 $5}' | sort |xargs"
19-
compare_command_output(conn,
20-
command.(local),
21-
command.(remote)
22-
)
23-
end
10+
# def verify_transfer(conn, local, remote) do
11+
# command = &"find #{&1} -type f -exec #{&2} {} \\; | sort | awk '{print $1}' | xargs"
12+
# compare_command_output(conn,
13+
# command.(local, SystemCommands.shasum_cmd()),
14+
# command.(remote, "sha1sum")
15+
# )
16+
# end
2417

25-
def verify_atime(conn, local, remote) do
26-
command = &"env find #{&1} -type f -exec #{&2} {} \\; | cut -f1,2 | sort | xargs"
27-
compare_command_output(conn,
28-
command.(local, SystemCommands.stat_cmd()),
29-
command.(remote, "stat -c '%s\t%X\t%Y'")
30-
)
31-
end
18+
# def verify_mode(conn, local, remote) do
19+
# command = &"find #{&1} -type f -exec ls -l {} + | awk '{print $1 $5}' | sort |xargs"
20+
# compare_command_output(conn,
21+
# command.(local),
22+
# command.(remote)
23+
# )
24+
# end
3225

33-
def verify_mtime(conn, local, remote) do
34-
command = &"env find #{&1} -type f -exec #{&2} {} \\; | cut -f1,3 | sort | xargs"
35-
compare_command_output(conn,
36-
command.(local, SystemCommands.stat_cmd()),
37-
command.(remote, "stat -c '%s\t%X\t%Y'")
38-
)
39-
end
26+
# def verify_atime(conn, local, remote) do
27+
# command = &"env find #{&1} -type f -exec #{&2} {} \\; | cut -f1,2 | sort | xargs"
28+
# compare_command_output(conn,
29+
# command.(local, SystemCommands.stat_cmd()),
30+
# command.(remote, "stat -c '%s\t%X\t%Y'")
31+
# )
32+
# end
4033

41-
def compare_command_output(context = %Context{}, local, remote) do
42-
Enum.map(context.hosts,
43-
fn(h) ->
44-
SSH.connect h.name, h.options, fn(conn) ->
45-
compare_command_output(conn, local, remote)
46-
end
47-
end)
48-
end
34+
# def verify_mtime(conn, local, remote) do
35+
# command = &"env find #{&1} -type f -exec #{&2} {} \\; | cut -f1,3 | sort | xargs"
36+
# compare_command_output(conn,
37+
# command.(local, SystemCommands.stat_cmd()),
38+
# command.(remote, "stat -c '%s\t%X\t%Y'")
39+
# )
40+
# end
4941

50-
def compare_command_output(conn, local, remote) do
51-
local_output = local |> String.to_charlist |> :os.cmd |> to_string
52-
{:ok, [stdout: remote_output], 0} = SSH.run(conn, remote)
53-
assert local_output == remote_output
54-
end
42+
# def compare_command_output(%Context{} = context, local, remote) do
43+
# Enum.map(context.hosts,
44+
# fn(h) ->
45+
# SSH.connect h.name, h.options, fn(conn) ->
46+
# compare_command_output(conn, local, remote)
47+
# end
48+
# end)
49+
# end
5550

56-
def create_local_tmp_path do
57-
rand =
58-
16
59-
|> :crypto.strong_rand_bytes()
60-
|> Base.url_encode64()
61-
|> binary_part(0, 16)
51+
# def compare_command_output(conn, local, remote) do
52+
# local_output = local |> String.to_charlist |> :os.cmd |> to_string
53+
# {:ok, [stdout: remote_output], 0} = SSH.run(conn, remote)
54+
# assert local_output == remote_output
55+
# end
6256

63-
Path.join(System.tmp_dir(), "sshkit-test-#{rand}")
64-
end
57+
# def create_local_tmp_path do
58+
# rand =
59+
# 16
60+
# |> :crypto.strong_rand_bytes()
61+
# |> Base.url_encode64()
62+
# |> binary_part(0, 16)
63+
64+
# Path.join(System.tmp_dir(), "sshkit-test-#{rand}")
65+
# end
6566
end

‎test/support/functional_case.ex‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ defmodule SSHKit.FunctionalCase do
1919
end
2020

2121
defmodule Host do
22+
@moduledoc false
23+
2224
defstruct [:id, :name, options: []]
2325
end
2426

‎test/support/functional_case_helpers.ex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule SSHKit.FunctionalCaseHelpers do
22
@moduledoc false
33

4-
def exec!(_host = %{id: id}, command, args \\ []) do
4+
def exec!(%{id: id} = _host, command, args \\ []) do
55
Docker.exec!([], id, command, args)
66
end
77

0 commit comments

Comments
 (0)