Skip to content
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.

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

azurerm_container_registry_task_schedule_run_now: fix state tracking #24592

Merged
merged 1 commit into from Jan 23, 2024

Conversation

walkline
Copy link
Contributor

@walkline walkline commented Jan 22, 2024

With the current implementation, there is a chance that we may track the state of the wrong run during creation process.

Here is my use case. With this request, I received the following response:

{
   "value":[
      {
         "type":"Microsoft.ContainerRegistry/registries/runs",
         "properties":{
            "runId":"cb1m",
            "status":"Queued",
            "lastUpdatedTime":"2024-01-22T19:22:00+00:00",
            "runType":"QuickRun",
            "createTime":"2024-01-22T19:22:00.6783774+00:00",
            "platform":{
               
            },
            "agentConfiguration":{
               
            },
            "provisioningState":"Succeeded",
            "isArchiveEnabled":false
         },
         "id":"***",
         "name":"cb1m",
         "systemData":{
            "lastModifiedBy":"****",
            "lastModifiedByType":"User",
            "lastModifiedAt":"2024-01-22T19:22:00.5717814+00:00"
         }
      },
      {
         "type":"Microsoft.ContainerRegistry/registries/runs",
         "properties":{
            "runId":"cb1k",
            "status":"Succeeded",
            "lastUpdatedTime":"2024-01-22T18:58:51+00:00",
            "runType":"QuickRun",
            "createTime":"2024-01-22T18:58:27.9292755+00:00",
            "startTime":"2024-01-22T18:58:28.3975826+00:00",
            "finishTime":"2024-01-22T18:58:51.6189431+00:00",
            "task":"mx-app-image-builder",
            "platform":{
               "os":"Linux"
            },
            "agentConfiguration":{
               "cpu":2
            },
            "provisioningState":"Succeeded",
            "isArchiveEnabled":false
         },
         "id":"***",
         "name":"cb1k",
         "systemData":{
            "lastModifiedBy":"***",
            "lastModifiedByType":"User",
            "lastModifiedAt":"2024-01-22T18:58:27.8583581+00:00"
         }
      }
   ]
}

From this response, it's obvious that we should choose the cb1m run, which is in a Queued status. However, we chose the cb1k run to track because this condition fails, as cb1m doesn't have a task field.

As a result, Terraform picks the wrong run, and the object is instantly created since cb1k has a Success status.

With the proposed changes, I couldn't reproduce the issue.

This may also possibly resolve this issue: #23334.

Copy link
Member

@stephybun stephybun left a comment

Choose a reason for hiding this comment

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

Thanks for this @walkline LGTM ⚡

@stephybun stephybun merged commit 43ffd70 into hashicorp:main Jan 23, 2024
29 checks passed
@github-actions github-actions bot added this to the v3.89.0 milestone Jan 23, 2024
Copy link

This functionality has been released in v3.89.0 of the Terraform Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

@walkline
Copy link
Contributor Author

Hey @stephybun. Now resource creation is broken, because of the changes to the azure sdk in vendor folder.
It always throws this error:

if scheduleResp.Model == nil {
  return fmt.Errorf("ScheduleRun model was nil for taskID %s", taskId)
}

Can you help me to solve this?

dduportal added a commit to jenkins-infra/azure that referenced this pull request Jan 25, 2024
<Actions>
<action
id="f410411e63aff4bb73a81c2aec1d373cf8a903e63b30dee2006b0030d8a94cc8">
        <h3>Bump Terraform `azurerm` provider version</h3>
<details
id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24">
            <summary>Update Terraform lock file</summary>
<p>changes detected:&#xA;&#x9;&#34;hashicorp/azurerm&#34; updated from
&#34;3.88.0&#34; to &#34;3.89.0&#34; in file
&#34;.terraform.lock.hcl&#34;</p>
            <details>
                <summary>3.89.0</summary>
