Bug Fix: Yaml Line Numbering Empty Mapping Fix (#512)

* If we are at the end of a mapping ensure we set is_inline_flow_mapping_key back to False * Add test for multi key just to verify functionality * Add explanation to reset of inline flow mapping key Co-authored-by: John-Paul Dakran <[email protected]>
Yelp · Feb 7, 2022 · 426ae5b · 426ae5b
1 parent 2f4f956
commit 426ae5b
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 0 deletions.
diff --git a/detect_secrets/transformers/yaml.py b/detect_secrets/transformers/yaml.py
@@ -221,6 +221,9 @@ def _compose_node_shim(
         node.__line__ = line + 1
 
         if node.tag.endswith(':map'):
+            # Reset the inline flow mapping key when the end of a mapping is reached
+            # to avoid complications with empty mappings
+            self.is_inline_flow_mapping_key = False
             return _tag_dict_values(node)
 
         # TODO: Not sure if need to do :seq

diff --git a/tests/transformers/yaml_transformer_test.py b/tests/transformers/yaml_transformer_test.py
@@ -357,3 +357,74 @@ def test_inline_dictionary_different_starting_line():
                 '__original_key__': 'b',
             },
         }
+
+    @staticmethod
+    def test_inline_empty_mapping_line_numbers():
+        file = mock_file_object(
+            textwrap.dedent("""
+                a: {}
+                b: "2"
+            """)[1:-1],
+        )
+
+        assert YAMLFileParser(file).json() == {
+            'a': {},
+            'b': {
+                '__value__': '2',
+                '__line__': 2,
+                '__original_key__': 'b',
+            },
+        }
+
+    @staticmethod
+    def test_inline_mapping_single_line_single_key_line_numbers():
+        file = mock_file_object(
+            textwrap.dedent("""
+                a: {b: "2"}
+                c: "3"
+            """)[1:-1],
+        )
+
+        assert YAMLFileParser(file).json() == {
+            'a': {
+                'b': {
+                    '__value__': '2',
+                    '__line__': 1,
+                    '__original_key__': 'b',
+                },
+            },
+            'c': {
+                '__value__': '3',
+                '__line__': 2,
+                '__original_key__': 'c',
+            },
+        }
+
+    @staticmethod
+    def test_inline_mapping_single_line_multikey_line_numbers():
+        file = mock_file_object(
+            textwrap.dedent("""
+                a: {b: "2", c: "3"}
+                d: "4"
+            """)[1:-1],
+        )
+
+        assert YAMLFileParser(file).json() == {
+            'a': {
+                'b': {
+                    '__value__': '2',
+                    '__line__': 1,
+                    '__original_key__': 'b',
+                },
+                'c': {
+                    '__value__': '3',
+                    '__line__': 1,
+                    '__original_key__': 'c',
+                },
+            },
+            'd': {
+                '__value__': '4',
+                '__line__': 2,
+                '__original_key__': 'd',
+            },
+        }