Merge pull request #55 from openagri-eu/main

Satellite Images, EU footer, New Reporting endpoints and TestBase Implementation

Author: fedjo

README.md

@@ -60,7 +60,7 @@ docker compose up
 
 The application will be served on http://127.0.0.1:8009 (I.E. typing localhost/docs in your browser will load the swagger documentation)
 
-Full list of APIs available you can check [here](https://editor-next.swagger.io/?url=https://gist.githubusercontent.com/JoleVLF/c29adf44808a683149426912383c75eb/raw/7b57a845ab37954424c0ef2108962fd248c6966f/api_v4.json)
+Full list of APIs available you can check [here](https://editor-next.swagger.io/?url=https://gist.githubusercontent.com/JoleVLF/7f5771b23a44e508b82e47d5fafd9f9c/raw/0ab48e33303efb114d7467a3ec1d8833fd62ff22/v5.json)
 # Documentation
 <h3>GET</h3>
 
@@ -211,14 +211,79 @@ If a valid JSON file is uploaded, the API processes the data directly to generat
 
 Response is uuid of generated PDF file.
 
+<h3>POST</h3>
+
+```
+/api/v1/openagri-report/pesticides-report/
+```
+
+## Request Params
+
+### pesticide_id
+- **Type**: `uudi str`
+- **Description**:  ID of Pesticide operation for which PDF is generated (optional)
+
+### data
+- **Type**: `UploadFile`
+- **Description**: API processes the data directly to generate the report if data passed. This parameter is not required and when it is, must be provided as an `UploadFile`.
+
+- ### from_date
+- **Type**: `date`
+- **Description**:  Optional date filter (from which data is filtered)
+
+- ### to_date
+- **Type**: `date`
+- **Description**:  AOptional date filter (until which data is filtered)
+
+- ### parcel_id
+- **Type**: `str`
+- **Description**:  Optional parcel filter.
+- 
+## Response
+
+Response is uuid of generated PDF file.
+
+<h3>POST</h3>
+
+
+```
+/api/v1/openagri-report/fertilization-report/
+```
+
+## Request Params
+
+### fertilization_id
+- **Type**: `uudi str`
+- **Description**:  ID of fert operation for which PDF is generated (optional)
+
+### data
+- **Type**: `UploadFile`
+- **Description**: API processes the data directly to generate the report if data passed. This parameter is not required and when it is, must be provided as an `UploadFile`.
+
+- ### from_date
+- **Type**: `date`
+- **Description**:  Optional date filter (from which data is filtered)
+
+- ### to_date
+- **Type**: `date`
+- **Description**:  AOptional date filter (until which data is filtered)
+
+- ### parcel_id
+- **Type**: `str`
+- **Description**:  Optional parcel filter.
+- 
+## Response
+
+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>
 

app/api/api_v1/endpoints/report.py

@@ -18,7 +18,7 @@
 from utils import decode_jwt_token
 from utils.animals_report import process_animal_data
 from utils.farm_calendar_report import process_farm_calendar_data
-from utils.irrigation_report import process_irrigation_data
+from utils.irrig_fert_pest_report import process_irrigation_fertilization_data
 from fastapi.responses import FileResponse
 
 router = APIRouter()
@@ -83,13 +83,13 @@ async def generate_irrigation_report(
     if data:
         data = data.file.read()
     background_tasks.add_task(
-        process_irrigation_data,
+        process_irrigation_fertilization_data,
         data=data,
         token=token,
         pdf_file_name=uuid_of_pdf,
         from_date=from_date,
         to_date=to_date,
-        irrigation_id=irrigation_id,
+        operation_id=irrigation_id,
         parcel_id=parcel_id
     )
 
@@ -194,3 +194,96 @@ async def generate_animal_report(
     )
 
     return PDF(uuid=uuid_v4)
+
+
+
+@router.post("/fertilization-report/", response_model=PDF)
+async def generate_fertilization_report(
+    background_tasks: BackgroundTasks,
+    token=Depends(deps.get_current_user),
+    fertilization_id: str = None,
+    data: UploadFile = None,
+    from_date: datetime.date = None,
+    to_date: datetime.date = None,
+    parcel_id: str = None
+):
+    """
+    Generates Fertilization Report PDF file
+
+    """
+    uuid_v4 = str(uuid.uuid4())
+    user_id = (
+        decode_jwt_token(token)["user_id"]
+        if settings.REPORTING_USING_GATEKEEPER
+        else token.id
+    )
+    uuid_of_pdf = f"{user_id}/{uuid_v4}"
+
+    if not data and not settings.REPORTING_USING_GATEKEEPER:
+        raise HTTPException(
+            status_code=400,
+            detail=f"Data file must be provided if gatekeeper is not used.",
+        )
+    if data:
+        data = data.file.read()
+    background_tasks.add_task(
+        process_irrigation_fertilization_data,
+        data=data,
+        token=token,
+        pdf_file_name=uuid_of_pdf,
+        from_date=from_date,
+        to_date=to_date,
+        operation_id=fertilization_id,
+        parcel_id=parcel_id,
+        irrigation_flag=False,
+        fertilization_flag=True
+    )
+
+    return PDF(uuid=uuid_v4)
+
+
+@router.post("/pesticides-report/", response_model=PDF)
+async def generate_pesticides_report(
+    background_tasks: BackgroundTasks,
+    token=Depends(deps.get_current_user),
+    pesticide_id: str = None,
+    data: UploadFile = None,
+    from_date: datetime.date = None,
+    to_date: datetime.date = None,
+    parcel_id: str = None
+):
+    """
+    Generates Pesticides Report PDF file
+
+    """
+    uuid_v4 = str(uuid.uuid4())
+    user_id = (
+        decode_jwt_token(token)["user_id"]
+        if settings.REPORTING_USING_GATEKEEPER
+        else token.id
+    )
+    uuid_of_pdf = f"{user_id}/{uuid_v4}"
+
+    if not data and not settings.REPORTING_USING_GATEKEEPER:
+        raise HTTPException(
+            status_code=400,
+            detail=f"Data file must be provided if gatekeeper is not used.",
+        )
+
+    if data:
+        data = data.file.read()
+
+    background_tasks.add_task(
+        process_irrigation_fertilization_data,
+        data=data,
+        token=token,
+        pdf_file_name=uuid_of_pdf,
+        from_date=from_date,
+        to_date=to_date,
+        operation_id=pesticide_id,
+        parcel_id=parcel_id,
+        irrigation_flag=False,
+        pesticides_flag= True
+    )
+
+    return PDF(uuid=uuid_v4)

app/assets/eu.png

@@ -25,6 +25,9 @@ class Settings(BaseSettings):
     REPORTING_FARMCALENDAR_BASE_URL: str = "api/proxy/farmcalendar/api/v1"
     REPORTING_FARMCALENDAR_URLS: dict = {
         "irrigations": "/IrrigationOperations/",
+        "fertilization": "/FertilizationOperations/",
+        "pesticides": "/CropProtectionOperations/",
+        "pest": "/Pesticides/",
         "activity_types": "/FarmCalendarActivityTypes/",
         "observations": "/Observations/",
         "operations": "/CompostOperations/",

app/core/config.py

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

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

@@ -10,10 +10,7 @@ class QuantityValue(BaseModel):
     unit: str
     numericValue: float
 
-
-class IrrigationOperation(BaseModel):
-    """Model for irrigation operations"""
-
+class GenericModel(BaseModel):
     type: str = Field(alias="@type")
     id: str = Field(alias="@id")
     activityType: Optional[dict] = None
@@ -24,5 +21,16 @@ class IrrigationOperation(BaseModel):
     responsibleAgent: Optional[str] = None
     usesAgriculturalMachinery: List[dict] = []
     hasAppliedAmount: QuantityValue
+
+class IrrigationOperation(GenericModel):
+    """Model for irrigation operations"""
     usesIrrigationSystem: Optional[Union[str, dict]] = None
     operatedOn: Optional[dict] = None
+
+class FertilizationOperation(IrrigationOperation):
+    hasApplicationMethod: Optional[str] = None
+    usesFertilizer: Optional[dict] = None
+
+class CropProtectionOperation(GenericModel):
+    operatedOn: Optional[dict] = None
+    usesPesticide: Optional[dict] = None

app/schemas/irrigation.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