Skip to content

bicep: Support @sealed() decorator on user defined types #4684

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
rajeshkamal5050 merged 1 commit into from
Jan 10, 2025
Merged

bicep: Support @sealed() decorator on user defined types #4684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 46 additions & 12 deletions cli/azd/pkg/azure/arm_template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ type ArmTemplateParameterDefinitions map[string]ArmTemplateParameterDefinition

type ArmTemplateOutputs map[string]ArmTemplateOutput

type ArmTemplateParameterAdditionalProperties struct {
type ArmTemplateParameterAdditionalPropertiesProperties struct {
Type string `json:"type"`
MinValue *int `json:"minValue,omitempty"`
MaxValue *int `json:"maxValue,omitempty"`
Expand All @@ -66,18 +66,52 @@ type ArmTemplateParameterAdditionalProperties struct {
Metadata map[string]json.RawMessage `json:"metadata"`
}

type ArmTemplateParameterAdditionalPropertiesValue struct {
props *ArmTemplateParameterAdditionalPropertiesProperties
}

func (v ArmTemplateParameterAdditionalPropertiesValue) HasAdditionalProperties() bool {
return v.props != nil
}

func (v ArmTemplateParameterAdditionalPropertiesValue) Properties() ArmTemplateParameterAdditionalPropertiesProperties {
return *v.props
}

func (v *ArmTemplateParameterAdditionalPropertiesValue) UnmarshalJSON(data []byte) error {
if string(data) == "false" {
return nil
}

var props ArmTemplateParameterAdditionalPropertiesProperties
if err := json.Unmarshal(data, &props); err != nil {
return err
}

v.props = &props
return nil
}

func (v *ArmTemplateParameterAdditionalPropertiesValue) MarshalJSON() ([]byte, error) {
if v.props == nil {
return []byte("false"), nil
}

return json.Marshal(v.props)
}

type ArmTemplateParameterDefinition struct {
Type string `json:"type"`
DefaultValue any `json:"defaultValue"`
AllowedValues *[]any `json:"allowedValues,omitempty"`
MinValue *int `json:"minValue,omitempty"`
MaxValue *int `json:"maxValue,omitempty"`
MinLength *int `json:"minLength,omitempty"`
MaxLength *int `json:"maxLength,omitempty"`
Metadata map[string]json.RawMessage `json:"metadata"`
Ref string `json:"$ref"`
Properties ArmTemplateParameterDefinitions `json:"properties,omitempty"`
AdditionalProperties ArmTemplateParameterAdditionalProperties `json:"additionalProperties,omitempty"`
Type string `json:"type"`
DefaultValue any `json:"defaultValue"`
AllowedValues *[]any `json:"allowedValues,omitempty"`
MinValue *int `json:"minValue,omitempty"`
MaxValue *int `json:"maxValue,omitempty"`
MinLength *int `json:"minLength,omitempty"`
MaxLength *int `json:"maxLength,omitempty"`
Metadata map[string]json.RawMessage `json:"metadata"`
Ref string `json:"$ref"`
Properties ArmTemplateParameterDefinitions `json:"properties,omitempty"`
AdditionalProperties *ArmTemplateParameterAdditionalPropertiesValue `json:"additionalProperties,omitempty"`
}

func (d *ArmTemplateParameterDefinition) Secure() bool {
Expand Down
35 changes: 33 additions & 2 deletions cli/azd/pkg/infra/provisioning/bicep/bicep_provider_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1032,17 +1032,18 @@ func TestUserDefinedTypes(t *testing.T) {
},
objectParam.Properties)
require.NotNil(t, objectParam.AdditionalProperties)
Comment thread
vhvb1989 marked this conversation as resolved.
require.True(t, objectParam.AdditionalProperties.HasAdditionalProperties())
require.Equal(
t,
azure.ArmTemplateParameterAdditionalProperties{
azure.ArmTemplateParameterAdditionalPropertiesProperties{
Type: "string",
MinLength: to.Ptr(10),
Metadata: map[string]json.RawMessage{
"fromDefinitionFoo": []byte(`"foo"`),
"fromDefinitionBar": []byte(`"bar"`),
},
},
objectParam.AdditionalProperties)
objectParam.AdditionalProperties.Properties())
require.NotNil(t, objectParam.Metadata)
require.Equal(
t,
Expand All @@ -1056,6 +1057,21 @@ func TestUserDefinedTypes(t *testing.T) {
},
objectParam.Metadata)

sealedObjectParam, exists := template.Parameters["sealedObjectParam"]
require.True(t, exists)
require.Equal(t, "object", sealedObjectParam.Type)
require.Nil(t, sealedObjectParam.AllowedValues)
require.NotNil(t, sealedObjectParam.Properties)
require.Equal(
t,
azure.ArmTemplateParameterDefinitions{
"name": {Type: "string"},
"sku": {Type: "string"},
},
sealedObjectParam.Properties)
require.NotNil(t, sealedObjectParam.AdditionalProperties)
require.False(t, sealedObjectParam.AdditionalProperties.HasAdditionalProperties())

// output resolves just the type. Value and Metadata should persist
customOutput, exists := template.Outputs["customOutput"]
require.True(t, exists)
Expand Down Expand Up @@ -1211,6 +1227,18 @@ const userDefinedParamsSample = `{
"fromDefinitionFoo": "foo",
"fromDefinitionBar": "bar"
}
},
Comment thread
vhvb1989 marked this conversation as resolved.
"sealedObjectType": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"sku": {
"type": "string"
}
},
"additionalProperties": false
}
},
"parameters": {
Expand Down Expand Up @@ -1242,6 +1270,9 @@ const userDefinedParamsSample = `{
"fromDefinitionBar": "override",
"fromParameter": "parameter"
}
},
"sealedObjectParam": {
"$ref": "#/definitions/sealedObjectType"
}
},
"resources": {},
Expand Down