Start-SecretDependency - fixes #179

thycotic-ps · May 7, 2021 · 2565995 · 2565995
1 parent e4d9c95
commit 2565995
Show file tree

Hide file tree

Showing 2 changed files with 124 additions and 0 deletions.
diff --git a/src/functions/secret-dependencies/Start-SecretDependency.ps1 b/src/functions/secret-dependencies/Start-SecretDependency.ps1
@@ -0,0 +1,69 @@
+function Start-SecretDependency {
+    <#
+    .SYNOPSIS
+    Start Secret Dependency
+
+    .DESCRIPTION
+    Start Secret Dependency, output must be captured to check run status
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    $ident = Start-TssSecretDependency -TssSession $session -Id 46
+    Get-TssSecretDependencyRunStatus -TssSession $session -Identifier $run
+
+    After starting a Secret's Dependency 46, get the status of that run
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/Start-TssSecretDependency
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-dependencies/Start-SecretDependency.ps1
+
+    .NOTES
+    Requires TssSession object returned by New-TssSession
+    #>
+    [CmdletBinding(SupportsShouldProcess)]
+    param (
+        # TssSession object created by New-TssSession for auth
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
+
+        # Secret Dependency ID
+        [Parameter(Mandatory,ValueFromPipelineByPropertyName)]
+        [Alias("DependencyId")]
+        [int[]]
+        $Id
+    )
+    begin {
+        $tssParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeTssParams $TssSession
+    }
+
+    process {
+        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
+        if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
+            $restResponse = $null
+            $uri = $TssSession.ApiUrl, 'secret-dependencies', 'run' -join '/'
+            $invokeParams.Uri = $uri
+            $invokeParams.Method = 'POST'
+
+            $invokeParams.Body = ConvertTo-Json @($Id)
+            if (-not $PSCmdlet.ShouldProcess("Dependency ID: $dependency","$($invokeParamsOther.Method) $uri with:`n$($invokeParams.Body)`n")) { return }
+            Write-Verbose "$($invokeParamsOther.Method) $uri with:`n$($invokeParams.Body)`n"
+            try {
+                $restResponse = . $InvokeApi @invokeParams
+            } catch {
+                $err = $_
+                . $ErrorHandling $err
+            }
+
+            if ($restResponse) {
+                [string]$restResponse
+            }
+        } else {
+            Write-Warning "No valid session found"
+        }
+    }
+}
diff --git a/tests/secret-dependencies/Start-SecretDependency.Tests.ps1 b/tests/secret-dependencies/Start-SecretDependency.Tests.ps1
@@ -0,0 +1,55 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+    . ([IO.Path]::Combine([string]$PSScriptRoot, '..', 'constants.ps1'))
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession', 'Id'
+        [object[]]$currentParams = ([Management.Automation.CommandMetaData]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')).Parameters.Keys
+        [object[]]$commandDetails = [System.Management.Automation.CommandInfo]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')
+        $unknownParameters = Compare-Object -ReferenceObject $knownParameters -DifferenceObject $currentParams -PassThru
+    }
+    Context "Verify parameters" -Foreach @{currentParams = $currentParams } {
+        It "$commandName should contain <_> parameter" -TestCases $knownParameters {
+            $_ -in $currentParams | Should -Be $true
+        }
+        It "$commandName should not contain parameter: <_>" -TestCases $unknownParameters {
+            $_ | Should -BeNullOrEmpty
+        }
+    }
+}
+Describe "$commandName functions" {
+    Context "Checking" {
+        BeforeAll {
+            $session = [pscustomobject]@{
+                ApiVersion   = 'api/v1'
+                Take         = 2147483647
+                SecretServer = 'http://alpha/'
+                ApiUrl       = 'http://alpha/api/v1'
+                AccessToken  = 'AgJf5YLChrisPine312UcBrM1s1KB2BGZ5Ufc4qLZ'
+                RefreshToken = '9oacYeah0YqgBNg0L7VinDiesel6-Z9ITE51Humus'
+                TokenType    = 'bearer'
+                ExpiresIn    = 1199
+            }
+            Mock -Verifiable -CommandName Invoke-RestMethod -ParameterFilter { $Uri -match '/version' } -MockWith {
+                return @{
+                   model = [pscustomobject]@{
+                       Version = '10.9.000000'
+                   }
+                }
+            }
+
+            Mock -Verifiable -CommandName Invoke-RestMethod -ParameterFilter { $Uri -match '/secret-dependencies/run' } -MockWith {
+                return (New-Guid).Guid
+            }
+            $object = Start-SecretDependency -TssSession $session -Id 42
+            Assert-VerifiableMock
+        }
+        It "Should not be empty" {
+            $object | Should -Not -BeNullOrEmpty
+        }
+        It "Should have called Invoke-RestMethod 2 times" {
+            Assert-MockCalled -CommandName Invoke-RestMethod -Times 2 -Scope Describe
+        }
+    }
+}