Move config module from rtd-build repo

readthedocs/config/tests/test_validation.py

@@ -0,0 +1,169 @@
+# -*- coding: utf-8 -*-
+from mock import patch
+from pytest import raises
+import os
+from six import text_type
+
+from readthedocs.config.validation import validate_bool
+from readthedocs.config.validation import validate_choice
+from readthedocs.config.validation import validate_list
+from readthedocs.config.validation import validate_directory
+from readthedocs.config.validation import validate_file
+from readthedocs.config.validation import validate_path
+from readthedocs.config.validation import validate_string
+from readthedocs.config.validation import ValidationError
+from readthedocs.config.validation import INVALID_BOOL
+from readthedocs.config.validation import INVALID_CHOICE
+from readthedocs.config.validation import INVALID_LIST
+from readthedocs.config.validation import INVALID_DIRECTORY
+from readthedocs.config.validation import INVALID_FILE
+from readthedocs.config.validation import INVALID_PATH
+from readthedocs.config.validation import INVALID_STRING
+
+
+def describe_validate_bool():
+    def it_accepts_true():
+        assert validate_bool(True) is True
+
+    def it_accepts_false():
+        assert validate_bool(False) is False
+
+    def it_accepts_0():
+        assert validate_bool(0) is False
+
+    def it_accepts_1():
+        assert validate_bool(1) is True
+
+    def it_fails_on_string():
+        with raises(ValidationError) as excinfo:
+            validate_bool('random string')
+        assert excinfo.value.code == INVALID_BOOL
+
+
+def describe_validate_choice():
+
+    def it_accepts_valid_choice():
+        result = validate_choice('choice', ('choice', 'another_choice'))
+        assert result is 'choice'
+
+        with raises(ValidationError) as excinfo:
+            validate_choice('c', 'abc')
+        assert excinfo.value.code == INVALID_LIST
+
+    def it_rejects_invalid_choice():
+        with raises(ValidationError) as excinfo:
+            validate_choice('not-a-choice', ('choice', 'another_choice'))
+        assert excinfo.value.code == INVALID_CHOICE
+
+
+def describe_validate_list():
+
+    def it_accepts_list_types():
+        result = validate_list(['choice', 'another_choice'])
+        assert result == ['choice', 'another_choice']
+
+        result = validate_list(('choice', 'another_choice'))
+        assert result == ['choice', 'another_choice']
+
+        def iterator():
+            yield 'choice'
+
+        result = validate_list(iterator())
+        assert result == ['choice']
+
+        with raises(ValidationError) as excinfo:
+            validate_choice('c', 'abc')
+        assert excinfo.value.code == INVALID_LIST
+
+    def it_rejects_string_types():
+        with raises(ValidationError) as excinfo:
+            result = validate_list('choice')
+        assert excinfo.value.code == INVALID_LIST
+
+
+def describe_validate_directory():
+
+    def it_uses_validate_path(tmpdir):
+        patcher = patch('readthedocs_build.config.validation.validate_path')
+        with patcher as validate_path:
+            path = text_type(tmpdir.mkdir('a directory'))
+            validate_path.return_value = path
+            validate_directory(path, str(tmpdir))
+            validate_path.assert_called_with(path, str(tmpdir))
+
+    def it_rejects_files(tmpdir):
+        tmpdir.join('file').write('content')
+        with raises(ValidationError) as excinfo:
+            validate_directory('file', str(tmpdir))
+        assert excinfo.value.code == INVALID_DIRECTORY
+
+
+def describe_validate_file():
+
+    def it_uses_validate_path(tmpdir):
+        patcher = patch('readthedocs_build.config.validation.validate_path')
+        with patcher as validate_path:
+            path = tmpdir.join('a file')
+            path.write('content')
+            path = str(path)
+            validate_path.return_value = path
+            validate_file(path, str(tmpdir))
+            validate_path.assert_called_with(path, str(tmpdir))
+
+    def it_rejects_directories(tmpdir):
+        tmpdir.mkdir('directory')
+        with raises(ValidationError) as excinfo:
+            validate_file('directory', str(tmpdir))
+        assert excinfo.value.code == INVALID_FILE
+
+
+def describe_validate_path():
+
+    def it_accepts_relative_path(tmpdir):
+        tmpdir.mkdir('a directory')
+        validate_path('a directory', str(tmpdir))
+
+    def it_accepts_files(tmpdir):
+        tmpdir.join('file').write('content')
+        validate_path('file', str(tmpdir))
+
+    def it_accepts_absolute_path(tmpdir):
+        path = str(tmpdir.mkdir('a directory'))
+        validate_path(path, 'does not matter')
+
+    def it_returns_absolute_path(tmpdir):
+        tmpdir.mkdir('a directory')
+        path = validate_path('a directory', str(tmpdir))
+        assert path == os.path.abspath(path)
+
+    def it_only_accepts_strings():
+        with raises(ValidationError) as excinfo:
+            validate_path(None, '')
+        assert excinfo.value.code == INVALID_STRING
+
+    def it_rejects_non_existent_path(tmpdir):
+        with raises(ValidationError) as excinfo:
+            validate_path('does not exist', str(tmpdir))
+        assert excinfo.value.code == INVALID_PATH
+
+
+def describe_validate_string():
+
+    def it_accepts_unicode():
+        result = validate_string(u'Unicöde')
+        assert isinstance(result, text_type)
+
+    def it_accepts_nonunicode():
+        result = validate_string('Unicode')
+        assert isinstance(result, text_type)
+
+    def it_rejects_float():
+        with raises(ValidationError) as excinfo:
+            validate_string(123.456)
+        assert excinfo.value.code == INVALID_STRING
+
+    def it_rejects_none():
+        with raises(ValidationError) as excinfo:
+            validate_string(None)
+        assert excinfo.value.code == INVALID_STRING
+

readthedocs/config/validation.py

@@ -0,0 +1,39 @@
+INVALID_BOOL = ''
+INVALID_CHOICE = ''
+INVALID_LIST = ''
+INVALID_DIRECTORY = ''
+INVALID_FILE = ''
+INVALID_PATH = ''
+INVALID_STRING = ''
+
+
+class ValidationError(Exception):
+    pass
+
+
+def validate_list(value):
+    pass
+
+
+def validate_choice(value, choices):
+    pass
+
+
+def validate_bool(value):
+    pass
+
+
+def validate_directory(value, base_path):
+    pass
+
+
+def validate_file(value, base_path):
+    pass
+
+
+def validate_path(value, base_path):
+    pass
+
+
+def validate_string(value):
+    pass

requirements/testing.txt

@@ -2,8 +2,11 @@
 
 django-dynamic-fixture==2.0.0
 
-pytest<4,>=3.3.2
+# 3.6.1 and >3.2.5 is incompatible
+# with pytest-describe 0.11.0
+pytest==3.2.5
 pytest-django==3.1.2
+pytest-describe==0.11.0
 pytest-xdist==1.22.0
 apipkg==1.4
 execnet==1.5.0