Add pingback support (bug 1377305)

Added POST API endpoint `/landings/{landing_id}/update`.
`landing_id` (from path) and `request_id` (from data) have to correspond
with database entry, otherwise 404 is raised.
Modified the schema by adding error and result.

Author: zalun

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://lando-api.test
     volumes:
       - ./:/app
       - ./.db/:/db/

landoapi/api/landings.py

@@ -7,11 +7,10 @@
 """
 from connexion import problem
 from flask import request
+from sqlalchemy.orm.exc import NoResultFound
 from landoapi.models.landing import (
-    Landing,
-    LandingNotCreatedException,
-    LandingNotFoundException,
-    RevisionNotFoundException,
+    Landing, LandingNotCreatedException, LandingNotFoundException,
+    RevisionNotFoundException, TRANSPLANT_JOB_FAILED, TRANSPLANT_JOB_LANDED
 )
 
 
@@ -71,3 +70,25 @@ def get(landing_id):
         )
 
     return landing.serialize(), 200
+
+
+def update(landing_id, data):
+    """Update landing on pingback from Transplant."""
+    try:
+        landing = Landing.query.filter_by(
+            id=landing_id, request_id=data['request_id']
+        ).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.error = data.get('error_msg', '')
+    landing.result = data.get('result', '')
+    landing.status = TRANSPLANT_JOB_LANDED if data['landed'
+                                                  ] else TRANSPLANT_JOB_FAILED
+    landing.save()
+    return landing.serialize(), 202

landoapi/models/landing.py

@@ -1,12 +1,16 @@
 # 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
+
 from landoapi.models.storage import db
 from landoapi.phabricator_client import PhabricatorClient
 from landoapi.transplant_client import TransplantClient
 
+TRANSPLANT_JOB_STARTING = 'starting'
 TRANSPLANT_JOB_STARTED = 'started'
-TRANSPLANT_JOB_FINISHED = 'finished'
+TRANSPLANT_JOB_LANDED = 'landed'
+TRANSPLANT_JOB_FAILED = 'failed'
 
 
 def _get_revision(revision_id, api_key=None):
@@ -42,35 +46,45 @@ class Landing(db.Model):
     request_id = db.Column(db.Integer, unique=True)
     revision_id = db.Column(db.String(30))
     status = db.Column(db.Integer)
+    error = db.Column(db.String(128), default='')
+    result = db.Column(db.String(128))
 
     def __init__(
-        self, request_id=None, revision_id=None, status=TRANSPLANT_JOB_STARTED
+        self,
+        request_id=None,
+        revision_id=None,
+        status=TRANSPLANT_JOB_STARTING
     ):
         self.request_id = request_id
         self.revision_id = revision_id
         self.status = status
 
     @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' % (
+            os.environ.get('HOST_URL'), landing.id
+        )
         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.status = TRANSPLANT_JOB_STARTED
+        landing.save(create=True)
 
         return landing
 
@@ -100,7 +114,9 @@ def serialize(self):
             'id': self.id,
             'revision_id': self.revision_id,
             'request_id': self.request_id,
-            'status': self.status
+            'status': self.status,
+            'error_msg': self.error,
+            'result': self.result
         }
 
 

landoapi/spec/swagger.yml

@@ -121,6 +121,61 @@ 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
+              tree:
+                type: string
+              rev:
+                type: string
+              patch:
+                type: string
+              destination:
+                type: string
+              trysyntax:
+                type: string
+              landed:
+                type: boolean
+              error_msg:
+                type: string
+              result:
+                type: string
+        - name: landing_id
+          in: path
+          type: string
+          description: |
+            The id of the landing to return
+          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: |
@@ -168,6 +223,14 @@ definitions:
         type: integer
         description: |
           The id of the Revision
+      result:
+        type: string
+        description: |
+          revision (sha) of push if landed == true
+      error:
+        type: string
+        description: |
+          Error message if landing failed
   Revision:
     type: object
     properties:

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.

migrations/67151bb74080_add_error_message_and_result_to_landing.py

@@ -0,0 +1,33 @@
+"""Add error message and result to Landing
+
+Revision ID: 67151bb74080
+Revises: ae9dd729e66c
+Create Date: 2017-06-29 22:16:56.874034
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision = '67151bb74080'
+down_revision = 'ae9dd729e66c'
+branch_labels = ()
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        'landings', sa.Column('error', sa.String(length=128), nullable=True)
+    )
+    op.add_column(
+        'landings', sa.Column('result', sa.String(length=128), nullable=True)
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('landings', 'result')
+    op.drop_column('landings', 'error')
+    # ### end Alembic commands ###

tests/canned_responses/lando_api/landings.py

@@ -7,23 +7,40 @@
         'id': 1,
         'request_id': 1,
         'revision_id': 'D1',
-        'status': 'started'
+        'status': 'started',
+        'error_msg': '',
+        'result': None,
     }, {
         'id': 2,
         'request_id': 2,
         'revision_id': 'D1',
-        'status': 'finished'
+        'status': 'finished',
+        'error_msg': '',
+        'result': None,
     }, {
         'id': 4,
         'request_id': 4,
         'revision_id': 'D1',
-        'status': 'started'
+        'status': 'started',
+        'error_msg': '',
+        'result': None,
     }
 ]
 
 CANNED_LANDING_1 = {
     'id': 1,
     'status': 'started',
     'request_id': 1,
-    'revision_id': 'D1'
+    'revision_id': 'D1',
+    'error_msg': '',
+    'result': None,
+}
+
+CANNED_LANDING_2 = {
+    'id': 2,
+    'status': 'started',
+    'request_id': 2,
+    'revision_id': 'D1',
+    'error_msg': '',
+    'result': None,
 }

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_LANDED
+)
 
 from tests.canned_responses.phabricator.revisions import *
 from tests.canned_responses.lando_api.revisions import *
