forked from OCram85/PSCredentialStore
remove optional depenency helper (#68)
#### 📖 Summary - removed optional dependency helper. Moved optional deps into `ExternalModuleDependencies` field. #### 📑 Test Plan > 💡 Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification <!-- Add your test details or justification for missing tests here. --> #### 📚 Additional Notes <!-- A place for additional detail notes. --> Co-authored-by: OCram85 <marco.blessing@googlemail.com> Reviewed-on: OCram85/PSCredentialStore#68
This commit is contained in:
parent
1e7dd78c2b
commit
a95ba31e40
@ -1,38 +0,0 @@
|
|||||||
{
|
|
||||||
"Version": 0.1,
|
|
||||||
"Mandatory": {},
|
|
||||||
"Optional": [
|
|
||||||
{
|
|
||||||
"Name": "foobar2000",
|
|
||||||
"Modules": [
|
|
||||||
"foobar2000"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Name": "foo",
|
|
||||||
"Modules": [
|
|
||||||
"foo",
|
|
||||||
"bar"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Name": "bar",
|
|
||||||
"Modules": [
|
|
||||||
"bar"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Name": "Existing",
|
|
||||||
"Modules": [
|
|
||||||
"PowerShellGet"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Name": "PSGetMixed",
|
|
||||||
"Modules": [
|
|
||||||
"PowerShellGet",
|
|
||||||
"foobar2000"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@ -130,12 +130,6 @@ function Connect-To {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
# First check the optional modules
|
|
||||||
if (-not (Resolve-Dependency -Name $Type)) {
|
|
||||||
Write-Error -Message (
|
|
||||||
"Could not resolve the optional dependencies defined for {0}" -f $Type
|
|
||||||
) -ErrorAction 'Stop'
|
|
||||||
}
|
|
||||||
switch ($Type) {
|
switch ($Type) {
|
||||||
"VMware" {
|
"VMware" {
|
||||||
# Disable the yellow certificate warning, since we haven't replaced the SSL certs for vCenter/ESXi
|
# Disable the yellow certificate warning, since we haven't replaced the SSL certs for vCenter/ESXi
|
||||||
|
|||||||
@ -143,7 +143,32 @@
|
|||||||
# RequireLicenseAcceptance = $false
|
# RequireLicenseAcceptance = $false
|
||||||
|
|
||||||
# External dependent modules of this module
|
# External dependent modules of this module
|
||||||
# ExternalModuleDependencies = @()
|
ExternalModuleDependencies = @(
|
||||||
|
@{
|
||||||
|
ModuleName = 'VMware.VimAutomation.Core'
|
||||||
|
ModuleVersion = '6.5.2.6234650'
|
||||||
|
},
|
||||||
|
@{
|
||||||
|
ModuleName = 'VMware.VimAutomation.Cis.Core'
|
||||||
|
ModuleVersion = '6.5.4.6983166'
|
||||||
|
},
|
||||||
|
@{
|
||||||
|
ModuleName = 'Cisco.UCS.Core'
|
||||||
|
ModuleVersion = '2.3.1.5'
|
||||||
|
},
|
||||||
|
@{
|
||||||
|
ModuleName = 'Cisco.UCSManager'
|
||||||
|
ModuleVersion = '2.5.2.2'
|
||||||
|
},
|
||||||
|
@{
|
||||||
|
ModuleName = 'WinSCP'
|
||||||
|
ModuleVersion = '5.17.8.1'
|
||||||
|
},
|
||||||
|
@{
|
||||||
|
ModuleName = 'DataONTAP'
|
||||||
|
ModuleVersion = '9.7.1.1'
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
} # End of PSData hashtable
|
} # End of PSData hashtable
|
||||||
|
|
||||||
|
|||||||
@ -1,60 +0,0 @@
|
|||||||
BeforeAll {
|
|
||||||
$ManifestFile = (Get-Item -Path "./src/*.psd1").FullName
|
|
||||||
Import-Module $ManifestFile -Force
|
|
||||||
|
|
||||||
$PrivateFunctions = (Get-ChildItem -Path "./src/Private/*.ps1" | Where-Object {
|
|
||||||
$_.BaseName -notmatch '.Tests'
|
|
||||||
}
|
|
||||||
).FullName
|
|
||||||
foreach ( $func in $PrivateFunctions) {
|
|
||||||
. $func
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Describe "Resolve-Dependency" {
|
|
||||||
Context "Basic syntax check" {
|
|
||||||
BeforeAll {
|
|
||||||
Mock Get-ModuleBase {
|
|
||||||
return (Join-Path -Path $PWD -ChildPath '/resources')
|
|
||||||
}
|
|
||||||
Mock Test-Module {
|
|
||||||
return $true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
It "Test1: Should not throw" {
|
|
||||||
{ Resolve-Dependency -Name 'foobar2000' } | Should -Not -Throw
|
|
||||||
}
|
|
||||||
It "Test2: Output type should be bool" {
|
|
||||||
Resolve-Dependency -Name 'foobar2000' | Should -BeOfType bool
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Context "Enforce Error" {
|
|
||||||
# Return incorrect module base to enforce there is no config file.
|
|
||||||
Mock Get-ModuleBase {
|
|
||||||
if ($IsWindows) { return "C:\" }
|
|
||||||
elseif ($isLinux) { return "/" }
|
|
||||||
}
|
|
||||||
It "Missing dependency file should not cause an error" {
|
|
||||||
{ Resolve-Dependency -Name 'awesome' } | Should -Not -Throw
|
|
||||||
}
|
|
||||||
|
|
||||||
It "Missing dependency file should return true" {
|
|
||||||
Resolve-Dependency -Name 'awesome' | Should -Be $true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Context "Testing input variations" {
|
|
||||||
It "Should return true if all given dependencies exist" {
|
|
||||||
Mock Get-ModuleBase {
|
|
||||||
return (Join-Path -Path $PWD -ChildPath '/resources')
|
|
||||||
}
|
|
||||||
Resolve-Dependency -Name 'Existing' | Should -Be $true
|
|
||||||
}
|
|
||||||
It "Mixed results should return false" {
|
|
||||||
Mock Get-ModuleBase {
|
|
||||||
return (Join-Path -Path $PWD -ChildPath '/resources')
|
|
||||||
}
|
|
||||||
Resolve-Dependency -Name 'PSGetMixed' | Should -Be $false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,87 +0,0 @@
|
|||||||
function Resolve-Dependency {
|
|
||||||
<#
|
|
||||||
.SYNOPSIS
|
|
||||||
Tests defined optional dependencies and returns the result as bool.
|
|
||||||
|
|
||||||
.DESCRIPTION
|
|
||||||
Use this function to test for optional modules. You can use it if you provide functions which needs special
|
|
||||||
modules but you don't want to make them required.
|
|
||||||
|
|
||||||
Place a file called Dependency.json in your module root dir. The default format is:
|
|
||||||
|
|
||||||
{
|
|
||||||
"Version": 0.1,
|
|
||||||
"Mandatory": {},
|
|
||||||
"Optional": [
|
|
||||||
{
|
|
||||||
"Name": "VMware",
|
|
||||||
"Modules": [
|
|
||||||
"VMware.VimAutomation.Core"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Name": "CiscoUCS",
|
|
||||||
"Modules": []
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
.PARAMETER Name
|
|
||||||
Select the dependency item name you defined in the dependency.json.
|
|
||||||
.INPUTS
|
|
||||||
[None]
|
|
||||||
|
|
||||||
.OUTPUTS
|
|
||||||
[bool]
|
|
||||||
|
|
||||||
.EXAMPLE
|
|
||||||
If (-not (Resolve-Dependency -Name 'VMware')) {
|
|
||||||
Write-Error -Message (
|
|
||||||
"Could not resolve the optional dependencies defined for {0}" -f 'VMware'
|
|
||||||
) -ErrorAction 'Stop'
|
|
||||||
}
|
|
||||||
#>
|
|
||||||
|
|
||||||
[OutputType([bool])]
|
|
||||||
[CmdletBinding()]
|
|
||||||
param (
|
|
||||||
[Parameter(Mandatory = $true)]
|
|
||||||
[ValidateNotNullOrEmpty()]
|
|
||||||
[string]$Name
|
|
||||||
)
|
|
||||||
|
|
||||||
begin {
|
|
||||||
$ModuleRootDir = Get-ModuleBase
|
|
||||||
$DepFilePath = Join-Path -Path $ModuleRootDir -ChildPath "Dependency.json"
|
|
||||||
if (Test-Path -Path $DepFilePath) {
|
|
||||||
$Dependency = Get-Content -Path $DepFilePath -Raw -Encoding UTF8 | ConvertFrom-Json
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
Write-Warning ("Could not find the dependency file: {0}" -f $DepFilePath)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
process {
|
|
||||||
# ScriptAnalyzer issue workaround (unused var)
|
|
||||||
$null = $Name
|
|
||||||
$SelectedDependency = $Dependency.Optional | Where-Object { $_.Name -match $Name }
|
|
||||||
# return true if there is no dependency defined
|
|
||||||
if ($null -eq $SelectedDependency) {
|
|
||||||
return $true
|
|
||||||
}
|
|
||||||
|
|
||||||
$res = @()
|
|
||||||
foreach ($Module in $SelectedDependency.Modules) {
|
|
||||||
$res += Test-Module -Name $Module
|
|
||||||
}
|
|
||||||
# return false if there was not module at all
|
|
||||||
if (($res -contains $false) -or ($res.Count -eq 0)) {
|
|
||||||
return $false
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
return $true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
end {}
|
|
||||||
}
|
|
||||||
Loading…
Reference in New Issue
Block a user