Add unit tests for Set-CredentialStoreItem

.changelog.yml

@@ -1,32 +0,0 @@
-# The full repository name
-repo: OCram85/PSCredentialStore
-
-# Service type (gitea or github)
-service: gitea
-
-# Base URL for Gitea instance if using gitea service type (optional)
-# Default: https://gitea.com
-base-url: https://gitea.ocram85.com
-
-# Changelog groups and which labeled PRs to add to each group
-groups:
-  - name: ✨ FEATURES
-    labels:
-      - feature
-  - name: 📦 META
-    labels:
-      - meta
-  - name: 🐛 BUGFIXES
-    labels:
-      - bug
-  - name: 🛠️ ENHANCEMENTS
-    labels:
-      - enhancement
-  - name: 📚 DOCS
-    labels:
-      - docs
-  - name: 🔖 MISC
-    default: true
-
-# regex indicating which labels to skip for the changelog
-skip-labels: skip-changelog|backport\/.+

.drone.yml

@@ -120,7 +120,7 @@ steps:
           Install-Module -Name 'DroneHelper' -Repository 'PSGallery' -ErrorAction 'Stop' -AllowPrerelease -Force;
           Import-Module -Name 'DroneHelper' -ErrorAction 'Stop';
           Install-ModuleDependency;
-          New-BuildPackage -Verbose -AdditionalPath @('./src/Vendor', './src/openssl.conf')
+          New-BuildPackage -Verbose
         }"
 
   - name: GiteaRelease

.gitattributes

