Issue #3445 - Part 2. Add machinery for "accepted: invalid" milestone

Author: Mike Taylor

tests/fixtures/webhooks/private_milestone_accepted_invalid.json

@@ -0,0 +1,41 @@
+{
+    "action": "milestoned",
+    "issue": {
+      "title": "www.netflix.com - test private issue accepted",
+      "repository_url": "https://api.github.com/repos/webcompat/webcompat-tests-private",
+      "number": 600,
+      "body": "<!-- @browser: Firefox 55.0 -->\n<!-- @ua_header: Mozilla/5.0 (X11; Linux x86_64; rv:55.0) Gecko/20100101 Firefox/55.0 -->\n<!-- @reported_with: web -->\n<!-- @public_url: https://github.com/webcompat/webcompat-tests/issues/1  -->\n\n**URL**: https://www.netflix.com/",
+      "labels": [
+        {
+          "id": 1788251357,
+          "node_id": "MDU6TGFiZWwxNzg4MjUxMzU3",
+          "url": "https://api.github.com/repos/webcompat/webcompat-tests/labels/action-needsmoderation",
+          "name": "action-needsmoderation",
+          "color": "d36200",
+          "default": false,
+          "description": "issue in the process of being moderated"
+        }
+      ],
+      "state": "open",
+      "milestone": {
+        "url": "https://api.github.com/repos/webcompat/webcompat-tests-private/milestones/2",
+        "html_url": "https://github.com/webcompat/webcompat-tests-private/milestone/2",
+        "labels_url": "https://api.github.com/repos/webcompat/webcompat-tests-private/milestones/2/labels",
+        "id": 5092463,
+        "node_id": "MDk6TWlsZXN0b25lNTA5MjQ2Mw==",
+        "number": 2,
+        "title": "accepted: invalid",
+        "description": "This is when a bug has been accepted for moderation",
+        "open_issues": 0,
+        "closed_issues": 2,
+        "state": "open",
+        "created_at": "2020-02-11T00:37:18Z",
+        "updated_at": "2020-02-11T18:34:04Z",
+        "due_on": null,
+        "closed_at": null
+      }
+    },
+    "milestone": {
+      "title": "accepted: invalid"
+    }
+  }

tests/unit/test_webhook.py

@@ -411,6 +411,21 @@ def test_repo_scope_unknown(self):
         actual = helpers.repo_scope(url)
         self.assertEqual(expected, actual)
 
+    def test_prepare_invalid_issue(self):
+        """Test we prepare the right payload for the invalid issue."""
+        expected = {'body': '<p>Thanks for the report, but this is not a Compatibility\nissue.</p><p>For this project we try to focus our effort on layouts, features\nor content that works as expected in one browser but not in another.\nClosing the issue as Invalid.</p>',  # noqa
+                    'milestone': 8,
+                    'state': 'closed',
+                    'title': 'Test title!'}
+        actual = helpers.prepare_invalid_issue('Test title!')
+        self.assertEqual(type(actual), dict)
+        self.assertEqual(actual, expected)
+
+    def test_prepare_invalid_issue_no_title(self):
+        """Test we raise for a missing title arguement."""
+        with pytest.raises(ValueError) as excinfo:
+            helpers.prepare_invalid_issue()
+
     def test_prepare_rejected_issue(self):
         """Test we prepare the right payload for the rejected issue."""
         expected = {'body': "<p>The content of this issue doesn't meet our\n"

tests/unit/test_webhook_model.py

@@ -142,6 +142,21 @@ def test_reject_private_issue(mock_mr):
     assert issue.get_public_issue_number() in uri
 
 
+@patch('webcompat.webhooks.model.make_request')
+def test_reject_invalid_issue(mock_mr):
+    """Test issue state and API request that is sent to GitHub."""
+    mock_mr.return_value.status_code == 200
+    json_event, signature = event_data('private_issue_opened.json')
+    payload = json.loads(json_event)
+    issue = WebHookIssue.from_dict(payload)
+    issue.reject_invalid_issue()
+    method, uri, data = mock_mr.call_args[0]
+    # make sure we sent a patch with the right data to GitHub
+    assert method == 'patch'
+    assert type(data) == dict
+    assert issue.get_public_issue_number() in uri
+
+
 def test_prepare_public_comment():
     """Test we prepare the right comment body."""
     expected_payload = '{"body": "[Original issue 1](https://github.com/webcompat/webcompat-tests/issues/1)"}'  # noqa
@@ -319,7 +334,10 @@ def test_process_issue_action_github_api_exception(mock_mr, caplog):
         ('new_event_valid.json', 'public:opened labels failed',
          'tag_as_public'),
         ('private_milestone_closed.json',
-         'public rejection failed', 'reject_private_issue')
+         'public rejection failed', 'reject_private_issue'),
+        ('private_milestone_accepted_invalid.json',
+         'private:closing public issue as invalid failed',
+         'reject_invalid_issue')
     ]
     for scenario in scenarios:
         issue_payload, expected_log, method = scenario

