DX-2691 Add TN Lookup Integration Tests (#92)

* Begin integration tests

Bad lookup status response model related to the oas definition

changed the definition and regenerated the spec

* Regenerate so that createLookupResponse returns enum for status

* Finalize Integration tests for phoneNumberLookup API

* Improve tests

Remove unused tearDown function
Add a verizon (non-bw) number
add stronger logic to test order status
add regex testing for uuid
test each lookup result field for type and data (where possible)
add tests for 401 and 403 responses

* Update test.yaml

new requirements filename

* Update test.yaml

* Update test.yaml

Load secrets as envs

* Add python 3.10 to matrix testing

* Add tests for AT&T and T-Mobile Tns

* missed env variables in new tests

* Reusable `validateResult` function

* Move the polling logic into a separate function

* Create `validateAuthException` helper function

* Missed asserting anything in testDuplicatePhoneNumberLookup

* PEP8 Formatting

* Add function docstrings

* Change validateAuthException name

Use assertAuthException to match unittest assert names

* Document function return types

Author: ajrice6713

.gitignore

@@ -6,6 +6,9 @@ __pycache__/
 # C extensions
 *.so
 
+# MacOS Files 
+.DS_Store
+
 # Distribution / packaging
 .Python
 env/

.openapi-generator/FILES

@@ -45,9 +45,9 @@ bandwidth/model/forbidden_request.py
 bandwidth/model/list_message_direction_enum.py
 bandwidth/model/list_message_item.py
 bandwidth/model/lookup_request.py
+bandwidth/model/lookup_result.py
 bandwidth/model/lookup_status.py
 bandwidth/model/lookup_status_enum.py
-bandwidth/model/lookup_status_result_inner.py
 bandwidth/model/machine_detection_configuration.py
 bandwidth/model/machine_detection_mode_enum.py
 bandwidth/model/media.py
@@ -118,9 +118,9 @@ docs/ForbiddenRequest.md
 docs/ListMessageDirectionEnum.md
 docs/ListMessageItem.md
 docs/LookupRequest.md
+docs/LookupResult.md
 docs/LookupStatus.md
 docs/LookupStatusEnum.md
-docs/LookupStatusResultInner.md
 docs/MFAApi.md
 docs/MachineDetectionConfiguration.md
 docs/MachineDetectionModeEnum.md
@@ -202,9 +202,9 @@ test/test_forbidden_request.py
 test/test_list_message_direction_enum.py
 test/test_list_message_item.py
 test/test_lookup_request.py
+test/test_lookup_result.py
 test/test_lookup_status.py
 test/test_lookup_status_enum.py
-test/test_lookup_status_result_inner.py
 test/test_machine_detection_configuration.py
 test/test_machine_detection_mode_enum.py
 test/test_media.py

README.md

@@ -207,9 +207,9 @@ Class | Method | HTTP request | Description
  - [ListMessageDirectionEnum](docs/ListMessageDirectionEnum.md)
  - [ListMessageItem](docs/ListMessageItem.md)
  - [LookupRequest](docs/LookupRequest.md)
+ - [LookupResult](docs/LookupResult.md)
  - [LookupStatus](docs/LookupStatus.md)
  - [LookupStatusEnum](docs/LookupStatusEnum.md)
- - [LookupStatusResultInner](docs/LookupStatusResultInner.md)
  - [MachineDetectionConfiguration](docs/MachineDetectionConfiguration.md)
  - [MachineDetectionModeEnum](docs/MachineDetectionModeEnum.md)
  - [Media](docs/Media.md)

bandwidth.json

@@ -4156,7 +4156,58 @@
                         "type": "string"
                     },
                     "status": {
-                        "type": "string"
+                        "$ref": "#/components/schemas/lookupStatusEnum"
+                    }
+                }
+            },
+            "lookupResult": {
+                "type": "object", 
+                "description": "Carrier information results for the specified telephone number.",
+                "properties": {
+                    "Response Code": {
+                        "type": "integer",
+                        "description": "Our vendor's response code.",
+                        "example": 0
+                    },
+                    "Message": {
+                        "type": "string",
+                        "description": "Message associated with the response code.",
+                        "example": "NOERROR"
+                    },
+                    "E.164 Format": {
+                        "type": "string",
+                        "description": "The telephone number in E.164 format.",
+                        "example": "+19195551234"
+                    },
+                    "Formatted": {
+                        "type": "string",
+                        "description": "The formatted version of the telephone number.",
+                        "example": "(919) 555-1234"
+                    },
+                    "Country": {
+                        "type": "string",
+                        "description": "The country of the telephone number.",
+                        "example": "US"
+                    },
+                    "Line Type": {
+                        "type": "string",
+                        "description": "The line type of the telephone number.",
+                        "example": "Mobile"
+                    },
+                    "Line Provider": {
+                        "type": "string",
+                        "description": "The messaging service provider of the telephone number.",
+                        "example": "Verizon Wireless"
+                    },
+                    "Mobile Country Code": {
+                        "type": "string",
+                        "description": "The first half of the Home Network Identity (HNI).",
+                        "example": "310"
+                    },
+                    "Mobile Network Code": {
+                        "type": "string",
+                        "description": "The second half of the HNI.",
+                        "example": "010"
                     }
                 }
             },
