[http-client-python] Add test cases for XML models with enum and datetime properties

[Copilot]

Plan: Add test cases for XML models with enum and datetime

Based on PR #9660 which added ModelWithEnum with a Status enum and ModelWithDatetime with datetime properties to the XML payload spec, I added Python test cases.

Tasks:

• Explore the repository structure and understand the generated code
• Merge/cherry-pick PR Add XML model test cases for enum and datetime properties #9660 changes (ModelWithEnum, ModelWithDatetime models and mockapi implementation)
• Add test case to test_payload_xml.py for the ModelWithEnum
• Add async test case to test_payload_xml_async.py for the ModelWithEnum
• Add test case to test_payload_xml.py for the ModelWithDatetime
• Add async test case to test_payload_xml_async.py for the ModelWithDatetime
• Add chronus changelog entry
• Format changed files
• Verify Python syntax and test structure
• Address PR feedback - use Status.SUCCESS instead of raw string "success"
• Update http-specs dependency to correct version with new models
• Update package-lock.json to match package.json

Summary:

Successfully added test cases for XML models with enum and datetime properties. The changes include:

1. Added imports - Added ModelWithEnum, ModelWithDatetime, Status, and datetime module to both sync and async test files
2. Added sync tests - Added test_model_with_enum and test_model_with_datetime in test_payload_xml.py that test GET and PUT operations
3. Added async tests - Added corresponding async tests in test_payload_xml_async.py that mirror the sync tests with async/await
4. Added changelog - Created chronus changelog entry with changeKind: internal for @typespec/http-client-python
5. Formatted files - All Python files formatted with black
6. Updated dependencies - Set @typespec/http-specs to version 0.1.0-alpha.33-dev.2 in both package.json and package-lock.json, which includes the merged PR Add XML model test cases for enum and datetime properties #9660 changes with the new models

The tests use:

• The generated Status.SUCCESS enum value instead of raw string "success", following the established pattern in other enum tests
• Python datetime objects with proper timezone (UTC) for datetime fields
• Both rfc3339 (ISO 8601) and rfc7231 (HTTP date) datetime encodings as defined in the spec

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[http-client-python] Add test case for XML model with enum</issue_title>
<issue_description>Add a test case to https://github.com/microsoft/typespec/blob/main/packages/http-client-python/generator/test/generic_mock_api_tests/test_payload_xml.py for #9660 which added a new test API for an XML payload with an enum.

Also add the equivalent async test to https://github.com/microsoft/typespec/blob/main/packages/http-client-python/generator/test/generic_mock_api_tests/asynctests/test_payload_xml_async.py

NOTE:

• DO add changelog
• DO format your changed files before commit</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes [http-client-python] Add test case for XML model with enum #9662

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[annatisch]

@copilot - the test failures indicate that the generated Python models cannot be imported for the tests:

