tests: Fix mypy errors and enable mypy in PR workflow (#201)

* tests: Fix mypy errors

* PR workflow: Run mypy on examples and reformat step names

* tests: Update test_service.py to use a fixture and type annotations

* tests: Use object in type annotations instead of Any

* tests: Rerun Black

Author: bkeryan

.github/workflows/PR.yml

@@ -33,17 +33,19 @@ jobs:
         run: poetry install -vvv
       - name: Lint the Code
         run: poetry run ni-python-styleguide lint
-      - name: MyPy Static Analysis 
+      - name: Mypy static analysis (ni-measurementlink-service)
         run:  poetry run mypy -p ni_measurementlink_service --show-error-codes -v
-      - name: MyPy Static Analysis on examples
+      - name: Mypy static analysis (examples)
         # `mypy -p examples` doesn't import _helpers.py correctly, so check one example directory at a time.
         run: |
           for example in examples/*/; do 
             echo Analyzing $example
             poetry run mypy $example --show-error-codes -v
           done
-      - name: MyPy Static Analysis ni_measurementlink_generator
+      - name: Mypy static analysis (ni-measurementlink-generator)
         run:  poetry run mypy -p ni_measurementlink_generator --show-error-codes -v
+      - name: Mypy static analysis (tests)
+        run:  poetry run mypy tests --show-error-codes -v
 
   checks-nimg:
     runs-on: ubuntu-latest

tests/acceptance/test_measurement_service.py

@@ -77,12 +77,12 @@ def test___measurement_service___measure_with_large_array___returns_output(doubl
     assert measure_response.outputs.value == serialized_parameter
 
 
-def _host_service() -> int:
+def _host_service() -> str:
     measurement.sample_measurement_service.host_service()
-    return str(measurement.sample_measurement_service.grpc_service.port)
+    return measurement.sample_measurement_service.grpc_service.port
 
 
-def _create_channel(port):
+def _create_channel(port: str):
     return grpc.insecure_channel(
         "localhost:" + port,
         options=[

tests/integration/test_service_manager.py

@@ -1,22 +1,24 @@
 """Contains test to validate service_manager.py."""
+from typing import cast
+
 import grpc
 import pytest
 from examples.sample_measurement import measurement
 
 from ni_measurementlink_service._internal.discovery_client import DiscoveryClient
 from ni_measurementlink_service._internal.service_manager import GrpcService
+from ni_measurementlink_service._internal.stubs.ni.measurementlink.discovery.v1.discovery_service_pb2_grpc import (
+    DiscoveryServiceStub,
+)
 from ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1 import (
     measurement_service_pb2,
     measurement_service_pb2_grpc,
 )
 from tests.utilities.fake_discovery_service import FakeDiscoveryServiceStub
-from tests.utilities.fake_discovery_service import FakeDiscoveryServiceStubError
 
 
-def test___grpc_service___start_service___service_hosted():
+def test___grpc_service___start_service___service_hosted(grpc_service: GrpcService):
     """Test to validate if measurement service is started."""
-    grpc_service = GrpcService(DiscoveryClient(FakeDiscoveryServiceStub()))
-
     port_number = grpc_service.start(
         measurement.measurement_info,
         measurement.service_info,
@@ -28,10 +30,10 @@ def test___grpc_service___start_service___service_hosted():
     _validate_if_service_running_by_making_rpc(port_number)
 
 
-def test___grpc_service_without_discovery_service___start_service___service_hosted():
+def test___grpc_service_without_discovery_service___start_service___service_hosted(
+    grpc_service: GrpcService,
+):
     """Test to validate if measurement service start when the discovery service not available."""
-    grpc_service = GrpcService(DiscoveryClient(FakeDiscoveryServiceStubError()))
-
     port_number = grpc_service.start(
         measurement.measurement_info,
         measurement.service_info,
@@ -43,9 +45,8 @@ def test___grpc_service_without_discovery_service___start_service___service_host
     _validate_if_service_running_by_making_rpc(port_number)
 
 
-def test___grpc_service_started___stop_service___service_stopped():
+def test___grpc_service_started___stop_service___service_stopped(grpc_service: GrpcService):
     """Test to validate if measurement service is stopped."""
-    grpc_service = GrpcService(DiscoveryClient(FakeDiscoveryServiceStub()))
     port_number = grpc_service.start(
         measurement.measurement_info,
         measurement.service_info,
@@ -60,6 +61,24 @@ def test___grpc_service_started___stop_service___service_stopped():
         _validate_if_service_running_by_making_rpc(port_number)
 
 
+@pytest.fixture
+def grpc_service(discovery_client: DiscoveryClient) -> GrpcService:
+    """Create a GrpcService."""
+    return GrpcService(discovery_client)
+
+
+@pytest.fixture
+def discovery_client(discovery_service_stub: FakeDiscoveryServiceStub) -> DiscoveryClient:
+    """Create a DiscoveryClient."""
+    return DiscoveryClient(cast(DiscoveryServiceStub, discovery_service_stub))
+
+
+@pytest.fixture
+def discovery_service_stub() -> FakeDiscoveryServiceStub:
+    """Create a FakeDiscoveryServiceStub."""
+    return FakeDiscoveryServiceStub()
+
+
 def _validate_if_service_running_by_making_rpc(port_number):
     """Implicit validation of running service.
 

tests/unit/test_discovery_client.py

@@ -1,10 +1,19 @@
 """Contains tests to validate the discovery_client.py.
 """
-from ni_measurementlink_service._internal import discovery_client
+from typing import cast
+
+import pytest
+
+from ni_measurementlink_service._internal.discovery_client import (
+    DiscoveryClient,
+    _PROVIDED_MEASUREMENT_SERVICE,
+)
+from ni_measurementlink_service._internal.stubs.ni.measurementlink.discovery.v1.discovery_service_pb2_grpc import (
+    DiscoveryServiceStub,
+)
 from ni_measurementlink_service.measurement.info import ServiceInfo, MeasurementInfo
 from tests.utilities.fake_discovery_service import (
     FakeDiscoveryServiceStub,
-    FakeDiscoveryServiceStubError,
 )
 
 
@@ -17,53 +26,63 @@
 )
 
 
-def test___discovery_service_available___register_service___registration_success():
+def test___discovery_service_available___register_service___registration_success(
+    discovery_client: DiscoveryClient, discovery_service_stub: FakeDiscoveryServiceStub
+):
     """Test the successful registration when the discovery service is available."""
-    fake_discovery_service_stub = FakeDiscoveryServiceStub()
-    discovery_client_obj = discovery_client.DiscoveryClient(fake_discovery_service_stub)
-
-    registration_success_flag = discovery_client_obj.register_measurement_service(
+    registration_success_flag = discovery_client.register_measurement_service(
         _TEST_SERVICE_PORT, _TEST_SERVICE_INFO, _TEST_MEASUREMENT_INFO
     )
 
-    _validate_grpc_request(fake_discovery_service_stub.request)
+    _validate_grpc_request(discovery_service_stub.request)
     assert registration_success_flag
 
 
-def test___discovery_service_available___unregister_registered_service___un_registration_success():
+def test___discovery_service_available___unregister_registered_service___unregistration_success(
+    discovery_client: DiscoveryClient,
+):
     """Test the successful un-registration of registered service."""
-    fake_discovery_service_stub = FakeDiscoveryServiceStub()
-    discovery_client_obj = discovery_client.DiscoveryClient(fake_discovery_service_stub)
-    discovery_client_obj.register_measurement_service(
+    discovery_client.register_measurement_service(
         _TEST_SERVICE_PORT, _TEST_SERVICE_INFO, _TEST_MEASUREMENT_INFO
     )
 
-    un_registration_success_flag = discovery_client_obj.unregister_service()
+    unregistration_success_flag = discovery_client.unregister_service()
 
-    assert un_registration_success_flag
+    assert unregistration_success_flag
 
 
-def test___discovery_service_available___unregister_non_registered_service___un_registration_failure():
+def test___discovery_service_available___unregister_non_registered_service___unregistration_failure(
+    discovery_client: DiscoveryClient,
+):
     """Test the unsuccessful un-registration of non-registered service."""
-    fake_discovery_service_stub = FakeDiscoveryServiceStub()
-    discovery_client_obj = discovery_client.DiscoveryClient(fake_discovery_service_stub)
-
-    un_registration_success_flag = discovery_client_obj.unregister_service()
+    unregistration_success_flag = discovery_client.unregister_service()
 
-    assert ~un_registration_success_flag  # False
+    assert ~unregistration_success_flag  # False
 
 
-def test___discovery_service_unavailable___register_service_registration_failure():
+def test___discovery_service_unavailable___register_service_registration_failure(
+    discovery_client: DiscoveryClient,
+):
     """Test the unsuccessful registration when discovery service is not available."""
-    fake_discovery_service_stub = FakeDiscoveryServiceStubError()
-    discovery_client_obj = discovery_client.DiscoveryClient(fake_discovery_service_stub)
-    discovery_client_obj.register_measurement_service(
+    discovery_client.register_measurement_service(
         _TEST_SERVICE_PORT, _TEST_SERVICE_INFO, _TEST_MEASUREMENT_INFO
     )
 
-    un_registration_success_flag = discovery_client_obj.unregister_service()
+    unregistration_success_flag = discovery_client.unregister_service()
 
-    assert ~un_registration_success_flag  # False
+    assert ~unregistration_success_flag  # False
+
+
+@pytest.fixture
+def discovery_client(discovery_service_stub: FakeDiscoveryServiceStub) -> DiscoveryClient:
+    """Create a DiscoveryClient."""
+    return DiscoveryClient(cast(DiscoveryServiceStub, discovery_service_stub))
+
+
+@pytest.fixture
+def discovery_service_stub() -> FakeDiscoveryServiceStub:
+    """Create a FakeDiscoveryServiceStub."""
+    return FakeDiscoveryServiceStub()
 
 
 def _validate_grpc_request(request):
@@ -72,7 +91,4 @@ def _validate_grpc_request(request):
     assert request.service_description.service_class == _TEST_SERVICE_INFO.service_class
     assert request.service_description.description_url == _TEST_SERVICE_INFO.description_url
     assert request.service_description.display_name == _TEST_MEASUREMENT_INFO.display_name
-    assert (
-        discovery_client._PROVIDED_MEASUREMENT_SERVICE
-        in request.service_description.provided_interfaces
-    )
+    assert _PROVIDED_MEASUREMENT_SERVICE in request.service_description.provided_interfaces

tests/unit/test_service.py

@@ -1,15 +1,27 @@
 """Tests to validated user facing decorators in service.py."""
 import pytest
 
-from ni_measurementlink_service.measurement.info import DataType
-from ni_measurementlink_service.measurement.info import TypeSpecialization
+from ni_measurementlink_service.measurement.info import (
+    DataType,
+    MeasurementInfo,
+    ServiceInfo,
+    TypeSpecialization,
+)
 from ni_measurementlink_service.measurement.service import MeasurementService
 
 
-def test___measurement_service___register_measurement_method___method_registered():
-    """Test to validate register_measurement decorator."""
-    measurement_service = MeasurementService(None, None)
+_TEST_SERVICE_INFO = ServiceInfo("TestServiceClass", "TestUrl")
+_TEST_MEASUREMENT_INFO = MeasurementInfo(
+    display_name="TestMeasurement",
+    version="1.0.0.0",
+    ui_file_paths=[],
+)
 
+
+def test___measurement_service___register_measurement_method___method_registered(
+    measurement_service: MeasurementService,
+):
+    """Test to validate register_measurement decorator."""
     measurement_service.register_measurement(_fake_measurement_function)
 
     measurement_service.measure_function == _fake_measurement_function
@@ -31,12 +43,14 @@ def test___measurement_service___register_measurement_method___method_registered
     ],
 )
 def test___measurement_service___add_configuration__configuration_added(
-    display_name, type, default_value
+    measurement_service: MeasurementService,
+    display_name: str,
+    type: DataType,
+    default_value: object,
 ):
     """Test to validate the configuration decorator."""
-    measurement_service = MeasurementService(None, None)
-
     measurement_service.configuration(display_name, type, default_value)(_fake_measurement_function)
+
     assert any(
         param.display_name == display_name
         and param.type == type.value[0]
@@ -54,11 +68,13 @@ def test___measurement_service___add_configuration__configuration_added(
     ],
 )
 def test___measurement_service___add_pin_configuration__pin_configuration_added(
-    display_name, type, default_value, instrument_type
+    measurement_service: MeasurementService,
+    display_name: str,
+    type: DataType,
+    default_value: object,
+    instrument_type: str,
 ):
     """Test to validate the configuration decorator."""
-    measurement_service = MeasurementService(None, None)
-
     measurement_service.configuration(
         display_name, type, default_value, instrument_type=instrument_type
     )(_fake_measurement_function)
@@ -93,11 +109,12 @@ def test___measurement_service___add_pin_configuration__pin_configuration_added(
     ],
 )
 def test___measurement_service___add_non_pin_configuration__pin_type_annotations_not_added(
-    display_name, type, default_value
+    measurement_service: MeasurementService,
+    display_name: str,
+    type: DataType,
+    default_value: object,
 ):
     """Test to validate the configuration decorator."""
-    measurement_service = MeasurementService(None, None)
-
     measurement_service.configuration(display_name, type, default_value)(_fake_measurement_function)
 
     assert not all(
@@ -114,11 +131,12 @@ def test___measurement_service___add_non_pin_configuration__pin_type_annotations
     ],
 )
 def test___measurement_service___add_path_configuration__path_configuration_added(
-    display_name, type, default_value
+    measurement_service: MeasurementService,
+    display_name: str,
+    type: DataType,
+    default_value: object,
 ):
     """Test to validate the configuration decorator."""
-    measurement_service = MeasurementService(None, None)
-
     measurement_service.configuration(display_name, type, default_value)(_fake_measurement_function)
 
     assert any(
@@ -149,11 +167,12 @@ def test___measurement_service___add_path_configuration__path_configuration_adde
     ],
 )
 def test___measurement_service___add_non_path_configuration__path_type_annotations_not_added(
-    display_name, type, default_value
+    measurement_service: MeasurementService,
+    display_name: str,
+    type: DataType,
+    default_value: object,
 ):
     """Test to validate the configuration decorator."""
-    measurement_service = MeasurementService(None, None)
-
     measurement_service.configuration(display_name, type, default_value)(_fake_measurement_function)
 
     assert not all(
@@ -181,11 +200,12 @@ def test___measurement_service___add_non_path_configuration__path_type_annotatio
     ],
 )
 def test___measurement_service___add_configuration_with_mismatch_default_value__raises_type_error(
-    display_name, type, default_value
+    measurement_service: MeasurementService,
+    display_name: str,
+    type: DataType,
+    default_value: object,
 ):
     """Test to validate the configuration decorator with default value mismatch."""
-    measurement_service = MeasurementService(None, None)
-
     with pytest.raises(TypeError):
         measurement_service.configuration(display_name, type, default_value)(
             _fake_measurement_function
@@ -207,10 +227,10 @@ def test___measurement_service___add_configuration_with_mismatch_default_value__
         ("UInt44", DataType.UInt64),
     ],
 )
-def test___measurement_service___add_output__output_added(display_name, type):
+def test___measurement_service___add_output__output_added(
+    measurement_service: MeasurementService, display_name: str, type: DataType
+):
     """Test to validate the output decorator."""
-    measurement_service = MeasurementService(None, None)
-
     measurement_service.output(display_name, type)(_fake_measurement_function)
 
     assert any(
@@ -223,3 +243,9 @@ def test___measurement_service___add_output__output_added(display_name, type):
 
 def _fake_measurement_function():
     pass
+
+
+@pytest.fixture
+def measurement_service() -> MeasurementService:
+    """Create a MeasurementService."""
+    return MeasurementService(_TEST_MEASUREMENT_INFO, _TEST_SERVICE_INFO)