Public/Get-Dependency.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
function Get-Dependency { <# .SYNOPSIS Read a dependency psd1 file .DESCRIPTION Read a dependency psd1 file The resulting object contains these properties DependencyFile : Path to psd1 file this dependency is defined in DependencyName : Unique dependency name (the key in the psd1 file). We reserve PSDependOptions for global options. DependencyType : Type of dependency. See Get-PSDependType Name : Name for the dependency Version : Version for the dependency Parameters : Hash table of parameters to pass to dependency script Source : Source for the dependency Target : Target for the dependency AddToPath : If specified and dependency type supports it, add dependency to path (e.g. a module is added to PSModulePath) Tags : One or more tags to categorize or filter dependencies DependsOn : Dependency that must be installed before this PreScripts : One or more paths to PowerShell scripts to run before the dependency PostScripts : One or more paths to PowerShell scripts to run after the dependency PSDependOptions: Hash table of global PSDepend options Raw : Raw output for this dependency from the PSD1. May include data outside of standard items above. These are parsed from dependency PSD1 files as follows: Simple syntax, intepreted: @{ DependencyName = 'Version' } With the simple syntax using interpretation: * The DependencyName (key) is used as the Name * If no DependencyType is specified, we parse the DependencyName to pick a default: * We default to GitHub if the DependencyName has a single / (e.g. aaa/bbb) * We default to git if the DependencyName has more than one / (e.g. https://gitlab.fqdn/org/some.git) * We default to PSGalleryModule in all other cases * The Version (value) is a string, and is used as the Version * Other properties are set to $null Simple syntax, with helpers: @{ DependencyType::DependencyName = 'Version' } With the simple syntax using helpers: * The dependency type and dependency name are included in the key (DependencyType::DependencyName, e.g. PSGalleryModule::Pester) * The version (value) is a string, and is used as the Version * Other properties are set to $null Advanced syntax: @{ DependencyName = @{ DependencyType = 'TypeOfDependency'. # See Get-PSDependType Name = 'NameForThisDependency' Version = '0.1.0' Parameters = @{ Example = 'Value' } # Optional parameters for the dependency script. Source = 'Some source' # Usually optional Target = 'Some target' # Usually optional AddToPath = $True # Whether to add new dependency to path, if dependency type supports it. Tags = 'prod', 'local' # One or more tags to categorize or filter dependencies DependsOn = 'Some_Other_DependencyName' # DependencyName that must run before this PreScripts = 'C:\script.ps1' # Script(s) to run before this dependency PostScripts = 'C:\script2.ps1' # Script(s) to run after this dependency } } We use the same default DependencyTypes for this advanced syntax Global options: @{ PSDependOptions = @{ Target = 'C:\temp' } # Supported for: # Parameters # Source # Target # AddToPath # Tags # DependsOn # PreScripts # PostScripts # Dependencies use these values as a default, unless you specify them explicitly for a dependency } Note that you can mix these syntax together in the same psd1. .PARAMETER Path Path to project root or dependency file. If a folder is specified, we search for and process *.depend.psd1 and requirements.psd1 files. .PARAMETER Tags Limit results to one or more tags defined in the Dependencies .PARAMETER Recurse If specified and path is a container, search for *.depend.psd1 and requirements.psd1 files recursively under $Path .PARAMETER InputObject If specified instead of Path, treat this hashtable as the contents of a dependency file. For example: -InputObject @{ BuildHelpers = 'latest' PSDeploy = 'latest' InvokeBuild = 'latest' } .PARAMETER Credentials Specifies a hashtable of PSCredentials to use for each dependency that is served from a private feed. For example: -Credentials @{ PrivatePackage = $privateCredentials AnotherPrivatePackage = $morePrivateCredenials } .LINK about_PSDepend .LINK about_PSDepend_Definitions .LINK Get-PSDependScript .LINK Get-PSDependType .LINK Install-Dependency .LINK Invoke-PSDepend .LINK https://github.com/RamblingCookieMonster/PSDepend #> [cmdletbinding(DefaultParameterSetName = 'File')] param( [parameter(ParameterSetName='File')] [string[]]$Path = $PWD.Path, [string[]]$Tags, [parameter(ParameterSetName='File')] [switch]$Recurse, [parameter(ParameterSetName='Hashtable')] [hashtable[]]$InputObject, [parameter(ParameterSetName='File')] [parameter(ParameterSetName='Hashtable')] [hashtable]$Credentials ) # Helper to pick from global psdependoptions, or return a default function Get-GlobalOption { param( $Options = $PSDependOptions, $Name, $Prefer, $Default = $null ) # Check for preferred value, otherwise try to get value from key, otherwise use default.... $Output = $Default if($Prefer) { $Output = $Prefer } else { try { $Output = $Options[$Name] } catch { $Output = $Default } } # Inject variables if( $Name -eq 'Target' -or $Name -eq 'Source' -or $Name -eq 'PreScripts' -or $Name -eq 'PostScripts') { $Output = Inject-Variable $Output } $Output } function Inject-Variable { [cmdletbinding()] param( $Value ) $Output = $Value switch($Value) { {$_ -match '^\.$|^\.\\|^\./'}{ $Output = $Output -replace '^\.', $PWD.Path } {$_ -Match '\$PWD'} { $Output = $Output -replace '\$PWD', $PWD.Path } {$_ -Match '\$ENV:ProgramData'} { $Output = $Output -replace '\$ENV:ProgramData', $ENV:ProgramData } {$_ -Match '\$ENV:USERPROFILE'} { $Output = $Output -replace '\$ENV:USERPROFILE', $ENV:USERPROFILE } {$_ -Match '\$ENV:APPDATA'} { $Output = $Output -replace '\$ENV:APPDATA', $ENV:APPDATA } {$_ -Match '\$ENV:TEMP'} { $Output = $Output -replace '\$ENV:TEMP', $ENV:TEMP } {$_ -Match '\$DependencyFolder|\$DependencyPath'} { $DependencyFolder = Split-Path $DependencyFile -Parent $Output = $Output -replace '\$DependencyFolder|\$DependencyPath', $DependencyFolder } } $Output } # Helper to take in a dependency hash and output Dependency objects function Parse-Dependency { [cmdletbinding()] param( $ParamSet = $PSCmdlet.ParameterSetName ) # Global settings.... $PSDependOptions = $null if($Dependencies.Containskey('PSDependOptions')) { $PSDependOptions = $Dependencies.PSDependOptions $Dependencies.Remove('PSDependOptions') } foreach($Dependency in $Dependencies.keys) { $DependencyHash = $Dependencies.$Dependency $DependencyType = Get-GlobalOption -Name DependencyType $CredentialName = Get-GlobalOption -Name Credential # Look simple syntax with helpers in the key first If( $DependencyHash -is [string] -and $Dependency -match '::' -and ($Dependency -split '::').count -eq 2 ) { [pscustomobject]@{ PSTypeName = 'PSDepend.Dependency' DependencyFile = $DependencyFile DependencyName = ($Dependency -split '::')[1] DependencyType = ($Dependency -split '::')[0] Name = ($Dependency -split '::')[1] Version = $DependencyHash Parameters = Get-GlobalOption -Name Parameters Source = Get-GlobalOption -Name Source Target = Get-GlobalOption -Name Target AddToPath = Get-GlobalOption -Name AddToPath Tags = Get-GlobalOption -Name Tags DependsOn = Get-GlobalOption -Name DependsOn PreScripts = Get-GlobalOption -Name PreScripts PostScripts = Get-GlobalOption -Name PostScripts PSDependOptions = $PSDependOptions Raw = $null } } #Parse simple key=name, value=version format # It doesn't look like a git repo, and simple syntax: PSGalleryModule elseif( $DependencyHash -is [string] -and $Dependency -notmatch '/' -and -not $DependencyType -or $DependencyType -eq 'PSGalleryModule') { [pscustomobject]@{ PSTypeName = 'PSDepend.Dependency' DependencyFile = $DependencyFile DependencyName = $Dependency DependencyType = 'PSGalleryModule' Name = $Dependency Version = $DependencyHash Parameters = Get-GlobalOption -Name Parameters Source = Get-GlobalOption -Name Source Target = Get-GlobalOption -Name Target AddToPath = Get-GlobalOption -Name AddToPath Tags = Get-GlobalOption -Name Tags DependsOn = Get-GlobalOption -Name DependsOn PreScripts = Get-GlobalOption -Name PreScripts PostScripts = Get-GlobalOption -Name PostScripts Credential = Resolve-Credential -Name $CredentialName PSDependOptions = $PSDependOptions Raw = $null } } # It looks like a git repo, simple syntax, and not a full URI elseif($DependencyHash -is [string] -and $Dependency -match '/' -and $Dependency.split('/').count -eq 2 -and -not $DependencyType -or $DependencyType -eq 'GitHub') { [pscustomobject]@{ PSTypeName = 'PSDepend.Dependency' DependencyFile = $DependencyFile DependencyName = $Dependency DependencyType = 'GitHub' Name = $Dependency Version = $DependencyHash Parameters = Get-GlobalOption -Name Parameters Source = Get-GlobalOption -Name Source Target = Get-GlobalOption -Name Target AddToPath = Get-GlobalOption -Name AddToPath Tags = Get-GlobalOption -Name Tags DependsOn = Get-GlobalOption -Name DependsOn PreScripts = Get-GlobalOption -Name PreScripts PostScripts = Get-GlobalOption -Name PostScripts PSDependOptions = $PSDependOptions Raw = $null } } # It looks like a git repo, and simple syntax: Git elseif($DependencyHash -is [string] -and $Dependency -match '/' -and -not $DependencyType -or $DependencyType -eq 'Git' ) { [pscustomobject]@{ PSTypeName = 'PSDepend.Dependency' DependencyFile = $DependencyFile DependencyName = $Dependency DependencyType = 'Git' Name = $Dependency Version = $DependencyHash Parameters = Get-GlobalOption -Name Parameters Source = Get-GlobalOption -Name Source Target = Get-GlobalOption -Name Target AddToPath = Get-GlobalOption -Name AddToPath Tags = Get-GlobalOption -Name Tags DependsOn = Get-GlobalOption -Name DependsOn PreScripts = Get-GlobalOption -Name PreScripts PostScripts = Get-GlobalOption -Name PostScripts PSDependOptions = $PSDependOptions Raw = $null } } else { # Parse dependency hash format # Default type is module, unless it's in a git-style format if(-not $DependencyHash.DependencyType) { # Is it a global option? if($DependencyType) {} # GitHub first elseif( # Ugly right? Watch out for split called on hashtable... ($Dependency -match '/' -and -not $Dependency.Name -and ($Dependency -is [string] -and $Dependency.split('/').count -eq 2) ) -or ($DependencyHash.Name -match '/' -and ($DependencyHash -is [string] -and $DependencyHash.split('/').count -eq 2) ) ) { $DependencyType = 'GitHub' } # Now git... elseif( ($Dependency -match '/' -and -not $Dependency.Name) -or $DependencyHash.Name -match '/' ) { $DependencyType = 'Git' } else # finally, psgallerymodule { $DependencyType = 'PSGalleryModule' } } else { $DependencyType = $DependencyHash.DependencyType } $CredentialName = Get-GlobalOption -Name Credential -Prefer $DependencyHash.Credential [pscustomobject]@{ PSTypeName = 'PSDepend.Dependency' DependencyFile = $DependencyFile DependencyName = $Dependency DependencyType = $DependencyType Name = $DependencyHash.Name Version = $DependencyHash.Version Parameters = Get-GlobalOption -Name Parameters -Prefer $DependencyHash.Parameters Source = Get-GlobalOption -Name Source -Prefer $DependencyHash.Source Target = Get-GlobalOption -Name Target -Prefer $DependencyHash.Target AddToPath = Get-GlobalOption -Name AddToPath -Prefer $DependencyHash.AddToPath Tags = Get-GlobalOption -Name Tags -Prefer $DependencyHash.Tags DependsOn = Get-GlobalOption -Name DependsOn -Prefer $DependencyHash.DependsOn PreScripts = Get-GlobalOption -Name PreScripts -Prefer $DependencyHash.PreScripts PostScripts = Get-GlobalOption -Name PostScripts -Prefer $DependencyHash.PostScripts Credential = Resolve-Credential -Name $CredentialName PSDependOptions = $PSDependOptions Raw = $DependencyHash } } } } # Heleper to retrieve the credential for a dependency function Resolve-Credential { [CmdletBinding()] param ( [string]$Name ) $credential = $null if (($null -ne $Name) -and ($null -ne $Credentials)) { if ($Credentials.ContainsKey($Name)) { $credential = $Credentials[$Name] } else { Write-Warning "No credential found for the specified name $Name. Was the dependency misconfigured?" } } return $credential } if($PSCmdlet.ParameterSetName -eq 'File') { $ParsedDependencies = foreach($DependencyPath in $Path) { #Resolve relative paths... Thanks Oisin! http://stackoverflow.com/a/3040982/3067642 $DependencyPath = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($DependencyPath) if(Test-Path $DependencyPath -PathType Container) { $DependencyFiles = @( Resolve-DependScripts -Path $DependencyPath -Recurse $Recurse ) } else { $DependencyFiles = @( $DependencyPath ) } $DependencyFiles = $DependencyFiles | Select-Object -Unique foreach($DependencyFile in $DependencyFiles) { # Read the file $Base = Split-Path $DependencyFile -Parent $File = Split-Path $DependencyFile -Leaf $Dependencies = Import-LocalizedData -BaseDirectory $Base -FileName $File Parse-Dependency -ParamSet $PSCmdlet.ParameterSetName } } } elseif($PSCmdlet.ParameterSetName -eq 'Hashtable') { $DependencyFile = 'Hashtable' $ParsedDependencies = foreach($InputDependency in $InputObject) { $Dependencies = $InputDependency Parse-Dependency -ParamSet $PSCmdlet.ParameterSetName } } If($PSBoundParameters.ContainsKey('Tags')) { $ParsedDependencies = Get-TaggedDependency -Dependency $ParsedDependencies -Tags $Tags if(-not $ParsedDependencies) { Write-Warning "No dependencies found with tags '$tags'" return } } Sort-PSDependency -Dependencies $ParsedDependencies } |