Skip to content

ProfileMap Endpoint Discovery #4

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

Merged
merged 3 commits into from
Nov 15, 2016
Merged

ProfileMap Endpoint Discovery #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7cd25e
ProfileMap Endpoint Discovery
viananth Oct 27, 2016
e84bafe
Update AzureRM.Bootstrapper.psm1
viananth Nov 10, 2016
17c8996
Update Bootstrapper with CR comments
viananth Nov 13, 2016
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
143 changes: 106 additions & 37 deletions tools/AzureRM.BootStrapper/AzureRM.Bootstrapper.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
$RollUpModule = "AzureRM"

$RollUpModule = "AzureRM"
$PSProfileMapEndpoint = "https://profile.azureedge.net/powershell/ProfileMap.json"
$PSModule = $ExecutionContext.SessionState.Module
$script:BootStrapRepo = "BootStrap"
$RepoLocation = "\\aaptfile01\adxsdk\PowerShell\bootstrapper"
$RepoLocation = "https://www.powershellgallery.com/api/v2/"
$existingRepos = Get-PSRepository | Where {$_.SourceLocation -eq $RepoLocation}
if ($existingRepos -eq $null)
{
Expand All @@ -14,33 +14,90 @@ else
}


function Get-AzProfile
function Get-ProfileCachePath
{
@{
'2015-05' =
@{
'AzureRM' = @('1.2.4');
'AzureRM.Storage' = @('1.2.4');
'Azure.Storage' = @('1.2.4');
'AzureRM.Profile' = @('1.2.4');
};
'2016-09' =
@{
'AzureRM' = @('2.0.1');
'AzureRM.Storage' = @('2.0.1')
'Azure.Storage' = @('2.0.1');
'AzureRM.Profile' = @('2.0.1');
}
}
$ProfileCache = Join-Path -path $env:LOCALAPPDATA -childpath "Microsoft\AzurePowerShell\ProfileCache"
Copy link
Owner

Choose a reason for hiding this comment

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

We will want to think about this. Not sure how the directory information will translate in powershell core.

return $ProfileCache
}


# Get-ProfileMap from Azure Endpoint
function Get-AzureProfileMap
{
$ProfileCache = Get-ProfileCachePath
Copy link
Owner

Choose a reason for hiding this comment

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

We need to have a default map that ships with the cmdlets, so that we can work if this call fails. We probably also want to have an aging mechanism for the cache, so that we don't download a new copy of the map on each request.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We already have a default profile map that ships with the cmdlets. Please check lines 83 & 84.
The caching works like this:
(I) Get-AzProfile first looks for ProfileMap in cache
(ii) If its not available, then looks at the default ProfileMap ($PSCommandPath)
(iii) If Get-AzProfile is used with -Force, then updates the cache from online. It doesn't prompt for update unless specified with -Force. (I'll change -Force to -Online)

if(-Not (Test-Path $ProfileCache))
{
New-Item -ItemType Directory -Force -Path $ProfileCache | Out-Null
}

$response = Invoke-RestMethod -ea SilentlyContinue -Uri $PSProfileMapEndpoint -ErrorVariable RestError -OutFile "$ProfileCache\ProfileMap.Json"

if ($RestError)
{
$HttpStatusCode = $RestError.ErrorRecord.Exception.Response.StatusCode.value__
$HttpStatusDescription = $RestError.ErrorRecord.Exception.Response.StatusDescription

Throw "Http Status Code: $($HttpStatusCode) `nHttp Status Description: $($HttpStatusDescription)"
Copy link
Owner

Choose a reason for hiding this comment

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

See above, we should have a default map

}

$ProfileMap = Get-Content -Raw -Path "$ProfileCache\ProfileMap.json" -ErrorAction SilentlyContinue | ConvertFrom-Json

return $ProfileMap
}


function Get-AzProfile
{
[CmdletBinding()]
param()
DynamicParam
{
$params = New-Object -Type System.Management.Automation.RuntimeDefinedParameterDictionary
Add-SwitchParam $params "Update"
Add-SwitchParam $params "ListAvailable" "ListAvailableParameterSet"
return $params
}

PROCESS
{
$Update = $PSBoundParameters.Update
# If Update is present, download ProfileMap from Storage blob endpoint
if ($Update.IsPresent)
{
return (Get-AzureProfileMap)
}

# Check the cache
$ProfileCache = Get-ProfileCachePath
if(Test-Path $ProfileCache)
{
$ProfileMap = Get-Content -Raw -Path "$ProfileCache\ProfileMap.json" -ErrorAction SilentlyContinue | ConvertFrom-Json

if ($ProfileMap -ne $null)
{
return $ProfileMap
}
}

# If cache doesn't exist, Check embedded source
$defaults = [System.IO.Path]::GetDirectoryName($PSCommandPath)
$ProfileMap = Get-Content -Raw -Path "$defaults\ProfileMap.json" -ErrorAction SilentlyContinue | ConvertFrom-Json
if($ProfileMap -eq $null)
{
# Cache & Embedded source empty; Return error and stop
throw [System.IO.FileNotFoundException] "$ProfileMap not found."
}

return $ProfileMap
}
}


