dojot / image-manager

Firmware image management service

Image Manager

[]

The Image Manager handles all CRUD operations related to dojot's firmware images.

Usage

These instructions are meant for development only. They should be run on the repository root and will execute the following:

1. Run the necessary environment (PostgreSQL and Minio) using Docker Compose
2. Build an image based on the current repository
3. Run the application inside Docker Compose network
4. Run the test application

Obs.: Using the option -v $PWD:/usr/src/app local/imagemanager will link the docker image application with the local development code; any changes in the code will update the application immediately using Flask's hot swap mechanism.

On terminal #1:

docker-compose -f local/compose.yml -p imgm up -d
docker build -f Dockerfile -t local/imagemanager .
docker run --rm -it --network imgm_default -p 8000:5000 --network-alias image-manager -v $PWD:/usr/src/app local/imagemanager

On terminal #2:

cd tests/
python3 client.py

image-manager's Issues

Add API tests

POST image metadata - OK
POST image metatadata missing Label - NOK / Assert database isn't changed
POST image metatadata missing FW version - NOK / Assert database isn't changed
POST image metatadata missing HW version - NOK / Assert database isn't changed
POST image metatadata missing SHA1 - NOK / Assert database isn't changed

POST image binary with existing metadata - OK/ Should update metadata with valid image
POST image binary with existing binary - OK?
POST image binary with missing metadata - NOK / DB untouched
POST imabe binary with invalid SHA1 - NOK / DB untouched

GET existing metadata - OK
GET non-existing metadata - NOK
GET existing binary - OK
GET non-existing binary - NOK
GET /image/ (list of all metadata) - OK / Should match uploaded metadata
GET /image/binary/ (list of all binaries) - OK / Should match uploaded binary

DELETE image metadata with non-existing binary - OK
DELETE image metadata with existing binary - OK / Binary should be deleted from DB
DELETE image binary - OK / metadata should be updated with missing binary
DELETE non-existing metadata - NOK
DELETE non-existing binary - NOK
DELETE /image/ - NOK
DELETE /image/binary/ - NOK

PUT image metadata on non-existing UUID - OK
PUT image metadata on existing UUID with matching SHA1 - OK
PUT image metadata on existing UUID with non-matching SHA1 - ERROR
PUT image binary on non-existing UUID - NOK
PUT image binary on existing UUID with matching SHA1 - OK
PUT image binary on existing UUID with non-matching SHA1 - NOK

Add API description file (.apib)

Standalone running instructions

There should be an easy to use, standalone procedure to run and test this service. Something in the lines of: dojot/device-manager#21 but preferably where you can access the service with no knowledge of the actual IP of the docker container, i.e. accessing via http://localhost:8000/image

Refactor DB access for consistency between Postgres and Minio

So far there is no unified approach for checking consistency between Minio and Postgres entries, each endpoint is responsible for its own sanity checking/exception handling and things are a bit clumsy. A rework is needed

Change codebase to Python3

Check SHA1 validity on file upload