+ as comment to a pull-request, either manually or via the "Rerun CI" dropdown.

+ This allows to re-run a test that failed due to some network outage or other

+ unexpected issues unrelated to the test suite.

+ to trigger this pagure-ci run. The format is following: ``{"<sentence>":

+ {"name": "<name of the CI>", "description": "<short description>"}}``

+ Sentences which have ``None`` as value won't show up in the "Rerun CI"

+ dropdown. Additionally, it's possible to add a ``requires_project_hook_attr``

+ key to the dict with data about a sentence. For example, having

+ ``"requires_project_hook_attr": ("ci_hook", "active_pr", True)`` would make

+ the "Rerun CI" dropdown have a button for this specific CI only if the

+ project has ``ci_hook`` activated and its ``active_pr`` value is ``True``.

+ 

+ In versions before 5.2, this was a list containing just the sentences.

+ 

+ Defaults to: ``{"pretty please pagure-ci rebuild": {"name": "Default CI",

+ "description": "Rerun default CI"}}``

+ TRIGGER_CI = {

+     "pretty please pagure-ci rebuild": {

+         "name": "Default CI",

+         "description": "Rerun default CI",

+         "requires_project_hook_attr": ("ci_hook", "active_pr", True),

+     },

+ }

+ 

+ 

+ class TriggerCIPRForm(PagureForm):

+     def __init__(self, *args, **kwargs):

+         # we need to instantiate dynamically because the configuration

+         # values may change during tests and we want to always respect

+         # the currently set value

+         super(TriggerCIPRForm, self).__init__(*args, **kwargs)

+         choices = []

+         trigger_ci = pagure_config["TRIGGER_CI"]

+         if isinstance(trigger_ci, dict):

+             # make sure to preserver compatibility with older configs

+             # which had TRIGGER_CI as a list

+             for comment, meta in trigger_ci.items():

+                 if meta is not None:

+                     choices.append((comment, comment))

+         self.comment.choices = choices

+ 

+     comment = wtforms.SelectField(

+         "comment", [wtforms.validators.Required()], choices=[]

+     )

+     ci_triggered = False

+         ci_triggered = True

+         not ci_triggered

+         and trigger_ci

+         <span class="dropdown dropdown-btn">

+           <a href="#" id="merge_dropdown_btn"

+           class="btn btn-outline-secondary btn-sm disabled dropdown-toggle" data-toggle="dropdown">

+             <span class="fa fa-circle-o-notch fa-spin fa-fw"></span> <span id="merge-status-text">Merge</span>

+           <div id="merge-alert" class="text-xs-center dropdown-menu dropdown-menu-right p-0" style="min-width:400px">

+                 {% if pull_request.status == 'Open' and g.repo_committer %}

+                 <small id="merge-alert-message"></small>

+                 <form action="{{ url_for('ui_ns.merge_request_pull',

+                         repo=repo.name,

+                         username=username,

+                         namespace=repo.namespace,

+                         requestid=requestid)

+                   }}" method="POST">

+                   {{ mergeform.csrf_token }}

+                   <button id="merge_btn" type="submit"

+                     onclick="return confirm('Confirm merging this pull-request');"

+                     class="btn btn-block my-2">Merge</button>

+                   {% if can_delete_branch %}

+                   <div class="small">

+                   {{ mergeform.delete_branch }} {{ mergeform.delete_branch.label }}

+                   </div>

+                   {% endif %}

+                 </form>

+               {% else %}

+               {% endif %}

+             </div>

+         </span>

+         {% if g.authenticated and trigger_ci %}

+         <span class="dropdown dropdown-btn">

+           <a href="#" id="ci_dropdown_btn"

+           class="btn btn-outline-primary btn-sm btn-info dropdown-toggle" data-toggle="dropdown">

+             Rerun CI

+           </a>

+           <div class="text-xs-center dropdown-menu dropdown-menu-right p-0">

+             <form action="{{ url_for('ui_ns.ci_trigger_request_pull',

