initial version

.gitignore

@@ -99,3 +99,8 @@ ENV/
 
 # mypy
 .mypy_cache/
+
+# Eclipse / Pydev
+.project
+.pydevproject
+

common_helper_passwords/__init__.py

+from .password_helper import get_merged_password_set
+
+__all__ = [
+    'get_merged_password_set',
+]

common_helper_passwords/password_helper.py

+'''
+password helper functions
+'''
+from common_helper_files.fail_safe_file_operations import get_files_in_dir, get_string_list_from_file
+from contextlib import suppress
+
+
+def get_merged_password_set(directory):
+    """
+    merges password lists in directory to a set of passwords
+    """
+    passwords = set()
+    password_files = get_files_in_dir(directory)
+    for item in password_files:
+        passwords.update(get_string_list_from_file(item))
+    with suppress(KeyError):
+        passwords.remove("")
+    return passwords

setup.py

+from setuptools import setup, find_packages
+
+VERSION = 0.1
+
+setup(
+    name="common_helper_passwords",
+    version=VERSION,
+    packages=find_packages(),
+    install_requires=[
+        'common_helper_files'
+    ],
+    dependency_links=[
+        'git+https://github.com/fkie-cad/common_helper_files.git#common_helper_files'
+    ],
+    description="Helper functions for handling password lists and files.",
+    author="Fraunhofer FKIE",
+    author_email="peter.weidenbach@fkie.fraunhofer.de",
+    url="http://www.fkie.fraunhofer.de",
+    license="GPL-3.0"
+)

test/data/password_lists/possible_failure/no_empty_line

+first password
+third password
\ No newline at end of file

test/data/password_lists/simple_including_empty_strings

+first password
+
+second password
\ No newline at end of file

test/test_password_helper.py

+import os
+import unittest
+from common_helper_files import get_dir_of_file
+
+from common_helper_passwords import get_merged_password_set
+
+TEST_DATA_DIR = os.path.join(get_dir_of_file(__file__), 'data')
+
+
+class TestHelperFunctionsPasswords(unittest.TestCase):
+
+    def test_get_merged_password_set(self):
+        test_dir = os.path.join(TEST_DATA_DIR, 'password_lists')
+        passwords = get_merged_password_set(test_dir)
+        self.assertEqual(len(passwords), 3, 'number of passwords not correct')
+        self.assertNotIn('', passwords, 'empty password not removed')
+
+    def test_get_merged_password_set_no_blank_lines(self):
+        test_dir = os.path.join(TEST_DATA_DIR, 'password_lists/possible_failure')
+        passwords = get_merged_password_set(test_dir)
+        self.assertEqual(len(passwords), 2, 'number of passwords not correct')