Merge pull request #1044 from davorbadrov/fix_logger_metadata_keys_al…

…l_check

fix logger metadata check when metadata :all set

lib/credo/check/warning/missed_metadata_key_in_logger_config.ex

@@ -43,11 +43,23 @@ defmodule Credo.Check.Warning.MissedMetadataKeyInLoggerConfig do
   @impl Credo.Check
   def run(%SourceFile{} = source_file, params) do
     issue_meta = IssueMeta.for(source_file, params)
-    state = {false, []}
 
-    {_, issues} = Credo.Code.prewalk(source_file, &traverse(&1, &2, issue_meta), state)
+    if ignore_check?(issue_meta) do
+      []
+    else
+      state = {false, []}
+
+      {_, issues} = Credo.Code.prewalk(source_file, &traverse(&1, &2, issue_meta), state)
+
+      issues
+    end
+  end
 
-    issues
+  # if logger metadata: :all is set, then ignore this check
+  defp ignore_check?(issue_meta) do
+    issue_meta_params = IssueMeta.params(issue_meta)
+    metadata_keys = find_metadata_keys(issue_meta_params)
+    metadata_keys == :all
   end
 
   defp traverse(

test/credo/check/warning/missed_metadata_key_in_logger_config_test.exs

@@ -120,6 +120,21 @@ defmodule Credo.Check.Warning.MissedMetadataKeyInLoggerConfigTest do
     |> refute_issues()
   end
 
+  test "it should NOT report when Logger.log/3 is used with metadata set to :all" do
+    """
+    defmodule CredoSampleModule do
+      def some_function(parameter1, parameter2) do
+        Logger.log(:info, fn ->
+          "A warning message: #{inspect(1)}"
+        end, account_id: 1)
+      end
+    end
+    """
+    |> to_source_file
+    |> run_check(@described_check, metadata_keys: :all)
+    |> refute_issues()
+  end
+
   test "it should NOT report when Logger.log/2 is used" do
     """
     defmodule CredoSampleModule do