+                     repo=repo.name,

+                     username=username,

+                     namespace=repo.namespace,

+                     requestid=requestid)

+               }}" method="POST" id="ci_pr_trigger_form">

+               {{ trigger_ci_pr_form.csrf_token }}

+               {{ trigger_ci_pr_form.comment(id="ci_pr_comment", hidden=True) }}

+                 {% for comment, meta in trigger_ci|dictsort %}

+                   <a class="dropdown-item" href="#" title="{{ meta["description"] }}"

+                   onclick="$('#ci_pr_comment').val('{{ comment }}'); $('#ci_pr_trigger_form').submit()">{{ meta["name"] }}</a>

+                 {% endfor %}

+             </form>

+           </div>

+         </span>

+         {% endif %}

+ import pagure.lib.plugins

+     trigger_ci_pr_form = pagure.forms.TriggerCIPRForm()

+ 

+     # we need to leave out all members of trigger_ci_conf that have

+     # "meta" set to False or meta["requires_project_hook_attr"] condition

+     # defined and it's not met

+     trigger_ci_conf = pagure_config["TRIGGER_CI"]

+     if not isinstance(trigger_ci_conf, dict):

+         trigger_ci_conf = {}

+     trigger_ci = {}

+     # make sure all the backrefs are set properly on repo

+     pagure.lib.plugins.get_enabled_plugins(repo)

+     for comment, meta in trigger_ci_conf.items():

+         if not meta:

+             continue

+         cond = meta.get("requires_project_hook_attr", ())

+         if cond and not pagure.utils.project_has_hook_attr_value(repo, *cond):

+             continue

+         trigger_ci[comment] = meta

+         trigger_ci=trigger_ci,

+         trigger_ci_pr_form=trigger_ci_pr_form,

+             trigger_ci = pagure_config["TRIGGER_CI"]

+             if isinstance(trigger_ci, dict):

+                 trigger_ci = list(trigger_ci.keys())

+                 trigger_ci=trigger_ci,

+ @UI_NS.route(

+     "/<repo>/pull-request/<int:requestid>/trigger-ci",

+     methods=["POST"]

+ )

+ @UI_NS.route(

+     "/<namespace>/<repo>/pull-request/<int:requestid>/trigger-ci",

+     methods=["POST"]

+ )

+ @UI_NS.route(

+     "/fork/<username>/<repo>/pull-request/<int:requestid>/trigger-ci",

+     methods=["POST"],

+ )

+ @UI_NS.route(

+     ("/fork/<username>/<namespace>/<repo>/pull-request/"

+      "<int:requestid>/trigger-ci"),

+     methods=["POST"],

+ )

+ @login_required

+ def ci_trigger_request_pull(repo, requestid, username=None, namespace=None):

+     """ Trigger CI testing for a PR.

+     """

+     form = pagure.forms.TriggerCIPRForm()

+     if not form.validate_on_submit():

+         flask.flash("Invalid input submitted", "error")

+         return flask.redirect(

+             flask.url_for(

+                 "ui_ns.request_pull",

+                 repo=repo,

+                 requestid=requestid,

+                 username=username,

+                 namespace=namespace,

+             )

+         )

+ 

+     repo_obj = flask.g.repo

+     request = pagure.lib.query.search_pull_requests(

+         flask.g.session, project_id=repo_obj.id, requestid=requestid

+     )

+ 

+     if not request:

+         flask.abort(404, "Pull-request not found")

+ 

+     trigger_ci = pagure_config["TRIGGER_CI"]

+     if isinstance(trigger_ci, dict):

+         trigger_ci = list(trigger_ci.keys())

+     pagure.lib.query.add_pull_request_comment(

+         flask.g.session,

+         request,

+         commit=None,

+         tree_id=None,

+         filename=None,

+         row=None,

+         comment=form.comment.data,

+         user=flask.g.fas_user.username,

+         notify=True,

+         notification=True,

+         trigger_ci=trigger_ci,

+     )