<pre>Changelog retrieved
from:&#xA;&#x9;https://github.com/hashicorp/terraform-provider-azurerm/releases/tag/v3.89.0&#xA;FEATURES:&#xA;&#xA;*
New Data Source: `azurerm_data_factory_trigger_schedule`
([#24572](https://github.com/hashicorp/terraform-provider-azurerm/issues/24572))&#xA;*
New Data Source: `azurerm_data_factory_trigger_schedules`
([#24572](https://github.com/hashicorp/terraform-provider-azurerm/issues/24572))&#xA;*
New Data Source: `azurerm_ip_groups`
([#24540](https://github.com/hashicorp/terraform-provider-azurerm/issues/24540))&#xA;*
New Data Source: `azurerm_nginx_certificate`
([#24577](https://github.com/hashicorp/terraform-provider-azurerm/issues/24577))&#xA;*
New Resource: `azurerm_chaos_studio_target`
([#24580](https://github.com/hashicorp/terraform-provider-azurerm/issues/24580))&#xA;*
New Resource: `azurerm_elastic_san_volume_group`
([#24166](https://github.com/hashicorp/terraform-provider-azurerm/issues/24166))&#xA;*
New Resource: `azurerm_netapp_account_encryption`
([#23733](https://github.com/hashicorp/terraform-provider-azurerm/issues/23733))&#xA;*
New Resource: `azurerm_redhat_openshift_cluster`
([#24375](https://github.com/hashicorp/terraform-provider-azurerm/issues/24375))&#xA;&#xA;ENHANCEMENTS:&#xA;&#xA;*
dependencies: updating to `v0.66.1` of
`github.com/hashicorp/go-azure-helpers`
([#24561](https://github.com/hashicorp/terraform-provider-azurerm/issues/24561))&#xA;*
dependencies: updating to `v0.20240124.1115501` of
`github.com/hashicorp/go-azure-sdk`
([#24619](https://github.com/hashicorp/terraform-provider-azurerm/issues/24619))&#xA;*
`bot`: updating to API Version `2021-05-01-preview`
([#24555](https://github.com/hashicorp/terraform-provider-azurerm/issues/24555))&#xA;*
`containerservice`: the SDK Clients now support logging
([#24564](https://github.com/hashicorp/terraform-provider-azurerm/issues/24564))&#xA;*
`cosmosdb`: updating to API Version `2023-04-15`
([#24541](https://github.com/hashicorp/terraform-provider-azurerm/issues/24541))&#xA;*
`loadtestservice`: updating to use the base layer from
`hashicorp/go-azure-sdk` rather than `Azure/go-autorest` (and support
logging)
([#24578](https://github.com/hashicorp/terraform-provider-azurerm/issues/24578))&#xA;*
`managedidentity`: updating to use the base layer from
`hashicorp/go-azure-sdk` rather than `Azure/go-autorest` (and support
logging)
([#24578](https://github.com/hashicorp/terraform-provider-azurerm/issues/24578))&#xA;*
`azurerm_api_management_api` - change the `id` format so specific
`revision`s can be managed by Terraform
([#23031](https://github.com/hashicorp/terraform-provider-azurerm/issues/23031))&#xA;*
`azurerm_data_protection_backup_vault` - the `redundancy` propety can
now be set to `ZoneRedundant`
([#24556](https://github.com/hashicorp/terraform-provider-azurerm/issues/24556))&#xA;*
`azurerm_data_factory_integration_runtime_azure_ssis` - support for the
`credential_name` property
([#24458](https://github.com/hashicorp/terraform-provider-azurerm/issues/24458))&#xA;*
`azurerm_orchestrated_virtual_machine_scale_set` - support
`2022-datacenter-azure-edition-hotpatch` and
`2022-datacenter-azure-edition-hotpatch-smalldisk` hotpatching images
([#23500](https://github.com/hashicorp/terraform-provider-azurerm/issues/23500))&#xA;*
`azurerm_stream_analytics_job` - support for the `sku_name` property
([#24554](https://github.com/hashicorp/terraform-provider-azurerm/issues/24554))&#xA;&#xA;BUG
FIXES:&#xA;&#xA;* Data Source: `azurerm_app_service` - parsing the API
Response for `app_service_plan_id` case-insensitively
([#24626](https://github.com/hashicorp/terraform-provider-azurerm/issues/24626))&#xA;*
Data Source: `azurerm_function_app` - parsing the API Response for
`app_service_plan_id` case-insensitively
([#24626](https://github.com/hashicorp/terraform-provider-azurerm/issues/24626))&#xA;*
`azurerm_app_configuration_key` - the value for the `value` property can
now be removed/emptied
([#24582](https://github.com/hashicorp/terraform-provider-azurerm/issues/24582))&#xA;&#xA;*
`azurerm_app_service` - parsing the API Response for
`app_service_plan_id` case-insensitively
([#24626](https://github.com/hashicorp/terraform-provider-azurerm/issues/24626))&#xA;*
`azurerm_app_service_plan` - fix casing in `serverFarms` due to ID
update
([#24562](https://github.com/hashicorp/terraform-provider-azurerm/issues/24562))&#xA;*
`azurerm_app_service_slot` - parsing the API Response for
`app_service_plan_id` case-insensitively
([#24626](https://github.com/hashicorp/terraform-provider-azurerm/issues/24626))&#xA;*
`azurerm_automation_schedule` - only one `monthly_occurence` block can
now be specified
([#24614](https://github.com/hashicorp/terraform-provider-azurerm/issues/24614))&#xA;*
`azurerm_cognitive_deployment` - the `model.version` property is no
longer required
([#24264](https://github.com/hashicorp/terraform-provider-azurerm/issues/24264))&#xA;*
`azurerm_container_app` - multiple `custom_scale_rule` can not be
updated
([#24509](https://github.com/hashicorp/terraform-provider-azurerm/issues/24509))&#xA;*
`azurerm_container_registry_task_schedule_run_now` - prevent issue where
the incorrect scheduled run in tracked if there have been multiple
([#24592](https://github.com/hashicorp/terraform-provider-azurerm/issues/24592))&#xA;*
`azurerm_function_app` - parsing the API Response for
`app_service_plan_id` case-insensitively
([#24626](https://github.com/hashicorp/terraform-provider-azurerm/issues/24626))&#xA;*
`azurerm_function_app_slot` - parsing the API Response for
`app_service_plan_id` case-insensitively
([#24626](https://github.com/hashicorp/terraform-provider-azurerm/issues/24626))&#xA;*
`azurerm_logic_app_standard` - now will parse the app service ID
insensitively
([#24562](https://github.com/hashicorp/terraform-provider-azurerm/issues/24562))&#xA;*
`azurerm_logic_app_workflow` - the `workflow_parameters` will now
correctly handle information specified by `$connections`
([#24141](https://github.com/hashicorp/terraform-provider-azurerm/issues/24141))&#xA;*
`azurerm_mssql_managed_instance_security_alert_policy` - can not update
empty storage attributes
([#24553](https://github.com/hashicorp/terraform-provider-azurerm/issues/24553))&#xA;*
`azurerm_network_interface` - the `ip_configuration` properties are no
longer added to a Load Balancer Backend if one of those
`ip_configurations` is associated with a backend
([#24470](https://github.com/hashicorp/terraform-provider-azurerm/issues/24470))&#xA;&#xA;&#xA;</pre>
            </details>
        </details>
<a
href="https://infra.ci.jenkins.io/job/terraform-jobs/job/azure/job/main/1052/">Jenkins
pipeline link</a>
    </action>
</Actions>

---

<table>
  <tr>
    <td width="77">
<img src="https://www.updatecli.io/images/updatecli.png" alt="Updatecli
logo" width="50" height="50">
    </td>
    <td>
      <p>
Created automatically by <a
href="https://www.updatecli.io/">Updatecli</a>
      </p>
      <details><summary>Options:</summary>
        <br />
<p>Most of Updatecli configuration is done via <a
href="https://www.updatecli.io/docs/prologue/quick-start/">its
manifest(s)</a>.</p>
        <ul>
<li>If you close this pull request, Updatecli will automatically reopen
it, the next time it runs.</li>
<li>If you close this pull request and delete the base branch, Updatecli
will automatically recreate it, erasing all previous commits made.</li>
        </ul>
        <p>
Feel free to report any issues at <a
href="https://github.com/updatecli/updatecli/issues">github.com/updatecli/updatecli</a>.<br
/>
If you find this tool useful, do not hesitate to star <a
href="https://github.com/updatecli/updatecli/stargazers">our GitHub
repository</a> as a sign of appreciation, and/or to tell us directly on
our <a
href="https://matrix.to/#/#Updatecli_community:gitter.im">chat</a>!
        </p>
      </details>
    </td>
  </tr>
</table>

Co-authored-by: Jenkins Infra Bot (updatecli) <60776566+jenkins-infra-bot@users.noreply.github.com>
Co-authored-by: Damien Duportal <damien.duportal@gmail.com>
@stephybun
Copy link
Member

@walkline apologies, I hadn't realised this change was dependent on the SDK change we made (and then reverted).

It should be possible to do a manual unmarshal of the response payload, below is a snippet that can hopefully get you started.

scheduleResp, err := registryClient.ScheduleRun(ctx, registryId, req)
if err != nil {
  return fmt.Errorf("scheduling the task: %+v", err)
}
if scheduleResp.HttpResponse != nil {
  if err = scheduleResp.HttpResponse.Unmarshal(&scheduleResp.Model); err != nil {
    return
  }
}
if scheduleResp.Model == nil {
  return fmt.Errorf("ScheduleRun model was nil for taskID %s", taskId)
}

Please shout if you require more assistance!

Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

azurerm_container_registry_task_schedule_run_now always in Failed state
2 participants