#1523 - added test cases for following APIs (#1547) (#1553)

- Act section
  - EAO Teams
  - Positions
  - Project types
  - Regions
  - Responsibility
  - Work type
#1536 - Fixed issue with reports download API due to date format

Co-authored-by: Salabh A N <salabh.n@aot-technologies.com>

Author: saravanpa-aot

epictrack-api/src/api/resources/eao_team.py

@@ -16,8 +16,8 @@
 
 from flask import jsonify
 from flask_restx import Namespace, Resource, cors
-from api.schemas.eao_team import EAOTeamSchema
 
+from api.schemas.eao_team import EAOTeamSchema
 from api.services.eao_team_service import EAOTeamService
 from api.utils import auth, constants, profiletime
 from api.utils.caching import AppCache

epictrack-api/src/api/resources/phase.py

@@ -15,14 +15,15 @@
 
 from http import HTTPStatus
 
-from flask_restx import Namespace, Resource, cors
 from flask import jsonify
+from flask_restx import Namespace, Resource, cors
 
+from api.schemas import response as res
 from api.services.phaseservice import PhaseService
 from api.utils import auth, constants, profiletime
 from api.utils.caching import AppCache
 from api.utils.util import cors_preflight
-from api.schemas import response as res
+
 
 API = Namespace('phases', description='Phases')
 

epictrack-api/src/api/resources/region.py

@@ -16,21 +16,21 @@
 
 from flask import jsonify, request
 from flask_restx import Namespace, Resource, cors
-from api.schemas.region import RegionSchema
 
+from api.schemas import request as req
+from api.schemas.region import RegionSchema
 from api.services.region import RegionService
 from api.utils import auth, constants, profiletime
 from api.utils.caching import AppCache
 from api.utils.util import cors_preflight
 
-from api.schemas import request as req
 
 API = Namespace("regions", description="Regions")
 
 
 @cors_preflight("GET")
 @API.route("", methods=["GET", "OPTIONS"])
-class SubTypes(Resource):
+class Regions(Resource):
     """Endpoint resource to return regions based on region type."""
 
     @staticmethod
@@ -39,7 +39,7 @@ class SubTypes(Resource):
     @profiletime
     @AppCache.cache.cached(timeout=constants.CACHE_DAY_TIMEOUT, query_string=True)
     def get():
-        """Return all sub_types based on type."""
+        """Return all regions based on region type."""
         req.RegionTypePathParameterSchema().load(request.args)
         region_type = request.args.get("type", None)
         regions = RegionService.find_regions_by_type(region_type)

epictrack-api/src/api/resources/reports.py

@@ -77,7 +77,7 @@ class FileReport(Resource):
     @profiletime
     def post(report_type):
         """Generate report from given date."""
-        report_date = datetime.strptime(API.payload['report_date'], '%m-%d-%Y')
+        report_date = datetime.strptime(API.payload['report_date'], '%Y-%m-%d')
         filters = API.payload.get('filters', None)
         report, file_name = ReportService.generate_report(report_type, report_date, 'file', filters=filters)
         if report:

epictrack-api/tests/unit/apis/test_act_section.py

@@ -0,0 +1,27 @@
+# Copyright © 2019 Province of British Columbia
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Test suite for Act Section."""
+from http import HTTPStatus
+from urllib.parse import urljoin
+
+
+API_BASE_URL = '/api/v1/'
+
+
+def test_get_act_section_by_ea_act(client):
+    """Test get act section by EA Act."""
+    url = urljoin(API_BASE_URL, 'act-sections?ea_act_id=3')
+    result = client.get(url)
+    assert result.status_code == HTTPStatus.OK

epictrack-api/tests/unit/apis/test_milestones.py renamed to epictrack-api/tests/unit/apis/test_eao_teams.py

@@ -11,17 +11,17 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""Test suite for phases."""
 
+"""Test suite for EAO Teams."""
 from http import HTTPStatus
 from urllib.parse import urljoin
 
 
 API_BASE_URL = '/api/v1/'
 
 
-def test_get_phases(client):
-    """Test get phases."""
-    url = urljoin(API_BASE_URL, 'milestones/phases/11')
+def test_get_eao_teams(client):
+    """Test get EAO Teams."""
+    url = urljoin(API_BASE_URL, 'eao-teams')
     result = client.get(url)
     assert result.status_code == HTTPStatus.OK

epictrack-api/tests/unit/apis/test_phases.py

@@ -26,4 +26,10 @@ def test_get_phases(client):
     url = f'{url}/ea_acts/3/work_types/6'
     result = client.get(url)
     assert result.status_code == HTTPStatus.OK
-    assert 'milestones' in result.json[0]
+
+
+def test_get_all_phases(client):
+    """Test GET all phases."""
+    url = urljoin(API_BASE_URL, 'phases/')
+    result = client.get(url)
+    assert result.status_code == HTTPStatus.OK

