Feature/satellite image (#14)

Author: JoleVLF

README.md

@@ -277,13 +277,13 @@ Response is uuid of generated PDF file.
 Response is uuid of generated PDF file.
 
 <h2>Pytest</h2>
-Pytest can be run on the same machine the service has been deployed to by moving into the tests dir and running:
+Pytest can be run on the same machine the service has been deployed to by moving into the app dir and running:
 
 ```
-pytest tests_.py 
+pytest
 ```
 
-This will run the tests and return success values for each api tested in the terminal.
+This will run all tests and return success values for each api tested in the terminal.
 
 <h3>These tests will NOT result in generated .pdf files.</h3>
 

pytest.ini app/pytest.inipytest.ini renamed to app/pytest.ini

@@ -1,3 +1,5 @@
 [pytest]
 env_files =
     testing.env
+pythonpath = .
+

tests/__init__.py app/tests/__init__.pytests/__init__.py renamed to app/tests/__init__.py

@@ -0,0 +1,93 @@
+from unittest import TestCase
+from unittest.mock import patch, MagicMock
+
+from fastapi import HTTPException
+import os
+
+REQUIRED_ENV_VARS = {
+    "REPORTING_GATEKEEPER_USERNAME": "mock_user",
+    "REPORTING_GATEKEEPER_PASSWORD": "mock_pass",
+    "REPORTING_BACKEND_CORS_ORIGINS": '["*"]',
+    "REPORTING_POSTGRES_USER": "mock_pg_user",
+    "REPORTING_POSTGRES_PASSWORD": "mock_pg_pass",
+    "REPORTING_POSTGRES_DB": "mock_db",
+    "REPORTING_POSTGRES_HOST": "mock_host",
+    "REPORTING_POSTGRES_PORT": "5432",
+    "REPORTING_SERVICE_NAME": "mock_service",
+    "REPORTING_SERVICE_PORT": "8000",
+    "REPORTING_GATEKEEPER_BASE_URL": "http://mock.gatekeeper",
+    "JWT_ACCESS_TOKEN_EXPIRATION_TIME": "3600",
+    "JWT_SIGNING_KEY": "mock_jwt_secret",
+    "PDF_DIRECTORY": "/",
+    "REPORTING_USING_GATEKEEPER": "True"
+}
+
+# TestReportAPI Class that will be used for unit test of report endpoints
+class TestReportAPI(TestCase):
+
+    CORRECT_TOKEN = 'eyJhbGciOiJIUzI1NiJ9.eyJJc3N1ZXIiOiJJc3N1ZXIifQ.HLkw6rgYSwcv0sE69OKiNQFvHoo-6VqlxC5nKuMmftg'
+    WRONG_TOKEN = "ayJhbGciOiJIUzI1NiJ9.eyJJc3N1ZXIiOiJJc3N1ZXIifQ.HLkw6rgYSwcv0sE69OKiNQFvHoo-6VqlxC5nKuMmftg"
+    BASE_URL = "/api/v1/openagri-report"
+
+    @staticmethod
+    def user_login(token):
+        if token == TestReportAPI.CORRECT_TOKEN:
+            return ""
+        else:
+            raise HTTPException(status_code=401, detail='Not Auth!')
+
+
+    def patch(self, obj, attr, value = None):
+        if value is None:
+            value = MagicMock()
+        patcher = patch.object(obj, attr, value)
+        self.addCleanup(patcher.stop)
+        return patcher.start()
+
+
+    def setUp(self):
+        for k, v in REQUIRED_ENV_VARS.items():
+            os.environ[k] = v
+
+        super().setUpClass()
+        from main import app
+        from api.api_v1.endpoints import report
+        from fastapi.testclient import TestClient
+        from api.deps import get_current_user
+
+        app.dependency_overrides[get_current_user] = TestReportAPI.user_login
+        self.patch(
+            report,
+            "decode_jwt_token",
+            MagicMock(return_value={"user_id": "123"})
+        )
+        self.client=TestClient(app)
+
+
+    def test_get_report_endpoint_not_auth(self):
+        response = self.client.get(f"{TestReportAPI.BASE_URL}/123/", headers={"X-Token": "OK"},
+                              params={"token": TestReportAPI.WRONG_TOKEN})
+        assert response.status_code == 401
+
+    def test_get_report_endpoint_auth_in_progress(self):
+        response = self.client.get(f"{TestReportAPI.BASE_URL}/123/", headers={"X-Token": "OK"},
+                          params={"token": TestReportAPI.CORRECT_TOKEN})
+        assert response.status_code == 202
+
+    def test_get_report_endpoint_success(self):
+        from api.api_v1.endpoints import report
+        from fastapi import Response
+        self.patch(
+            report,
+            "FileResponse",
+            MagicMock(return_value=Response(content=b"PDF", media_type="application/pdf"))
+        )
+
+        self.patch(
+            report.os.path,
+            "exists",
+            MagicMock(return_value=True)
+        )
+        response =  self.client.get(f"{TestReportAPI.BASE_URL}/123/", headers={"X-Token": "OK"},
+                          params={"token": TestReportAPI.CORRECT_TOKEN})
+        assert response.status_code == 200

app/tests/unit/__init__.py

@@ -16,7 +16,7 @@
     decode_dates_filters,
     get_parcel_info,
     get_farm_operation_data,
-    FarmInfo,
+    FarmInfo, display_pdf_parcel_details,
 )
 from utils.json_handler import make_get_request
 from geopy.geocoders import Nominatim
