1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
16 - Flask with Gevent serving
22 This project follows semver. When changes are made, the versions are in:
24 1) ``docs/release-notes.rst``
28 3) ``container-tag.yaml``
30 4) ``integration_tests/a1mediator/Chart.yaml``
32 5) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
34 6) in the ric-plt repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
40 As of 2020/02/13, A1 (Dockerfile), Dockerfile-Unit-Test, and all three
41 integration test receivers use an Alpine base image and install RMR
42 from a base builder image. Must update and rebuild all 5 containers
43 in the A1 repo (or just A1 itself for prod usage).
45 In addition these items in this repo must be kept in sync:
46 * ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins
47 * ``integration_tests/install_rmr.sh`` is a useful script for a variety of local testing.
49 Version bumping Python
50 ----------------------
52 If you want to update the version of python itself (ie just done from 37 to 38):
56 2) ``Dockerfile-Unit-Test``
63 Running the unit tests requires the python packages ``tox`` and ``pytest``.
65 The RMR library is also required during unit tests. If running directly from tox
66 (outside a Docker container), install RMR using the script in the integration_tests
67 directory: ``install_rmr.sh``.
69 Upon completion, view the test coverage like this:
74 open htmlcov/index.html
76 Alternatively, you can run the unit tests in Docker (this is somewhat
77 less nice because you don't get the pretty HTML)
81 docker build --no-cache -f Dockerfile-Unit-Test .
86 This tests A1’s external API with three test receivers. This requires
87 docker, kubernetes and helm.
93 docker build -t a1:latest .
94 cd integration_tests/testxappcode
95 docker build -t delayreceiver:latest -f Dockerfile-delay-receiver .
96 docker build -t queryreceiver:latest -f Dockerfile-query-receiver .
97 docker build -t testreceiver:latest -f Dockerfile-test-receiver .
100 Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
104 tox -c tox-integration.ini
107 1. Deploys 3 helm charts (5 containers) into a local kubernetes installation
108 2. Port forwards a pod ClusterIP to localhost
109 3. Uses “tavern” to run some tests against the server
110 4. Barrages the server with apache bench
111 5. Tears everything down