Merge pull request #112 from mapillary/Rubix982/Hotfix-For-Tests

[Testing] Hotfix For Tests

Author: Rubix982

Makefile

@@ -2,3 +2,6 @@
 
 style:
 	black src/mapillary && flake8 src/mapillary
+
+test:
+	@ pytest --log-cli-level=20

Pipfile.lock

@@ -0,0 +1,9 @@
+[pytest]
+log_format = %(asctime)s %(levelname)s %(message)s
+log_date_format = %Y-%m-%d %H:%M:%S
+filterwarnings = default
+                ignore:.*is deprecated.*:Warning
+                error::DeprecationWarning:importlib.*
+log_file = ./tests/log/tests.log
+markers =
+    smoke: for smoke testing

pytest.ini

@@ -1 +1,20 @@
-# Copyright (c) Facebook, Inc. and its affiliates. (http://www.facebook.com)
+# Copyright (c) Facebook, Inc. and its affiliates. (http://www.facebook.com)
+# -*- coding: utf-8 -*-
+
+"""
+tests.__init__
+
+This module loads the test modules under tests/
+
+:copyright: (c) 2021 Facebook
+:license: MIT LICENSE
+"""
+
+# Configuration
+from . import conftest  # noqa: F401
+
+# Utils testing
+from . import utils as tests_utils  # noqa: F401
+
+# Helper testing
+from . import helper as tests_helper  # noqa: F401

tests/__init__.py

@@ -0,0 +1,49 @@
+# Copyright (c) Facebook, Inc. and its affiliates. (http://www.facebook.com)
+# -*- coding: utf-8 -*-
+
+"""
+tests.conftest.py
+
+This module loads variables needed to run the test
+
+:copyright: (c) 2021 Facebook
+:license: MIT LICENSE
+"""
+
+# Package imports
+import pytest
+import requests
+import mercantile
+from vt2geojson.tools import vt_bytes_to_geojson
+
+@pytest.fixture(autouse=True)
+def mly_access_token():
+    """Specify the access token here"""
+
+    token = "MLY|YYY"
+
+    if "MLY|YYY" in token or "MLY|XXX" in token:
+        raise ValueError("[tests.conftest]: MLY Access Token is not specified")
+
+    return token
+
+
+@pytest.fixture(autouse=True)
+def data(mly_access_token):
+
+    zoom, longitude, latitude = 14, 31, 30
+
+    tile = mercantile.tile(lng=longitude, lat=latitude, zoom=zoom)
+
+    data = vt_bytes_to_geojson(
+        b_content=requests.get(
+            f"https://tiles.mapillary.com/maps/vtp/mly1_public/2/14/{tile[0]}/{tile[1]}/"
+            f"?access_token={mly_access_token}"
+        ).content,
+        x=tile.x,
+        y=tile.y,
+        z=tile.z,
+        layer="image",
+    )
+
+    return {"data": data, "tile": tile, "longitude": longitude, "latitude": latitude}

tests/conftest.py

@@ -38,9 +38,10 @@
     "UNDERLINE": "\033[4m",
 }
 
+
 def list_fetched_functions(fetched_functions: list) -> None:
     """Simply lists out the functions described in fetch.py along with their DocString
-    
+
     :param fetched_functions: List of function names along with their references in a tuple set
     :type fetched_functions: list
 
@@ -51,16 +52,15 @@ def list_fetched_functions(fetched_functions: list) -> None:
     # Through each tuple in the format (name, reference)
     for index, function in enumerate(fetched_functions):
 
-        # Print out ... 
+        # Print out ...
         print(
-
             # ... an index for the function, then the name of the function in cyan color ...
             f"{index + 1}. {colors['OKCYAN']}{function[0]}{colors['ENDC']} "
-
             # ... then print the docstring as well
             f"- {function[1].__doc__}"
         )
 
+
 def save_as_geojson(data: dict) -> None:
     """Saves the resulting geojson dictionary in a file tagged .geojson
 
@@ -74,11 +74,14 @@ def save_as_geojson(data: dict) -> None:
     # TODO: Test if this works perfectly fine in Windows, since it uses the `os` package
 
     # Save the file at the given path, create it if it does not exist
