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

[Modules] Reduce parameter names to necessary baseline #2976

Merged
merged 9 commits into from
Mar 27, 2023

Conversation

AlexanderSehr
Copy link
Contributor

@AlexanderSehr AlexanderSehr commented Mar 11, 2023

Description

  • As described in the issue, this PR intends to incrementally remove redundant elements from parameter names
  • Replaced id with resourceId in several cases to align with other modules

Pipeline references

For module/pipeline changes, please create and attach the status badge of your successful run.

Pipeline
Network - NatGateways
OperationalInsights - Workspaces
RecoveryServices - Vaults
Sql - ManagedInstances
Sql - Servers
Storage - StorageAccounts
Web - Sites

Type of Change

Please delete options that are not relevant.

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Update to documentation

@github-actions
Copy link

github-actions bot commented Mar 13, 2023

Test Results

    1 files  ±    0      1 suites  ±0   5m 16s ⏱️ + 4m 46s
472 tests +426  465 ✔️ +420    7 💤 +6  0 ±0 
488 runs  +438  477 ✔️ +429  11 💤 +9  0 ±0 

Results for commit 88dba6a. ± Comparison against base commit 208866c.

This pull request removes 46 and adds 472 tests. Note that renamed tests count towards both.
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.VirtualMachineImages/imageTemplates] used resource type [imageTemplates] should use one of the recent API version(s). Currently using [2022-02-14]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.VirtualMachineImages/imageTemplates] used resource type [locks] should use one of the recent API version(s). Currently using [2020-05-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.VirtualMachineImages/imageTemplates] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.VirtualMachineImages/imageTemplates] All apiVersion properties should be set to a static, hard-coded value
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.VirtualMachineImages/imageTemplates] All non-required parameters in template file should not have description that start with "Required."
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.VirtualMachineImages/imageTemplates] All parameters in parameters files exist in template file (deploy.json)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.VirtualMachineImages/imageTemplates] All required parameters in template file (deploy.json) should exist in parameters files
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.VirtualMachineImages/imageTemplates] CUA ID deployment should be present in the template
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.VirtualMachineImages/imageTemplates] Conditional parameters' description should contain 'Required if' followed by the condition making the parameter required.
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.VirtualMachineImages/imageTemplates] Each parameters' description should start with a one word category starting with a capital letter, followed by a dot, a space and the actual description text ending with a dot.
…
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies] used resource type [storageAccounts/blobServices/containers/immutabilityPolicies] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices/containers] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices/containers] used resource type [storageAccounts/blobServices/containers/immutabilityPolicies] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices/containers] used resource type [storageAccounts/blobServices/containers] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices] used resource type [diagnosticsettings] should use one of the recent API version(s). Currently using [2021-05-01-preview]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices] used resource type [storageAccounts/blobServices/containers/immutabilityPolicies] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices] used resource type [storageAccounts/blobServices/containers] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/blobServices] used resource type [storageAccounts/blobServices] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests.In [Microsoft.Storage/storageAccounts/fileServices/shares] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
…
This pull request removes 1 skipped test and adds 7 skipped tests. Note that renamed tests count towards both.
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ File/folder tests..test folder.[Microsoft.VirtualMachineImages/imageTemplates] JSON test files in the .test folder should be valid json
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.Storage/storageAccounts/fileServices/shares] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.Storage/storageAccounts/localUsers] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.Storage/storageAccounts/managementPolicies] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.Storage/storageAccounts/queueServices/queues] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.General template.[Microsoft.Storage/storageAccounts/tableServices/tables] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ File/folder tests..test folder.[Microsoft.Storage/storageAccounts] JSON test files in the .test folder should be valid json

♻️ This comment has been updated with latest results.

@AlexanderSehr AlexanderSehr marked this pull request as ready for review March 14, 2023 16:21
@AlexanderSehr AlexanderSehr requested a review from a team as a code owner March 14, 2023 16:21
@AlexanderSehr AlexanderSehr enabled auto-merge (squash) March 14, 2023 16:22
Copy link
Contributor

@eriqua eriqua left a comment

Choose a reason for hiding this comment

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

🆗

@AlexanderSehr AlexanderSehr merged commit 9370abf into main Mar 27, 2023
@AlexanderSehr AlexanderSehr deleted the users/alsehr/2677_paramNames_3 branch March 27, 2023 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[cat] modules category: modules enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Reduce module parameter-names to their name without the modules identifier
2 participants