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.

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

Add support for updating Az modules with parameter AzureModuleClass #6

Merged
merged 10 commits into from
Jun 13, 2019
Merged

Add support for updating Az modules with parameter AzureModuleClass #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6fd8209
require automation module name param in Update-ProfileAndAutomationVe…
ayoung012 May 9, 2019
9ea09ac
introduce AzureModuleClass parameter to specify which module class to…
ayoung012 May 13, 2019
ec15e38
stick to existing param syntax
ayoung012 May 13, 2019
94bbfdb
support full use of Az module to perform updates based on param Azure…
ayoung012 May 13, 2019
9aacc6c
doco and param adjustments as per PR comments
ayoung012 May 16, 2019
4d1df03
avoid importing conflicting modules
ayoung012 May 23, 2019
f4b2702
locale independant documentation url
ayoung012 May 25, 2019
7610d38
earlier filtering of conflicting modules
ayoung012 May 25, 2019
e119b9c
restrict Az to updating only Az modules
ayoung012 Jun 6, 2019
e39baa6
repair tests for AzureRM module class
ayoung012 Jun 13, 2019
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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@ Import this runbook into your Automation account, and [start](https://docs.micro
run when the **Update Azure Modules** button is pushed or when this runbook is invoked directly
via ARM API for this Automation account. If this is not what you want, specify a different name
when importing this runbook.
* Only **Azure** and **AzureRM.\*** modules are currently supported. The new [Azure PowerShell Az modules](https://docs.microsoft.com/powershell/azure/new-azureps-module-az) are not supported yet.
Avoid starting this runbook on Automation accounts that contain Az modules.
* **Azure** and **AzureRM.\*** modules are currently supported by default.
* The new [Azure PowerShell Az modules](https://docs.microsoft.com/powershell/azure/new-azureps-module-az)
are also supported. You **must** supply the `AzureModuleClass` runbook parameter with `Az` if
your runbooks use only Az modules to avoid conflicts. More information can be found in the
[Microsoft Docs](https://docs.microsoft.com/azure/automation/az-modules) and
issue [#5](https://github.com/microsoft/AzureAutomation-Account-Modules-Update/issues/5).
Avoid starting this runbook on Automation accounts that contain both AzureRM and Az modules.
* Before starting this runbook, make sure your Automation account has an [Azure Run As account credential](https://docs.microsoft.com/azure/automation/manage-runas-account) created.
* You can use this code as a regular PowerShell script instead of a runbook: just login to Azure
using the [Connect-AzureRmAccount](https://docs.microsoft.com/powershell/module/azurerm.profile/connect-azurermaccount)
Expand Down
64 changes: 32 additions & 32 deletions Tests/Update-AutomationAzureModulesForAccount.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
Context 'No overridden module versions' {
Mock Get-AzureRmAutomationModule {
@{
Name = 'FakeAzureModule'
Name = 'AzureRM.FakeAzureModule'
Version = '1.0.0'
ProvisioningState = 'Succeeded'
}
Expand Down Expand Up @@ -154,10 +154,10 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
} -Verifiable

Mock Invoke-RestMethod -ParameterFilter {
$Uri -match '%27FakeAzureModule%27'
$Uri -match '%27AzureRM.FakeAzureModule%27'
} -MockWith {
$Method | Should be 'Get' > $null
Assert-CorrectSearchUri -Uri $Uri -ModuleName FakeAzureModule
Assert-CorrectSearchUri -Uri $Uri -ModuleName AzureRM.FakeAzureModule

@{
id = 'fake FakeAzureModule search result id'
Expand All @@ -181,21 +181,21 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
} -Verifiable

Mock Invoke-WebRequest -ParameterFilter {
$Uri -match 'https://www.powershellgallery.com/api/v2/package/FakeAzureModule'
$Uri -match 'https://www.powershellgallery.com/api/v2/package/AzureRM.FakeAzureModule'
} -MockWith {
$Uri | Should be 'https://www.powershellgallery.com/api/v2/package/FakeAzureModule' > $null
$Uri | Should be 'https://www.powershellgallery.com/api/v2/package/AzureRM.FakeAzureModule' > $null

@{
Headers = @{
Location = 'Fake/FakeAzureModule/Content/Location.nupkg'
Location = 'Fake/AzureRM.FakeAzureModule/Content/Location.nupkg'
}
}
} -Verifiable

Mock New-AzureRmAutomationModule -ParameterFilter {
$Name -eq 'FakeAzureModule'
$Name -eq 'AzureRM.FakeAzureModule'
} -MockWith {
$ContentLink | Should be 'Fake/FakeAzureModule/Content/Location.nupkg' > $null
$ContentLink | Should be 'Fake/AzureRM.FakeAzureModule/Content/Location.nupkg' > $null
} -Verifiable

Invoke-Update-AutomationAzureModulesForAccount -OptionalParameters @{
Expand All @@ -207,7 +207,7 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
}

It 'Updates fake Azure module' {
Assert-MockCalled New-AzureRmAutomationModule -ParameterFilter { $Name -eq 'FakeAzureModule' } -Times 1 -Exactly
Assert-MockCalled New-AzureRmAutomationModule -ParameterFilter { $Name -eq 'AzureRM.FakeAzureModule' } -Times 1 -Exactly
}

Assert-VerifiableMock
Expand All @@ -216,7 +216,7 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
Context 'With overridden module versions' {
Mock Get-AzureRmAutomationModule {
@{
Name = 'FakeAzureModule'
Name = 'AzureRM.FakeAzureModule'
Version = '1.0.0'
ProvisioningState = 'Succeeded'
}
Expand Down Expand Up @@ -295,10 +295,10 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
} -Verifiable

Mock Invoke-RestMethod -ParameterFilter {
$Uri -match '%27FakeAzureModule%27'
$Uri -match '%27AzureRM.FakeAzureModule%27'
} -MockWith {
$Method | Should be 'Get' > $null
Assert-CorrectSearchUri -Uri $Uri -ModuleName FakeAzureModule
Assert-CorrectSearchUri -Uri $Uri -ModuleName AzureRM.FakeAzureModule

@{
id = 'fake FakeAzureModule search result id'
Expand All @@ -322,21 +322,21 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
} -Verifiable

Mock Invoke-WebRequest -ParameterFilter {
$Uri -match 'https://www.powershellgallery.com/api/v2/package/FakeAzureModule'
$Uri -match 'https://www.powershellgallery.com/api/v2/package/AzureRM.FakeAzureModule'
} -MockWith {
$Uri | Should be 'https://www.powershellgallery.com/api/v2/package/FakeAzureModule' > $null
$Uri | Should be 'https://www.powershellgallery.com/api/v2/package/AzureRM.FakeAzureModule' > $null

@{
Headers = @{
Location = 'Fake/FakeAzureModule/Content/Location.nupkg'
Location = 'Fake/AzureRM.FakeAzureModule/Content/Location.nupkg'
}
}
} -Verifiable

Mock New-AzureRmAutomationModule -ParameterFilter {
$Name -eq 'FakeAzureModule'
$Name -eq 'AzureRM.FakeAzureModule'
} -MockWith {
$ContentLink | Should be 'Fake/FakeAzureModule/Content/Location.nupkg' > $null
$ContentLink | Should be 'Fake/AzureRM.FakeAzureModule/Content/Location.nupkg' > $null
} -Verifiable

Invoke-Update-AutomationAzureModulesForAccount -OptionalParameters @{
Expand All @@ -350,7 +350,7 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
}

It 'Updates fake Azure module' {
Assert-MockCalled New-AzureRmAutomationModule -ParameterFilter { $Name -eq 'FakeAzureModule' } -Times 1 -Exactly
Assert-MockCalled New-AzureRmAutomationModule -ParameterFilter { $Name -eq 'AzureRM.FakeAzureModule' } -Times 1 -Exactly
}

Assert-VerifiableMock
Expand Down Expand Up @@ -407,31 +407,31 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {

Mock Get-AzureRmAutomationModule {
@{
Name = 'FakeAzureModule'
Name = 'AzureRM.FakeAzureModule'
Version = '1.0.0'
ProvisioningState = 'Succeeded'
}
} -Verifiable

Mock Invoke-RestMethod -ParameterFilter {
$Uri -match '%27FakeAzureModule%27'
$Uri -match '%27AzureRM.FakeAzureModule%27'
} -MockWith {
$Method | Should be 'Get' > $null
Assert-CorrectSearchUri -Uri $Uri -ModuleName FakeAzureModule -Filter "Version%20eq%20'2.0.0'"
Assert-CorrectSearchUri -Uri $Uri -ModuleName AzureRM.FakeAzureModule -Filter "Version%20eq%20'2.0.0'"

@{
id = 'fake FakeAzureModule search result id 1'
title = @{ InnerText = 'FakeAzureModule.Different' }
title = @{ InnerText = 'AzureRM.FakeAzureModule.Different' }
}

@{
id = 'fake FakeAzureModule search result id 2'
title = @{ InnerText = 'FakeAzureModule' }
title = @{ InnerText = 'AzureRM.FakeAzureModule' }
}

@{
id = 'fake FakeAzureModule search result id 3'
title = @{ InnerText = 'FakeAzureModule.AnotherOne' }
title = @{ InnerText = 'AzureRM.FakeAzureModule.AnotherOne' }
}
} -Verifiable

Expand All @@ -452,33 +452,33 @@ Describe 'Update-AutomationAzureModulesForAccount runbook' {
} -Verifiable

Mock Invoke-WebRequest -ParameterFilter {
$Uri -match 'https://www.powershellgallery.com/api/v2/package/FakeAzureModule'
$Uri -match 'https://www.powershellgallery.com/api/v2/package/AzureRM.FakeAzureModule'
} -MockWith {
$Uri | Should be 'https://www.powershellgallery.com/api/v2/package/FakeAzureModule/2.0.0' > $null
$Uri | Should be 'https://www.powershellgallery.com/api/v2/package/AzureRM.FakeAzureModule/2.0.0' > $null

@{
Headers = @{
Location = 'Fake/FakeAzureModule/Content/Location.nupkg'
Location = 'Fake/AzureRM.FakeAzureModule/Content/Location.nupkg'
}
}
} -Verifiable

Mock New-AzureRmAutomationModule -ParameterFilter {
$Name -eq 'FakeAzureModule'
$Name -eq 'AzureRM.FakeAzureModule'
} -MockWith {
$ContentLink | Should be 'Fake/FakeAzureModule/Content/Location.nupkg' > $null
$ContentLink | Should be 'Fake/AzureRM.FakeAzureModule/Content/Location.nupkg' > $null
} -Verifiable

Invoke-Update-AutomationAzureModulesForAccount -OptionalParameters @{
ModuleVersionOverrides = "{
'FakeAzureModule' : '2.0.0'
'AzureRM.FakeAzureModule' : '2.0.0'
}"
}

It 'Updates fake Azure module' {
Assert-MockCalled New-AzureRmAutomationModule -ParameterFilter { $Name -eq 'FakeAzureModule' } -Times 1 -Exactly
Assert-MockCalled New-AzureRmAutomationModule -ParameterFilter { $Name -eq 'AzureRM.FakeAzureModule' } -Times 1 -Exactly
}

Assert-VerifiableMock
}
}
}
Loading