@@ -4176,54 +4227,7 @@
                         "type": "array",
                         "description": "The carrier information results for the specified telephone number.",
                         "items": {
-                            "type": "object",
-                            "properties": {
-                                "Response Code": {
-                                    "type": "integer",
-                                    "description": "Our vendor's response code.",
-                                    "example": 0
-                                },
-                                "Message": {
-                                    "type": "string",
-                                    "description": "Message associated with the response code.",
-                                    "example": "NOERROR"
-                                },
-                                "E.164 Format": {
-                                    "type": "string",
-                                    "description": "The telephone number in E.164 format.",
-                                    "example": "+19195551234"
-                                },
-                                "Formatted": {
-                                    "type": "string",
-                                    "description": "The formatted version of the telephone number.",
-                                    "example": "(919) 555-1234"
-                                },
-                                "Country": {
-                                    "type": "string",
-                                    "description": "The country of the telephone number.",
-                                    "example": "US"
-                                },
-                                "Line Type": {
-                                    "type": "string",
-                                    "description": "The line type of the telephone number.",
-                                    "example": "Mobile"
-                                },
-                                "Line Provider": {
-                                    "type": "string",
-                                    "description": "The messaging service provider of the telephone number.",
-                                    "example": "Verizon Wireless"
-                                },
-                                "Mobile Country Code": {
-                                    "type": "string",
-                                    "description": "The first half of the Home Network Identity (HNI).",
-                                    "example": "310"
-                                },
-                                "Mobile Network Code": {
-                                    "type": "string",
-                                    "description": "The second half of the HNI.",
-                                    "example": "010"
-                                }
-                            }
+                            "$ref": "#/components/schemas/lookupResult"
                         }
                     },
                     "failedTelephoneNumbers": {

bandwidth/model/create_lookup_response.py

@@ -30,6 +30,10 @@
 from bandwidth.exceptions import ApiAttributeError
 
 
+def lazy_import():
+    from bandwidth.model.lookup_status_enum import LookupStatusEnum
+    globals()['LookupStatusEnum'] = LookupStatusEnum
+
 
 class CreateLookupResponse(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
@@ -67,6 +71,7 @@ def additional_properties_type():
         This must be a method because a model may have properties that are
         of type self, this must run after the class is loaded
         """
+        lazy_import()
         return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
 
     _nullable = False
@@ -81,9 +86,10 @@ def openapi_types():
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
             'request_id': (str,),  # noqa: E501
-            'status': (str,),  # noqa: E501
+            'status': (LookupStatusEnum,),  # noqa: E501
         }
 
     @cached_property
@@ -138,7 +144,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             request_id (str): [optional]  # noqa: E501
-            status (str): [optional]  # noqa: E501
+            status (LookupStatusEnum): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -225,7 +231,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             request_id (str): [optional]  # noqa: E501
-            status (str): [optional]  # noqa: E501
+            status (LookupStatusEnum): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)