+ 

+     return flask.redirect(

+         flask.url_for(

+             "ui_ns.request_pull",

+             repo=repo,

+             username=username,

+             namespace=namespace,

+             requestid=requestid,

+         )

+     )

+ 

+ 

+ 

+ 

+ def project_has_hook_attr_value(project, hook, attr, value):

+     """ Finds out if project's hook has attribute of given value.

+ 

+     :arg project: The project to inspect

+     :type project: pagure.lib.model.Project

+     :arg hook: Name of the hook to inspect

+     :type hook: str

+     :arg attr: Name of hook attribute to inspect

+     :type attr: str

+     :arg value: Value to compare project's hook attribute value with

+     :type value: object

+     :return: True if project's hook attribute value is equal with given

+         value, False otherwise

+     """

+     retval = False

+     hook_obj = getattr(project, hook, None)

+     if hook_obj is not None:

+         attr_obj = getattr(hook_obj, attr, None)

+         if attr_obj == value:

+             retval = True

+ 

+     return retval

+     def test_request_pull_ci_dropdown(self, send_email):

+         """ Test presence of the "Rerun CI" dropdown with various settings. """

+         send_email.return_value = True

+ 

+         tests.create_projects(self.session)

+         tests.create_projects_git(

+             os.path.join(self.path, 'requests'), bare=True)

+         self.set_up_git_repo(new_project=None, branch_from='feature')

+ 

+         user = tests.FakeUser()

+         user.username = 'pingou'

+         with tests.user_set(self.app.application, user):

+             # old-style TRIGGER_CI list - test backwards compatibility

+             with patch.dict('pagure.config.config',

+                             {'TRIGGER_CI': ['old-style-trigger-ci']}):

+                 output = self.app.get('/test/pull-request/1')

+                 self.assertEqual(output.status_code, 200)

+                 output_text = output.get_data(as_text=True)

+                 self.assertNotIn('Rerun CI', output_text)

+ 

+             # new-style TRIGGER_CI, but no button to show

+             with patch.dict('pagure.config.config',

+                             {'TRIGGER_CI': {'no-button': None}}):

+                 output = self.app.get('/test/pull-request/1')

+                 self.assertEqual(output.status_code, 200)

+                 output_text = output.get_data(as_text=True)

+                 self.assertNotIn('Rerun CI', output_text)

+ 

+             trigger_ci = {

+                 'foobar-ci': {

+                     'name': 'foobar-ci-name',

+                     'description': 'barfoo',

+                 },

+                 'spam-ci': {

+                     'name': 'spam-ci-name',

+                     'description': 'with beans and eggs',

+                 },

+                 'no-button-for-me-ci': None,

+             }

+             # new-style TRIGGER_CI, several buttons to show

+             with patch.dict('pagure.config.config',

+                             {'TRIGGER_CI': trigger_ci}):

+                 output = self.app.get('/test/pull-request/1')

+                 self.assertEqual(output.status_code, 200)

+                 output_text = output.get_data(as_text=True)

+                 self.assertIn('Rerun CI', output_text)

+                 self.assertIn('foobar-ci-name', output_text)

+                 self.assertIn('spam-ci-name', output_text)

+                 self.assertNotIn('no-button-for-me-ci', output_text)

+ 

+             trigger_ci = {

+                 'foobar-ci': {

+                     'name': 'foobar-ci-name',

+                     'description': 'barfoo',

+                     'requires_project_hook_attr': ('ci_hook', 'active_pr', True),

+                 },

+             }

+             # new-style TRIGGER_CI with requires_project_hook_attr that is

+             # not fulfilled by the project

+             with patch.dict('pagure.config.config',

+                             {'TRIGGER_CI': trigger_ci}):

+                 output = self.app.get('/test/pull-request/1')

+                 self.assertEqual(output.status_code, 200)

+                 output_text = output.get_data(as_text=True)

+                 self.assertNotIn('Rerun CI', output_text)