@@ -21,5 +21,4 @@
 
 # Vendor resources config
 src/Vendor/libressl255/* filter=lfs diff=lfs merge=lfs -text
-src/Vendor/libressl/* filter=lfs diff=lfs merge=lfs -text
 *.pfx filter=lfs diff=lfs merge=lfs -text

CHANGELOG.md

@@ -1,25 +1,9 @@
 # Changelog
 
 <!-- insertMark -->
-## [v1.1.1](https://gitea.ocram85.com/OCram85/PSCredentialStore/releases/tag/v1.1.1) - 2022-10-10
-
-* 📦 META
-  * Adds changelog config for gitea changelog cli tool (#77)
-* 🐛 BUGFIXES
-  * Fix Set-CredentialStoreItem (#76)
-  * Fix optional module dependencies (#75)
-
-### Contributors
-
-
-* [@OCram85](https://gitea.ocram85.com/OCram85)
-* [@pinguinfuss](https://gitea.ocram85.com/pinguinfuss)
-
 ## `v1.1.0`
 
-- (3d4f53d) adds pinguinfuss contributed fix (#73)
+- (acb09ba) update Changelog
-- (6fce8d6) Updates libressl files (#71)
-- (ddb85d9) addChangelog (#70)
 - (5bdb383) updates Readme (#69)
 - (a95ba31) remove optional depenency helper (#68)
 - (1e7dd78) adds CiscoUCSCentral connection type (#67)
@@ -36,6 +20,7 @@
 - (4abfec5) adds PR template (#55)
 - (7708df9) Update pwsh style to latest community standards (#52)
 
+
 ## `v1.0.542`
 
 - 🧙 pre migrated Gitea version

src/Certificate/New-CSCertificate.ps1

@@ -66,7 +66,7 @@ function New-CSCertificate {
             ($PSVersionTable.PSEdition -eq 'Desktop' -and $PSVersionTable.PSVersion.Major -lt 6) -or
             ($IsWindows -eq $true)
         ) {
-            $openssl = Join-Path -Path $ModuleBase -ChildPath '/Vendor/libressl/openssl.exe'
+            $openssl = Join-Path -Path $ModuleBase -ChildPath '/Vendor/libressl255/openssl.exe'
         }
 
         $Env:OPENSSL_CONF = Join-Path $ModuleBase -ChildPath '/openssl.conf'

src/Item/Find-CredentialStoreItem.Tests.ps1

@@ -1,150 +0,0 @@
-[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
-    'PSAvoidUsingConvertToSecureStringWithPlainText',
-    '',
-    Justification = 'just used in pester tests.'
-)]
-param ()
-
-BeforeAll {
-    $Repo = Get-RepoPath
-    Import-Module $Repo.Src.Manifest.Item.FullName -Force
-
-    # Backup existing CredentialStores
-    $Paths = @(('{0}\AppData\Roaming' -f $env:USERPROFILE), ('{0}\ProgramData\PSCredentialStore\' -f $env:SystemDrive))
-    $Files = @('CredentialStore.json', 'PSCredentialStore.pfx')
-
-    foreach ($Filepath in $Paths) {
-        foreach ($File in $Files) {
-            $OrgPath = Join-Path -Path $FilePath -ChildPath $File
-            $NewPath = $OrgPath + '.orig'
-            if (Test-Path $OrgPath) {
-                try {
-                    $null = Remove-Item -Path $NewPath -Force -Confirm:$false
-                    $null = Rename-Item -Path $OrgPath -NewName $NewPath -Confirm:$false
-                }
-                catch {
-                    $_.Exception.Message | Write-Warning
-                    Write-Error -Message ('Unable to revert {0} to {1}' -f $OrgPath, $NewPath)
-                }
-            }
-        }
-    }
-
-    # Construct the necessary CredentialStores for the Unit tests.
-    New-CredentialStore -Force
-    New-CredentialStore -Shared -Force
-
-    # Construct the necessary CredentialStoreItems for the Unit tests.
-    $CredentialUserName = 'MyUser'
-    $CredentialPassword = 'FooBar' | ConvertTo-SecureString -AsPlainText -Force
-    $Credential = [PSCredential]::new($CredentialUserName, $CredentialPassword)
-
-    # Create the CredentialStoreItems
-    New-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Credential $Credential
-    New-CredentialStoreItem -Shared -RemoteHost 'test-case-a.domain.my' -Credential $Credential
-
-    New-CredentialStoreItem -Shared -RemoteHost 'test-case-b.domain.my' -Credential $Credential
-    New-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' -Credential $Credential
-
-    New-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Credential $Credential -Identifier 'Foo'
-    New-CredentialStoreItem -Shared -RemoteHost 'test-case-a.domain.my' -Credential $Credential -Identifier 'Foo'
-
-    New-CredentialStoreItem -Shared -RemoteHost 'test-case-b.domain.my' -Credential $Credential -Identifier 'Foo'
-    New-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' -Credential $Credential -Identifier 'Foo'
-}
-
-AfterAll {
-    # Check if the private CredentialStore exists
-    $Paths = @(('{0}\AppData\Roaming' -f $env:USERPROFILE), ('{0}\ProgramData\PSCredentialStore\' -f $env:SystemDrive))
-    $Files = @('CredentialStore.json.orig', 'PSCredentialStore.pfx.orig')
-
-    foreach ($Filepath in $Paths) {
-        foreach ($File in $Files) {
-            $OrgPath = Join-Path -Path $FilePath -ChildPath $File
-            $NewPath = $OrgPath.Replace('.orig', '')
-            if (Test-Path $OrgPath) {
-                try {
-                    $null = Remove-Item -Path $NewPath -Force -Confirm:$false -ErrorAction SilentlyContinue
-                    $null = Rename-Item -Path $OrgPath -NewName $NewPath -Confirm:$false
-                }
-                catch {
-                    $_.Exception.Message | Write-Warning
-                    Write-Error -Message ('Unable to revert {0} to {1}' -f $OrgPath, $NewPath)
-                }
-            }
-        }
-    }
-}
-
-Describe 'Find-CredentialStoreItem' {
-    Context 'Default tests' -Tag 'Default' {
-        It 'Test Function' {
-            { Get-Command -Name 'Find-CredentialStoreItem' -Module $Repo.Artifact } | Should -Not -Throw
-        }
-
-        It 'Test Help' {
-            { Get-Help -Name 'Find-CredentialStoreItem' } | Should -Not -Throw
-        }
-
-        It 'Help Content' {
-            $foo = Get-Help -Name 'Find-CredentialStoreItem'
-            $foo.Synopsis.Length | Should -BeGreaterThan 5
-            $foo.Description.Count | Should -BeGreaterOrEqual 1
-            $foo.Description[0].Text.Length | Should -BeGreaterThan 5
-        }
-    }
-
-    Context 'Coding tests' -Tag 'Coding' {
-        It 'Calling Find-CredentialStoreItem with wrong Type' {
-            { Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Type 'Foo' } | Should -Throw
-        }
-
-        It 'Calling Find-CredentialStoreItem present in both CredentialStores w/o Identifier' {
-            { Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' } | Should -Not -Throw
-
-            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my'
-            $foo.UserName | Should -Be 'MyUser'
-            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
-        }
-
-        It 'Calling Find-CredentialStoreItem present only in shared CredentialStore w/o Identifier' {
-            { Find-CredentialStoreItem -RemoteHost 'test-case-b.domain.my' } | Should -Not -Throw
-
-            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-b.domain.my'
-            $foo.UserName | Should -Be 'MyUser'
-            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
-        }
-
-        It 'Calling Find-CredentialStoreItem present only in private CredentialStore w/o Identifier' {
-            { Find-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' } | Should -Not -Throw
-
-            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-c.domain.my'
-            $foo.UserName | Should -Be 'MyUser'
-            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
-        }
-
-        It 'Calling Find-CredentialStoreItem present in both CredentialStores w Identifier' {
-            { Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Identifier 'Foo' } | Should -Not -Throw
-
-            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-a.domain.my' -Identifier 'Foo'
-            $foo.UserName | Should -Be 'MyUser'
-            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
-        }
-
-        It 'Calling Find-CredentialStoreItem present only in shared CredentialStore w/o Identifier' {
-            { Find-CredentialStoreItem -RemoteHost 'test-case-b.domain.my' -Identifier 'Foo' } | Should -Not -Throw
-
-            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-b.domain.my' -Identifier 'Foo'
-            $foo.UserName | Should -Be 'MyUser'
-            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
-        }
-
-        It 'Calling Find-CredentialStoreItem present only in private CredentialStore w/o Identifier' {
-            { Find-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' -Identifier 'Foo' } | Should -Not -Throw
-
-            $foo = Find-CredentialStoreItem -RemoteHost 'test-case-c.domain.my' -Identifier 'Foo'
-            $foo.UserName | Should -Be 'MyUser'
-            $foo.GetNetworkCredential().Password | Should -Be 'FooBar'
-        }
-    }
-}

src/Item/Find-CredentialStoreItem.ps1

@@ -1,152 +0,0 @@
-function Find-CredentialStoreItem {
-    <#
-    .SYNOPSIS
-        Locates a CredentialStoreItem in any CredentialStore from a given remote host item.
-
-    .DESCRIPTION
-        Find the credential object and return it as PSCredential object.
-
-    .PARAMETER RemoteHost
-        Specify the host, for which you would like to find the credentials.
-
-    .PARAMETER Identifier
-        Provide a custom identifier to the given remote host key. This enables you to store multiple credentials
-        for a single remote host entry. For example ad/sys1, ftp/sys1, sql/sys1
-
-    .PARAMETER Type
-        Influence in which types of CredentialStore this function will look for a object. List of possible types:
-          - All (include private and shared CredentialStore) - this is also the default.
-          - Private (only look in a private CredentialStore)
-          - Shared (only look in the shared CredentialStore)
-
-    .INPUTS
-        [None]
-
-    .OUTPUTS
-        [System.Management.Automation.PSCredential]
-
-    .EXAMPLE
-        $Credential = Find-CredentialStoreItem -RemoteHost 'support.komm-one.net' -Type 'All'
-
-    .EXAMPLE
-        $params = @{
-            RemoteHost = 'support.komm-one.net'
-            Type = 'Private'
-            Identifier = 'PersonId'
-        }
-        $Credential = Find-CredentialStoreItem @params
-    #>
-
-    [CmdletBinding()]
-
-    param(
-        [Parameter(Mandatory = $true)]
-        [ValidateNotNullOrEmpty()]
-        [string] $RemoteHost,
-
-        [Parameter(Mandatory = $false)]
-        [string] $Identifier,
-
-        [Parameter(Mandatory = $false)]
-        [ValidateSet('All', 'Private', 'Shared')]
-        [string] $Type = 'All'
-    )
-
-    begin {
-        # Define some defaults for the PreferenceVariables.
-        $ErrorActionPreference = 'Stop'
-        $InformationPreference = 'Continue'
-        $WarningPreference = 'Continue'
-        $ProgressPreference = 'SilentlyContinue'
-
-        # Construct the CredentialStore list, based on what $Type says.
-        switch ($Type) {
-            'All' {
-                $CredentialStoreList = @('Private', 'Shared')
-                break
-            }
-            'Private' {
-                $CredentialStoreList = @('Private')
-            }
-            'Shared' {
-                $CredentialStoreList = @('Shared')
-            }
-        }
-    }
-
-    process {
-        # Now go and look for the CredentialStoreItem.
-        foreach ($Store in $CredentialStoreList) {
-            # First make sure, that the CredentialStore exists. Sadly I don't have a way to solve this any better
-            # programmatically, as PowerShell behaves oddly, if you try and pass an empty splatting to a function.
-            Write-Verbose -Message ('Checking if CredentialStore of type {0} exists' -f $Store)
-
-            if ($Store -eq 'Private') {
-                if (-not (Test-CredentialStore)) {
-                    Write-Warning -Message ('CredentialStore of type {0} not found, skipping ahead' -f $Store)
-                    continue
-                }
-            }
-            elseif ($Store -eq 'Shared') {
-                if (-not (Test-CredentialStore -Shared)) {
-                    Write-Warning -Message ('CredentialStore of type {0} not found, skipping ahead' -f $Store)
-                    continue
-                }
-            }
-            else {
-                Write-Error -Message ('Invalid CredentialStore type {0} supplied' -f $Store)
-                continue
-            }
-
-            # Now that we're here, means we have tested the CredentialStore for existence. We can check, if it
-            # contains a CredentialStoreItem that we are looking for.
-            $params = @{
-                RemoteHost = $RemoteHost
-            }
-
-            # Check if the user passed -Identifier, then we add it to the splatting.
-            if (-not [string]::IsNullOrWhiteSpace($Identifier)) {
-                $params.Add('Identifier', $Identifier)
-            }
-
-            # Check the CredentialStore type we're currently looking at.
-            if ($Store -eq 'Shared') {
-                $params.Add('Shared', $true)
-            }
-
-            # Now check if the CredentialStoreItem exists
-            $message = 'Checking if CredentialStoreItem {0}/{1} exists in CredentialStore {2}'
-            $argumentlist = @($RemoteHost, $Identifier, $Store)
-            Write-Verbose -Message ($message -f $argumentlist)
-
-            if (Test-CredentialStoreItem @params) {
-                $message = 'Looking up CredentialStoreItem {0}/{1} from CredentialStore {2}'
-                $argumentlist = @($RemoteHost, $Identifier, $Store)
-                Write-Verbose -Message ($message -f $argumentlist)
-
-                try {
-                    Write-Information -MessageData ($message -f $argumentlist)
-                    # Read the CredentialStoreItem from the CredentialStore and store it in $CredentialObject
-                    $CredentialObject = Get-CredentialStoreItem @params
-
-                    # Now finish the loop, as we've found what we're looking for.
-                    break
-                }
-                catch {
-                    $_.Exception.Message | Write-Warning
-                    $message = 'Unable to read CredentialStoreItem {0}/{1} from CredentialStore {2}'
-                    $argumentlist = @($RemoteHost, $Identifier, $Store)
-
-                    Write-Warning -Message ($message -f $argumentlist)
-                }
-            }
-        }
-    }
-
-    end {
-        # Only if we've found a CredentialStoreItem above, return it back to the caller.
-        if ($null -ne $CredentialObject) {
-            $CredentialObject
-        }
-    }
-}

src/Item/New-CredentialStoreItem.Tests.ps1

@@ -102,7 +102,7 @@ Describe "New-CredentialStoreItem" {
         It "Missing CredentialStore should throw" {
             {
                 New-CredentialStoreItem -Shared -Path '/tmp/missingStore.json' -RemoteHost 'notrelevant'
-            } | Should -Throw "The given credential store (/tmp/missingStore.json) does not exist!"
+            } | Should -Throw "Could not add anything into the given CredentialStore."
         }
     }
     Context "Testing pipeline paramter" {

src/Item/New-CredentialStoreItem.ps1

@@ -32,7 +32,7 @@ function New-CredentialStoreItem {
         [None]
 
     .EXAMPLE
-        New-CredentialStoreItem -Path 'C:\TMP\mystore.json' -RemoteHost esx01.myside.local'
+        New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
     #>
 
     [CmdletBinding(DefaultParameterSetName = 'Private')]
@@ -68,7 +68,7 @@ function New-CredentialStoreItem {
 
     begin {
         # Set the CredentialStore for private, shared or custom mode.
-        Write-Debug ('ParameterSetName: {0}' -f $PSCmdlet.ParameterSetName)
+        Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName)
         if ($PSCmdlet.ParameterSetName -eq 'Private') {
             $Path = Get-DefaultCredentialStorePath
         }
@@ -84,9 +84,9 @@ function New-CredentialStoreItem {
         if (-not(Test-CredentialStore -Shared -Path $Path)) {
             $MessageParams = @{
                 Exception   = [System.IO.FileNotFoundException]::new(
-                    'The given credential store ({0}) does not exist!' -f $Path
+                    'Could not add anything into the given CredentialStore.'
                 )
-                ErrorAction = 'Stop'
+                ErrorAction = "Stop"
             }
             Write-Error @MessageParams
         }
@@ -95,8 +95,8 @@ function New-CredentialStoreItem {
 
         $CurrentDate = Get-Date -Format 'u'
 
-        if ($Identifier -ne '') {
+        if ($Identifier -ne "") {
-            $CredentialName = $RemoteHost = '{0}/{1}' -f $Identifier, $RemoteHost
+            $CredentialName = $RemoteHost = "{0}/{1}" -f $Identifier, $RemoteHost
         }
         else {
             $CredentialName = $RemoteHost

src/Item/Set-CredentialStoreItem.Tests.ps1

@@ -11,10 +11,10 @@
 param ()
 
 BeforeAll {
-    $ManifestFile = (Get-Item -Path './src/*.psd1').FullName
+    $ManifestFile = (Get-Item -Path "./src/*.psd1").FullName
     Import-Module $ManifestFile -Force
 
-    $PrivateFunctions = (Get-ChildItem -Path './src/Private/*.ps1' | Where-Object {
+    $PrivateFunctions = (Get-ChildItem -Path "./src/Private/*.ps1" | Where-Object {
             $_.BaseName -notmatch '.Tests'
         }
     ).FullName
@@ -23,25 +23,25 @@ BeforeAll {
     }
 
     # Backup existing credential stores
-    $VerbosePreference = 'Continue'
+    $VerbosePreference = "Continue"
-    Write-Verbose -Message 'Backup private Credential Store...'
+    Write-Verbose "Backup private Credential Store..."
     $CSPath = Get-DefaultCredentialStorePath
-    $BackupFile = '{0}.back' -f $CSPath
+    $BackupFile = "{0}.back" -f $CSPath
     if (Test-Path -Path $CSPath) {
         Move-Item -Path $CSPath -Destination $BackupFile
     }
-    Write-Verbose -Message 'Backup shared CredentialStore...'
+    Write-Verbose "Backup shared CredentialStore..."
     $CSShared = Get-DefaultCredentialStorePath -Shared
-    $BackupSharedFile = '{0}.back' -f $CSShared
+    $BackupSharedFile = "{0}.back" -f $CSShared
     if (Test-Path -Path $CSShared) {
         Move-Item -Path $CSShared -Destination $BackupSharedFile
     }
-    Write-Verbose -Message 'Remove old CredentialStore in Temp dir'
+    Write-Verbose "Remove old CredentialStore in Temp dir"
     $CSTemp = Join-Path -Path (Get-TempDir) -ChildPath '/CredentialStore.json'
     if (Test-Path -Path $CSTemp) {
         Remove-Item -Path $CSTemp
     }
-    $VerbosePreference = 'SilentlyContinue'
+    $VerbosePreference = "SilentlyContinue"
 }
 
 Describe 'New-CredentialStoreItem' {
@@ -109,8 +109,8 @@ Describe 'New-CredentialStoreItem' {
 
 AfterAll {
     # Cleanup test stores and restore existing ones.
-    $VerbosePreference = 'Continue'
+    $VerbosePreference = "Continue"
-    Write-Verbose -Message 'Restoring private CredentialStore'
+    Write-Verbose "Restoring private CredentialStore"
     If (Test-Path -Path $BackupFile) {
         If (Test-Path -Path $CSPath) {
             Remove-Item -Path $CSPath
@@ -118,13 +118,13 @@ AfterAll {
         }
     }
 
-    Write-Verbose -Message 'Restoring shared CredentialStore'
+    Write-Verbose "Restoring shared CredentialStore"
     If (Test-Path -Path $BackupSharedFile) {
         If (Test-Path -Path $CSShared) {
             Remove-Item -Path $CSShared
             Move-Item -Path $BackupSharedFile -Destination $CSShared
         }
     }
-    $VerbosePreference = 'SilentlyContinue'
+    $VerbosePreference = "SilentlyContinue"
 
 }

src/PSCredentialStore.psd1

@@ -85,7 +85,6 @@
         'Test-CSConnection',
         # Item
         'Get-CredentialStoreItem',
-        'Find-CredentialStoreItem',
         'New-CredentialStoreItem',
         'Remove-CredentialStoreItem',
         'Set-CredentialStoreItem',
@@ -147,27 +146,27 @@
             ExternalModuleDependencies = @(
                 @{
                     ModuleName = 'VMware.VimAutomation.Core'
-                    ModuleVersion = '12.7.0.20091293'
+                    ModuleVersion = '6.5.2.6234650'
                 },
                 @{
                     ModuleName = 'VMware.VimAutomation.Cis.Core'
-                    ModuleVersion = '12.6.0.19601368'
+                    ModuleVersion = '6.5.4.6983166'
                 },
                 @{
-                    ModuleName = 'Cisco.UCS.Common'
+                    ModuleName = 'Cisco.UCS.Core'
-                    ModuleVersion = '3.0.1.2'
+                    ModuleVersion = '2.3.1.5'
                 },
                 @{
                     ModuleName = 'Cisco.UCSManager'
-                    ModuleVersion = '3.0.1.2'
+                    ModuleVersion = '2.5.2.2'
                 },
                 @{
                     ModuleName = 'WinSCP'
                     ModuleVersion = '5.17.8.1'
                 },
                 @{
-                    ModuleName = 'NetApp.ONTAP'
+                    ModuleName = 'DataONTAP'
-                    ModuleVersion = '9.10.1.2111'
+                    ModuleVersion = '9.7.1.1'
                 }
             )