def test_dont_localmedia_build_pdf_epub_search_in_mkdocs( self, load_config): load_config.side_effect = create_load() project = get(Project, slug='project-1', documentation_type='mkdocs', enable_pdf_build=True, enable_epub_build=True, versions=[fixture()]) version = project.versions.all().first() build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = load_yaml_config(version) task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env, version=version, config=config) task.build_docs() # Only html for mkdocs was built self.mocks.html_build_mkdocs.assert_called_once() self.mocks.html_build.assert_not_called() self.mocks.localmedia_build.assert_not_called() self.mocks.pdf_build.assert_not_called() self.mocks.epub_build.assert_not_called()
def test_build(self, load_config): '''Test full build''' load_config.side_effect = create_load() project = get(Project, slug='project-1', documentation_type='sphinx', conf_py_file='test_conf.py', versions=[fixture()]) version = project.versions.all()[0] self.mocks.configure_mock('api_versions', {'return_value': [version]}) self.mocks.configure_mock( 'api', {'get.return_value': { 'downloads': "no_url_here" }}) self.mocks.patches['html_build'].stop() build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = load_yaml_config(version) task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env, version=version, config=config) task.build_docs() # Get command and check first part of command list is a call to sphinx self.assertEqual(self.mocks.popen.call_count, 3) cmd = self.mocks.popen.call_args_list[2][0] self.assertRegex(cmd[0][0], r'python') self.assertRegex(cmd[0][1], r'sphinx-build')
def test_build_respects_pdf_flag(self, load_config): '''Build output format control''' load_config.side_effect = create_load() project = get(Project, slug='project-1', documentation_type='sphinx', conf_py_file='test_conf.py', enable_pdf_build=True, enable_epub_build=False, versions=[fixture()]) version = project.versions.all()[0] build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = load_yaml_config(version) task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env, version=version, config=config) task.build_docs() # The HTML and the Epub format were built. self.mocks.html_build.assert_called_once_with() self.mocks.pdf_build.assert_called_once_with() # PDF however was disabled and therefore not built. self.assertFalse(self.mocks.epub_build.called)
def test_build_respects_pdf_flag(self, load_config): '''Build output format control''' load_config.side_effect = create_load() project = get(Project, slug='project-1', documentation_type='sphinx', conf_py_file='test_conf.py', enable_pdf_build=True, enable_epub_build=False, versions=[fixture()]) version = project.versions.all()[0] build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = load_yaml_config(version) task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env, version=version, search=False, localmedia=False, config=config) task.build_docs() # The HTML and the Epub format were built. self.mocks.html_build.assert_called_once_with() self.mocks.pdf_build.assert_called_once_with() # PDF however was disabled and therefore not built. self.assertFalse(self.mocks.epub_build.called)
def test_dont_localmedia_build_pdf_epub_search_in_mkdocs(self, load_config): load_config.side_effect = create_load() project = get( Project, slug='project-1', documentation_type='mkdocs', enable_pdf_build=True, enable_epub_build=True, versions=[fixture()], ) version = project.versions.all().first() build_env = LocalBuildEnvironment( project=project, version=version, build={}, ) python_env = Virtualenv(version=version, build_env=build_env) config = load_yaml_config(version) task = UpdateDocsTaskStep( build_env=build_env, project=project, python_env=python_env, version=version, config=config, ) task.build_docs() # Only html for mkdocs was built self.mocks.html_build_mkdocs.assert_called_once() self.mocks.html_build.assert_not_called() self.mocks.localmedia_build.assert_not_called() self.mocks.pdf_build.assert_not_called() self.mocks.epub_build.assert_not_called()
def test_build(self, load_config): '''Test full build''' load_config.side_effect = create_load() project = get(Project, slug='project-1', documentation_type='sphinx', conf_py_file='test_conf.py', versions=[fixture()]) version = project.versions.all()[0] self.mocks.configure_mock('api_versions', {'return_value': [version]}) self.mocks.configure_mock('api', { 'get.return_value': {'downloads': "no_url_here"} }) self.mocks.patches['html_build'].stop() build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = load_yaml_config(version) task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env, version=version, search=False, localmedia=False, config=config) task.build_docs() # Get command and check first part of command list is a call to sphinx self.assertEqual(self.mocks.popen.call_count, 3) cmd = self.mocks.popen.call_args_list[2][0] self.assertRegexpMatches(cmd[0][0], r'python') self.assertRegexpMatches(cmd[0][1], r'sphinx-build')
def test_build_respects_yaml(self): '''Test YAML build options''' project = get(Project, slug='project-1', documentation_type='sphinx', conf_py_file='test_conf.py', enable_pdf_build=False, enable_epub_build=False, versions=[fixture()]) version = project.versions.all()[0] build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = ConfigWrapper(version=version, yaml_config=create_load({'formats': ['epub']})()[0]) task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env, version=version, search=False, localmedia=False, config=config) task.build_docs() # The HTML and the Epub format were built. self.mocks.html_build.assert_called_once_with() self.mocks.epub_build.assert_called_once_with() # PDF however was disabled and therefore not built. self.assertFalse(self.mocks.pdf_build.called)
def test_build_pdf_latex_not_failure(self, load_config): """Test pass during PDF builds and bad latex failure status code.""" load_config.side_effect = create_load() self.mocks.patches['html_build'].stop() self.mocks.patches['pdf_build'].stop() project = get( Project, slug='project-2', documentation_type='sphinx', conf_py_file='test_conf.py', enable_pdf_build=True, enable_epub_build=False, versions=[fixture()], ) version = project.versions.all()[0] assert project.conf_dir() == '/tmp/rtd' build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = load_yaml_config(version) task = UpdateDocsTaskStep( build_env=build_env, project=project, python_env=python_env, version=version, config=config, ) # Mock out the separate calls to Popen using an iterable side_effect returns = [ ((b'', b''), 0), # sphinx-build html ((b'', b''), 0), # sphinx-build pdf ((b'', b''), 1), # sphinx version check ((b'Output written on foo.pdf', b''), 1), # latex ((b'', b''), 0), # makeindex ((b'', b''), 0), # latex ] mock_obj = mock.Mock() mock_obj.communicate.side_effect = [ output for (output, status) in returns ] type(mock_obj).returncode = mock.PropertyMock( side_effect=[status for (output, status) in returns], ) self.mocks.popen.return_value = mock_obj with build_env: task.build_docs() self.assertEqual(self.mocks.popen.call_count, 6) self.assertTrue(build_env.successful)
def test_build_pdf_latex_not_failure(self, load_config): """Test pass during PDF builds and bad latex failure status code.""" load_config.side_effect = create_load() self.mocks.patches['html_build'].stop() self.mocks.patches['pdf_build'].stop() project = get( Project, slug='project-2', documentation_type='sphinx', conf_py_file='test_conf.py', enable_pdf_build=True, enable_epub_build=False, versions=[fixture()], ) version = project.versions.all()[0] assert project.conf_dir() == '/tmp/rtd' build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = load_yaml_config(version) task = UpdateDocsTaskStep( build_env=build_env, project=project, python_env=python_env, version=version, config=config, ) # Mock out the separate calls to Popen using an iterable side_effect returns = [ ((b'', b''), 0), # sphinx-build html ((b'', b''), 0), # sphinx-build pdf ((b'Output written on foo.pdf', b''), 1), # latex ((b'', b''), 0), # makeindex ((b'', b''), 0), # latex ] mock_obj = mock.Mock() mock_obj.communicate.side_effect = [ output for (output, status) in returns ] type(mock_obj).returncode = mock.PropertyMock( side_effect=[status for (output, status) in returns], ) self.mocks.popen.return_value = mock_obj with build_env: task.build_docs() self.assertEqual(self.mocks.popen.call_count, 7) self.assertTrue(build_env.successful)
def test_build_pdf_latex_failures(self): '''Build failure if latex fails''' self.mocks.patches['html_build'].stop() self.mocks.patches['pdf_build'].stop() project = get(Project, slug='project-1', documentation_type='sphinx', conf_py_file='test_conf.py', enable_pdf_build=True, enable_epub_build=False, versions=[fixture()]) version = project.versions.all()[0] assert project.conf_dir() == '/tmp/rtd' build_env = LocalBuildEnvironment(project=project, version=version, build={}) python_env = Virtualenv(version=version, build_env=build_env) config = ConfigWrapper(version=version, yaml_config=create_load()()[0]) task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env, version=version, search=False, localmedia=False, config=config) # Mock out the separate calls to Popen using an iterable side_effect returns = [ ((b'', b''), 0), # sphinx-build html ((b'', b''), 0), # sphinx-build pdf ((b'', b''), 1), # latex ((b'', b''), 0), # makeindex ((b'', b''), 0), # latex ] mock_obj = mock.Mock() mock_obj.communicate.side_effect = [ output for (output, status) in returns ] type(mock_obj).returncode = mock.PropertyMock( side_effect=[status for (output, status) in returns]) self.mocks.popen.return_value = mock_obj with build_env: task.build_docs() self.assertEqual(self.mocks.popen.call_count, 7) self.assertTrue(build_env.failed)
def test_get_env_vars(self): project = get( Project, slug='project', documentation_type='sphinx', ) get( EnvironmentVariable, name='TOKEN', value='a1b2c3', project=project, ) build = get(Build) version = get(Version, slug='1.8', project=project) task = UpdateDocsTaskStep( project=project, version=version, build={'id': build.pk}, ) # mock this object to make sure that we are NOT in a conda env task.config = mock.Mock(conda=None) env = { 'READTHEDOCS': True, 'READTHEDOCS_VERSION': version.slug, 'READTHEDOCS_PROJECT': project.slug, 'BIN_PATH': os.path.join( project.doc_path, 'envs', version.slug, 'bin', ), 'TOKEN': 'a1b2c3', } self.assertEqual(task.get_env_vars(), env) # mock this object to make sure that we are in a conda env task.config = mock.Mock(conda=True) env.update({ 'CONDA_ENVS_PATH': os.path.join(project.doc_path, 'conda'), 'CONDA_DEFAULT_ENV': version.slug, 'BIN_PATH': os.path.join( project.doc_path, 'conda', version.slug, 'bin', ), }) self.assertEqual(task.get_env_vars(), env)
def test_save_config_in_build_model(self, load_config, api_v2): load_config.side_effect = create_load() api_v2.build.get.return_value = {} project = get( Project, slug='project', documentation_type='sphinx', ) build = get(Build) version = get(Version, slug='1.8', project=project) task = UpdateDocsTaskStep(project=project, version=version, build={'id': build.pk}) task.setup_vcs = mock.Mock() task.run_setup() build_config = task.build['config'] # For patch api_v2.build.assert_called_once() assert build_config['version'] == '1' assert 'sphinx' in build_config assert build_config['doctype'] == 'sphinx'
def test_save_config_in_build_model(self, load_config, api_v2): load_config.side_effect = create_load() api_v2.build.get.return_value = {} project = get( Project, slug='project', documentation_type='sphinx', ) build = get(Build) version = get(Version, slug='1.8', project=project) task = UpdateDocsTaskStep( project=project, version=version, build={'id': build.pk}, ) task.setup_vcs = mock.Mock() task.run_setup() build_config = task.build['config'] # For patch api_v2.build.assert_called_once() assert build_config['version'] == '1' assert 'sphinx' in build_config assert build_config['doctype'] == 'sphinx'
def test_get_env_vars(self): project = get( Project, slug='project', documentation_type='sphinx', ) get( EnvironmentVariable, name='TOKEN', value='a1b2c3', project=project, ) build = get(Build) version = get(Version, slug='1.8', project=project) task = UpdateDocsTaskStep( project=project, version=version, build={'id': build.pk}, ) # mock this object to make sure that we are NOT in a conda env task.config = mock.Mock(conda=None) env = { 'READTHEDOCS': 'True', 'READTHEDOCS_VERSION': version.slug, 'READTHEDOCS_PROJECT': project.slug, 'READTHEDOCS_LANGUAGE': project.language, 'BIN_PATH': os.path.join( project.doc_path, 'envs', version.slug, 'bin', ), 'TOKEN': 'a1b2c3', } self.assertEqual(task.get_env_vars(), env) # mock this object to make sure that we are in a conda env task.config = mock.Mock(conda=True) env.update({ 'CONDA_ENVS_PATH': os.path.join(project.doc_path, 'conda'), 'CONDA_DEFAULT_ENV': version.slug, 'BIN_PATH': os.path.join( project.doc_path, 'conda', version.slug, 'bin', ), }) self.assertEqual(task.get_env_vars(), env)