graphql-engine/server/tests-py/jwk_server.py
Samir Talwar 8cb2738cbe server/tests-py: Declaratively state the HGE environment variables.
This has two purposes:

* When running the Python integration tests against a running HGE instance, with `--hge-url`, it will check the environment variables available and actively skip the test if they aren't set. This replaces the previous ad-hoc skip behavior.
* More interestingly, when running against a binary with `--hge-bin`, the environment variables are passed through, which means different tests can run with different environment variables.

  On top of this, the various services we use for testing now also provide their own environment variables, rather than expecting a test script to do it.

In order to make this work, I also had to invert the dependency between various services and `hge_ctx`. I extracted a `pg_version` fixture to provide the PostgreSQL version, and now pass the `hge_url` and `hge_key` explicitly to `ActionsWebhookServer`.

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6028
GitOrigin-RevId: 16d866741dba5887da1adf4e1ade8182ccc9d344
2022-09-28 09:21:02 +00:00

110 lines
3.8 KiB
Python

# A "fake" JWK server. Which returns `Cache-Control` and `Expires` headers in its response
# This is useful for testing our `jwk_url` behaviour
import datetime
from http import HTTPStatus
import http.server
import requests
from webserver import MkHandlers, RequestHandler, Response
def mkJSONResp(json_result):
return Response(HTTPStatus.OK, json_result, {'Content-Type': 'application/json'})
# fetch a valid JWK from google servers - this seemed easier than
# generating key pairs and then constructing a JWK JSON response
jwk_url = 'https://www.googleapis.com/service_accounts/v1/jwk/securetoken@system.gserviceaccount.com'
state = {
'cache-control': 0,
'expires': 0
}
class JwkExpiresHandler(RequestHandler):
def post(self, request):
return Response(HTTPStatus.METHOD_NOT_ALLOWED)
def get(self, request):
jwk_resp = requests.get(jwk_url)
res = jwk_resp.json()
resp = mkJSONResp(res)
if request.qs and 'error' in request.qs and 'true' in request.qs['error']:
resp.headers['Expires'] = 'invalid-value'
else:
if request.qs and 'seconds' in request.qs and len(request.qs['seconds']) > 0:
expires_in_secs = int(request.qs['seconds'][0])
else:
expires_in_secs = 3
expiry = datetime.datetime.utcnow() + datetime.timedelta(seconds=expires_in_secs)
resp.headers['Expires'] = datetime.datetime.strftime(expiry, "%a, %d %b %Y %T GMT")
state['expires'] += 1
return resp
class JwkCacheControlHandler(RequestHandler):
def post(self, request):
return Response(HTTPStatus.METHOD_NOT_ALLOWED)
def get(self, request):
jwk_resp = requests.get(jwk_url)
res = jwk_resp.json()
header_vals = []
if request.qs:
for param in request.qs:
if len(request.qs[param]) > 0:
val = request.qs[param][0]
if val == 'true':
header_vals.append(param)
elif val.isnumeric():
header_vals.append(param + "=" + val)
resp = mkJSONResp(res)
resp.headers['Cache-Control'] = ", ".join(header_vals)
# HGE should always prefer Cache-Control over Expires header
expiry = datetime.datetime.utcnow() + datetime.timedelta(seconds=600)
resp.headers['Expires'] = datetime.datetime.strftime(expiry, "%a, %d %b %Y %T GMT")
state['cache-control'] += 1
return resp
class StateHandler(RequestHandler):
def post(self, request):
return Response(HTTPStatus.METHOD_NOT_ALLOWED)
def get(self, request):
resp = mkJSONResp(state)
return resp
class ResetStateHandler(RequestHandler):
def post(self, request):
state['cache-control'] = 0
state['expires'] = 0
return Response(HTTPStatus.OK)
def get(self, request):
return Response(HTTPStatus.METHOD_NOT_ALLOWED)
handlers = MkHandlers({
# sending query string: `?field=smaxage`, will return Cache-Control with s-maxage, else with max-age
# sending query string: `error=true` will respond with invalid header value
'/jwk-cache-control': JwkCacheControlHandler,
# sending query string: `error=true` will respond with invalid header value
'/jwk-expires': JwkExpiresHandler,
# API so that testing can be done
'/state': StateHandler,
# Resets the state back to zeros
'/reset-state': ResetStateHandler
})
def create_server(host='127.0.0.1', port=5001):
return http.server.HTTPServer((host, port), handlers)
def stop_server(server):
server.shutdown()
server.server_close()
# if you want to run this module to emulate a JWK server during development
if __name__ == '__main__':
s = create_server(port=5001)
s.serve_forever()
stop_server(s)