Merge remote-tracking branch 'bosh-psmodules/windows-2019' into windows-2019

Author: aramprice

README-psmodules.md

@@ -0,0 +1,53 @@
+# bosh-psmodules
+
+The recommended approach for creating local BOSH Windows stemcells which can be deployed on [Cloud Foundry BOSH](https://bosh.io), is [`stembuild`](https://github.com/cloudfoundry-incubator/stembuild).
+
+[Documentation on how to use `stembuild` can be found here.](https://bosh.io/docs/windows-stemcell-create/)
+
+---
+
+Powershell scripts to set up a Windows VM in a manner appropriate for a BOSH Stemcell.
+
+Used by [stembuild](https://github.com/cloudfoundry-incubator/stembuild) and [bosh-windows-stemcell-builder](https://github.com/cloudfoundry-incubator/bosh-windows-stemcell-builder)
+
+## Testing
+
+Tests are written using the Pester testing framework and must be run in Powershell on a Windows environment.
+
+The test suite for each module currently assumes that the tests are being run with the module as the current working directory.
+
+This requires iterating through the module directories to run all the tests:
+
+```
+cd bosh-psmodules
+foreach ($module in (Get-ChildItem "./modules").Name) {
+  Push-Location "modules/$module"
+    $results=Invoke-Pester -PassThru
+    if ($results.FailedCount -gt 0) {
+      $result += $results.FailedCount
+    }
+  Pop-Location
+}
+echo "Failed Tests: $result"
+```
+
+If you just need to test a single module, you could do this:
+
+```
+cd "bosh-psmodules\module\BOSH.<module>"
+Invoke-Pester
+```
+
+## Running a subset of tests on MacOS
+
+You can use Powershell and MacOS to run the tests that do not require Windows system calls:
+
+```
+cd ~/workspace
+brew install powershell
+git clone --depth 1 --branch 4.4.0 [email protected]:pester/Pester.git
+pwsh
+Import-Module ./Pester/Pester.psm1
+cd stembuild/module/BOSH.<module>
+Invoke-Pester
+```

modules/BOSH.Account/BOSH.Account.Tests.ps1

@@ -0,0 +1,47 @@
+Remove-Module -Name BOSH.Account -ErrorAction Ignore
+Import-Module ./BOSH.Account.psm1
+
+Remove-Module -Name BOSH.Utils -ErrorAction Ignore
+Import-Module ../BOSH.Utils/BOSH.Utils.psm1
+
+Describe "Account" {
+
+    Context "when username is not provided" {
+        It "throws" {
+            { Add-Account } | Should Throw "Provide a user name"
+        }
+    }
+
+    Context "when password is not provided" {
+        It "throws" {
+            { Add-Account -User hello } | Should Throw "Provide a password"
+        }
+    }
+
+    Context "when the username and password are valid" {
+        $timestamp=(get-date -UFormat "%s" -Millisecond 0)
+        $user = "TestUser_$timestamp"
+        $password = "Password123!"
+
+         BeforeEach {
+            $userExists = !!(Get-LocalUser | Where {$_.Name -eq $user})
+            if($userExists) {
+                Remove-LocalUser -Name $user
+            }
+        }
+
+        It "Adds and removes a new user account" {
+            Add-Account -User $user -Password $password
+            mkdir "C:\Users\$user" -ErrorAction Ignore
+            $adsi = [ADSI]"WinNT://$env:COMPUTERNAME"
+            $existing = $adsi.Children | where {$_.SchemaClassName -eq 'user' -and $_.Name -eq $user }
+            $existing | Should Not Be $null
+            Remove-Account -User $user
+            $existing = $adsi.Children | where {$_.SchemaClassName -eq 'user' -and $_.Name -eq $user }
+            $existing | Should Be $null
+        }
+    }
+}
+
+Remove-Module -Name BOSH.Account -ErrorAction Ignore
+Remove-Module -Name BOSH.Utils -ErrorAction Ignore

modules/BOSH.Account/BOSH.Account.psd1

@@ -0,0 +1,21 @@
+@{
+RootModule = 'BOSH.Account'
+ModuleVersion = '0.1'
+GUID = 'ebdf7a79-39df-46ce-a046-42dd10de82ce'
+Author = 'BOSH'
+Copyright = '(c) 2017 BOSH'
+Description = 'Commands for creating a new Windows user'
+PowerShellVersion = '4.0'
+RequiredModules = @('BOSH.Utils')
+FunctionsToExport = @('Add-Account','Remove-Account')
+CmdletsToExport = @()
+VariablesToExport = '*'
+AliasesToExport = @()
+PrivateData = @{
+    PSData = @{
+        Tags = @('BOSH')
+        LicenseUri = 'https://github.com/cloudfoundry-incubator/bosh-windows-stemcell-builder/blob/master/LICENSE'
+        ProjectUri = 'https://github.com/cloudfoundry-incubator/bosh-windows-stemcell-builder'
+    }
+}
+}

modules/BOSH.Account/BOSH.Account.psm1

@@ -0,0 +1,45 @@
+<#
+.Synopsis
+    Add Windows user
+.Description
+    This cmdlet adds a Windows user
+#>
+function Add-Account {
+    Param(
+            [string]$User = $(Throw "Provide a user name"),
+            [string]$Password = $(Throw "Provide a password")
+         )
+    Write-Log "Add-Account"
+
+    Write-Log "Creating new local user $User."
+    & NET USER $User $Password /add /y /expires:never
+
+    $Group = "Administrators"
+
+    Write-Log "Adding local user $User to $Group."
+    $adsi = [ADSI]"WinNT://$env:COMPUTERNAME"
+    Write-Log $adsi
+    $AdminGroup = $adsi.Children | where {$_.SchemaClassName -eq 'group' -and $_.Name -eq $Group }
+    Write-Log $AdminGroup
+    $UserObject = $adsi.Children | where {$_.SchemaClassName -eq 'user' -and $_.Name -eq $User }
+    Write-Log $UserObject
+    $AdminGroup.Add($UserObject.Path)
+    Write-Log "Completed adding $User to $Group"
+}
+
+<#
+.Synopsis
+Remove Windows user
+.Description
+This cmdlet removes a Windows user
+#>
+function Remove-Account {
+    Param(
+            [string]$User = $(Throw "Provide a user name")
+         )
+    Write-Log "Remove-Account"
+    Write-Log "Removing local user $User."
+    $adsi = [ADSI]"WinNT://$env:COMPUTERNAME"
+    $adsi.Delete('User', $User)
+    Move-Item -Path "C:\Users\$User" -Destination "$env:windir\Temp\$User" -Force -ErrorAction Ignore
+}