227 lines
9.6 KiB
Python
227 lines
9.6 KiB
Python
import logging
|
|
from . import OBSLocal
|
|
from check_source import CheckSource
|
|
import random
|
|
import os
|
|
from osclib.core import request_action_list
|
|
from osc.core import get_request_list
|
|
|
|
PROJECT = 'openSUSE:Factory'
|
|
SRC_PROJECT = 'devel:Fishing'
|
|
FIXTURES = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'fixtures')
|
|
REVIEW_TEAM = 'reviewers-team'
|
|
FACTORY_MAINTAINERS = 'group:factory-maintainers'
|
|
|
|
# NOTE: Since there is no documentation explaining the good practices for creating tests for a
|
|
# review bot, this test is created by mimicking parts of other existing tests. Most decisions are
|
|
# documented, but some rationales may be wrong. So don't take this as a model for creating
|
|
# future tests.
|
|
|
|
# Inherit from OBSLocal.Testcase since it provides many commodity methods for testing against
|
|
# a local testing instance of OBS
|
|
|
|
|
|
class TestCheckSource(OBSLocal.TestCase):
|
|
def setUp(self):
|
|
super(TestCheckSource, self).setUp()
|
|
|
|
# Using OBSLocal.FactoryWorkflow makes it easier to setup testing scenarios
|
|
self.wf = OBSLocal.FactoryWorkflow(PROJECT)
|
|
self.project = self.wf.projects[PROJECT]
|
|
|
|
# Set up the reviewers team
|
|
self.wf.create_group(REVIEW_TEAM)
|
|
|
|
self.wf.remote_config_set(
|
|
{'required-source-maintainer': 'Admin', 'review-team': REVIEW_TEAM}
|
|
)
|
|
|
|
self.bot_user = 'factory-auto'
|
|
self.wf.create_user(self.bot_user)
|
|
# When creating a review, set the by_user to bot_user
|
|
self.project.add_reviewers(users = [self.bot_user])
|
|
|
|
# Ensure different test runs operate in unique namespace.
|
|
self.bot_name = '::'.join([type(self).__name__, str(random.getrandbits(8))])
|
|
|
|
# StagingWorkflow creates reviews with the reviewer set to bot_user, so it's necessary to
|
|
# configure our review bot to act upon such reviews
|
|
self.review_bot = CheckSource(
|
|
self.wf.apiurl, user=self.bot_user, logger=logging.getLogger(self.bot_name)
|
|
)
|
|
self.review_bot.bot_name = self.bot_name
|
|
|
|
def tearDown(self):
|
|
super().tearDown()
|
|
del self.wf
|
|
|
|
def test_no_devel_project(self):
|
|
"""Declines the request when it does not come from a devel project"""
|
|
req_id = self.wf.create_submit_request(SRC_PROJECT, self.randomString('package')).reqid
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'new'))
|
|
|
|
self.review_bot.set_request_ids([req_id])
|
|
self.review_bot.check_requests()
|
|
|
|
review = self.assertReview(req_id, by_user=(self.bot_user, 'declined'))
|
|
self.assertIn('%s is not a devel project of %s' % (SRC_PROJECT, PROJECT), review.comment)
|
|
|
|
def test_devel_project(self):
|
|
"""Accepts a request coming from a devel project"""
|
|
self._setup_devel_project()
|
|
|
|
req_id = self.wf.create_submit_request(SRC_PROJECT, 'blowfish', add_commit = False).reqid
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'new'))
|
|
|
|
self.review_bot.set_request_ids([req_id])
|
|
self.review_bot.check_requests()
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'accepted'))
|
|
self.assertReview(req_id, by_group=(REVIEW_TEAM, 'new'))
|
|
|
|
def test_missing_patch_in_changelog(self):
|
|
"""Reject a request if it adds patch and it is not mentioned in changelog"""
|
|
# devel files contain patch but not changes
|
|
self._setup_devel_project(devel_files='blowfish-with-patch')
|
|
|
|
req_id = self.wf.create_submit_request(self.devel_package.project,
|
|
self.devel_package.name, add_commit = False).reqid
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'new'))
|
|
|
|
self.review_bot.set_request_ids([req_id])
|
|
self.review_bot.check_requests()
|
|
|
|
review = self.assertReview(req_id, by_user=(self.bot_user, 'declined'))
|
|
self.assertIn(
|
|
'A patch (test.patch) is being added without this addition being mentioned in the changelog.',
|
|
review.comment
|
|
)
|
|
|
|
def test_patch_in_changelog(self):
|
|
"""Accepts a request if it adds patch and it is mentioned in changelog"""
|
|
self._setup_devel_project()
|
|
|
|
req_id = self.wf.create_submit_request(self.devel_package.project,
|
|
self.devel_package.name, add_commit = False).reqid
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'new'))
|
|
|
|
self.review_bot.set_request_ids([req_id])
|
|
self.review_bot.check_requests()
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'accepted'))
|
|
self.assertReview(req_id, by_group=(REVIEW_TEAM, 'new'))
|
|
|
|
def test_revert_of_patch(self):
|
|
"""Accepts a request if it reverts addition of patch"""
|
|
# switch target and devel, so basically do revert of changes done
|
|
# with patch and changes
|
|
self._setup_devel_project(devel_files='blowfish',
|
|
target_files='blowfish-with-patch-changes')
|
|
|
|
req_id = self.wf.create_submit_request(self.devel_package.project,
|
|
self.devel_package.name, add_commit = False).reqid
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'new'))
|
|
|
|
self.review_bot.set_request_ids([req_id])
|
|
self.review_bot.check_requests()
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'accepted'))
|
|
self.assertReview(req_id, by_group=(REVIEW_TEAM, 'new'))
|
|
|
|
def test_no_source_maintainer(self):
|
|
"""Declines the request when the 'required_maintainer' is not maintainer of the source project
|
|
|
|
Create also request to add required maintainers to source project unless it is already open
|
|
"""
|
|
self._setup_devel_project()
|
|
|
|
# Change the required maintainer
|
|
self.wf.create_group(FACTORY_MAINTAINERS.replace('group:', ''))
|
|
self.wf.remote_config_set({'required-source-maintainer': FACTORY_MAINTAINERS})
|
|
|
|
req = self.wf.create_submit_request(SRC_PROJECT, 'blowfish', add_commit = False)
|
|
|
|
self.assertReview(req.reqid, by_user=(self.bot_user, 'new'))
|
|
|
|
self.review_bot.set_request_ids([req.reqid])
|
|
self.review_bot.check_requests()
|
|
|
|
review = self.assertReview(req.reqid, by_user=(self.bot_user, 'declined'))
|
|
add_role_req = get_request_list(self.wf.apiurl, SRC_PROJECT, req_state=['new'], req_type='add_role')[0]
|
|
|
|
self.assertIn('unless %s is a maintainer of %s' % (FACTORY_MAINTAINERS, SRC_PROJECT), review.comment)
|
|
self.assertIn('Created the add_role request %s' % add_role_req.reqid, review.comment)
|
|
|
|
self.assertEqual(add_role_req.actions[0].tgt_project, SRC_PROJECT)
|
|
self.assertEqual('Created automatically from request %s' % req.reqid, add_role_req.description)
|
|
|
|
# reopen request and do it again to test that new add_role request won't be created
|
|
req.change_state('new')
|
|
|
|
self.review_bot.check_requests()
|
|
add_role_reqs = get_request_list(self.wf.apiurl, SRC_PROJECT, req_state=['new'], req_type='add_role')
|
|
|
|
self.assertEqual(len(add_role_reqs), 1)
|
|
|
|
def test_source_maintainer(self):
|
|
"""Accepts the request when the 'required_maintainer' is a group and is a maintainer for the project"""
|
|
group_name = FACTORY_MAINTAINERS.replace('group:', '')
|
|
self.wf.create_group(group_name)
|
|
self.wf.remote_config_set({'required-source-maintainer': FACTORY_MAINTAINERS})
|
|
|
|
self._setup_devel_project(maintainer={'groups': [group_name]})
|
|
|
|
req_id = self.wf.create_submit_request(SRC_PROJECT, 'blowfish', add_commit = False).reqid
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'new'))
|
|
|
|
self.review_bot.set_request_ids([req_id])
|
|
self.review_bot.check_requests()
|
|
|
|
self.assertReview(req_id, by_user=(self.bot_user, 'accepted'))
|
|
self.assertReview(req_id, by_group=(REVIEW_TEAM, 'new'))
|
|
|
|
def test_source_inherited_maintainer(self):
|
|
"""Declines the request when the 'required_maintainer' is only inherited maintainer of the source project"""
|
|
# Change the required maintainer
|
|
group_name = FACTORY_MAINTAINERS.replace('group:', '')
|
|
self.wf.create_group(group_name)
|
|
self.wf.remote_config_set({'required-source-maintainer': FACTORY_MAINTAINERS})
|
|
|
|
self.wf.create_project(SRC_PROJECT.rsplit(':', 1)[0], maintainer={'groups': [group_name]})
|
|
|
|
self._setup_devel_project()
|
|
|
|
req = self.wf.create_submit_request(SRC_PROJECT, 'blowfish', add_commit = False)
|
|
|
|
self.assertReview(req.reqid, by_user=(self.bot_user, 'new'))
|
|
|
|
self.review_bot.set_request_ids([req.reqid])
|
|
self.review_bot.check_requests()
|
|
|
|
review = self.assertReview(req.reqid, by_user=(self.bot_user, 'declined'))
|
|
add_role_req = get_request_list(self.wf.apiurl, SRC_PROJECT, req_state=['new'], req_type='add_role')[0]
|
|
|
|
self.assertIn('unless %s is a maintainer of %s' % (FACTORY_MAINTAINERS, SRC_PROJECT), review.comment)
|
|
self.assertIn('Created the add_role request %s' % add_role_req.reqid, review.comment)
|
|
|
|
self.assertEqual(add_role_req.actions[0].tgt_project, SRC_PROJECT)
|
|
self.assertEqual('Created automatically from request %s' % req.reqid, add_role_req.description)
|
|
|
|
def _setup_devel_project(self, maintainer={}, devel_files='blowfish-with-patch-changes',
|
|
target_files='blowfish'):
|
|
devel_project = self.wf.create_project(SRC_PROJECT, maintainer=maintainer)
|
|
self.devel_package = OBSLocal.Package('blowfish', project=devel_project)
|
|
|
|
fixtures_path = os.path.join(FIXTURES, 'packages', devel_files)
|
|
self.devel_package.commit_files(fixtures_path)
|
|
|
|
fixtures_path = os.path.join(FIXTURES, 'packages', target_files)
|
|
self.target_package = OBSLocal.Package('blowfish', self.project, devel_project=SRC_PROJECT)
|
|
self.target_package.commit_files(fixtures_path)
|