images-farm

A practie using REST

Continuous Integration:

Instructions

Installation steps

1. Infra-structure:
   1. Install npm (Or make sure it is installed)
   2. Make sure virtualenv and python3 are installed. If not, you can: pip3 install virtualenv
2. setup

git clone [email protected]:sosi-org/image-farms.git
cd image-farms

./bin/preinstall.sh
#                    does: virtualenv -p /usr/bin/python3.5  ifarms
./bin/reinstall.sh
#                    installs flask, etc

source ifarms/bin/activate
#                   not literally essential. but recommended.

3. Run: Then: Run the server: (You can also use source ./bin/start_service.sh)

./bin/start_service.sh &

Finally, run the test as many times as you want:

./bin/test_api.sh

Important suggestion

For next task, I would use the appropriate locking mechanism when necessary. Although the requests are read-only, and the upload does not yield an image number until it is finished, but at some point a lock mechanism will be necessary. For example, when multiple requests are make on converting an object, one is not finished and the other request arrives. In that case, the produced cached image is not created. And the system may attempt to run the image generation twice. In such a case, a locking mechanism will be necessary. A simple mechanism is to generate a Lock object for each image created. There can be one for each cached sub-resource such as the converted image.

Notes

Note that if original is gif, convertion to gif creates a separate (cached) image.

The original image maintains the gif animation but after convrering back to gif, the animation will be naturally lost.

The images are stored in "folderhashs" (created based on sha256). This can be useful for defining partitions for scaling. The filenames are fixed. So that the storage will be secure.

The conversions to various image file formats are implemented. The converted files are cached (stored on disk).

Some tests are implemented using node.js.

This includes the upload test.

The upload will not receive the imageid (i.e. folderhashs)

The default imageid is 0, in which there is a preloaded image. For test purposes. All other image-id s are hash codes (folderhashs).

The upload is a simple POST method with a certainway of passing parameters.

The DELETE operation now works.

Examples

Examples: (for imageid=0)

http://localhost:5000/progimage.com/api/v1.0/all-local

http://localhost:5000/progimage.com/api/v1.0/0/original
http://localhost:5000/progimage.com/api/v1.0/0/jpeg
http://localhost:5000/progimage.com/api/v1.0/0/gif

http://localhost:5000/progimage.com/api/v1.0/0/upload

Suggestion: Some manual testing can be also done using Insomnia.

Future work

Next steps:

• A classic upload method that can be used with forms. The current upload can be renamed to .
• Check both /command and /command/
• Swagger documents (and its tests)
• Software configuration using ENV variables.

Copyright Sohail S. 2018