WIP Add callback

Author: zalun

dev-requirements.txt

@@ -27,3 +27,6 @@ py==1.4.33 \
     --hash=sha256:1f9a981438f2acc20470b301a07a496375641f902320f70e31916fe3377385a9
 requests-mock==1.3.0 \
     --hash=sha256:23edd6f7926aa13b88bf79cb467632ba2dd5a253034e9f41563f60ed305620c7
+pytest-mock==1.6.0 \
+    --hash=sha256:83a17cbcd4dbc7c6c9dc885a0d598f9acd11f2d5142e0718ed32e14538670c1f \
+    --hash=sha256:29bf62c12a67dc0e7f6d02efa2404f0b4d068b38cd64f22a06c8a16cb545a03e

docker-compose.yml

@@ -17,6 +17,7 @@ services:
       - PHABRICATOR_UNPRIVILEGED_API_KEY=api-123456789
       - TRANSPLANT_URL=https://stub.transplant.example.com
       - DATABASE_URL=sqlite:////db/sqlite.db
+      - HOST_URL=https://landoapi.mozilla.org
     volumes:
       - ./:/app
       - ./.db/:/db/

landoapi/api/landings.py

@@ -7,6 +7,7 @@
 """
 from connexion import problem
 from flask import request
+from sqlalchemy.orm.exc import NoResultFound
 from landoapi.models.landing import (
     Landing,
     LandingNotCreatedException,
@@ -71,3 +72,19 @@ def get(landing_id):
         )
 
     return landing.serialize(), 200
+
+
+def update(landing_id, auth, data):
+    """Update landing on pingback from Transplant."""
+    try:
+        landing = Landing.query.filter_by(id=landing_id, auth=auth).one()
+    except NoResultFound:
+        return problem(
+            404,
+            'Landing not found',
+            'The requested Landing does not exist',
+            type='https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404'
+        )
+    landing.status = data['status']
+    landing.save()
+    return landing.serialize(), 202

landoapi/models/landing.py

@@ -1,6 +1,10 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
+import os
+import random
+import string
+
 from landoapi.models.storage import db
 from landoapi.phabricator_client import PhabricatorClient
 from landoapi.transplant_client import TransplantClient
@@ -9,6 +13,10 @@
 TRANSPLANT_JOB_FINISHED = 'finished'
 
 
+def _hashtag(size=6, chars=string.ascii_uppercase + string.digits):
+    return ''.join(random.choice(chars) for _ in range(size))
+
+
 def _get_revision(revision_id, api_key=None):
     """ Gets revision from Phabricator.
 
@@ -42,35 +50,41 @@ class Landing(db.Model):
     request_id = db.Column(db.Integer, unique=True)
     revision_id = db.Column(db.String(30))
     status = db.Column(db.Integer)
+    auth = db.Column(db.String(30))
 
     def __init__(
         self, request_id=None, revision_id=None, status=TRANSPLANT_JOB_STARTED
     ):
         self.request_id = request_id
         self.revision_id = revision_id
         self.status = status
+        self.auth = _hashtag()
 
     @classmethod
-    def create(cls, revision_id, phabricator_api_key=None, save=True):
+    def create(cls, revision_id, phabricator_api_key=None):
         """ Land revision and create a Transplant item in storage. """
         revision = _get_revision(revision_id, phabricator_api_key)
         if not revision:
             raise RevisionNotFoundException(revision_id)
 
+        # save landing to make sure we've got the callback
+        landing = cls(
+            revision_id=revision_id,
+        )
+        landing.save()
+
         trans = TransplantClient()
+        callback = '%s/landings/%s/update?auth=%s' % (
+            os.environ.get('HOST_URL'), landing.id, landing.auth
+        )
         request_id = trans.land(
-            'ldap_username@example.com', revision['repo_url']
+            'ldap_username@example.com', revision['repo_url'], callback
         )
         if not request_id:
             raise LandingNotCreatedException
 
-        landing = cls(
-            revision_id=revision_id,
-            request_id=request_id,
-            status=TRANSPLANT_JOB_STARTED
-        )
-        if save:
-            landing.save(create=True)
+        landing.request_id = request_id
+        landing.save(create=True)
 
         return landing
 

landoapi/spec/swagger.yml

