Check the status of landing jobs (bug 1375042)

Renamed Transplant to Landing in API, models, db schema.
Current API:
  - /landings
    POST - land the revision
    GET - get a list by revision and/or status
  - /landings/{id}
    GET - get a specific landing

Author: zalun

.gitignore

@@ -2,3 +2,4 @@ __pycache__
 /*.egg-info/
 /.cache/
 /docker-compose.override.yml
+*.pyc

README.md

@@ -53,3 +53,12 @@ Server: Werkzeug/0.12.1 Python/3.5.3
 
 Start a development server and expose its ports as documented above, and visit 
 `http://localhost:8000/ui/` in your browser to view the API documentation.
+
+## Testing
+
+We're using `pytest` with `pytest-flask`. All tests are placed in `./tests/`
+To run the tests please call
+
+```bash
+$ invoke test
+```

dev-requirements.txt

@@ -27,4 +27,3 @@ py==1.4.33 \
     --hash=sha256:1f9a981438f2acc20470b301a07a496375641f902320f70e31916fe3377385a9
 requests-mock==1.3.0 \
     --hash=sha256:23edd6f7926aa13b88bf79cb467632ba2dd5a253034e9f41563f60ed305620c7
-

docker-compose.yml

@@ -18,6 +18,7 @@ services:
       - PHABRICATOR_URL=https://mozphab.dev.mozaws.net
       - PHABRICATOR_UNPRIVILEGED_API_KEY=api-123456789
       - TRANSPLANT_URL=https://stub.transplant.example.com
+      - DATABASE_URL=sqlite:////sqlite.db
   py3-linter:
     build:
       context: ./

docker/Dockerfile-dev

@@ -4,7 +4,10 @@
 
 FROM python:3.5-alpine
 
+RUN apk --update --no-cache add \
+	sqlite
 ADD requirements.txt /requirements.txt
+ADD docker/db/schema.db /sqlite.db
 RUN pip install --no-cache -r /requirements.txt
 ADD dev-requirements.txt /dev-requirements.txt
 RUN pip install --no-cache -r /dev-requirements.txt

docker/Dockerfile-prod

@@ -7,6 +7,9 @@ FROM python:3.5-alpine
 RUN addgroup -g 1001 app && \
     adduser -D -u 1001 -G app -s /usr/sbin/nologin app
 
+RUN apk --update --no-cache add \
+	sqlite > /dev/null 2>&1
+
 COPY requirements.txt /requirements.txt
 RUN pip install --no-cache -r /requirements.txt
 

docker/db/schema.db

@@ -0,0 +1,73 @@
+# 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/.
+"""
+Transplant API
+See the OpenAPI Specification for this API in the spec/swagger.yml file.
+"""
+from connexion import problem
+from flask import request
+from landoapi.models.landing import (
+    Landing,
+    LandingNotCreatedException,
+    LandingNotFoundException,
+    RevisionNotFoundException,
+)
+
+
+def land(data, api_key=None):
+    """ API endpoint at /revisions/{id}/transplants to land revision. """
+    # get revision_id from body
+    revision_id = data['revision_id']
+    try:
+        landing = Landing.create(revision_id, api_key)
+    except RevisionNotFoundException:
+        # We could not find a matching revision.
+        return problem(
+            404,
+            'Revision not found',
+            'The requested revision does not exist',
+            type='https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404'
+        )
+    except LandingNotCreatedException:
+        # We could not find a matching revision.
+        return problem(
+            502,
+            'Landing not created',
+            'The requested revision does exist, but landing failed.'
+            'Please retry your request at a later time.',
+            type='https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502'
+        )
+
+    return {'id': landing.id}, 202
+
+
+def get_list(revision_id=None, status=None):
+    """ API endpoint at /landings to return all Landing objects related to a
+    Revision or of specific status.
+    """
+    kwargs = {}
+    if revision_id:
+        kwargs['revision_id'] = revision_id
+
+    if status:
+        kwargs['status'] = status
+
+    landings = Landing.query.filter_by(**kwargs).all()
+    return list(map(lambda l: l.serialize(), landings)), 200
+
+
+def get(landing_id):
+    """ API endpoint at /landings/{landing_id} to return stored Landing.
+    """
+    try:
+        landing = Landing.get(landing_id)
+    except LandingNotFoundException:
+        return problem(
+            404,
+            'Landing not found',
+            'The requested Landing does not exist',
+            type='https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404'
+        )
+
+    return landing.serialize(), 200

landoapi/api/landings.py

@@ -7,28 +7,13 @@
 """
 from connexion import problem
 from landoapi.phabricator_client import PhabricatorClient
-from landoapi.transplant_client import TransplantClient
 
 
 def get(revision_id, api_key=None):
-    """ API endpoint at /revisions/{id} to get revision data. """
-    phab = PhabricatorClient(api_key)
-    revision = phab.get_revision(id=revision_id)
+    """ Gets revision from Phabricator.
 
-    if not revision:
-        # We could not find a matching revision.
-        return problem(
-            404,
-            'Revision not found',
-            'The requested revision does not exist',
-            type='https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404'
-        )
-
-    return _format_revision(phab, revision, include_parents=True), 200
-
-
-def land(revision_id, api_key=None):
-    """ API endpoint at /revisions/{id}/transplants to land revision. """
+    Returns None or revision.
+    """
     phab = PhabricatorClient(api_key)
     revision = phab.get_revision(id=revision_id)
 
@@ -41,18 +26,7 @@ def land(revision_id, api_key=None):
             type='https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404'
         )
 
-    revision = _format_revision(phab, revision, include_parents=True)
-
-    trans = TransplantClient()
-<<<<<<< HEAD
-    id = trans.land('ldap_username@example.com', revision)
-=======
-    id = trans.land(
-        'ldap_username@example.com', revision['repo']['url'], 'patch',
-        'destination', 'push_bookmark', 'http://pingback.url'
-    )
->>>>>>> Land revision to a stub Transplant API (bug 1372538)
-    return {}, 202
+    return _format_revision(phab, revision, include_parents=True), 200
 
 
 def _format_revision(

landoapi/api/revisions.py

@@ -7,6 +7,7 @@
 import connexion
 from connexion.resolver import RestyResolver
 from landoapi.dockerflow import dockerflow
+from landoapi.models.storage import db
 
 
 def create_app(version_path):
@@ -17,8 +18,13 @@ def create_app(version_path):
     # Get the Flask app being wrapped by the Connexion app.
     flask_app = app.app
     flask_app.config['VERSION_PATH'] = version_path
-    flask_app.register_blueprint(dockerflow)
+    flask_app.config.setdefault(
+        'SQLALCHEMY_DATABASE_URI',
+        os.environ.get('DATABASE_URL', 'sqlite:////sqlite.db')
+    )
 
+    flask_app.register_blueprint(dockerflow)
+    db.init_app(flask_app)
     return app
 
 

landoapi/app.py

@@ -0,0 +1,122 @@
+# 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/.
+from landoapi.models.storage import db
+from landoapi.phabricator_client import PhabricatorClient
+from landoapi.transplant_client import TransplantClient
+
+TRANSPLANT_JOB_STARTED = 'started'
+TRANSPLANT_JOB_FINISHED = 'finished'
+
+
+def _get_revision(revision_id, api_key=None):
+    """ Gets revision from Phabricator.
+
+    Returns None or revision.
+    """
+    phab = PhabricatorClient(api_key)
+    revision = phab.get_revision(id=revision_id)
+    if not revision:
+        return None
+
+    raw_repo = phab.get_repo(revision['repositoryPHID'])
+    return {
+        'id': int(revision['id']),
+        'phid': revision['phid'],
+        'repo_url': raw_repo['uri'],
+        'title': revision['title'],
+        'url': revision['uri'],
+        'date_created': int(revision['dateCreated']),
+        'date_modified': int(revision['dateModified']),
+        'status': int(revision['status']),
+        'status_name': revision['statusName'],
+        'summary': revision['summary'],
+        'test_plan': revision['testPlan'],
+    }
+
+
+class Landing(db.Model):
+    __tablename__ = "landings"
+
+    id = db.Column(db.Integer, primary_key=True)
+    request_id = db.Column(db.Integer, unique=True)
+    revision_id = db.Column(db.String(30))
+    status = db.Column(db.Integer)
+
+    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
+
+    @classmethod
+    def create(cls, revision_id, phabricator_api_key=None, save=True):
+        """ Land revision and create a Transplant item in storage. """
+        revision = _get_revision(revision_id, phabricator_api_key)
+        if not revision:
+            raise RevisionNotFoundException(revision_id)
+
+        trans = TransplantClient()
+        request_id = trans.land(
+            'ldap_username@example.com', revision['repo_url']
+        )
+        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)
+
+        return landing
+
+    @classmethod
+    def get(cls, landing_id):
+        """ Get Landing object from storage. """
+        landing = cls.query.get(landing_id)
+        if not landing:
+            raise LandingNotFoundException()
+
+        return landing
+
+    def save(self, create=False):
+        """ Save objects in storage. """
+        if create:
+            db.session.add(self)
+
+        db.session.commit()
+        return self
+
+    def __repr__(self):
+        return '<Landing: %s>' % self.id
+
+    def serialize(self):
+        """ Serialize to JSON compatible dictionary. """
+        return {
+            'id': self.id,
+            'revision_id': self.revision_id,
+            'request_id': self.request_id,
+            'status': self.status
+        }
+
+
+class LandingNotCreatedException(Exception):
+    """ Transplant service failed to land a revision. """
+    pass
+
+
+class LandingNotFoundException(Exception):
+    """ No specific Landing was found in database. """
+    pass
+
+
+class RevisionNotFoundException(Exception):
+    """ Phabricator returned 404 for a given revision id. """
+
+    def __init__(self, revision_id):
+        super().__init__()
+        self.revision_id = revision_id

landoapi/models/__init__.py

@@ -0,0 +1,6 @@
+# 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/.
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()