Merge pull request #29 from brootware/dev

Dev

Author: brootware

.github/workflows/pylint.yml .github/workflows/ci.yml.github/workflows/pylint.yml renamed to .github/workflows/ci.yml

@@ -1,11 +1,8 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
-name: "pylint"
+name: "CI"
 
 on:
   push:
-    branches: [main]
+    branches: [dev]
   pull_request:
     branches: [main]
 
@@ -30,8 +27,9 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install --upgrade poetry
-          pip install flake8 pytest
+          pip install flake8 pytest nltk numpy
           poetry install
+          python tools/install_nltk_popular.py
 
       - name: Lint with flake8
         run: |
@@ -40,6 +38,10 @@ jobs:
           # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
           flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
 
+      - name: Test with pytest
+        run: |
+          pytest
+
       # - name: Build and push Docker Image
       #   uses: mr-smithers-excellent/docker-build-push@v5
       #   with:

README.md

@@ -14,7 +14,7 @@
    <a href="https://twitter.com/brootware"><img src="https://img.shields.io/twitter/follow/brootware?style=social" alt="Twitter Follow"></a>
    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/pyredactkit"> <img alt="PyPI" src="https://img.shields.io/pypi/v/pyredactkit">
    <a href="https://sonarcloud.io/summary/new_code?id=brootware_PyRedactKit"><img src="https://sonarcloud.io/api/project_badges/measure?project=brootware_PyRedactKit&metric=alert_status" alt="reliability rating"></a>
-   <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/brootware/pyredactkit/pylint?label=pylint">
+   <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/brootware/pyredactkit/CI?label=CI&branch=dev">
 </p>
 
 ## Features

adhocscripts/hash_test.py adhocscripts/hash_poc.pyadhocscripts/hash_test.py renamed to adhocscripts/hash_poc.py

@@ -43,29 +43,32 @@
 mask_names = "\u2588" * 15
 count_names = 4
 
+
 @pytest.fixture
-def obj():
+def redactor_obj():
     return Redactor()
 
 
-def test_check_python_file(obj):
-    assert obj.check_file_type(
+def test_check_python_file(redactor_obj):
+    assert redactor_obj.check_file_type(
         __file__) == 'text/x-python', 'Failed python file check'
 
 
-def test_number_of_allowed_types(obj):
-    assert len(obj.get_allowed_files()
+def test_number_of_allowed_types(redactor_obj):
+    assert len(redactor_obj.get_allowed_files()
                ) == 10, 'Number of allowed tests does not match expected'
 
 
-def test_current_file_is_allowed(obj):
-    assert obj.allowed_file(__file__), f'{__file__} should be allowed'
+def test_current_file_is_allowed(redactor_obj):
+    assert redactor_obj.allowed_file(__file__), f'{__file__} should be allowed'
 
 
-def test_redact_function_should_return_string(obj):
-    assert type(obj.redact(data)) == str, 'redact function should return string'
+def test_valid_option_function_should_return_tuple(redactor_obj):
+    assert type(redactor_obj.valid_options()
+                ) == tuple, 'redact function should return tuple'
 
 
-def test_redact_name_function_should_return_string_and_integer(obj):
-    set1 = (f'{mask_names},{mask_names},{mask_names},{mask_names}',count_names)
-    assert obj.redact_name(people_names) == set1, 'redact_name function should return masked data and count'
+def test_redact_name_function_should_return_string_and_integer(redactor_obj):
+    set1 = (f'{mask_names},{mask_names},{mask_names},{mask_names}', count_names)
+    assert redactor_obj.redact_name(
+        people_names) == set1, 'redact_name function should return masked data and count'

test/test_redact.py

@@ -0,0 +1,18 @@
+import pytest
+from pyredactkit.unredact import Unredactor
+from pyredactkit.identifiers import Identifier
+
+key_mapping = {
+    "2b21e939-abc9-4d06-9c5a-de9bf2aa22b4": "10.10.10.1"}
+redacted_text = "My router is : 2b21e939-abc9-4d06-9c5a-de9bf2aa22b4"
+unredacted_text = "My router is : 10.10.10.1"
+
+
+@pytest.fixture
+def unredactor_obj():
+    return Unredactor()
+
+
+def test_replace_all_function_should_return_unredacted_string(unredactor_obj):
+    assert unredactor_obj.replace_all(
+        redacted_text, key_mapping) == unredacted_text, 'replace_all function should return unredacted string'

test/test_unredact.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+import nltk
+import ssl
+
+try:
+    _create_unverified_https_context = ssl._create_unverified_context
+except AttributeError:
+    pass
+else:
+    ssl._create_default_https_context = _create_unverified_https_context
+
+nltk.download('popular')