README.md

BAT Project Template

example python microservice project

Installation

install in developer mode from source

python setup.py develop

Install latest batconf from github branch

pip install git+ssh://[email protected]/lundybernard/batconf.git@main

Run Functional tests

Manually

start the web server on local host

bat start

run tests against the web server

python -m unittest functional_tests/service_test.py
pytest functional_tests/service_test.py

Run the service and tests via CLI

Install the package

python setup.py install
python setup.py develop

start webserver with cli

bat start

Run functional tests

bat test service
pytest functional_tests/service_test.py

Run Container tests

to validate the docker container works properly, and docker-compose works

Manual Test

Run the container with docker-compose and test it with functional_tests

docker-compose build
docker-compose up
pytest functional_tests/service_test.py

Automatic test

container_test will run docker-compose before each test case, and execute the test against the running container

python -m unittest container_tests/container_test.py
pytest container_tests/container_test.py

CLI

bat run_container_tests

rebuild local containers

sometimes necessary if container tests are failing

docker-compose down --rmi local
docker-compose build

Kubernetes deployment example:

1. install Microk8s

sudo snap install microk8s --classic
microk8s.start

2. Start a local Docker Registry

docker run -p 5001:5001 registry

3. Tag and Push the image to your docker registry

docker build -t bat-app ./
docker tag bat localhost:5001/bat-app
docker push localhost:5001/bat-app

4. Run the application and ingress

microk8s.kubectl apply -f k8/ingress.yml
microk8s.kubectl apply -f k8/bat-app-deployment.yml

5. enable ingress

microk8s.enable ingress

and verify

microk8s.kubectl get all -A

6. expose the application

microk8s.kubectl expose deployment bat-app --type=LoadBalancer --port=8080

7. test the endpoint

curl -kL https://127.0.0.1/bat-app