mirror of
https://pagure.io/fm-orchestrator.git
synced 2026-06-14 22:17:34 +08:00
3878affa41
This patch separates the use of database session in different MBS components and do not mix them together. In general, MBS components could be separated as the REST API (implemented based on Flask) and non-REST API including the backend build workflow (implemented as a fedmsg consumer on top of fedmsg-hub and running independently) and library shared by them. As a result, there are two kind of database session used in MBS, one is created and managed by Flask-SQLAlchemy, and another one is created from SQLAclhemy Session API directly. The goal of this patch is to make ensure session object is used properly in the right place. All the changes follow these rules: * REST API related code uses the session object db.session created and managed by Flask-SQLAlchemy. * Non-REST API related code uses the session object created with SQLAlchemy Session API. Function make_db_session does that. * Shared code does not created a new session object as much as possible. Instead, it accepts an argument db_session. The first two rules are applicable to tests as well. Major changes: * Switch tests back to run with a file-based SQLite database. * make_session is renamed to make_db_session and SQLAlchemy connection pool options are applied for PostgreSQL backend. * Frontend Flask related code uses db.session * Shared code by REST API and backend build workflow accepts SQLAlchemy session object as an argument. For example, resolver class is constructed with a database session, and some functions accepts an argument for database session. * Build workflow related code use session object returned from make_db_session and ensure db.session is not used. * Only tests for views use db.session, and other tests use db_session fixture to access database. * All argument name session, that is for database access, are renamed to db_session. * Functions model_tests_init_data, reuse_component_init_data and reuse_shared_userspace_init_data, which creates fixture data for tests, are converted into pytest fixtures from original function called inside setup_method or a test method. The reason of this conversion is to use fixture ``db_session`` rather than create a new one. That would also benefit the whole test suite to reduce the number of SQLAlchemy session objects. Signed-off-by: Chenxiong Qi <cqi@redhat.com>
257 lines
11 KiB
Python
257 lines
11 KiB
Python
# Copyright (c) 2016 Red Hat, Inc.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in all
|
|
# copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
#
|
|
# Written by Ralph Bean <rbean@redhat.com>
|
|
|
|
import mock
|
|
|
|
import module_build_service.messaging
|
|
import module_build_service.scheduler.handlers.repos
|
|
import module_build_service.models
|
|
from module_build_service.models import ComponentBuild
|
|
from tests import conf, scheduler_init_data
|
|
|
|
|
|
class TestRepoDone:
|
|
|
|
@mock.patch("module_build_service.models.ModuleBuild.from_repo_done_event")
|
|
def test_no_match(self, from_repo_done_event, db_session):
|
|
""" Test that when a repo msg hits us and we have no match,
|
|
that we do nothing gracefully.
|
|
"""
|
|
scheduler_init_data(db_session)
|
|
from_repo_done_event.return_value = None
|
|
msg = module_build_service.messaging.KojiRepoChange(
|
|
"no matches for this...", "2016-some-nonexistent-build")
|
|
module_build_service.scheduler.handlers.repos.done(
|
|
config=conf, db_session=db_session, msg=msg)
|
|
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.recover_orphaned_artifact",
|
|
return_value=[],
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.get_average_build_time",
|
|
return_value=0.0,
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.list_tasks_for_components",
|
|
return_value=[],
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.buildroot_ready",
|
|
return_value=True,
|
|
)
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.get_session")
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.build")
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.buildroot_connect"
|
|
)
|
|
def test_a_single_match(
|
|
self, connect, build_fn, get_session, ready, list_tasks_fn, mock_gabt, mock_uea, db_session
|
|
):
|
|
""" Test that when a repo msg hits us and we have a single match.
|
|
"""
|
|
scheduler_init_data(db_session)
|
|
get_session.return_value = mock.Mock(), "development"
|
|
build_fn.return_value = 1234, 1, "", None
|
|
|
|
msg = module_build_service.messaging.KojiRepoChange(
|
|
"some_msg_id", "module-testmodule-master-20170109091357-7c29193d-build")
|
|
module_build_service.scheduler.handlers.repos.done(
|
|
config=conf, db_session=db_session, msg=msg)
|
|
build_fn.assert_called_once_with(
|
|
artifact_name="tangerine",
|
|
source=(
|
|
"https://src.fedoraproject.org/rpms/tangerine?"
|
|
"#fbed359411a1baa08d4a88e0d12d426fbf8f602c"
|
|
),
|
|
)
|
|
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.finalize")
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.recover_orphaned_artifact",
|
|
return_value=[],
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.get_average_build_time",
|
|
return_value=0.0,
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.list_tasks_for_components",
|
|
return_value=[],
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.buildroot_ready",
|
|
return_value=True,
|
|
)
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.get_session")
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.build")
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.buildroot_connect"
|
|
)
|
|
def test_a_single_match_finalize(
|
|
self, connect, build_fn, get_session, ready, list_tasks_fn, mock_gabt, mock_uea, finalizer,
|
|
db_session
|
|
):
|
|
""" Test that when a repo msg hits us and we have a single match.
|
|
"""
|
|
scheduler_init_data(db_session, tangerine_state=1)
|
|
get_session.return_value = mock.Mock(), "development"
|
|
build_fn.return_value = 1234, 1, "", None
|
|
|
|
# Ensure the time_completed is None, so we can test it is set to
|
|
# some date once the build is finalized.
|
|
module_build = module_build_service.models.ModuleBuild.get_by_id(db_session, 2)
|
|
module_build.time_completed = None
|
|
db_session.commit()
|
|
|
|
def mocked_finalizer(succeeded=None):
|
|
# Check that the time_completed is set in the time when
|
|
# finalizer is called.
|
|
assert succeeded is True
|
|
module_build = module_build_service.models.ModuleBuild.get_by_id(db_session, 2)
|
|
assert module_build.time_completed is not None
|
|
|
|
finalizer.side_effect = mocked_finalizer
|
|
|
|
msg = module_build_service.messaging.KojiRepoChange(
|
|
"some_msg_id", "module-testmodule-master-20170109091357-7c29193d-build")
|
|
module_build_service.scheduler.handlers.repos.done(
|
|
config=conf, db_session=db_session, msg=msg)
|
|
|
|
finalizer.assert_called_once()
|
|
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.recover_orphaned_artifact",
|
|
return_value=[],
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.get_average_build_time",
|
|
return_value=0.0,
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.list_tasks_for_components",
|
|
return_value=[],
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.buildroot_ready",
|
|
return_value=True,
|
|
)
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.get_session")
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.build")
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.buildroot_connect"
|
|
)
|
|
def test_a_single_match_build_fail(
|
|
self, connect, build_fn, config, ready, list_tasks_fn, mock_gabt, mock_uea, db_session
|
|
):
|
|
""" Test that when a KojiModuleBuilder.build fails, the build is
|
|
marked as failed with proper state_reason.
|
|
"""
|
|
scheduler_init_data(db_session)
|
|
config.return_value = mock.Mock(), "development"
|
|
build_fn.return_value = None, 4, "Failed to submit artifact tangerine to Koji", None
|
|
|
|
msg = module_build_service.messaging.KojiRepoChange(
|
|
"some_msg_id", "module-testmodule-master-20170109091357-7c29193d-build")
|
|
module_build_service.scheduler.handlers.repos.done(
|
|
config=conf, db_session=db_session, msg=msg)
|
|
build_fn.assert_called_once_with(
|
|
artifact_name="tangerine",
|
|
source=(
|
|
"https://src.fedoraproject.org/rpms/tangerine?"
|
|
"#fbed359411a1baa08d4a88e0d12d426fbf8f602c"
|
|
),
|
|
)
|
|
component_build = db_session.query(
|
|
module_build_service.models.ComponentBuild
|
|
).filter_by(package="tangerine").one()
|
|
assert component_build.state_reason == "Failed to submit artifact tangerine to Koji"
|
|
|
|
@mock.patch("module_build_service.scheduler.handlers.repos.log.info")
|
|
def test_erroneous_regen_repo_received(self, mock_log_info, db_session):
|
|
""" Test that when an unexpected KojiRepoRegen message is received, the module doesn't
|
|
complete or go to the next build batch.
|
|
"""
|
|
scheduler_init_data(db_session, 1)
|
|
|
|
component_build = db_session.query(ComponentBuild).filter_by(package="tangerine").one()
|
|
component_build.tagged = False
|
|
db_session.commit()
|
|
|
|
msg = module_build_service.messaging.KojiRepoChange(
|
|
"some_msg_id", "module-testmodule-master-20170109091357-7c29193d-build")
|
|
|
|
module_build_service.scheduler.handlers.repos.done(
|
|
config=conf, db_session=db_session, msg=msg)
|
|
|
|
mock_log_info.assert_called_with(
|
|
"Ignoring repo regen, because not all components are tagged."
|
|
)
|
|
module_build = module_build_service.models.ModuleBuild.get_by_id(db_session, 2)
|
|
# Make sure the module build didn't transition since all the components weren't tagged
|
|
assert module_build.state == module_build_service.models.BUILD_STATES["build"]
|
|
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder."
|
|
"KojiModuleBuilder.list_tasks_for_components",
|
|
return_value=[],
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.buildroot_ready",
|
|
return_value=True,
|
|
)
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.get_session")
|
|
@mock.patch("module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.build")
|
|
@mock.patch(
|
|
"module_build_service.builder.KojiModuleBuilder.KojiModuleBuilder.buildroot_connect"
|
|
)
|
|
@mock.patch(
|
|
"module_build_service.builder.GenericBuilder.default_buildroot_groups",
|
|
return_value={"build": [], "srpm-build": []},
|
|
)
|
|
def test_failed_component_build(
|
|
self, dbg, connect, build_fn, config, ready, list_tasks_fn, db_session
|
|
):
|
|
""" Test that when a KojiModuleBuilder.build fails, the build is
|
|
marked as failed with proper state_reason.
|
|
"""
|
|
scheduler_init_data(db_session, 3)
|
|
config.return_value = mock.Mock(), "development"
|
|
build_fn.return_value = None, 4, "Failed to submit artifact x to Koji", None
|
|
|
|
msg = module_build_service.messaging.KojiRepoChange(
|
|
"some_msg_id", "module-testmodule-master-20170109091357-7c29193d-build")
|
|
module_build_service.scheduler.handlers.repos.done(
|
|
config=conf, db_session=db_session, msg=msg)
|
|
module_build = module_build_service.models.ModuleBuild.get_by_id(db_session, 2)
|
|
|
|
assert module_build.state == module_build_service.models.BUILD_STATES["failed"]
|