function Add-ProfileParam
{
param([System.Management.Automation.RuntimeDefinedParameterDictionary]$params, [string]$set = "__AllParameterSets")
$ProfileMap = (Get-AzProfile)
$AllProfiles = $ProfileMap.Keys
$AllProfiles = ($ProfileMap | Get-Member -MemberType NoteProperty).Name
$profileAttribute = New-Object -Type System.Management.Automation.ParameterAttribute
$profileAttribute.ParameterSetName = $set
$profileAttribute.Mandatory = $true
Expand All @@ -57,7 +114,6 @@ function Add-ForceParam
{
param([System.Management.Automation.RuntimeDefinedParameterDictionary]$params, [string]$set = "__AllParameterSets")
Add-SwitchParam $params "Force" $set

}

function Add-SwitchParam
Expand All @@ -83,9 +139,13 @@ function Get-AzureRmModule
{
$params = New-Object -Type System.Management.Automation.RuntimeDefinedParameterDictionary
Add-ProfileParam $params
$enum = $ProfileMap.Values.GetEnumerator()
$ProfileMap = (Get-AzProfile)
$Profiles = ($ProfileMap | Get-Member -MemberType NoteProperty).Name
$enum = $Profiles.GetEnumerator()
$toss = $enum.MoveNext()
$moduleValid = New-Object -Type System.Management.Automation.ValidateSetAttribute($enum.Current.Keys)
$Current = $enum.Current
$Keys = ($($ProfileMap.$Current) | Get-Member -MemberType NoteProperty).Name
$moduleValid = New-Object -Type System.Management.Automation.ValidateSetAttribute($Keys)
$moduleAttribute = New-Object -Type System.Management.Automation.ParameterAttribute
$moduleAttribute.ParameterSetName =
$moduleAttribute.Mandatory = $true
Expand All @@ -101,10 +161,10 @@ function Get-AzureRmModule
PROCESS
{
$ProfileMap = (Get-AzProfile)
$AllProfiles = $ProfileMap.Keys
$AllProfiles = ($ProfileMap | Get-Member -MemberType NoteProperty).Name
$Profile = $PSBoundParameters.Profile
$Module = $PSBoundParameters.Module
$versionList = $ProfileMap[$Profile][$Module]
$versionList = $ProfileMap.$Profile.$Module
$moduleList = Get-Module -Name $Module -ListAvailable | where {$_.RepositorySourceLocation -ne $null}
foreach ($version in $versionList)
{
Expand Down Expand Up @@ -132,16 +192,25 @@ function Get-AzureRmProfile
{
$params = New-Object -Type System.Management.Automation.RuntimeDefinedParameterDictionary
Add-SwitchParam $params "ListAvailable" "ListAvailableParameterSet"
Add-SwitchParam $params "Update"
return $params
}
PROCESS
{
[switch]$ListAvailable = $PSBoundParameters.ListAvailable
$ProfileMap = (Get-AzProfile)
$AllProfiles = $ProfileMap.Keys
$ProfileMap = (Get-AzProfile @PSBoundParameters)
$AllProfiles = ($ProfileMap | Get-Member -MemberType NoteProperty).Name
if ($ListAvailable.IsPresent)
{
$AllProfiles
foreach ($Profile in $ProfileMap)
{
foreach ($Module in ($Profile | get-member -MemberType NoteProperty).Name)
{
Write-Output "Profile: $Module"
Write-Output "----------------"
$Profile.$Module | fl
}
}
}
else
{
Expand Down Expand Up @@ -177,14 +246,14 @@ function Use-AzureRmProfile
{
$Force = $PSBoundParameters.Force
$ProfileMap = (Get-AzProfile)
$AllProfiles = $ProfileMap.Keys
$AllProfiles = ($ProfileMap | Get-Member -MemberType NoteProperty).Name
$Profile = $PSBoundParameters.Profile
if ($PSCmdlet.ShouldProcess($Profile, "Loading modules for profile in the current scope"))
{
$version = Get-AzureRmModule -Profile $Profile -Module $RollUpModule
if (($version -eq $null) -and ($Force.IsPresent -or $PSCmdlet.ShouldContinue("Install Modules for Profile $Profile from the gallery?", "Installing Modules for Profile $Profile")))
{
$versions = $ProfileMap[$Profile][$RollUpModule]
$versions = $ProfileMap.$Profile.$RollUpModule
$versionEnum = $versions.GetEnumerator()
$toss = $versionEnum.MoveNext()
$version = $versionEnum.Current
Expand Down Expand Up @@ -213,9 +282,9 @@ function Install-AzureRmProfile

PROCESS {
$ProfileMap = (Get-AzProfile)
$AllProfiles = $ProfileMap.Keys
$AllProfiles = ($ProfileMap | Get-Member -MemberType NoteProperty).Name
$Profile = $PSBoundParameters.Profile
$versions = $ProfileMap[$Profile][$RollUpModule]
$versions = $ProfileMap.$Profile.$RollUpModule
$versionEnum = $versions.GetEnumerator()
$toss = $versionEnum.MoveNext()
$version = $versionEnum.Current
Expand All @@ -242,10 +311,10 @@ function Uninstall-AzureRmProfile
PROCESS {
$Force = $PSBoundParameters.Force
$ProfileMap = (Get-AzProfile)
$AllProfiles = $ProfileMap.Keys
$AllProfiles = ($ProfileMap | Get-Member -MemberType NoteProperty).Name
$Profile = $PSBoundParameters.Profile
$versions = $ProfileMap[$Profile]
foreach ($module in $versions.Keys)
$versions = ($ProfileMap.$profile | Get-Member -MemberType NoteProperty).Name
foreach ($module in $versions)
{
$canceled = $false
Do
Expand Down Expand Up @@ -285,4 +354,4 @@ function Set-BootstrapRepo
[CmdletBinding()]
param([string]$Repo)
$script:BootStrapRepo = $Repo
}
}