added tests for mkdocs file

Author: silentfatez

readthedocs/rtd_tests/tests/test_doc_builder.py

@@ -12,6 +12,8 @@
 from readthedocs.doc_builder.python_environments import Virtualenv
 from readthedocs.projects.exceptions import ProjectConfigurationError
 from readthedocs.projects.models import Project
+from readthedocs.doc_builder.backends.mkdocs import BaseMkdocs
+from readthedocs.doc_builder.exceptions import MkDocsYAMLParseError
 
 
 @override_settings(PRODUCTION_DOMAIN="readthedocs.org")
@@ -112,3 +114,65 @@ def test_multiple_conf_py(
         with pytest.raises(ProjectConfigurationError):
             with override_settings(DOCROOT=tmp_docs_dir):
                 base_sphinx.show_conf()
+
+
+@override_settings(PRODUCTION_DOMAIN="readthedocs.org")
+class MkdocsBuilderTest(TestCase):
+    fixtures = ["test_data", "eric"]
+
+    def setUp(self):
+        self.project = Project.objects.get(slug="pip")
+        self.version = self.project.versions.first()
+
+        self.build_env = mock.MagicMock()
+        self.build_env.project = self.project
+        self.build_env.version = self.version
+        self.build_env.build = {
+            "id": 123,
+        }
+        self.build_env.api_client = mock.MagicMock()
+
+        BaseMkdocs.type = "base"
+        BaseMkdocs.mkdocs_build_dir = tempfile.mkdtemp()
+        BaseMkdocs.relative_output_dir = "_readthedocs/"
+
+
+    @patch("readthedocs.doc_builder.backends.sphinx.BaseMkdocs.docs_dir")
+    @patch("readthedocs.doc_builder.backends.sphinx.BaseMkdocs.run")
+    @patch("readthedocs.builds.models.Version.get_mkdocs_yaml_path")
+    @patch("readthedocs.projects.models.Project.checkout_path")
+    @patch("readthedocs.doc_builder.python_environments.load_yaml_config")
+    def test_project_without_mkdocs_yaml(
+        self,
+        load_yaml_config,
+        checkout_path,
+        get_mkdocs_yaml_path,
+        _,
+        docs_dir,
+    ):
+        """
+        Test for a project without ``conf.py`` file.
+
+        When this happen, the ``get_conf_py_path`` raises a
+        ``ProjectConfigurationError`` which is captured by our own code.
+        """
+        tmp_dir = tempfile.mkdtemp()
+        checkout_path.return_value = tmp_dir
+        docs_dir.return_value = tmp_dir
+        get_mkdocs_yaml_path.side_effect = MkDocsYAMLParseError
+        python_env = Virtualenv(
+            version=self.version,
+            build_env=self.build_env,
+            config=get_build_config({}, validate=True),
+        )
+        base_mkdocs = BaseMkdocs(
+            build_env=self.build_env,
+            python_env=python_env,
+        )
+        with self.assertRaises(MkDocsYAMLParseError) as e:
+            base_mkdocs.show_conf()
+
+        self.assertEqual(
+            e.exception.message_id,
+            MkDocsYAMLParseError.NOT_FOUND,
+        )