@@ -55,7 +55,7 @@ def __init__(
 
 
 def create_farm_calendar_pdf(
-    calendar_data: FarmCalendarData, token: dict[str, str]
+    calendar_data: FarmCalendarData, token: dict[str, str], parcel_id: str | None = None
 ) -> EX:
     """Create PDF report from farm calendar data"""
     pdf = EX()
@@ -85,6 +85,11 @@ def create_farm_calendar_pdf(
     pdf.line(pdf.l_margin, y_position, line_end_x, y_position)
     pdf.ln(5)
 
+    parcel_defined = False
+    if parcel_id and len(calendar_data.operations) > 1:
+        display_pdf_parcel_details(pdf, parcel_id, geolocator, token)
+        parcel_defined = True
+
     if len(calendar_data.operations) == 1:
         operation = calendar_data.operations[0]
 
@@ -175,8 +180,9 @@ def create_farm_calendar_pdf(
         ag = operation.responsibleAgent if operation.responsibleAgent else ""
         pdf.multi_cell(0, 8, ag, ln=True, fill=True, align="L")
 
-        pdf.set_font("FreeSerif", "B", 10)
-        pdf.cell(40, 8, "Initial Materials:")
+        pdf.set_font("FreeSerif", "B", 12)
+        pdf.set_x(15)
+        pdf.cell(40, 8, "Initial Materials")
         pdf.ln(15)
         if calendar_data.materials:
             with pdf.table(text_align="CENTER", padding=0.5, v_align=VAlign.M) as table:
@@ -204,10 +210,11 @@ def create_farm_calendar_pdf(
 
     if len(calendar_data.operations) > 1:
         calendar_data.operations.sort(key=lambda x: x.hasStartDatetime)
+        pdf.set_font("FreeSerif", "B", 12)
+        pdf.set_x(15)
+        pdf.cell(0, 10, "Operations", ln=True, align='L')
+        pdf.ln(5)
         with pdf.table(text_align="CENTER", padding=0.5) as table:
-            pdf.set_font("FreeSerif", "B", 12)
-            pdf.cell(0, 10, "Operations", ln=True)
-            pdf.ln(5)
 
             row = table.row()
             pdf.set_font("FreeSerif", "B", 10)
@@ -217,8 +224,9 @@ def create_farm_calendar_pdf(
             row.cell("End")
             row.cell("Agent")
             row.cell("Machinery IDs")
-            row.cell("Parcel")
-            row.cell("Farm")
+            if not parcel_defined:
+                row.cell("Parcel")
+                row.cell("Farm")
             row.cell("Compost Pile")
             row.cell("Responsible Agent")
             pdf.set_font("FreeSerif", "", 9)
@@ -275,9 +283,10 @@ def create_farm_calendar_pdf(
                         address = parcel_data.address
 
                 row.cell(f"{machinery_ids}")
-                row.cell(address)
-                farm_local = f"Name: {farm.name} | Municipality: {farm.municipality}"
-                row.cell(farm_local)
+                if not parcel_defined:
+                    row.cell(address)
+                    farm_local = f"Name: {farm.name} | Municipality: {farm.municipality}"
+                    row.cell(farm_local)
                 operation = calendar_data.operations[0]
                 cp = (
                     operation.isOperatedOn.get("@id").split(":")[3]
@@ -300,6 +309,7 @@ def create_farm_calendar_pdf(
         pdf.set_fill_color(0, 255, 255)
 
         pdf.set_font("FreeSerif", "B", 12)
+        pdf.set_x(15)
         pdf.cell(0, 10, "Data Table", ln=True)
         pdf.ln(5)
         types = {
@@ -440,44 +450,44 @@ def process_farm_calendar_data(
             if not operation_id:
                 # Check for generic response
                 if calendar_activity_type:
-                    params["name"] = calendar_activity_type
-                    farm_activity_type_info = make_get_request(
-                        url=f'{settings.REPORTING_FARMCALENDAR_BASE_URL}{settings.REPORTING_FARMCALENDAR_URLS["activity_types"]}',
-                        token=token,
-                        params=params,
-                    )
-
-                    del params["name"]
-
-                    if farm_activity_type_info:
-                        params["activity_type"] = farm_activity_type_info[0][
-                            "@id"
-                        ].split(":")[3]
-                        decode_dates_filters(params, from_date, to_date)
-                        observations = make_get_request(
-                            url=obs_url,
+                    if calendar_activity_type.strip() != "Compost Operation":
+                        params["name"] = calendar_activity_type
+                        farm_activity_type_info = make_get_request(
+                            url=f'{settings.REPORTING_FARMCALENDAR_BASE_URL}{settings.REPORTING_FARMCALENDAR_URLS["activity_types"]}',
                             token=token,
                             params=params,
                         )
 
+                        del params["name"]
+                        if farm_activity_type_info:
+
+                            params["activity_type"] = farm_activity_type_info[0][
+                                "@id"
+                            ].split(":")[3]
+                            decode_dates_filters(params, from_date, to_date)
+                            observations = make_get_request(
+                                url=obs_url,
+                                token=token,
+                                params=params,
+                            )
+                    else:
                         if parcel_id:
                             params["parcel"] = parcel_id
                         operations = make_get_request(
                             url=operation_url,
                             token=token,
                             params=params,
                         )
-
-                        del params["activity_type"]
-                        for o in operations:
-                            id = o["@id"].split(":")[3]
-                            get_farm_operation_data(
-                                id=id,
-                                materials=materials,
-                                params=params,
-                                observations=observations,
-                                token=token,
-                            )
+                        if operations:
+                            for o in operations:
+                                id = o["@id"].split(":")[3]
+                                get_farm_operation_data(
+                                    id=id,
+                                    materials=materials,
+                                    params=params,
+                                    observations=observations,
+                                    token=token,
+                                )
 
             else:
                 operation_url = f"{operation_url}{operation_id}/"
@@ -555,7 +565,7 @@ def process_farm_calendar_data(
                     materials=[],
                 )
 
-        pdf = create_farm_calendar_pdf(calendar_data, token)
+        pdf = create_farm_calendar_pdf(calendar_data, token, parcel_id)
         pdf_dir = f"{settings.PDF_DIRECTORY}{pdf_file_name}"
         os.makedirs(os.path.dirname(f"{pdf_dir}.pdf"), exist_ok=True)
         pdf.output(f"{pdf_dir}.pdf")

app/tests/unit/test_reports_endpoints.py

@@ -3,7 +3,7 @@
 
 import pandas as pd
 import matplotlib
-
+from core.config import settings
 from utils import get_pesticide
 
 matplotlib.use("Agg")
@@ -14,8 +14,10 @@
 
 
 def get_pest_from_obj(pt: CropProtectionOperation, token: dict | str):
-    pest_id = pt.usesPesticide.get("@id", None) if pt.usesPesticide else None
     pest_name = ""
+    if not settings.REPORTING_USING_GATEKEEPER:
+        return pest_name
+    pest_id = pt.usesPesticide.get("@id", None) if pt.usesPesticide else None
     if pest_id:
         pest_id = pest_id.split(":")[3]
         pest = get_pesticide(pest_id, token)