Match v1 config interface to new one (#4456)

* Add integratio tests for config file v2

* Complete tests for python

* Change external keys to python scope v1

* Fix tests

* Adapt tests from v1

* Skip new tests

* Refactor code to use new python options

* Refactor conda option from v1

* Use new conda option in tests

* Linter

* Use new configurations

* Add doctype to v1 & move models

* Use build model in v1

* Use new key for build.image

* Stop skipping tests

* Test empty requirements

* Linter

* Use new settings

* Add tests for sphinx

* Add tests for mkdocs

* Pass config object to builders

* Revert "Pass config object to builders"

This reverts commit 5b37760.

* Skip new tests

* Style

* Fix test

* One more test for v2

* Test conf.py default value

* Better check for conda

Author: stsewd

readthedocs/config/config.py

@@ -7,12 +7,12 @@
 
 import os
 import re
-from collections import namedtuple
 from contextlib import contextmanager
 
 import six
 
 from .find import find_one
+from .models import Build, Conda, Mkdocs, Python, Sphinx, Submodules
 from .parser import ParseError, parse
 from .validation import (
     ValidationError, validate_bool, validate_choice, validate_dict,
@@ -177,7 +177,7 @@ def python_interpreter(self):
 
     @property
     def python_full_version(self):
-        ver = self.python_version
+        ver = self.python.version
         if ver in [2, 3]:
             # Get the highest version of the major series version if user only
             # gave us a version of '2', or '3'
@@ -361,12 +361,9 @@ def validate_python(self):
         version = self.defaults.get('python_version', 2)
         python = {
             'use_system_site_packages': use_system_packages,
-            'pip_install': False,
+            'install_with_pip': False,
             'extra_requirements': [],
-            'setup_py_install': install_project,
-            'setup_py_path': os.path.join(
-                os.path.dirname(self.source_file),
-                'setup.py'),
+            'install_with_setup': install_project,
             'version': version,
         }
 
@@ -388,7 +385,7 @@ def validate_python(self):
             # Validate pip_install.
             if 'pip_install' in raw_python:
                 with self.catch_validation_error('python.pip_install'):
-                    python['pip_install'] = validate_bool(
+                    python['install_with_pip'] = validate_bool(
                         raw_python['pip_install'])
 
             # Validate extra_requirements.
@@ -399,26 +396,22 @@ def validate_python(self):
                         'python.extra_requirements',
                         self.PYTHON_EXTRA_REQUIREMENTS_INVALID_MESSAGE,
                         code=PYTHON_INVALID)
-                for extra_name in raw_extra_requirements:
-                    with self.catch_validation_error(
-                            'python.extra_requirements'):
-                        python['extra_requirements'].append(
-                            validate_string(extra_name)
-                        )
+                if not python['install_with_pip']:
+                    python['extra_requirements'] = []
+                else:
+                    for extra_name in raw_extra_requirements:
+                        with self.catch_validation_error(
+                                'python.extra_requirements'):
+                            python['extra_requirements'].append(
+                                validate_string(extra_name)
+                            )
 
             # Validate setup_py_install.
             if 'setup_py_install' in raw_python:
                 with self.catch_validation_error('python.setup_py_install'):
-                    python['setup_py_install'] = validate_bool(
+                    python['install_with_setup'] = validate_bool(
                         raw_python['setup_py_install'])
 
-            # Validate setup_py_path.
-            if 'setup_py_path' in raw_python:
-                with self.catch_validation_error('python.setup_py_path'):
-                    base_path = os.path.dirname(self.source_file)
-                    python['setup_py_path'] = validate_file(
-                        raw_python['setup_py_path'], base_path)
-
             if 'version' in raw_python:
                 with self.catch_validation_error('python.version'):
                     # Try to convert strings to an int first, to catch '2', then
@@ -451,11 +444,14 @@ def validate_conda(self):
                     self.PYTHON_INVALID_MESSAGE,
                     code=PYTHON_INVALID)
 
+            conda_environment = None
             if 'file' in raw_conda:
                 with self.catch_validation_error('conda.file'):
                     base_path = os.path.dirname(self.source_file)
-                    conda['file'] = validate_file(
-                        raw_conda['file'], base_path)
+                    conda_environment = validate_file(
+                        raw_conda['file'], base_path
+                    )
+            conda['environment'] = conda_environment
 
             return conda
         return None
@@ -511,58 +507,24 @@ def formats(self):
     @property
     def python(self):
         """Python related configuration."""
-        return self._config.get('python', {})
-
-    @property
-    def python_version(self):
-        """Python version."""
-        return self._config['python']['version']
-
-    @property
-    def pip_install(self):
-        """True if the project should be installed using pip."""
-        return self._config['python']['pip_install']
-
-    @property
-    def install_project(self):
-        """True if the project should be installed."""
-        if self.pip_install:
-            return True
-        return self._config['python']['setup_py_install']
-
-    @property
-    def extra_requirements(self):
-        """Extra requirements to be installed with pip."""
-        if self.pip_install:
-            return self._config['python']['extra_requirements']
-        return []
-
-    @property
-    def use_system_site_packages(self):
-        """True if the project should have access to the system packages."""
-        return self._config['python']['use_system_site_packages']
-
-    @property
-    def use_conda(self):
-        """True if the project use Conda."""
-        return self._config.get('conda') is not None
+        requirements = self._config['requirements_file']
+        self._config['python']['requirements'] = requirements
+        return Python(**self._config['python'])
 
     @property
-    def conda_file(self):
-        """The Conda environment file."""
-        if self.use_conda:
-            return self._config['conda'].get('file')
+    def conda(self):
+        if self._config['conda'] is not None:
+            return Conda(**self._config['conda'])
         return None
 
     @property
-    def requirements_file(self):
-        """The project requirements file."""
-        return self._config['requirements_file']
+    def build(self):
+        """The docker image used by the builders."""
+        return Build(**self._config['build'])
 
     @property
-    def build_image(self):
-        """The docker image used by the builders."""
-        return self._config['build']['image']
+    def doctype(self):
+        return self.defaults['doctype']
 
 
 class BuildConfigV2(BuildConfigBase):
@@ -888,47 +850,26 @@ def formats(self):
 
     @property
     def conda(self):
-        Conda = namedtuple('Conda', ['environment'])  # noqa
         if self._config['conda']:
             return Conda(**self._config['conda'])
         return None
 
     @property
     def build(self):
-        Build = namedtuple('Build', ['image'])  # noqa
         return Build(**self._config['build'])
 
     @property
     def python(self):
-        Python = namedtuple(  # noqa
-            'Python',
-            [
-                'version',
-                'requirements',
-                'install_with_pip',
-                'install_with_setup',
-                'extra_requirements',
-                'use_system_site_packages',
-            ],
-        )
         return Python(**self._config['python'])
 
     @property
     def sphinx(self):
-        Sphinx = namedtuple(  # noqa
-            'Sphinx',
-            ['builder', 'configuration', 'fail_on_warning'],
-        )
         if self._config['sphinx']:
             return Sphinx(**self._config['sphinx'])
         return None
 
     @property
     def mkdocs(self):
-        Mkdocs = namedtuple(  # noqa
-            'Mkdocs',
-            ['configuration', 'fail_on_warning'],
-        )
         if self._config['mkdocs']:
             return Mkdocs(**self._config['mkdocs'])
         return None
@@ -941,10 +882,6 @@ def doctype(self):
 
     @property
     def submodules(self):
-        Submodules = namedtuple(  # noqa
-            'Submodules',
-            ['include', 'exclude', 'recursive'],
-        )
         return Submodules(**self._config['submodules'])
 
 

readthedocs/config/models.py

@@ -0,0 +1,37 @@
+"""Models for the response of the configuration object."""
+
+from __future__ import division, print_function, unicode_literals
+
+from collections import namedtuple
+
+
+Build = namedtuple('Build', ['image'])  # noqa
+
+Python = namedtuple(  # noqa
+    'Python',
+    [
+        'version',
+        'requirements',
+        'install_with_pip',
+        'install_with_setup',
+        'extra_requirements',
+        'use_system_site_packages',
+    ],
+)
+
+Conda = namedtuple('Conda', ['environment'])  # noqa
+
+Sphinx = namedtuple(  # noqa
+    'Sphinx',
+    ['builder', 'configuration', 'fail_on_warning'],
+)
+
+Mkdocs = namedtuple(  # noqa
+    'Mkdocs',
+    ['configuration', 'fail_on_warning'],
+)
+
+Submodules = namedtuple(  # noqa
+    'Submodules',
+    ['include', 'exclude', 'recursive'],
+)