Skip to content

Latest commit

 

History

History
109 lines (84 loc) · 4.59 KB

README.md

File metadata and controls

109 lines (84 loc) · 4.59 KB
Raw

AMP Test Status Bot

A GitHub App that reports the status of different test types on the AMPHTML repository.

This app runs on an instance of Google AppEngine and is installed exclusively on ampproject/amphtml.

Interfaces

GitHub Webhooks

The App subscribes to the following GitHub Webhooks:

  • PullRequestEvent (opened and synchronize actions)
    • Records the head SHA to enable creating checks on the pull request

API for CI Runs

The App has the following API points, which are to be triggered from CI runs.

  • POST /v0/tests/:headSha/:type/:subType/:status(queued|started|skipped)
    • Creates a new check on the supplied head commit (for status = queued or skipped) or reports that the type/subType tests have started running.
  • POST /v0/tests/:headSha/:type/:subType/report/:passed/:failed
    • Updates the equivalent check with the number of passed and failed tests
    • If failed is 0, sets the check's conclusion to success, which turns the check green
    • If failed ≥ 1, sets the check's conclusion to action_required, which turns the check red.

Local development

Setup

Follow these setup instructions to start developing for this App locally:

  1. Clone this repository and cd into the test-status directory
  2. npm install
  3. Run a local instance of PostgreSQL, or use the Cloud SQL Proxy
    • While other database engines might work, we have only tested this on pg
  4. Start a new Smee channel. This can be used to proxy GitHub webhooks to your local machine
  5. Create a new GitHub App:
    • Give your app a name
    • Set the Homepage and Webhook URL fields to the Smee channel that you created above
    • Set the User authorization callback URL to http://localhost:3000/login/callback
    • Set the Webhook secret to a random, secure value
    • Give the App Read & Write permissions on Checks, and Read only on Pull requests
    • Subscribe to the Pull request events
    • None of the other fields are required
  6. After creating the application, generate and download a private key. Also take note of the App ID, Client ID, and Client secret
  7. Install the application on a GitHub repository that you want to use for testing. You might want to create a new repository for this purpose.
  8. Copy the redacted.env file to .env and modify the fields based on the instructions in that file and the values from the GitHub App page
    • The value for the PRIVATE_KEY field is a base64 representation of the .pem file you downloaded from the GitHub App page. On Linux/Mac you can convert that file by running cat private-key-file.pem | base64 in a command line
  9. npm run dev
    • This will reload the App on every file change. Quit the server with <Ctrl> + C or <Cmd> + C

If there are no errors after running the last command then the App is running locally on your machine.

Testing locally

Now, create a pull request on your testing repo (which should be caught by the app via the GitHub webhook - see the console logs where you ran npm run dev).

Then, send POST requests the various API end-points. e.g., (where [HEAD_SHA] is the head SHA of the branch that the pull request was created from):

  • POST http://localhost:3000/v0/tests/[HEAD_SHA]/unit/queued
  • POST http://localhost:3000/v0/tests/[HEAD_SHA]/unit/started
  • POST http://localhost:3000/v0/tests/[HEAD_SHA]/unit/report/50/0
  • POST http://localhost:3000/v0/tests/[HEAD_SHA]/e2e/queued
  • POST http://localhost:3000/v0/tests/[HEAD_SHA]/sauce-labs/queued
  • POST http://localhost:3000/v0/tests/[HEAD_SHA]/sauce-labs/started
  • POST http://localhost:3000/v0/tests/[HEAD_SHA]/sauce-labs/report/50/1

Sending all of the above requests in sequence will create 3 checks on the pull request: for unit tests with 50 passed tests and 0 failures (green check), for e2e tests that are still "queued" to execute, and for sauce-labs tests with 50 passed tests and 1 failure (red check).

Finally, follow the Resolve link in the details page of the failed tests check from above. This should redirect you to the web interface (passing through GitHub's initial app authorization/login screen) where you can follow the form to skip the test, turning it green.

Deployment

This GitHub App is deployed on an AppEngine instance: https://amp-test-status-bot.appspot.com/