etkirsch / postpyre Goto Github PK

Administrator task only.

This task will add Auth0 domain and audience to the webserver. It will also add route protections against unauthenticated users, shown as a preliminary GET route.

Developer Tasks

• Implement auth0.py
  • Credentials not necessary; the administration will add environment variables to webserver dynos
  • See auth0.py here for reference
• Add a route /about-self to the webserver
  • Route should only accept a GET
  • If un-identified, return 401 using the abort method
  • if identified, return the string success

Requirements

#4 Set up Auth0 site and Audience
#5 Create Heroku Dynos and PostgreSQL Resources

Admin task only.

If the user is authenticated, show a numeric input field (default 8, valid range is [1, 255]) and a button. When button is pressed, POST a payload (details below) to the server. Then generate a list of N uniformly random integers from 0 to 128 on server, return to React via the format below and display as table.

Route Details for /random:
Payload

{
    length: 5 // valid range is [1, 255]
}

Result

{
    randomized: [1, 29, 13, 245, 100]
}

Note: The /random route returns a 401 if the user did not pass valid jwt

Developer Tasks

• Implement /random on webserver
  • Accept POST only
  • Require Auth0 credentials, otherwise abort(401)
  • use random.uniform to generate a list of length N, where N is the length value in the payload
  • return the result as JSON using the format above
• Implement button and API call in UI
  • If the user is authorized, show a numeric input on the landing page that accepts inputs in the range of [1, 255]
  • If the user is authorized, show a button next to the numeric input with the text Generate
  • When the button is clicked, submit a POST call to /random on the webserver using the format of the payload above -- length should be set to the value of the numeric input
  • When the POST call resolves, display the data in an ordered list somewhere on the page -- design not important.
  • If the call fails with a 401, show a div in red text on the landing page that says "Webserver did not recognize credentials for most recent call."
  • If a call fails with a 401 but then a subsequent call resolves correctly, clear the error text from the bullet point above

No auth0 stuff -- reminder, add that tomorrow and flesh this out.

Erukar 2.0 requires a webserver that is cable of automatic CI-gated deployments. There are a few options which were considered but we will be moving forward with Python 3.8+, Flask, and SQLAlchemy hosted on Heroku dynos.

Developer Tasks

• Implement a basic webserver using Python 3.8 and Flask
  • Webserver code should be set up under ./webserver/ in this repository.
• Set up a heroku pipelines to have develop, qa, and prod dyno instances
  • The developer instance should automatically deploy the develop branch (gated by CI)
  • The QA instance should automatically deploy the master branch (gated by CI) and should have the option to promote to prod
  • prod has no automatic deployment and must be promoted from qa
• Add a PostgreSQL resource to all dynos on heroku
• Document dynos and pass credentials off to admins (@etkirsch and/or @NullVoxPopuli)
  • These will later be persisted in LastPass for all recognized developers to access

All builds for the Heroku develop and qa dynos must be gated by CI. We need to add a preliminary testing suite to the webserver code covering all functionality aside from direct routes.

Developer Criteria

• Add preliminary unit and integration testing to webserver
  • Route coverage is not necessary
• Implement CI gating on Heroku
  • develop dyno points to develop branch
  • qa dyno points to master branch

Prerequisites

#2 Create basic Python 3.8 Flask Webserver and Set up Heroku

Administrator task only.