`azurerm_log_analytics_saved_search` - update validation for `azurerm_log_analytics_saved_search` #26701

ziyeqf · 2024-07-19T06:27:46Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

These validation regxp might be out of date, can not validate some format of parameters. The expression was provided on #26685, Thanks to @Folling

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevent documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

❯❯ tftest loganalytics TestAccLogAnalyticsSavedSearch
=== RUN   TestAccLogAnalyticsSavedSearch_basic
=== PAUSE TestAccLogAnalyticsSavedSearch_basic
=== RUN   TestAccLogAnalyticsSavedSearch_complete
=== PAUSE TestAccLogAnalyticsSavedSearch_complete
=== RUN   TestAccLogAnalyticsSavedSearch_withTag
=== PAUSE TestAccLogAnalyticsSavedSearch_withTag
=== RUN   TestAccLogAnalyticsSavedSearch_requiresImport
=== PAUSE TestAccLogAnalyticsSavedSearch_requiresImport
=== CONT  TestAccLogAnalyticsSavedSearch_basic
=== CONT  TestAccLogAnalyticsSavedSearch_withTag
=== CONT  TestAccLogAnalyticsSavedSearch_complete
=== CONT  TestAccLogAnalyticsSavedSearch_requiresImport
--- PASS: TestAccLogAnalyticsSavedSearch_withTag (191.96s)
--- PASS: TestAccLogAnalyticsSavedSearch_requiresImport (202.24s)
--- PASS: TestAccLogAnalyticsSavedSearch_complete (208.41s)
--- PASS: TestAccLogAnalyticsSavedSearch_basic (218.12s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/loganalytics  220.329s

❯❯ tftest loganalytics TestAccLogAnalyticsSavedSearch_functionParameter
=== RUN   TestAccLogAnalyticsSavedSearch_functionParameter
=== PAUSE TestAccLogAnalyticsSavedSearch_functionParameter
=== CONT  TestAccLogAnalyticsSavedSearch_functionParameter
--- PASS: TestAccLogAnalyticsSavedSearch_functionParameter (281.36s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/loganalytics  283.494s

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

azurerm_log_analytics_saved_search - pdate validation for azurerm_log_analytics_saved_search [azurerm_log_analytics_saved_search - update validation for azurerm_log_analytics_saved_search #26701]

This is a (please select all that apply):

Bug Fix
New Feature (ie adding a service, resource, or data source)
Enhancement
Breaking Change

Related Issue(s)

Fixes #26685

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

…log_analytics_saved_search`

Folling · 2024-07-19T07:28:01Z

internal/services/loganalytics/log_analytics_saved_search_resource_test.go

+
+  category     = "Saved Search Test Category"
+  display_name = "Create or Update Saved Search Test"
+  query        = "Heartbeat | summarize Count() by Computer | take a"


Suggested change

query = "Heartbeat | summarize Count() by Computer | take a"

query = "Heartbeat | summarize Count() by Computer | take 1"

Folling · 2024-07-19T07:28:17Z

website/docs/r/log_analytics_saved_search.html.markdown

@@ -52,7 +52,7 @@ The following arguments are supported:

 * `function_alias` - (Optional) The function alias if the query serves as a function. Changing this forces a new resource to be created.

-* `function_parameters` - (Optional) The function parameters if the query serves as a function. Changing this forces a new resource to be created.
+* `function_parameters` - (Optional) The function parameters if the query serves as a function. Changing this forces a new resource to be created. For more examples and proper syntax please refer to [this document](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/functions/user-defined-functions)


Suggested change

* `function_parameters` - (Optional) The function parameters if the query serves as a function. Changing this forces a new resource to be created. For more examples and proper syntax please refer to [this document](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/functions/user-defined-functions)

* `function_parameters` - (Optional) The function parameters if the query serves as a function. Changing this forces a new resource to be created. For more examples and proper syntax please refer to [this document](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/functions/user-defined-functions).

Folling · 2024-07-19T07:28:56Z

internal/services/loganalytics/log_analytics_saved_search_resource_test.go

+  log_analytics_workspace_id = azurerm_log_analytics_workspace.test.id
+
+  category     = "Saved Search Test Category"
+  display_name = "Create or Update Saved Search Test"


Suggested change

display_name = "Create or Update Saved Search Test"

display_name = "SavedSearchTest"

Folling · 2024-07-19T07:29:15Z

internal/services/loganalytics/log_analytics_saved_search_resource_test.go

+  name                       = "acctestLASS-%d"
+  log_analytics_workspace_id = azurerm_log_analytics_workspace.test.id
+
+  category     = "Saved Search Test Category"


Not sure if spaces are allowed here

per the testing result it should be fine

Folling · 2024-07-19T08:45:54Z

internal/services/loganalytics/log_analytics_saved_search_resource_test.go

+			),
+		},
+		data.ImportStep(),
+		{


ideally a test case should be added that verifies multiple parameters as well, perhaps in 2-3 different forms, just to test the repetitive part of the regex

multiple parameters are tested in the TestAccLogAnalyticsSavedSearch_complete test case

stephybun

Thanks @ziyeqf. Could you address the review comments left by @Folling. Once that's done and the tests pass this should be good to go.

ziyeqf · 2024-08-06T05:36:18Z

Sorry for the delay, just updated

Folling · 2024-08-06T08:02:13Z

lgtm since the tests pass

stephybun

Thanks @ziyeqf LGTM 👍

github-actions · 2024-09-07T02:15:11Z

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.

ziyeqf added 2 commits July 19, 2024 13:33

azurerm_log_analytics_saved_search: update validation for `azurerm_…

279caf6

…log_analytics_saved_search`

adding test case

bf3a54a

ziyeqf mentioned this pull request Jul 19, 2024

Saved Search Validation Incorrectly Flags Tabular Parameters #26685

Closed

1 task

github-actions bot added documentation service/log-analytics size/M labels Jul 19, 2024

Folling reviewed Jul 19, 2024

View reviewed changes

stephybun requested changes Jul 31, 2024

View reviewed changes

github-actions bot added the waiting-response label Jul 31, 2024

stephybun mentioned this pull request Jul 31, 2024

Add support for tabular functions to azurerm_log_analytics_saved_search #26626

Closed

14 tasks

update per comments

6386c95

github-actions bot removed the waiting-response label Aug 6, 2024

Folling approved these changes Aug 6, 2024

View reviewed changes

stephybun added the enhancement label Aug 7, 2024

stephybun approved these changes Aug 7, 2024

View reviewed changes

stephybun merged commit 942d18d into hashicorp:main Aug 7, 2024
36 checks passed

github-actions bot added this to the v3.115.0 milestone Aug 7, 2024

stephybun added a commit that referenced this pull request Aug 8, 2024

Update for #26640 #26758 #26699 #26924 #26747 #26701 #26599

61f652e

github-actions bot locked as resolved and limited conversation to collaborators Sep 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`azurerm_log_analytics_saved_search` - update validation for `azurerm_log_analytics_saved_search` #26701

`azurerm_log_analytics_saved_search` - update validation for `azurerm_log_analytics_saved_search` #26701

ziyeqf commented Jul 19, 2024 •

edited

Loading

Folling Jul 19, 2024

Folling Jul 19, 2024

Folling Jul 19, 2024

Folling Jul 19, 2024

ziyeqf Aug 6, 2024

Folling Jul 19, 2024

ziyeqf Aug 6, 2024

stephybun left a comment

ziyeqf commented Aug 6, 2024

Folling commented Aug 6, 2024

stephybun left a comment

github-actions bot commented Sep 7, 2024

	query = "Heartbeat \| summarize Count() by Computer \| take a"
	query = "Heartbeat \| summarize Count() by Computer \| take 1"

	* `function_parameters` - (Optional) The function parameters if the query serves as a function. Changing this forces a new resource to be created. For more examples and proper syntax please refer to [this document](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/functions/user-defined-functions)
	* `function_parameters` - (Optional) The function parameters if the query serves as a function. Changing this forces a new resource to be created. For more examples and proper syntax please refer to [this document](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/functions/user-defined-functions).

	display_name = "Create or Update Saved Search Test"
	display_name = "SavedSearchTest"

azurerm_log_analytics_saved_search - update validation for azurerm_log_analytics_saved_search #26701

azurerm_log_analytics_saved_search - update validation for azurerm_log_analytics_saved_search #26701

Conversation

ziyeqf commented Jul 19, 2024 • edited Loading

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

Folling Jul 19, 2024

Choose a reason for hiding this comment

Folling Jul 19, 2024

Choose a reason for hiding this comment

Folling Jul 19, 2024

Choose a reason for hiding this comment

Folling Jul 19, 2024

Choose a reason for hiding this comment

ziyeqf Aug 6, 2024

Choose a reason for hiding this comment

Folling Jul 19, 2024

Choose a reason for hiding this comment

ziyeqf Aug 6, 2024

Choose a reason for hiding this comment

stephybun left a comment

Choose a reason for hiding this comment

ziyeqf commented Aug 6, 2024

Folling commented Aug 6, 2024

stephybun left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 7, 2024

`azurerm_log_analytics_saved_search` - update validation for `azurerm_log_analytics_saved_search` #26701

`azurerm_log_analytics_saved_search` - update validation for `azurerm_log_analytics_saved_search` #26701

ziyeqf commented Jul 19, 2024 •

edited

Loading