webcompat/issues.py

@@ -23,10 +23,10 @@
 PRIVATE_REPO_URI = app.config['PRIVATE_REPO_URI']
 PRIVATE_REPO_MILESTONE = app.config['PRIVATE_REPO_MILESTONE']
 
-REJECTED_TITLE = 'Issue rejected.'
-REJECTED_BODY = '''<p>The content of this issue doesn't meet our
-<a href="https://webcompat.com/terms#acceptable-use">acceptable use</a>
-guidelines. Its original content has been deleted.</p>'''
+INVALID_BODY = '''<p>Thanks for the report, but this is not a Compatibility
+issue.</p><p>For this project we try to focus our effort on layouts, features
+or content that works as expected in one browser but not in another.
+Closing the issue as Invalid.</p>'''
 ONGOING_TITLE = 'In the moderation queue.'
 ONGOING_BODY = '''<p>This issue has been put in the moderation queue. A human
 will review if the message meets our current
@@ -35,20 +35,30 @@
 It will probably take a couple of days depending on the backlog.
 Once it has been reviewed, the content will be either made public
 or deleted.</p>'''
+REJECTED_TITLE = 'Issue rejected.'
+REJECTED_BODY = '''<p>The content of this issue doesn't meet our
+<a href="https://webcompat.com/terms#acceptable-use">acceptable use</a>
+guidelines. Its original content has been deleted.</p>'''
 
 
-def moderation_template(choice='ongoing'):
+def moderation_template(choice='ongoing', title=None):
     """Gets the placeholder data to send for unmoderated issues.
 
-    The moderation is for now two types:
+    The moderation is for now these types:
     - ongoing: the issue is in the moderation queue.
     - rejected: the issue has been rejected.
+    - invalid: the issue is invalid (but not rejected)
 
     The default is 'ongoing' even with unknown keywords.
     """
     if choice == 'rejected':
         title = REJECTED_TITLE
         body = REJECTED_BODY
+    elif choice == 'invalid':
+        if not title:
+            raise ValueError("A title must be passed in for invalid issues")
+        title = title
+        body = INVALID_BODY
     else:
         title = ONGOING_TITLE
         body = ONGOING_BODY

webcompat/webhooks/helpers.py

@@ -209,6 +209,25 @@ def msg_log(msg, issue_number):
     log.info(msg)
 
 
+def prepare_invalid_issue(title=None):
+    """Create the payload for the invalid moderated issue.
+
+    When the issue has been moderated as "accepted:invalid",
+    we need to change a couple of things in the public space
+
+    - change body
+    - close the issue
+    - remove the action-needsmoderation label
+    - change the milestone to invalid
+    """
+    # Extract the relevant information
+    invalid_id = app.config['STATUSES']['invalid']['id']
+    payload_request = moderation_template('invalid', title)
+    payload_request['state'] = 'closed'
+    payload_request['milestone'] = invalid_id
+    return payload_request
+
+
 def prepare_rejected_issue():
     """Create the payload for the rejected moderated issue.
 

webcompat/webhooks/model.py

@@ -21,6 +21,7 @@
 from webcompat.webhooks.helpers import make_request
 from webcompat.webhooks.helpers import msg_log
 from webcompat.webhooks.helpers import oops
+from webcompat.webhooks.helpers import prepare_invalid_issue
 from webcompat.webhooks.helpers import prepare_rejected_issue
 from webcompat.webhooks.helpers import repo_scope
 
@@ -143,6 +144,14 @@ def prepare_public_comment(self):
         # prepare the payload
         return f'[Original issue {public_number}]({self.public_url})'
 
+    def reject_invalid_issue(self):
+        """Send a passed-moderation-yet-invalid PATCH to the public issue."""
+        payload_request = prepare_invalid_issue(self.title)
+        public_number = self.get_public_issue_number()
+        # Preparing the proxy request
+        path = f'repos/{PUBLIC_REPO}/{public_number}'
+        make_request('patch', path, payload_request)
+
     def reject_private_issue(self):
         """Send a rejected moderation PATCH on the public issue."""
         payload_request = prepare_rejected_issue()
@@ -237,6 +246,19 @@ def process_issue_action(self):
                 # we didn't get exceptions, so it's safe to close it
                 self.close_private_issue()
                 return make_response('Moderated issue accepted', 200)
+        elif (self.action == 'milestoned' and scope == 'private' and
+              self.milestoned_with == 'accepted: invalid'):
+            try:
+                self.reject_invalid_issue()
+            except HTTPError as e:
+                msg_log(
+                    'private:closing public issue as invalid failed',
+                    self.number)
+                return oops()
+            else:
+                # we didn't get exceptions, so it's safe to close it
+                self.close_private_issue()
+                return make_response('Moderated issue closed as invalid', 200)
         elif (scope == 'private' and self.state == 'closed' and
               not self.milestone == 'accepted'):
             # private issue has been closed. It is rejected