Merge pull request 'flask-ML' (#5) from flask-ML into dev

Reviewed-on: #5

README.md

@@ -0,0 +1 @@
+Cat detection

docker/.dockerignore

@@ -0,0 +1,6 @@
+*.md
+/venv
+.git
+__pycache__
+.pytest_cache
+/tests

docker/Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.11
+
+WORKDIR /app
+
+COPY . /app
+
+RUN pip install --no-cache-dir -r requirements.txt
+
+EXPOSE 5000
+
+CMD ["python", "main.py"]

docker/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3.3'
+
+services:
+  cat-detection:
+    image: cat-detection
+    build:
+      context: ../
+      dockerfile: ./docker/Dockerfile
+    ports:
+      - "5000:5000"

language_label_mapper.py

@@ -1,3 +1,5 @@
+import os
+
 from jproperties import Properties
 
 """
@@ -10,9 +12,11 @@ from jproperties import Properties
 def translate(to_translate, lang):
     try:
         config = Properties()
+        script_directory = os.path.dirname(os.path.abspath(__file__))
+        resources_path = os.path.join(script_directory, "./resources")
 
         # Load properties file for given lang
-        with open(f"resources/{lang}.properties", 'rb') as config_file:
+        with open(os.path.join(resources_path, f"./{lang}.properties"), 'rb') as config_file:
             config.load(config_file, encoding='UTF-8')
 
         # Translate labels for given to_translate dictionary

main.py

@@ -103,4 +103,4 @@ def upload_file():
 
 
 if __name__ == '__main__':
-    app.run(debug=True)
+    app.run(host='0.0.0.0')

requirements.txt

@@ -2,4 +2,7 @@ flask==3.0.0
 numpy==1.26.3
 pillow==10.2.0
 keras==2.15.0
-jproperties==2.1.1
+jproperties==2.1.1
+tensorflow==2.15.0
+werkzeug==3.0.1
+pytest==7.4.4

scripts/build_image.bat

@@ -0,0 +1,24 @@
+@echo off
+chcp 65001 >nul
+
+docker -v >nul 2>&1
+if %errorlevel% neq 0 (
+    echo Docker is not installed.
+    exit /b 1
+)
+
+docker info >nul 2>&1
+if %errorlevel% neq 0 (
+    echo Docker engine is not running.
+    exit /b 1
+)
+
+cd ../docker
+echo Building docker image...
+docker compose build cat-detection
+if %errorlevel% neq 0 (
+    echo Building cdocker imagew failed.
+    exit /b 1
+)
+
+echo The image was built successfully.

scripts/build_image.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+export LC_ALL=C.UTF-8
+export LANG=C.UTF-8
+
+docker -v > /dev/null 2>&1
+if [ $? -ne 0 ]; then
+    echo -e "\033[31mDocker is not installed.\033[0m"
+    exit 1
+fi
+
+docker info > /dev/null 2>&1
+if [ $? -ne 0 ]; then
+    echo -e "\033[31mDocker engine is not running.\033[0m"
+    exit 1
+fi
+
+cd ../docker
+echo -e "\033[32mBuilding docker image...\033[0m"
+docker-compose build cat-detection
+
+if [ $? -ne 0 ]; then
+    echo -e "\033[31mBuilding docker image failed.\033[0m"
+    exit 1
+fi
+
+echo -e "\033[32mThe image was built successfully.\033[0m"

scripts/run_tests.bat

@@ -0,0 +1,14 @@
+@echo off
+echo Running unit tests.
+
+set PYTHONPATH=%CD%;%PYTHONPATH%
+
+cd %~dp0
+pytest ../tests
+
+if %ERRORLEVEL% equ 0 (
+    echo Tests passed successfully.
+) else (
+Tests failed.
+    echo Tests failed.
+)

scripts/start.bat

@@ -0,0 +1,8 @@
+@echo off
+chcp 65001 >nul
+
+docker compose -f ../docker/docker-compose.yml up cat-detection -d
+if %errorlevel% neq 0 (
+    echo Starting docker container failed.
+    exit /b 1
+)

scripts/start.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+export LC_ALL=C.UTF-8
+export LANG=C.UTF-8
+
+docker-compose -f ../docker/docker-compose.yml up cat-detection -d
+
+if [ $? -ne 0 ]; then
+    echo -e "\033[31mStarting docker container failed.\033[0m"
+    exit 1
+fi

tests/test_1.py

@@ -0,0 +1,19 @@
+import os
+
+from werkzeug.datastructures import FileStorage
+
+from main import app
+
+
+def test_upload_file():
+    with app.test_client() as test_client:
+        script_directory = os.path.dirname(os.path.abspath(__file__))
+        image_path = os.path.join(script_directory, "./img/tiger_cat/cat1.jpg")
+        image = FileStorage(
+            stream=open(image_path, "rb"),
+            filename="cat1.jpg",
+            content_type="image/jpeg",
+        )
+
+        response = test_client.post('/api/v1/detect-cat', data={'image': image}, content_type='multipart/form-data')
+        assert response.status_code == 200

validator.py

@@ -1,5 +1,3 @@
-import imghdr
-
 """
     Validation method.
     If everything fine then returns empty list.