Merge pull request #55 from diogoosorio/bootstrap-tests

Bootstrap tests for the project

Author: codingo

.gitignore

@@ -104,4 +104,7 @@ ENV/
 *.suo
 *.pyproj
 *.sln
-*.sqlite
+*.sqlite
+
+# vscode editor
+.vscode

README.md

@@ -87,3 +87,14 @@ $ echo -e 'a.example.com\b.example.com' | VhostScan.py -t localhost -w ./wordlis
 Here is an example with fuzzy logic enabled. You can see the last comparison is much more similar than the first two (it is comparing the content not the actual hashes):
 
 ![VHOSTScan Fuzzy Logic Example](https://github.com/codingo/codingo.github.io/blob/master/assets/VHostScan-Fuzzy-Wuzzy.PNG)
+
+## Running the tests
+
+The project includes a small battery of tests. It's really simple to run the tests:
+
+```bash
+pip install -r test-requirements.txt
+pytest
+```
+
+If you're thinking of adding a new feature to the project, consider also contributing with a couple of tests. A well-tested codebase is a sane codebase. :)

test-requirements.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+
+pytest==3.2.3
+pytest-mock==1.6.3

tests/__init__.py

@@ -0,0 +1,4 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))

tests/conftest.py

@@ -0,0 +1,42 @@
+import itertools
+import pytest
+import sys
+
+from collections import namedtuple
+from lib.helpers.file_helper import parse_word_list_argument, get_combined_word_lists
+
+WORDLIST_FILES = {
+    'simpsons': ['marge', 'bart', 'homer', 'lisa', 'maggie'],
+    'family_guy': ['stewie', 'lois', 'peter', 'brian', 'maggie', 'chris'],
+    'flinstones': ['fred', 'bambam', 'wilma', 'barney', 'betty'],
+    'duplicates': ['marge', 'bart'],
+}
+
+WordlistFiles = namedtuple('WordlistFiles', 'files words')
+
+@pytest.fixture(scope='session')
+def wordlist(tmpdir_factory):
+    tmpdir = tmpdir_factory.mktemp('wordlists')
+
+    def create_file(filename):
+        file = tmpdir.join(filename)
+        file.write('\n'.join(WORDLIST_FILES[filename]))
+        return str(file)
+
+    words = list(itertools.chain.from_iterable(WORDLIST_FILES.values()))
+    files = [create_file(file) for file in WORDLIST_FILES.keys()]
+
+    return WordlistFiles(files=files, words=words)
+
+def test_parse_word_list_argument(wordlist):
+    argument = ','.join(wordlist.files + ['/non-existing-file'])
+    result = parse_word_list_argument(argument)
+
+    assert wordlist.files == result # non-existing files should be discarded
+
+def test_get_combined_word_lists(wordlist):
+    result = get_combined_word_lists(','.join(wordlist.files))
+
+    assert wordlist.files == result['file_paths']
+    assert wordlist.words == result['words']
+