Skip to content

{ARM} Add comments for JsonCTemplatePolicy #21991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhoxing-ms merged 2 commits into from
Apr 21, 2022
Merged

{ARM} Add comments for JsonCTemplatePolicy #21991

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ad0799
Refine JSONCtemplate policy
zhoxing-ms Apr 8, 2022
d00873d
Modify variable name
zhoxing-ms Apr 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions src/azure-cli/azure/cli/command_modules/resource/custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,8 +389,8 @@ def _deploy_arm_template_core_unmodified(cmd, resource_group_name, template_file


class JsonCTemplate:
def __init__(self, template_as_bytes):
self.template_as_bytes = template_as_bytes
def __init__(self, template_string):
self.template_string = template_string
Comment on lines -392 to +393
Copy link
Contributor Author

@zhoxing-ms zhoxing-ms Apr 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The template_as_bytes will be converted to bytes in the subsequent step of JsonCTemplatePolicy, but not in the step of JSONSerializer. So correct the variable name to avoid misleading

Copy link
Member

@jiasli jiasli Apr 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data is ambiguous. It can mean object or string. Let's call it template_str.



class JSONSerializer(Serializer):
Expand All @@ -408,6 +408,7 @@ def body(self, data, data_type, **kwargs):

class JsonCTemplatePolicy(SansIOHTTPPolicy):

# Obtain the template data from JsonCTemplate object, and then splice it with other properties into the JSONC format
def on_request(self, request):
http_request = request.http_request
request_data = getattr(http_request, 'data', {}) or {}
Expand All @@ -422,14 +423,19 @@ def on_request(self, request):
template = http_request.data["properties"]["template"]
if not isinstance(template, JsonCTemplate):
raise ValueError()

del http_request.data["properties"]["template"]

# templateLink nad template cannot exist at the same time in deployment_dry_run mode
if "templateLink" in http_request.data["properties"].keys():
del http_request.data["properties"]["templateLink"]
partial_request = json.dumps(http_request.data)

http_request.data = partial_request[:-2] + ", template:" + template.template_as_bytes + r"}}"
# The 'template' and other properties (such as 'parameters','mode'...) are spliced and encoded into the UTF-8 bytes as the request data
# The format of the request data is: {"properties": {"parameters": {...}, "mode": "Incremental", template:{\r\n "$schema": "...",\r\n "contentVersion": "...",\r\n "parameters": {...}}}
# This is not an ordinary JSON format, but it is a JSONC format that service can deserialize
# If not do this splicing, the request data generated by default serialization cannot be deserialized on the service side.
# Because the service cannot deserialize the template element: "template": "{\r\n \"$schema\": \"...\",\r\n \"contentVersion\": \"...\",\r\n \"parameters\": {...}}"
partial_request = json.dumps(http_request.data)
http_request.data = partial_request[:-2] + ", template:" + template.template_string + r"}}"
http_request.data = http_request.data.encode('utf-8')


Expand Down