test: Add end to end test (requires renaming golden record directories)

Author: Constantinos Symeonides

CONTRIBUTING.md

@@ -1,6 +1,5 @@
-""" Regenerate golden-record """
+""" Regenerate golden_record """
 import shutil
-import sys
 from pathlib import Path
 
 from typer.testing import CliRunner
@@ -11,7 +10,7 @@
     runner = CliRunner()
     openapi_path = Path(__file__).parent / "openapi.json"
 
-    gr_path = Path(__file__).parent / "golden-record"
+    gr_path = Path(__file__).parent / "golden_record"
     output_path = Path.cwd() / "my-test-api-client"
     config_path = Path(__file__).parent / "config.yml"
 

README.md

@@ -2,6 +2,7 @@
 from filecmp import cmpfiles, dircmp
 from pathlib import Path
 from typing import Dict, Optional
+from unittest.mock import ANY
 
 import pytest
 from typer.testing import CliRunner
@@ -49,7 +50,7 @@ def run_e2e_test(extra_args=None, expected_differences=None):
     runner = CliRunner()
     openapi_path = Path(__file__).parent / "openapi.json"
     config_path = Path(__file__).parent / "config.yml"
-    gr_path = Path(__file__).parent / "golden-record"
+    gr_path = Path(__file__).parent / "golden_record"
     output_path = Path.cwd() / "my-test-api-client"
     shutil.rmtree(output_path, ignore_errors=True)
 
@@ -79,3 +80,34 @@ def test_custom_templates():
         extra_args=["--custom-template-path=end_to_end_tests/test_custom_templates"],
         expected_differences={"README.md": "my-test-api-client"},
     )
+
+
+def test_file_upload(mocker):
+    # Arrange
+    from io import StringIO
+
+    from end_to_end_tests.golden_record.my_test_api_client.models import BodyUploadFileTestsUploadPost
+    from end_to_end_tests.golden_record.my_test_api_client.types import File
+
+    payload = StringIO("my payload")
+    file = File(payload=payload, file_name="my_file_name", mime_type="foo/bar")
+    multipart_data = BodyUploadFileTestsUploadPost(some_file=file, some_string="my_string")
+
+    base_url = "http://my.base.url"
+    client = mocker.MagicMock(base_url=base_url)
+    get = mocker.patch("httpx.post")
+
+    # Act
+    from .golden_record.my_test_api_client.api.tests import upload_file_tests_upload_post
+
+    upload_file_tests_upload_post.sync(client=client, multipart_data=multipart_data)
+
+    # Assert
+    get.assert_called_once_with(
+        url=f"{base_url}/tests/upload",
+        headers=ANY,
+        cookies=ANY,
+        timeout=ANY,
+        files={"some_file": ("my_file_name", payload, "foo/bar")},
+        data={"some_string": "my_string"},
+    )

end_to_end_tests/golden-record/.gitignore renamed to end_to_end_tests/golden_record/.gitignore

@@ -78,7 +78,7 @@ exclude = '''
     | openapi_python_client/templates
     | tests/test_templates
     | end_to_end_tests/test_custom_templates
-    | end_to_end_tests/golden-record-custom
+    | end_to_end_tests/golden_record_custom
   )/
 )
 '''