Skip to content

Commit

Permalink
Rename plural properties to singular for consistency
Browse files Browse the repository at this point in the history 
`secrets` to `secret`
`registries` to `registry`
  • Loading branch information
@oWretch
oWretch committed May 27, 2024
1 parent e3b8432 commit 718da53
Show file tree
Hide file tree
Showing 3 changed files with 145 additions and 20 deletions.
147 changes: 136 additions & 11 deletions internal/services/containerapps/container_app_job_resource.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (

"github.com/hashicorp/go-azure-helpers/lang/pointer"
"github.com/hashicorp/go-azure-helpers/lang/response"
"github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema"
"github.com/hashicorp/go-azure-helpers/resourcemanager/identity"
"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
Expand All @@ -19,9 +20,11 @@ import (
"github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2023-05-01/jobs"
"github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2023-05-01/managedenvironmentsstorages"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-provider-azurerm/internal/features"
"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
"github.com/hashicorp/terraform-provider-azurerm/internal/services/containerapps/helpers"
"github.com/hashicorp/terraform-provider-azurerm/internal/services/containerapps/validate"
keyVaultValidate "github.com/hashicorp/terraform-provider-azurerm/internal/services/keyvault/validate"
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/validation"
)
Expand All @@ -37,8 +40,10 @@ type ContainerAppJobModel struct {
Template []helpers.JobTemplateModel `tfschema:"template"`
ReplicaRetryLimit int64 `tfschema:"replica_retry_limit"`
ReplicaTimeoutInSeconds int64 `tfschema:"replica_timeout_in_seconds"`
Secrets []helpers.Secret `tfschema:"secrets"`
Registries []helpers.Registry `tfschema:"registries"`
Secrets []helpers.Secret `tfschema:"secret"`
SecretsDeprecated []helpers.Secret `tfschema:"secrets,removedInNextMajorVersion"`
Registries []helpers.Registry `tfschema:"registry"`
RegistriesDeprecated []helpers.Registry `tfschema:"registries,removedInNextMajorVersion"`
EventTriggerConfig []helpers.EventTriggerConfiguration `tfschema:"event_trigger_config"`
ManualTriggerConfig []helpers.ManualTriggerConfiguration `tfschema:"manual_trigger_config"`
ScheduleTriggerConfig []helpers.ScheduleTriggerConfiguration `tfschema:"schedule_trigger_config"`
Expand Down Expand Up @@ -93,17 +98,93 @@ func (r ContainerAppJobResource) Arguments() map[string]*schema.Schema {

"template": helpers.JobTemplateSchema(),

// TODO rename `secrets` to `secrets` in 4.0
"secrets": helpers.SecretsSchema(),
"secret": helpers.SecretsSchema(),

"secrets": {
Type: pluginsdk.TypeSet,
Optional: true,
Sensitive: true,
ConflictsWith: []string{"secret"},
Deprecated: "`secrets` has been renamed to `secret` and will be removed in version 4.0 of the AzureRM Provider.",
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"identity": {
Type: pluginsdk.TypeString,
Optional: true,
ValidateFunc: validation.Any(
commonids.ValidateUserAssignedIdentityID,
validation.StringInSlice([]string{"System"}, false),
),
Description: "The identity to use for accessing key vault reference.",
},

"key_vault_secret_id": {
Type: pluginsdk.TypeString,
Optional: true,
ValidateFunc: keyVaultValidate.NestedItemIdWithOptionalVersion,
Description: "The Key Vault Secret ID. Could be either one of `id` or `versionless_id`.",
},

"name": {
Type: pluginsdk.TypeString,
Required: true,
ValidateFunc: validate.SecretName,
Description: "The secret name.",
},

"value": {
Type: pluginsdk.TypeString,
Optional: true,
Sensitive: true,
Description: "The value for this secret.",
},
},
},
},

"replica_retry_limit": {
Type: pluginsdk.TypeInt,
Optional: true,
ValidateFunc: validation.IntAtLeast(0),
},

// TODO rename `registries` to `registry` in 4.0
"registries": helpers.ContainerAppRegistrySchema(),
"registry": helpers.ContainerAppRegistrySchema(),

"registries": {
Type: pluginsdk.TypeList,
MinItems: 1,
Optional: true,
ConflictsWith: []string{"registry"},
Deprecated: "`registries` has been renamed to `registry` and will be removed in version 4.0 of the AzureRM Provider.",
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"server": {
Type: pluginsdk.TypeString,
Required: true,
ValidateFunc: validation.StringIsNotEmpty,
Description: "The hostname for the Container Registry.",
},

"username": {
Type: pluginsdk.TypeString,
Optional: true,
Description: "The username to use for this Container Registry.",
},

"password_secret_name": {
Type: pluginsdk.TypeString,
Optional: true,
Description: "The name of the Secret Reference containing the password value for this user on the Container Registry.",
},

"identity": {
Type: pluginsdk.TypeString,
Optional: true,
Description: "ID of the System or User Managed Identity used to pull images from the Container Registry",
},
},
},
},