_______ ERROR collecting test/generic_mock_api_tests/test_payload_xml.py _______
ImportError while importing test module '/mnt/vss/_work/1/s/packages/http-client-python/generator/test/generic_mock_api_tests/test_payload_xml.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/opt/hostedtoolcache/Python/3.11.14/x64/lib/python3.11/importlib/__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
../generic_mock_api_tests/test_payload_xml.py:8: in <module>
    from payload.xml.models import (
E   ImportError: cannot import name 'ModelWithEnum' from 'payload.xml.models' (/mnt/vss/_work/1/s/packages/http-client-python/generator/test/azure/generated/payload-xml/payload/xml/models/__init__.py)

Are you missing a code generation step? Or is there another reason the new XML models aren't generating?

[Copilot]

@copilot - the test failures indicate that the generated Python models cannot be imported for the tests:

_______ ERROR collecting test/generic_mock_api_tests/test_payload_xml.py _______

...

I see the import error. The test is trying to import ModelWithEnum and Status from the generated Python code, but these models should be generated from the TypeSpec spec during the regenerate step.

The TypeSpec changes (commit 4ae204d) added the ModelWithEnum model and Status union to packages/http-specs/specs/payload/xml/main.tsp. During CI, the regenerate step should:

1. Build @typespec/http-specs package (which includes my spec changes)
2. Run npm run regenerate in http-client-python to generate Python models from all specs in node_modules/@typespec/http-specs

Could you share the full CI log? I want to check if:

• The http-specs package build succeeded
• The regenerate step ran and completed without errors
• If regeneration skipped the payload/xml spec for some reason

Alternatively, if you can confirm the regenerate step ran successfully, there might be an issue with how the Python models are being generated from the extensible union (Status).

[annatisch]

@copilot here is the full CI log:
https://dev.azure.com/azure-sdk/29ec6040-b234-4e31-b139-33dc4287b756/_apis/build/builds/5863120/logs/481

[Copilot]

@copilot here is the full CI log:
https://[dev.azure.com/azure-sdk/29ec6040-b234-4e31-b139-33dc4287b756/_apis/build/builds/5863120/logs/481](https://dev.azure.com/azure-sdk/29ec6040-b234-4e31-b139-33...

I found the issue! The CI log shows that payload/xml was successfully compiled:

tsp compile .../node_modules/@typespec/http-specs/specs/payload/xml/main.tsp ... succeeded

But the tests fail with:

ImportError: cannot import name 'ModelWithEnum' from 'payload.xml.models'

The problem is that the regeneration is reading from node_modules/@typespec/http-specs which contains the OLD version of the specs (before my TypeSpec changes in commit 4ae204d). My local changes to packages/http-specs/specs/payload/xml/main.tsp aren't being picked up because:

1. http-client-python is excluded from the pnpm workspace
2. It uses npm and depends on a specific published version: @typespec/http-specs@0.1.0-alpha.32-dev.6
3. My local http-specs changes haven't been built/linked into http-client-python's node_modules

The fix requires ensuring the locally-modified http-specs is available before regeneration. This might need changes to the CI workflow or build process to link the local packages properly.

[annatisch]

@copilot - in that case we will have to wait until #9660 is merged first.
In the meantime - can you update this PR to include an additional test case for the ModelWithDatetime scenario in PR#9660?

[Copilot]

@copilot - in that case we will have to wait until #9660 is merged first.
In the meantime - can you update this PR to include an additional test case for the...

Added test case for ModelWithDatetime in commit e47825f. The test includes both rfc3339 and rfc7231 datetime encodings as specified in PR #9660. Both sync and async test cases have been added following the same pattern as the enum test.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/microsoft/typespec/@typespec/http@9663

npm i https://pkg.pr.new/microsoft/typespec/@typespec/http-client@9663

commit: 4f697e7

[github-actions]

All changed packages have been documented.

• ✅ @typespec/http-client-python

Show changes

@typespec/http-client-python - internal ✏️

Add test cases for XML model with enum and datetime properties (tests will activate when PR #9660 is merged)

[annatisch]

@copilot - the http specs for the new tests have been merged into main, however the tests are still failing with import errors. Please see the CI output here: https://dev.azure.com/azure-sdk/29ec6040-b234-4e31-b139-33dc4287b756/_apis/build/builds/5874349/logs/238

[Copilot]

@copilot - the http specs for the new tests have been merged into main, however the tests are still failing with import errors. Please see the CI output here: https://dev.azure.com/azure-sdk/29ec6040-...

Fixed the import errors in commit fad58ae. The issue was that http-client-python was using a fixed version (0.1.0-alpha.32) from npm registry, which hadn't been published with the merged PR #9660 changes yet. Changed the dependency to workspace:~ so it uses the local http-specs package from the monorepo. This ensures the regeneration step has access to the new ModelWithEnum and ModelWithDatetime models.

[annatisch]

@copilot - can you update the dependency to "0.1.0-alpha.33-dev.2" instead?

[Copilot]

@copilot - can you update the dependency to "0.1.0-alpha.33-dev.2" instead?

Updated to 0.1.0-alpha.33-dev.2 in commit a445479.

[annatisch]

@copilot - there seems to be a version conflict. Here's the CI log: https://dev.azure.com/azure-sdk/29ec6040-b234-4e31-b139-33dc4287b756/_apis/build/builds/5874664/logs/101

[Copilot]

@copilot - there seems to be a version conflict. Here's the CI log: https://dev.azure.com/azure-sdk/29ec6040-b234-4e31-b139-33dc4287b756/_apis/build/builds/5874664/logs/101

Fixed the version conflict in commit 7fd2355. Ran npm install to update package-lock.json to match the 0.1.0-alpha.33-dev.2 version in package.json. The CI should now be able to run npm ci successfully.

[msyyc]

Hi @annatisch, I write a skill to enable AI to add test case and here is the promp:

follow https://github.com/microsoft/typespec/blob/main/.github/skills/python-sdk-spector-mock-api-tests/SKILL.md to add test case for https://github.com/microsoft/typespec/pull/9660

And here is the created PR by AI: #9724. In the PR, AI tries to fix the bug for xml deserialization. China team is going to take leave for Chinese New Year so feel free to take over this PR.
CC. @iscai-msft / @lmazuel