epictrack-api/tests/unit/apis/test_positions.py

@@ -0,0 +1,27 @@
+# Copyright © 2019 Province of British Columbia
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Test suite for Positions."""
+from http import HTTPStatus
+from urllib.parse import urljoin
+
+
+API_BASE_URL = '/api/v1/'
+
+
+def test_get_positions(client):
+    """Test get positions."""
+    url = urljoin(API_BASE_URL, 'positions')
+    result = client.get(url)
+    assert result.status_code == HTTPStatus.OK

epictrack-api/tests/unit/apis/test_project_types.py

@@ -0,0 +1,27 @@
+# Copyright © 2019 Province of British Columbia
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Test suite for project types."""
+from http import HTTPStatus
+from urllib.parse import urljoin
+
+
+API_BASE_URL = '/api/v1/'
+
+
+def test_get_project_types(client):
+    """Test get project types."""
+    url = urljoin(API_BASE_URL, 'project-types')
+    result = client.get(url)
+    assert result.status_code == HTTPStatus.OK

epictrack-api/tests/unit/apis/test_projects.py

@@ -25,13 +25,17 @@ def test_create_project(client):
     payload = {
         "name": "New Project",
         "description": "Testing the create project endpoint",
-        "latitude": "54.2681",
-        "longitude": "-130.3828",
+        "location": "Victoria, BC",
+        "address": "Helsinki Airport, Artesaaninkuja, Lemminkäinen, Tuusula, Helsinki sub-region, \
+            Uusimaa, Southern Finland, Mainland Finland, 04360, Finland",
         "type_id": 1,
         "sub_type_id": 1,
         "proponent_id": 1,
         "region_id_env": 1,
         "region_id_flnro": 1,
+        "latitude": "54.2681",
+        "longitude": "-130.3828",
+        "abbreviation": "NP",
     }
     url = urljoin(API_BASE_URL, "projects")
     response = client.post(url, json=payload)
@@ -58,6 +62,9 @@ def test_update_project(client):
         "proponent_id": 1,
         "region_id_env": 1,
         "region_id_flnro": 1,
+        "type_id": 1,
+        "sub_type_id": 1,
+        "abbreviation": "NPC",
     }
     # Create a project
     url = urljoin(API_BASE_URL, "projects")
@@ -84,6 +91,9 @@ def test_delete_project(client):
         "proponent_id": 1,
         "region_id_env": 1,
         "region_id_flnro": 1,
+        "type_id": 1,
+        "sub_type_id": 1,
+        "abbreviation": "NPD",
     }
     # Create a project
     projects_url = urljoin(API_BASE_URL, "projects")
@@ -100,7 +110,7 @@ def test_delete_project(client):
 def test_project_detail(client):
     """Test project details."""
     payload = {
-        "name": "New Project for details",
+        "name": "New Project for details testing",
         "description": "Testing the create project endpoint",
         "latitude": "54.2681",
         "longitude": "-130.3828",
@@ -109,6 +119,7 @@ def test_project_detail(client):
         "proponent_id": 1,
         "region_id_env": 1,
         "region_id_flnro": 1,
+        "abbreviation": "NPDT",
     }
     # Create a project
     projects_url = urljoin(API_BASE_URL, "projects")

epictrack-api/tests/unit/apis/test_outcome.py renamed to epictrack-api/tests/unit/apis/test_regions.py

@@ -11,24 +11,23 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""Test suite for outcome."""
 
+"""Test suite for Region."""
 from http import HTTPStatus
 from urllib.parse import urljoin
 
 
 API_BASE_URL = '/api/v1/'
 
 
-def test_get_staff_by_position(client):
-    """Test get staff by position."""
-    url = urljoin(API_BASE_URL, 'outcomes/milestones/3')
+def test_get_regions_by_type(client):
+    """Test get regions by type."""
+    # type = ENV
+    url = urljoin(API_BASE_URL, 'regions?type=ENV')
     result = client.get(url)
     assert result.status_code == HTTPStatus.OK
 
-
-def test_get_all_active_staff(client):
-    """Test get all active staff."""
-    url = urljoin(API_BASE_URL, 'staffs')
+    # type = FLNR
+    url = urljoin(API_BASE_URL, 'regions?type=FLNR')
     result = client.get(url)
     assert result.status_code == HTTPStatus.OK

epictrack-api/tests/unit/apis/test_responsibility.py

@@ -0,0 +1,27 @@
+# Copyright © 2019 Province of British Columbia
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Test suite for Responsibilities."""
+
+from http import HTTPStatus
+from urllib.parse import urljoin
+
+
+API_BASE_URL = "/api/v1/"
+
+
+def test_get_all_responsibilities(client):
+    """Test get all responsibilities."""
+    url = urljoin(API_BASE_URL, "responsibilities")
+    result = client.get(url)
+    assert result.status_code == HTTPStatus.OK