@@ -121,6 +121,51 @@ paths:
           schema:
             allOf:
               - $ref: '#/definitions/Error'
+  /landings/{landing_id}/update:
+    post:
+      operationId: landoapi.api.landings.update
+      description: |
+        Sends request to transplant service and responds just the status code
+      parameters:
+        - name: data
+          in: body
+          description: |
+            Retrieve status of the landing job
+          required: true
+          schema:
+            type: object
+            required:
+              - request_id
+            properties:
+              request_id:
+                type: integer
+        - name: landing_id
+          in: path
+          type: string
+          description: |
+            The id of the landing to return
+          required: true
+        - name: auth
+          in: query
+          type: string
+          description: |
+            Random hashtag saved in schema to authenticate the pingback
+          required: true
+      responses:
+        201:
+          description: OK
+          schema:
+            $ref: '#/definitions/Landing'
+        404:
+          description: Landing does not exist
+          schema:
+            allOf:
+              - $ref: '#/definitions/Error'
+        default:
+          description: Unexpected error
+          schema:
+            allOf:
+              - $ref: '#/definitions/Error'
   /landings/{landing_id}:
     get:
       description: |

landoapi/transplant_client.py

@@ -17,7 +17,7 @@ def __init__(self):
         self.api_url = os.getenv('TRANSPLANT_URL')
 
     @requests_mock.mock()
-    def land(self, ldap_username, tree, request):
+    def land(self, ldap_username, tree, pingback, request):
         """ Sends a push request to Transplant API to land a revision.
 
         Returns request_id received from Transplant API.

tests/test_landings.py

@@ -5,7 +5,9 @@
 import pytest
 
 from landoapi.models.storage import db as _db
-from landoapi.models.landing import (Landing, TRANSPLANT_JOB_STARTED)
+from landoapi.models.landing import (
+    Landing, TRANSPLANT_JOB_STARTED, TRANSPLANT_JOB_FINISHED
+)
 
 from tests.canned_responses.phabricator.revisions import *
 from tests.canned_responses.lando_api.revisions import *
@@ -112,3 +114,69 @@ def test_get_jobs(db, client):
     response = client.get('/landings?revision_id=D1&status=finished')
     assert response.status_code == 200
     assert len(response.json) == 1
+
+
+def test_update_landing(db, client, mocker):
+    m_hashtag = mocker.patch('landoapi.models.landing._hashtag')
+    m_hashtag.return_value = 'abc'
+    Landing(1, 'D1', 'started').save(True)
+
+    response = client.post(
+        '/landings/1/update?auth=abc',
+        data=json.dumps(
+            {
+                'request_id': 1,
+                'status': TRANSPLANT_JOB_FINISHED,
+                'revision_id': 'D1'
+            }
+        ),
+        content_type='application/json'
+    )
+
+    assert response.status_code == 202
+    response = client.get('/landings/1')
+    assert response.json['status'] == TRANSPLANT_JOB_FINISHED
+
+
+def test_update_landing_bad_id(db, client, mocker):
+    m_hashtag = mocker.patch('landoapi.models.landing._hashtag')
+    m_hashtag.return_value = 'abc'
+    Landing(1, 'D1', 'started').save(True)
+
+    response = client.post(
+        '/landings/2/update?auth=abc',
+        data=json.dumps(
+            {
+                'request_id': 1,
+                'status': TRANSPLANT_JOB_FINISHED,
+                'revision_id': 'D1'
+            }
+        ),
+        content_type='application/json'
+    )
+
+    assert response.status_code == 404
+    response = client.get('/landings/1')
+    assert response.json['status'] == TRANSPLANT_JOB_STARTED
+
+
+def test_update_landing_bad_auth(db, client, mocker):
+    m_hashtag = mocker.patch('landoapi.models.landing._hashtag')
+    m_hashtag.return_value = 'abc'
+    Landing(1, 'D1', 'started').save(True)
+
+    response = client.post(
+        '/landings/1/update?auth=cde',
+        data=json.dumps(
+            {
+                'request_id': 1,
+                'status': TRANSPLANT_JOB_FINISHED,
+                'revision_id': 'D1'
+            }
+        ),
+        content_type='application/json'
+    )
+
+    assert response.status_code == 404
+    response = client.get('/landings/1')
+    assert response.json['status'] == TRANSPLANT_JOB_STARTED