Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Don't share state in build task #3946

Merged
merged 2 commits into from
Apr 19, 2018
Merged

Don't share state in build task #3946

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af2d922
Don't share state in build task
agjohnson Apr 13, 2018
35145ec
Add docs
agjohnson Apr 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions readthedocs/projects/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,14 +161,21 @@ def _log(self, msg):
msg=msg))


class SyncRepositoryTask(SyncRepositoryMixin, Task):
class SyncRepositoryTask(Task):

"""Entry point to synchronize the VCS documentation."""

max_retries = 5
default_retry_delay = (7 * 60)
name = __name__ + '.sync_repository'

def run(self, *args, **kwargs):
step = SyncRepositoryTaskStep()
return step.run(*args, **kwargs)


class SyncRepositoryTaskStep(SyncRepositoryMixin):

def run(self, version_pk): # pylint: disable=arguments-differ
"""
Run the VCS synchronization.
Expand All @@ -194,7 +201,18 @@ def run(self, version_pk): # pylint: disable=arguments-differ
return False


class UpdateDocsTask(SyncRepositoryMixin, Task):
class UpdateDocsTask(Task):

max_retries = 5
default_retry_delay = (7 * 60)
name = __name__ + '.update_docs'

def run(self, *args, **kwargs):
step = UpdateDocsTaskStep()
return step.run(*args, **kwargs)


class UpdateDocsTaskStep(SyncRepositoryMixin):

"""
The main entry point for updating documentation.
Expand All @@ -204,11 +222,6 @@ class UpdateDocsTask(SyncRepositoryMixin, Task):
html docs if needed.
"""

max_retries = 5
default_retry_delay = (7 * 60)
name = __name__ + '.update_docs'

# TODO: the argument from the __init__ are used only in tests
def __init__(self, build_env=None, python_env=None, config=None,
force=False, search=True, localmedia=True,
build=None, project=None, version=None):
Expand Down
14 changes: 7 additions & 7 deletions readthedocs/rtd_tests/tests/test_builds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from readthedocs.doc_builder.environments import LocalBuildEnvironment
from readthedocs.doc_builder.python_environments import Virtualenv
from readthedocs.doc_builder.loader import get_builder_class
from readthedocs.projects.tasks import UpdateDocsTask
from readthedocs.projects.tasks import UpdateDocsTaskStep
from readthedocs.rtd_tests.tests.test_config_wrapper import create_load

from ..mocks.environment import EnvironmentMockGroup
Expand Down Expand Up @@ -44,7 +44,7 @@ def test_build(self):
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 = UpdateDocsTask(build_env=build_env, project=project, python_env=python_env,
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
task.build_docs()

Expand All @@ -68,7 +68,7 @@ def test_build_respects_pdf_flag(self):
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 = UpdateDocsTask(build_env=build_env, project=project, python_env=python_env,
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)

task.build_docs()
Expand All @@ -93,7 +93,7 @@ def test_build_respects_epub_flag(self):
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 = UpdateDocsTask(build_env=build_env, project=project, python_env=python_env,
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
task.build_docs()

Expand All @@ -119,7 +119,7 @@ def test_build_respects_yaml(self):
config = ConfigWrapper(version=version, yaml_config=create_load({
'formats': ['epub']
})()[0])
task = UpdateDocsTask(build_env=build_env, project=project, python_env=python_env,
task = UpdateDocsTaskStep(build_env=build_env, project=project, python_env=python_env,
version=version, search=False, localmedia=False, config=config)
task.build_docs()

Expand Down Expand Up @@ -174,7 +174,7 @@ def test_build_pdf_latex_failures(self):
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 = UpdateDocsTask(build_env=build_env, project=project, python_env=python_env,
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
Expand Down Expand Up @@ -216,7 +216,7 @@ def test_build_pdf_latex_not_failure(self):
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 = UpdateDocsTask(build_env=build_env, project=project, python_env=python_env,
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
Expand Down
18 changes: 9 additions & 9 deletions readthedocs/rtd_tests/tests/test_celery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ def test_clear_artifacts(self):
self.assertTrue(result.successful())
self.assertFalse(exists(directory))

@patch('readthedocs.projects.tasks.UpdateDocsTask.setup_python_environment', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTask.build_docs', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTask.setup_vcs', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.setup_python_environment', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.build_docs', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.setup_vcs', new=MagicMock)
def test_update_docs(self):
build = get(Build, project=self.project,
version=self.project.versions.first())
Expand All @@ -79,10 +79,10 @@ def test_update_docs(self):
intersphinx=False)
self.assertTrue(result.successful())

@patch('readthedocs.projects.tasks.UpdateDocsTask.setup_python_environment', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTask.build_docs', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.setup_python_environment', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.build_docs', new=MagicMock)
@patch('readthedocs.doc_builder.environments.BuildEnvironment.update_build', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTask.setup_vcs')
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.setup_vcs')
def test_update_docs_unexpected_setup_exception(self, mock_setup_vcs):
exc = Exception()
mock_setup_vcs.side_effect = exc
Expand All @@ -97,10 +97,10 @@ def test_update_docs_unexpected_setup_exception(self, mock_setup_vcs):
intersphinx=False)
self.assertTrue(result.successful())

@patch('readthedocs.projects.tasks.UpdateDocsTask.setup_python_environment', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTask.setup_vcs', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.setup_python_environment', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.setup_vcs', new=MagicMock)
@patch('readthedocs.doc_builder.environments.BuildEnvironment.update_build', new=MagicMock)
@patch('readthedocs.projects.tasks.UpdateDocsTask.build_docs')
@patch('readthedocs.projects.tasks.UpdateDocsTaskStep.build_docs')
def test_update_docs_unexpected_build_exception(self, mock_build_docs):
exc = Exception()
mock_build_docs.side_effect = exc
Expand Down