Properly print out exclude keyword (Yelp#315)

* Properly print out exclude keyword

* Add tests

* Format

* One more test case for regex

* Fix build

Author: XIANJUN ZHU

.travis.yml

@@ -51,6 +51,9 @@ matrix:
         #   python: pypy
 install:
     - pip install tox
+    # add public DNS name for public.dhe.ibm.com. The 9.x one is not serving traffic now
+    # public.dhe.ibm.com access is required for ibm-db pip package
+    - echo "$(dig @8.8.8.8 public.dhe.ibm.com +short | tail -n1) public.dhe.ibm.com" | sudo tee -a /etc/hosts
 # normal script supports multiple line syntax
 script: |
       set -e

detect_secrets/plugins/keyword.py

@@ -269,7 +269,7 @@ def default_options(cls):
     @property
     def __dict__(self):
         output = {
-            'keyword_exclude': self.keyword_exclude,
+            'keyword_exclude': self.keyword_exclude and self.keyword_exclude.pattern or None,
         }
         output.update(super(KeywordDetector, self).__dict__)
 

tests/plugins/keyword_test.py

@@ -1,3 +1,8 @@
+from __future__ import absolute_import
+from __future__ import unicode_literals
+
+import json
+
 import ahocorasick
 import pytest
 
@@ -398,3 +403,32 @@ def test_analyze_example_negatives(self, file_content):
             'mock_filename.example',
         )
         assert len(output) == 0
+
+    @pytest.mark.parametrize(
+        'keyword_exclude, dict_content',
+        (
+            (
+                None,
+                {'keyword_exclude': None, 'name': 'KeywordDetector'},
+            ),
+            (
+                'keyword',
+                {'keyword_exclude': 'keyword', 'name': 'KeywordDetector'},
+            ),
+            (
+                'a.*|b.*',
+                {'keyword_exclude': 'a.*|b.*', 'name': 'KeywordDetector'},
+            ),
+        ),
+    )
+    def test_dict_output(self, keyword_exclude, dict_content):
+        detector = KeywordDetector(keyword_exclude)
+        actual = json.dumps(
+            detector.__dict__,
+            sort_keys=True,
+        )
+        expected = json.dumps(
+            dict_content,
+            sort_keys=True,
+        )
+        assert actual == expected