Extend Dockerfile and improve documentation

[ric-plt/a1.git] / docs / developer-guide.rst

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index e3e47c5..d9a3a8a 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -1,8 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-Developer-Guide
-===============
+A1 Developer Guide
+==================
 
 .. contents::
    :depth: 3
@@ -14,10 +14,10 @@ Tech Stack
 -  OpenAPI3
 -  Connexion
 -  Flask with Gevent serving
--  Python3.7
+-  Python3.8
 
-Version bumping
----------------
+Version bumping A1
+------------------
 
 This project follows semver. When changes are made, the versions are in:
 
@@ -29,61 +29,72 @@ This project follows semver. When changes are made, the versions are in:
 
 4) ``integration_tests/a1mediator/Chart.yaml``
 
-6) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
+5) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
 
-7) in the it/dep repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
+6) in the ric-plt repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
 
 
-Version bumping rmr
---------------------
-rmr is a critical dependency of A1. Bumping the rmr version dependency requires changes in:
+Version bumping RMR
+-------------------
 
-1) ``Dockerfile``
+As of 2020/02/13, A1 (Dockerfile), Dockerfile-Unit-Test, and all three
+integration test receivers use an Alpine base image and install RMR
+from a base builder image.  Must update and rebuild all 5 containers
+in the A1 repo (or just A1 itself for prod usage).
 
-2) ``Dockerfile-Unit-Test``
+In addition these items in this repo must be kept in sync:
+* ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins
+* ``integration_tests/install_rmr.sh`` is a useful script for a variety of local testing.
 
-3) ``integration_tests/Dockerfile-test-delay-receiver``
+Version bumping Python
+----------------------
 
-4) ``integration_tests/Dockerfile-query-receiver``
+If you want to update the version of python itself (ie just done from 37 to 38):
 
-5) ``rmr-version.yaml``
+1) ``Dockerfile``
 
-rmr-python is the python binding to rmr . Installing rmr per the above does not install it.
-Bumping the rmr python version dependency requires changes in:
+2) ``Dockerfile-Unit-Test``
 
-1) ``setup.py``
+3) ``tox.ini``
 
-2) ``integration_tests/Dockerfile-test-delay-receiver``
+Unit Testing
+------------
 
-3) ``integration_tests/Dockerfile-query-receiver``
+Running the unit tests requires the python packages ``tox`` and ``pytest``.
 
-Run the integration tests after attempting this.
+The RMR library is also required during unit tests. If running directly from tox
+(outside a Docker container), install RMR using the script in the integration_tests
+directory: ``install_rmr.sh``.
 
-Unit Testing
-------------
-Note,  before this will work, for the first time on the machine running the tests, run ``./install_deps.sh``. This is only needed once on the machine.
-Also, this requires the python packages ``tox`` and ``pytest``.
+Upon completion, view the test coverage like this:
 
 ::
 
    tox
    open htmlcov/index.html
 
-Alternatively, you can run the unit tests in Docker (this is somewhat less nice because you don't get the pretty HTML)
+Alternatively, you can run the unit tests in Docker (this is somewhat
+less nice because you don't get the pretty HTML)
 
 ::
 
-   docker build  --no-cache -t a1test:latest -f Dockerfile-Unit-Test
+   docker build  --no-cache -f Dockerfile-Unit-Test .
 
 Integration testing
 -------------------
-This tests A1’s external API with three test receivers. This depends on helm+k8s.
 
-Build all the containers:
+This tests A1’s external API with three test receivers. This requires
+docker, kubernetes and helm.
+
+Build all the images:
 
 ::
 
-    docker build  -t a1:latest .; cd integration_tests/; docker build  -t testreceiver:latest . -f Dockerfile-test-delay-receiver; docker build -t queryreceiver:latest . -f Dockerfile-query-receiver; cd ..
+    docker build  -t a1:latest .
+    cd integration_tests/testxappcode
+    docker build -t delayreceiver:latest -f Dockerfile-delay-receiver .
+    docker build -t queryreceiver:latest -f Dockerfile-query-receiver .
+    docker build -t testreceiver:latest  -f Dockerfile-test-receiver  .
 
 
 Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
@@ -93,7 +104,7 @@ Then, run all the tests from the root (this requires the python packages ``tox``
    tox -c tox-integration.ini
 
 This script:
-1. Deploys 2 helm charts (4 containers) into a local kubernetes installation
+1. Deploys 3 helm charts (5 containers) into a local kubernetes installation
 2. Port forwards a pod ClusterIP to localhost
 3. Uses “tavern” to run some tests against the server
 4. Barrages the server with apache bench