-    with open(f'{os.path.abspath(".")}/data/{sys.argv[2]}.geojson', mode='w') as geojson_file:
-        
+    with open(
+        f'{os.path.abspath(".")}/data/{sys.argv[2]}.geojson', mode="w"
+    ) as geojson_file:
+
         # Save the dictionary as a json in a clean formatted way
         json.dump(data, geojson_file, sort_keys=True, indent=4)
 
+
 def main():
     """Main logic for the CLI"""
 
@@ -88,18 +91,14 @@ def main():
     # If there are insufficient arguments
     if len(sys.argv) < 3:
 
-        # Log an error ... 
+        # Log an error ...
         logging.error(
-
             # ... indicating the source of the error ...
             " - client.py\n"
-
             # ... the reason for the error ...
             f"{colors['FAIL']}Invalid format!{colors['ENDC']}\n"
-
             # ... giving the user a format for the colors ...
             f"Try: python client.py {colors['BOLD']}'MLY|XXX'{colors['ENDC']} "
-
             # ... format of the function called
             f"{colors['OKCYAN']}fetch_function_here{colors['ENDC']}\n"
         )
@@ -127,21 +126,18 @@ def main():
         # If the results ends up empty
         if result == {}:
 
-            # Log an error ... 
+            # Log an error ...
             logging.error(
-
-                # ... indicating the source of the error ...                
+                # ... indicating the source of the error ...
                 " - client.py\n"
-
-            # ... the reason for the error                
+                # ... the reason for the error
                 f"{colors['FAIL']}Unrecognized function call!{colors['ENDC']}\n"
             )
 
             # Finally, list the functions for the user
             list_fetched_functions(fetched_functions=fetched_functions)
 
         # Saving the data
-        # TODO: Assumes user is working in Linux!
         save_as_geojson(result)
 
 

tests/helper/client.py

@@ -0,0 +1,17 @@
+# Copyright (c) Facebook, Inc. and its affiliates. (http://www.facebook.com)
+# -*- coding: utf-8 -*-
+
+"""
+tests.utils.__init__
+
+This module loads the modules under src/mapillary/utils for tests
+
+:copyright: (c) 2021 Facebook
+:license: MIT LICENSE
+"""
+
+# Exraction testing
+from . import test_extract  # noqa: F401
+
+# Filter testing
+from . import test_filter  # noqa: F401

tests/utils/__init__.py

@@ -11,32 +11,30 @@
 :license: MIT LICENSE
 """
 
-import requests
-import mercantile
-from vt2geojson.tools import vt_bytes_to_geojson
-from mapillary.utils.extract import extract_properties
+# Package imports
+import pytest
+import logging  # Logger
 
-def test_extract_properties(properties: list) -> dict:
+# Local imports
+from mapillary.utils.extract import extract_properties  # Function to test
+from tests.conftest import data  # Data as fixture
 
-    tile = mercantile.tile(lng=31, lat=30, zoom=14)
+logger = logging.getLogger(__name__)
 
-    data = vt_bytes_to_geojson(
-        b_content=requests.get(
-            f"https://tiles.mapillary.com/maps/vtp/mly1_public/2/14/{tile[0]}/{tile[1]}/?access_token=MLY|4352045404840373|b35c62c790e9b52c8476cfd08eb58704"
-        ).content,
-        x=tile.x,
-        y=tile.y,
-        z=tile.z,
-        layer="image",
-    )
 
-    extracted = extract_properties(data, properties)
+@pytest.mark.parametrize(
+    "operation, expected", [("extract_properties(data['data'], ['id'])", 0)]
+)
+def test_extract_properties(data: dict, operation, expected):
 
-    assert('id' in extracted)
+    # Operation to test
+    test_that = f"{operation} != {expected}"
 
-    assert(len(extracted['id']) != 0)
+    # Logging the intended operation to be tested
+    logger.info(f"\n[test_extract_properties] Test that {test_that}")
 
-    return {"Test": "Success"}
+    # Actual data on left, operation on right
+    actual = extract_properties(data["data"], ["id"])
 
-if __name__ == '__main__':
-    test_extract_properties(['id'])
+    # What was expected left, what was actual on the right
+    assert len(actual["id"]) != 0, f"{test_that} failed, got {actual}"