New-Group - new command

thycotic-ps · Jun 29, 2021 · 0da7494 · 0da7494
1 parent 2f27030
commit 0da7494
Show file tree

Hide file tree

Showing 2 changed files with 123 additions and 0 deletions.
diff --git a/src/functions/groups/New-Group.ps1 b/src/functions/groups/New-Group.ps1
@@ -0,0 +1,99 @@
+function New-Group {
+    <#
+    .SYNOPSIS
+    Create a new Group
+
+    .DESCRIPTION
+    Create a new Group
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    New-TssGroup -TssSession $session -GroupName 'Local Admin Group' -Enabled
+
+    Creates a local Secret Server group named, Local Admin Group, enabling it upon creation
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/New-TssGroup
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/groups/New-Group.ps1
+
+    .NOTES
+    Requires TssSession object returned by New-TssSession
+    #>
+    [CmdletBinding(SupportsShouldProcess)]
+    [OutputType('TssGroup')]
+    param (
+        # TssSession object created by New-TssSession for auth
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
+
+        # Name of the Group
+        [Parameter(Mandatory,ValueFromPipeline)]
+        [string]
+        $GroupName,
+
+        #  Create the group as Active
+        [Parameter(Mandatory,ValueFromPipeline)]
+        [switch]
+        $Enabled,
+
+        # Directory Services Domain ID
+        [int]
+        $DomainId,
+
+        # Active Directory Object GUID
+        [string]
+        $AdGuid,
+
+        # Synchronize Group with Directory Services
+        [switch]
+        $Synchronized,
+
+        # Directory Services Sync will only pull members for Domain Groups that have this set to true
+        [switch]
+        $SynchronizeNow
+    )
+    begin {
+        $tssNewParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeTssParams $TssSession
+    }
+    process {
+        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
+        if ($tssNewParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
+            $restResponse = $null
+            $uri = $TssSession.ApiUrl, 'groups' -join '/'
+            $invokeParams.Uri = $uri
+            $invokeParams.Method = 'POST'
+
+            $newGroupBody = [ordered]@{}
+            switch ($tssNewParams.Keys) {
+                'GroupName' { $newGroupBody.Add('name',$GroupName) }
+                'Enabled' { $newGroupBody.Add('enabled',[boolean]$Enabled) }
+                'DomainId' { $newGroupBody.Add('domainId',$DomainId) }
+                'AdGuid' { $newGroupBody.Add('adGuid',$AdGuid) }
+                'Synchronized' { $newGroupBody.Add('synchronized',[boolean]$Synchronized) }
+                'SynchronizeNow' { $newGroupBody.Add('synchronizeNow', [boolean]$SynchronizeNow) }
+            }
+            $invokeParams.Body = ($newGroupBody | ConvertTo-Json)
+
+            Write-Verbose "Performing the operation $($invokeParams.Method) $uri with:`n $newGroupBody"
+            if (-not $PSCmdlet.ShouldProcess("", "$($invokeParams.Method) $uri with $($invokeParams.Body)")) { return }
+            try {
+                $restResponse = . $InvokeApi @invokeParams
+            } catch {
+                Write-Warning "Issue creating group [$Name]"
+                $err = $_
+                . $ErrorHandling $err
+            }
+
+            if ($restResponse) {
+                Get-TssGroup -TssSession $TssSession -Id $restResponse.Id
+            }
+        } else {
+            Write-Warning "No valid session found"
+        }
+    }
+}
diff --git a/tests/groups/New-Group.Tests.ps1 b/tests/groups/New-Group.Tests.ps1
@@ -0,0 +1,24 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession', 'Name', 'Enabled', 'DomainId', 'AdGuid', 'Synchronized', 'SynchronizeNow'
+        [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
+        }
+    }
+    Context "Command specific details" {
+        It "$commandName should set OutputType to TssGroup" -TestCases $commandDetails {
+            $_.OutputType.Name | Should -Be 'TssGroup'
+        }
+    }
+}