+             # now activate the hook and try again

+             data = {

+                 'active_pr': 'y',

+                 'ci_url': 'https://jenkins.fedoraproject.org',

+                 'ci_job': 'ci_job',

+                 'ci_type': 'jenkins',

+                 'csrf_token': self.get_csrf()

+             }

+             output = self.app.post('/test/settings/Pagure CI', data=data,

+                                    follow_redirects=True)

+             self.assertEqual(output.status_code, 200)

+             with patch.dict('pagure.config.config',

+                             {'TRIGGER_CI': trigger_ci}):

+                 output = self.app.get('/test/pull-request/1')

+                 self.assertEqual(output.status_code, 200)

+                 output_text = output.get_data(as_text=True)

+                 self.assertIn('Rerun CI', output_text)

+                 self.assertIn('foobar-ci-name', output_text)

+ 

+         # shouldn't show up if user is not logged in

+         with patch.dict('pagure.config.config',

+                         {'TRIGGER_CI': trigger_ci}):

+             output = self.app.get('/test/pull-request/1')

+             self.assertEqual(output.status_code, 200)

+             output_text = output.get_data(as_text=True)

+             self.assertNotIn('Rerun CI', output_text)

+ 

+     @patch('pagure.lib.notify.send_email')

+     @patch.dict('pagure.config.config',

+                 {'TRIGGER_CI': {'CI1': {'name': 'CI1', 'description': 'CI1!'}}})

+     def test_request_pull_ci_rerun(self, send_email):

+         """ Test rerunning CI using button from the "Rerun CI" dropdown. """

+         send_email.return_value = True

+ 

+         tests.create_projects(self.session)

+         tests.create_projects_git(

+             os.path.join(self.path, 'requests'), bare=True)

+         self.set_up_git_repo(new_project=None, branch_from='feature')

+         user = tests.FakeUser()

+         user.username = 'pingou'

+         project = pagure.lib.query.get_authorized_project(self.session, 'test')

+         request = project.requests[0]

+ 

+         with tests.user_set(self.app.application, user):

+             # no csrf token

+             output = self.app.get('/test/pull-request/1')

+             self.assertEqual(output.status_code, 200)

+             output = self.app.post(

+                 '/test/pull-request/1/trigger-ci', follow_redirects=True)

+             self.assertEqual(output.status_code, 200)

+             self.assertIn('Invalid input', output.get_data(as_text=True))

+ 

+             # no such PR

+             output = self.app.get('/test/pull-request/1')

+             self.assertEqual(output.status_code, 200)

+             output = self.app.post(

+                 '/test/pull-request/2/trigger-ci', follow_redirects=True)

+             self.assertEqual(output.status_code, 404)

+ 

+             # wrong comment

+             output = self.app.get('/test/pull-request/1')

+             self.assertEqual(output.status_code, 200)

+             csrf_token = self.get_csrf(output=output)

+             data = {'csrf_token': csrf_token, 'comment': 'this doesnt exist'}

+             output = self.app.post(

+                 '/test/pull-request/1/trigger-ci', data=data, follow_redirects=True)

+             self.assertEqual(output.status_code, 200)

+             self.assertIn('Invalid input', output.get_data(as_text=True))

+ 

+             # everything ok

+             output = self.app.get('/test/pull-request/1')

+             self.assertEqual(output.status_code, 200)

+             csrf_token = self.get_csrf(output=output)

+             data = {'csrf_token': csrf_token, 'comment': 'CI1'}

+             output = self.app.post(

+                 '/test/pull-request/1/trigger-ci', data=data, follow_redirects=True)

+             output_text = output.get_data(as_text=True)

+             self.assertEqual(output.status_code, 200)

+             self.assertIn('<p>CI1</p>', output_text)

+             comment = request.comments[0]

+             self.assertTrue(comment.notification)

+             self.assertEqual(comment.comment, 'CI1')

+ 

+ 

+     @patch('pagure.lib.notify.send_email')