@@ -40,12 +42,7 @@ def test_landing_revision(db, client, phabfactory):
 
     # test saved data
     landing = Landing.query.get(1)
-    assert landing.serialize() == {
-        'id': 1,
-        'request_id': 1,
-        'revision_id': 'D1',
-        'status': TRANSPLANT_JOB_STARTED
-    }
+    assert landing.serialize() == CANNED_LANDING_1
 
     response = client.post(
         '/landings?api_key=api-key',
@@ -60,12 +57,7 @@ def test_landing_revision(db, client, phabfactory):
 
     # test saved data
     landing = Landing.query.get(2)
-    assert landing.serialize() == {
-        'id': 2,
-        'request_id': 2,
-        'revision_id': 'D1',
-        'status': TRANSPLANT_JOB_STARTED
-    }
+    assert landing.serialize() == CANNED_LANDING_2
 
 
 def test_get_transplant_status(db, client):
@@ -112,3 +104,53 @@ 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):
+    Landing(1, 'D1', 'started').save(True)
+
+    response = client.post(
+        '/landings/1/update',
+        data=json.dumps({
+            'request_id': 1,
+            'landed': True,
+            'result': 'sha123'
+        }),
+        content_type='application/json'
+    )
+
+    assert response.status_code == 202
+    response = client.get('/landings/1')
+    assert response.json['status'] == TRANSPLANT_JOB_LANDED
+
+
+def test_update_landing_bad_id(db, client):
+    Landing(1, 'D1', 'started').save(True)
+
+    response = client.post(
+        '/landings/2/update',
+        data=json.dumps({
+            'request_id': 1,
+            'landed': True,
+            'result': 'sha123'
+        }),
+        content_type='application/json'
+    )
+
+    assert response.status_code == 404
+
+
+def test_update_landing_bad_request_id(db, client):
+    Landing(1, 'D1', 'started').save(True)
+
+    response = client.post(
+        '/landings/1/update',
+        data=json.dumps({
+            'request_id': 2,
+            'landed': True,
+            'result': 'sha123'
+        }),
+        content_type='application/json'
+    )
+
+    assert response.status_code == 404