"event_trigger_config": {
Type: pluginsdk.TypeList,
Expand Down Expand Up @@ -253,14 +334,25 @@ func (r ContainerAppJobResource) Create() sdk.ResourceFunc {
if err != nil {
return fmt.Errorf("expanding registry config for %s: %v", id, err)
}
if !features.FourPointOhBeta() && len(model.RegistriesDeprecated) > 0 {
registries, err = helpers.ExpandContainerAppJobRegistries(model.RegistriesDeprecated)
if err != nil {
return fmt.Errorf("expanding registry config for %s: %v", id, err)
}
}

secrets := helpers.ExpandContainerAppJobSecrets(model.Secrets)
if !features.FourPointOhBeta() && len(model.SecretsDeprecated) > 0 {
secrets = helpers.ExpandContainerAppJobSecrets(model.SecretsDeprecated)
}

job := jobs.Job{
Location: location.Normalize(model.Location),
Properties: &jobs.JobProperties{
Configuration: &jobs.JobConfiguration{
ReplicaRetryLimit: pointer.To(model.ReplicaRetryLimit),
ReplicaTimeout: model.ReplicaTimeoutInSeconds,
Secrets: helpers.ExpandContainerAppJobSecrets(model.Secrets),
Secrets: secrets,
Registries: registries,
},
EnvironmentId: pointer.To(model.ContainerAppEnvironmentId),
Expand Down Expand Up @@ -350,7 +442,11 @@ func (r ContainerAppJobResource) Read() sdk.ResourceFunc {
state.ContainerAppEnvironmentId = envId.ID()
state.Template = helpers.FlattenContainerAppJobTemplate(props.Template)
if config := props.Configuration; config != nil {
state.Registries = helpers.FlattenContainerAppJobRegistries(config.Registries)
if !features.FourPointOhBeta() && len(state.RegistriesDeprecated) > 0 {
state.RegistriesDeprecated = helpers.FlattenContainerAppJobRegistries(config.Registries)
} else {
state.Registries = helpers.FlattenContainerAppJobRegistries(config.Registries)
}
state.ReplicaTimeoutInSeconds = config.ReplicaTimeout
if config.ReplicaRetryLimit != nil {
state.ReplicaRetryLimit = pointer.From(config.ReplicaRetryLimit)
Expand All @@ -373,7 +469,11 @@ func (r ContainerAppJobResource) Read() sdk.ResourceFunc {
if err != nil {
return fmt.Errorf("listing secrets for %s: %+v", *id, err)
}
state.Secrets = helpers.FlattenContainerAppJobSecrets(secretResp.Model)
if !features.FourPointOhBeta() && len(state.SecretsDeprecated) > 0 {
state.SecretsDeprecated = helpers.FlattenContainerAppJobSecrets(secretResp.Model)
} else {
state.Secrets = helpers.FlattenContainerAppJobSecrets(secretResp.Model)
}

return metadata.Encode(&state)
},
Expand Down Expand Up @@ -421,11 +521,20 @@ func (r ContainerAppJobResource) Update() sdk.ResourceFunc {

d := metadata.ResourceData

if metadata.ResourceData.HasChange("secrets") {
if !features.FourPointOhBeta() && d.HasChange("secrets") {
model.Properties.Configuration.Secrets = helpers.ExpandContainerAppJobSecrets(state.SecretsDeprecated)
}
if d.HasChange("secret") {
model.Properties.Configuration.Secrets = helpers.ExpandContainerAppJobSecrets(state.Secrets)
}

if d.HasChange("registries") {
if !features.FourPointOhBeta() && d.HasChange("registries") {
model.Properties.Configuration.Registries, err = helpers.ExpandContainerAppJobRegistries(state.RegistriesDeprecated)
if err != nil {
return fmt.Errorf("invalid registry config for %s: %v", id, err)
}
}
if d.HasChange("registry") {
model.Properties.Configuration.Registries, err = helpers.ExpandContainerAppJobRegistries(state.Registries)
if err != nil {
return fmt.Errorf("invalid registry config for %s: %v", id, err)
Expand Down Expand Up @@ -502,6 +611,11 @@ func (r ContainerAppJobResource) Delete() sdk.ResourceFunc {
func (r ContainerAppJobResource) CustomizeDiff() sdk.ResourceFunc {
return sdk.ResourceFunc{
Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
var job ContainerAppJobModel
if err := metadata.DecodeDiff(&job); err != nil {
return err
}

if metadata.ResourceDiff != nil && metadata.ResourceDiff.HasChange("secrets") {
stateSecretsRaw, configSecretsRaw := metadata.ResourceDiff.GetChange("secrets")
stateSecrets := stateSecretsRaw.(*schema.Set).List()
Expand All @@ -526,6 +640,17 @@ func (r ContainerAppJobResource) CustomizeDiff() sdk.ResourceFunc {
}
}
}

if !features.FourPointOhBeta() {
if len(job.SecretsDeprecated) > 0 && len(job.Secrets) > 0 {
return fmt.Errorf("cannot use both `secret` and `secrets` blocks in the same configuration")
}

if len(job.RegistriesDeprecated) > 0 && len(job.Registries) > 0 {
return fmt.Errorf("cannot use both `registry` and `registries` blocks in the same configuration")
}
}

return nil
},
}
Expand Down
10 changes: 5 additions & 5 deletions internal/services/containerapps/container_app_job_resource_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -637,11 +637,11 @@ resource "azurerm_container_app_job" "test" {
parallelism = 4
replica_completion_count = 1
}
secrets {
secret {
name = "registry-password"
value = azurerm_container_registry.test.admin_password
}
registries {
registry {
server = azurerm_container_registry.test.login_server
username = azurerm_container_registry.test.admin_username
password_secret_name = "registry-password"
Expand Down Expand Up @@ -738,17 +738,17 @@ resource "azurerm_container_app_job" "test" {
replica_completion_count = 2
}
secrets {
secret {
name = "registry-password"
value = azurerm_container_registry.test.admin_password
}
secrets {
secret {
name = "foo"
value = "bar"
}
registries {
registry {
server = azurerm_container_registry.test.login_server
username = azurerm_container_registry.test.admin_username
password_secret_name = "registry-password"
Expand Down
8 changes: 4 additions & 4 deletions website/docs/r/container_app_job.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ The following arguments are supported:

* `replica_retry_limit` - (Optional) The maximum number of times a replica is allowed to retry.

* `secrets` - (Optional) A `secrets` block as defined below.
* `secret` - (Optional) One or more `secret` blocks as defined below.

* `registries` - (Optional) A `registries` block as defined below.
* `registry` - (Optional) One or more `registry` blocks as defined below.

* `manual_trigger_config` - (Optional) A `manual_trigger_config` block as defined below.

Expand Down Expand Up @@ -312,15 +312,15 @@ A `volume` block supports the following:

---

A `secrets` block supports the following:
A `secret` block supports the following:

* `name` - (required) Name of the secret.

* `value` - (required) Value of the secret.

---

A `registries` block supports the following:
A `registry` block supports the following:

* `identity` - (Optional) A Managed Identity to use to authenticate with Azure Container Registry.

Expand Down

0 comments on commit 718da53

Please sign in to comment.