Merge pull request #34 from samuelcolvin/tests

adding tests

Author: JoshData

.gitignore

@@ -16,4 +16,7 @@ docs/_build/
 .env
 .venv
 env/
+env27/
 .idea/
+.coverage
+htmlcov/

.travis.yml

@@ -4,16 +4,19 @@ language: python
 cache: pip
 
 python:
-- '2.7'
-- '3.4'
+#- '2.7'
+#- '3.4'
 - '3.5'
 - '3.6'
 - '3.7'
 - '3.8'
 
 install:
-- pip install -r test_requirements.txt
+- make install
 
 script:
-- flake8 email_validator
+- make lint
+- make test
 
+after_success:
+- bash <(curl -s https://codecov.io/bash)

Makefile

@@ -0,0 +1,40 @@
+.DEFAULT_GOAL := all
+
+.PHONY: install
+install:
+	pip install -U setuptools pip
+	pip install -U -r test_requirements.txt
+	pip install -e .
+
+.PHONY: lint
+lint:
+	python setup.py check -rms
+	flake8 email_validator tests
+
+.PHONY: test
+test:
+	pytest --cov=email_validator
+
+.PHONY: testcov
+testcov: test
+	@echo "building coverage html"
+	@coverage html
+
+.PHONY: all
+all: testcov lint
+
+.PHONY: clean
+clean:
+	rm -rf `find . -name __pycache__`
+	rm -f `find . -type f -name '*.py[co]' `
+	rm -f `find . -type f -name '*~' `
+	rm -f `find . -type f -name '.*~' `
+	rm -rf .cache
+	rm -rf .pytest_cache
+	rm -rf htmlcov
+	rm -rf *.egg-info
+	rm -f .coverage
+	rm -f .coverage.*
+	rm -rf build
+	rm -rf dist
+	python setup.py clean

README.rst

@@ -191,8 +191,8 @@ information without telling them.)
 UCS-4 support required for Python 2.7
 '''''''''''''''''''''''''''''''''''''
 
-Note that when using Python 2.7, it is required that it was built with 
-UCS-4 support (see `here <https://stackoverflow.com/questions/29109944/python-returns-length-of-2-for-single-unicode-character-string>`__); otherwise emails with unicode characters outside 
+Note that when using Python 2.7, it is required that it was built with
+UCS-4 support (see `here <https://stackoverflow.com/questions/29109944/python-returns-length-of-2-for-single-unicode-character-string>`__); otherwise emails with unicode characters outside
 of the BMP (Basic Multilingual Plane) will not validate correctly.
 
 Normalization
@@ -387,12 +387,11 @@ or likely to cause trouble:
 Testing
 -------
 
-A handful of valid email addresses are pasted in ``test_pass.txt``. Run
-them through the validator (without deliverability checks) like so:
+Tests can be run using
 
 ::
 
-    python3 email_validator/__init__.py --tests < test_pass.txt
+    make test
 
 For Project Maintainers
 -----------------------

email_validator/__init__.py

@@ -315,45 +315,7 @@ def main():
     import sys
     import json
 
-    if sys.argv[-1] == "--tests":
-        # Pass a file of valid/invalid email addresses.
-        correct_answer = None
-        failed = 0
-        for line in sys.stdin:
-            # Strip newlines and skip blank lines and comments.
-            line = line.strip()
-            if line == "" or line[0] == "#":
-                continue
-            if sys.version_info < (3,):
-                line = line.decode("utf8")  # assume utf8 in input
-
-            # Pick up "[valid]"/"[invalid]" lines.
-            if line == "[valid]":
-                correct_answer = True
-                continue
-            elif line == "[invalid]":
-                correct_answer = False
-                continue
-            elif correct_answer is None:
-                raise Exception("Missing [valid]/[invalid] line.")
-
-            # Run.
-            try:
-                email = line
-                validate_email(email, check_deliverability=False)
-                if correct_answer is False:
-                    # Should have failed.
-                    print(email, "was recognized as valid.")
-                    failed += 1
-            except EmailNotValidError as e:
-                if correct_answer is True:
-                    # Should have passed.
-                    print(email, e)
-                    failed += 1
-        print("%d tests failed" % failed)
-        sys.exit(0 if not failed else 1)
-
-    elif len(sys.argv) == 1:
+    if len(sys.argv) == 1:
         # Read lines for STDIN and validate the email address on each line.
         allow_smtputf8 = True
         for line in sys.stdin:

setup.cfg

@@ -6,3 +6,8 @@ license_file = LICENSE
 
 [flake8]
 max-line-length = 120
+
+[tool:pytest]
+testpaths = tests
+filterwarnings =
+    error

test_pass.txt

@@ -1 +1,5 @@
+coverage==4.5.4
+docutils==0.15.2
 flake8==3.7.9
+pytest==5.2.2
+pytest-cov==2.8.1