SimpleEnv.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
Write-Verbose 'Importing from [C:\Users\chanc_000\Source\SimpleEnv\SimpleEnv\classes]'
Write-Verbose 'Importing from [C:\Users\chanc_000\Source\SimpleEnv\SimpleEnv\private]'
Write-Verbose 'Importing from [C:\Users\chanc_000\Source\SimpleEnv\SimpleEnv\public]'
# .\Pre-Module.ps1


$Script:Configuration = @{
    ConfigFilePath = "$Env:USERPROFILE/SimpleENV.json"
}


function ClearEnvironment
{
    $script:Environment = @{
        SimpleEnvVersion = ''
        EnvironmentInfo  = @{ }
        Servers          = @()
    }
    
    $Environment.SimpleEnvVersion = [string]$MyInvocation.MyCommand.Module.Version
}

ClearEnvironment







# .\classes\SimpleEnvServer.ps1

class SimpleEnvServer
{
    [string] $Name
    [string] $ComputerName
    [string] $Environment
    [string[]] $Roles = @()
    [string[]] $Tags = @()
    [hashtable] $Properties = @{ }
}

# .\public\Add-SimpleEnvServer.ps1

function Add-SimpleEnvServer
{
    <#
    .SYNOPSIS
    Adds a SimpleEnvServer object to the loaded environment, and optionally save the changes back to the environment config.
 
    .PARAMETER ServerObject
    The [SimpleEnvServer] object to add.
 
    .PARAMETER Save
    Save changes back to the environment config file at the end of pipeline exectution.
 
    .EXAMPLE
    PS> (1..4) | %{New-SimpleEnvServer -Name "TestServer_$_"} | Add-SimpleEnvServer -Save
        Creates new SimpleEnv Servers named: Test_1,Test_2,Test_3,Test_4 and adds them to the loaded environment,
        then saves the changes back to the backing JSON file.
     
    #>

    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'low')]    
    param (
        
        # SimpleEnvServer object
        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [object]
        $ServerObject,

        
        #
        [Parameter(Mandatory = $false)]
        [switch]
        $Save
    )
    

    process
    {
        $server = [SimpleEnvServer]$ServerObject
        if ($PSCmdlet.ShouldProcess($server.Name, "Add to the existing environment?"))
        {
            $script:Environment.Servers += $server
            
        }
    }
    end
    {
        
        if ($Save.IsPresent -and $PSCmdlet.ShouldProcess( "Save changes to the existing environment?") )
        {
            $SaveArgs = @{
                Verbose = $Verbose
            }
            
            Save-SimpleEnv @SaveArgs
        }
    }

}



# .\public\Clear-SimpleEnv.ps1
function Clear-SimpleEnv
{
    <#
.Description
Resets the in-memory SimpleEnv to a blank environment.
 
.example
PS> Clear-SimpleEnv
 
#>

    [CmdletBinding()]
    param ()
    Write-Verbose "Setting environment to default."
    ClearEnvironment
}
# .\public\Export-SimpleEnv.ps1

function Export-SimpleEnv
{
    <#
    .description
     
    Writes the current SimpleEnv to a JSON file (with utf8 encoding).
 
    .parameter FilePath
    The Filepath to write too.
 
    .PARAMETER Force
 
    Overwrites existing file without confirmation
 
    .example
    PS> Export-SimpleEnv -FilePath '~\desktop\MyEnvironment.SimpleEnv.json'
 
    #>

    [CmdletBinding()]
    param (
        # Path to Json file
        [Parameter(Mandatory = $true,
            ParameterSetName = "json",
            ValueFromPipelineByPropertyName = $true
        )]
        [alias("path")]
        [string]
        $FilePath,

        #
        [Parameter()]
        [switch]
        $Force
    )

    $FileParams = @{
        FilePath = $FilePath 
        Encoding = 'utf8'
    }

    if ($Force.IsPresent)
    {
        $FileParams['Force'] = $true
    }
    else
    {
        $FileParams['NoClobber'] = $true
    }

    $script:Environment | ConvertTo-Json -Depth 5 | Out-File @FileParams
}

# .\public\Get-SimpleEnv.ps1
function Get-SimpleEnv
{
    <#
.Synopsis
Get the entire stored simpleEnv as an object.
 
.Parameter Full
 
Get the entire stored simpleEnv as an object.
 
 
.EXAMPLE
 
PS> Get-SimpleEnv
 
Get the entire stored simpleEnv as an object.
 
.EXAMPLE
 
PS> Get-SimpleEnv -Server
 
Get the list of all server
 
 
#>



    [CmdletBinding(DefaultParameterSetName = 'Full')]
    param (
        #
        [Parameter(Mandatory = $true, ParameterSetName = 'Full')]
        [switch]
        $Full,

        [Parameter(Mandatory = $true, ParameterSetName = 'servers')]
        [switch]
        $Servers#,

        # [Parameter(Mandatory = $false, ParameterSetName = 'info')]
        # [switch]
        # $EnvironmentInfo
    )

    begin
    {

    }

    process
    {
        if ($PSCmdlet.ParameterSetName -eq 'Full')
        {
            $script:Environment

        }
        elseif ($PSCmdlet.ParameterSetName -eq 'servers')
        {
            $script:Environment.Servers

        }
        elseif ($PSCmdlet.ParameterSetName -eq 'info')
        {
            $script:Environment.EnvironmentInfo
        }
    }

    end
    {
    }
}

# .\public\Get-SimpleEnvConfiguration.ps1

function Get-SimpleEnvConfiguration
{
    <#
.description
 
Returns the current SimpleEnv configuration as a hashtable.
 
.PARAMETER All
 
Returns the full configuration
 
.PARAMETER FilePath
 
Returns only the FilePath of the backing JSON file.
 
 
.example
 
PS> Get-SimpleEnvConfiguration
 
 
#>

    [CmdletBinding(DefaultParameterSetName = 'all')]
    
    [OutPutType([hashtable], ParameterSetName = 'all')]
    [OutPutType([string], ParameterSetName = 'filepath')]

    param (


        [Parameter(ParameterSetName = 'all')]
        [switch]
        $All,


        [Parameter(ParameterSetName = 'filepath')]
        [switch]
        $FilePath

    )
    
    if ($PSCmdlet.ParameterSetName -eq 'all')
    {
        return $Script:Configuration 
    }
    else
    {
        if ($FilePath.IsPresent)
        {
            $Script:Configuration.ConfigFilePath
        }
    }    
}

# .\public\Get-SimpleEnvServer.ps1
function Get-SimpleEnvServer
{
    <#
    .description
    Retrieves the specified servers from the loaded SimpleEnv.
 
    .parameter Name
    Selects servers with a matching name, wildcard patterns are supported.
 
    .parameter Role
    Select Servers that have a Role that matches the wildcard pattern.
 
    .parameter Tag
    Select Servers that have a tag that matches the wildcard pattern.
 
   .parameter Environment
    Selects servers with a matching Environment, wildcard patterns are supported.
 
    .parameter All
    Return all servers.
 
    .parameter JustComputerName
    Return only the ComputerName(s) of the selected servers.
 
    .example
    PS> Get-SimpleEnvServer
 
    Name ComputerName Tags Properties
    ---- -------- ---- ----------
    DevOps DevOps.test.env.com {dev, 2019, infrastructure, ops} {DistinguishedName}
    Dev-box Dev-box.test.env.com {dev, 2012r2, developer} {DistinguishedName}
 
    .example
    PS> Get-Server -Name *ops
 
    Name ComputerName Tags Properties
    ---- -------- ---- ----------
    DevOps DevOps.test.env.com {dev, 2019, infrastructure, ops} {DistinguishedName}
 
 
    .example
    PS> Get-Server -Tag 2012*
 
    Name ComputerName Tags Properties
    ---- -------- ---- ----------
    Dev-box Dev-box.test.env.com {dev, 2012r2, developer} {DistinguishedName}
 
 
    .example
    PS> Get-Server -Tag 2012* -JustComputerName
 
    Dev-box.test.env.com
 
 
 
    #>

    [CmdletBinding(DefaultParameterSetName = 'all')]
    param (
        #
        [Parameter(Mandatory = $false, ParameterSetName = 'filtered', Position = 0)]
        [ValidateNotNullOrEmpty()]
        [SupportsWildcards()]
        [string]
        $Name,

        #
        [Parameter(Mandatory = $false, ParameterSetName = 'filtered')]
        [ValidateNotNullOrEmpty()]
        [SupportsWildcards()]
        [string]
        $Role,

        #
        [Parameter(Mandatory = $false, ParameterSetName = 'filtered')]
        [ValidateNotNullOrEmpty()]
        [SupportsWildcards()]
        [string]
        $Tag,

        #
        [Parameter(Mandatory = $false, ParameterSetName = 'filtered')]
        [ValidateNotNullOrEmpty()]
        [SupportsWildcards()]
        [string]
        $Environment,

        # Parameter help description
        [Parameter(Mandatory = $false, ParameterSetName = 'all')]
        [Parameter(Mandatory = $false, ParameterSetName = 'filtered')]
        [Alias('DnsName')]
        [switch]
        $JustComputerName,

        # Parameter help description
        [Parameter(Mandatory = $false, ParameterSetName = 'all')]
        [switch]
        $All

    )

    begin
    {
        if ($script:Environment.Servers.count -eq 0)
        {
            Write-Warning -Message ("No servers in environment [{0}] Try importing another configuration, or adding a server." -f $Script:Configuration.ConfigFilePath)
        }

        [bool] $SkipName = (-not $PSBoundParameters.ContainsKey('Name'))
        [bool] $SkipTags = (-not $PSBoundParameters.ContainsKey('tag'))
        [bool] $SkipRoles = (-not $PSBoundParameters.ContainsKey('role'))
        [bool] $SkipEnv = (-not $PSBoundParameters.ContainsKey('Environment'))

        filter OutputFormat
        {

            if ($JustComputerName.IsPresent)
            {
                $Psitem.ComputerName
            }
            else
            {
                $Psitem
            }
        }
    }

    Process
    {
        $Servers = if ($PSCmdlet.ParameterSetName -like 'all')
        {
            $script:Environment.Servers
        }
        else
        {
            $script:Environment.Servers |
            Where-Object { ($SkipName -or ($_.Name -like $Name )) } |
            Where-Object { ($SkipTags -or ($_.Tags -like $Tag )) } |
            Where-Object { ($SkipRoles -or ($_.Roles -like $Role )) } |
            Where-Object { ($SkipEnv -or ($_.Environment -like $Environment )) }
        }
        Write-Verbose "Found $($Servers.count) servers."
        $Servers | OutputFormat

    }
    end
    {
    }
}


Set-Alias -Name 'Get-Server' -Value Get-SimpleEnvServer

# .\public\Import-SimpleEnv.ps1


function Import-SimpleEnv
{
    <#
.SYNOPSIS
 
Imports the specified Json file into the currently loaded SimpleEnv, however changes are still persisted back to the oridginal file.
 
.PARAMETER FilePath
 
Path to the SimpleENV json file to import.
 
.PARAMETER ClearExisting
 
Remove existing servers before importing, instead of combining the environments.
 
.EXAMPLE
PS> Import-SimpleEnv -FilePath Test.simpleenv.json -ClearExisting
Should only have the servers in 'Test.simpleenv.json' loaded.
 
#>


    [CmdletBinding()]
    param (
        # Path to Json file
        [Parameter(Mandatory = $true,
            ParameterSetName = "json",
            ValueFromPipelineByPropertyName = $true
        )]
        [alias("path")]
        [string]
        $FilePath,

        #
        [Parameter()]
        [switch]
        $ClearExisting
    )
    
    begin
    {
        #$ImportProperties = [SimpleEnvServer].DeclaredProperties.Name

        if ($ClearExisting.IsPresent)
        {
            $script:Environment.Servers.Clear()
        
        }
        function ObjToShallowhashtable($object)
        {

            if ($null -ne $object)
            {
                $props = $object
                $PropTable = @{ }
                $Keys = $props | Get-Member -MemberType NoteProperty | Select-Object -ExpandProperty Name
                $Keys | ForEach-Object {
                    $PropTable.$_ = $props.$_
                }                
                $PropTable
            }
            else
            {
                return @{ }
            }
        }
    }
    
    process
    {
        $temp = Get-Content -Path $Filepath -Raw | ConvertFrom-Json
        # Reset-SimpleEnv

        $temp.Servers | ForEach-Object {
            $Srv = $_
            if ($null -ne $Srv.Properties)
            {
                $srv.Properties = ObjToShallowhashtable -object $Srv.Properties
            }
        }

        $Temp.Servers | New-SimpleEnvServer | Add-SimpleEnvServer

        if ($null -ne $temp.EnvironmentInfo)
        {
            $script:Environment.EnvironmentInfo = ObjToShallowhashtable -object $Temp.EnvironmentInfo
        }
        elseif ($null -ne $temp.MetaData)
        {
            $script:Environment.EnvironmentInfo = ObjToShallowhashtable -object $Temp.Metadata
        }
    }
    
    end
    {
    }
}
# .\public\New-SimpleEnvServer.ps1


function New-SimpleEnvServer
{
    <#
.SYNOPSIS
 
Creates a new SimpleEnvServer object.
 
.PARAMETER Name
 
Friendly name for the server
 
.PARAMETER ComputerName
 
The Network addressable name for the computer.
This was changed from DnsName to provide better interoperability with built-in commands.
 
.PARAMETER Environment
 
A short environment identifier.
 
 
.PARAMETER Tags
 
A list of strings to tag the server with.
 
.PARAMETER Roles
 
A list of strings identifing the servers roles.
 
.PARAMETER Properties
 
A hashtable of properties / metadata to store about the server.
This hashtable should be no more than 2 layers deep, or it may not be fully serialized.
 
 
 
.Example
 
PS> New-SimpleEnvServer -Name "Test01"
 
Server DNS Name Environment Roles Tags Properties
------ -------- ----------- ----- ---- ----------
Test01 {} {} {}
 
 
 
#>


    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'low')]
    [OutputType([SimpleEnvServer])]
    param (
        
        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
        [string]
        $Name,

        [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
        [string]
        $Environment,
        
        [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
        [Alias('FullName')]
        [Alias('DnsName')]
        [string]
        $ComputerName,

        [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
        [string[]]
        $Tags,

        [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
        [string[]]
        $Roles,

        [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
        [Alias('Metadata')]
        [hashtable]
        $Properties
    )
    
    begin
    {
        $ParametersToImport = [SimpleEnvServer].DeclaredProperties.Name
    }
    
    process
    {
        $Item = @{
            Name = $Name
        }

        $ParametersToImport | ForEach-Object {
            if ($PSBoundParameters.ContainsKey($_))
            {
                $Item[$_] = $PSBoundParameters[$_]
            }
        }
        if ($PSCmdlet.ShouldProcess("Create new SimpleEnvServer object"))
        {
            [SimpleEnvServer]$item
        }   

    }
    
    end
    {
        
    }
}
# .\public\Remove-SimpleEnvServer.ps1

function Remove-SimpleEnvServer
{
    <#
.synopsis
 
Remove a SimpleEnvServer object from the loaded environment, and optionally save the changes back to the environment config.
 
.parameter ServerObject
 
The [SimpleEnvServer] Object to remove.
 
.parameter Save
 
Save changes back to the environment config file at the end of pipeline exectution.
 
.example
PS> Get-Server -Tag Agent | Remove-SimpleEnvServer -Save
Removes all servers tagged 'Agent' and saves the changes.
 
#>


    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'low')]   
    param (
        #
        # inputobject
        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
        # [ValidateScript( { $_ -is [SimpleEnvServer] })]
        [object]
        $ServerObject,

        #
        [Parameter(Mandatory = $false)]
        [switch]
        $Save
    )
    

    process
    {
        $Server = [SimpleEnvServer]$ServerObject
        if ($PSCmdlet.ShouldProcess($Server.Name, "Remove from existing SimpleEnv ?"))
        {
            $script:Environment.Servers = $script:Environment.Servers | Where-Object { $_ -ne $Server } 
        }
    }
    end
    {
        if ($Save.IsPresent -and $PSCmdlet.ShouldProcess( "Save changes to the existing environment?") )
        {
            $SaveArgs = @{
                Verbose = $Verbose
            }
            
            Save-SimpleEnv @SaveArgs
        }
    }

}


# .\public\Save-SimpleEnv.ps1

function Save-SimpleEnv
{
    <#
     
.Description
Exports the current SimpleEnv configuration to the current Configuration File Path
 
.Example
PS> Save-SimpleEnv
#>


    [CmdletBinding()]

    $ExportArgs = @{
        FilePath = $Script:Configuration.ConfigFilePath
        Verbose  = $VerbosePreference
        Force    = $true
    }
    Export-SimpleEnv @ExportArgs
}

# .\public\Set-SimpleEnvConfiguration.ps1
function Set-SimpleEnvConfiguration
{
    <#
.SYNOPSIS
 
Set SimpleEnv Configuration options.
 
.PARAMETER FilePath
 
Sets the path of the backing JSON File, and attempts to import it if it exists.
If you want to overwrite the file without importing it, try Export-SimpleEnv instead.
 
.EXAMPLE
 
PS> Set-SimpleEnvConfiguration -FilePath 'myEnv.SimpleEnv.JSON'
Imports the environment from myEnv.SimpleEnv.JSON, and will persist changes back to it.
 
 
 
.LINK
Export-SimpleEnv
 
#>


    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'low')]
    param (
        #
        [Parameter(Mandatory = $true)]
        [string]
        $FilePath
    )
    
    if ($PSCmdlet.ShouldProcess($Filepath, "Set the source environment JSON file to:" ))
    {
        try
        {
            Write-Verbose "Importing Configuration from $Filepath"
            if (Test-Path $Filepath)
            {
                Import-SimpleEnv -Filepath $Filepath
            }
            $Script:Configuration.ConfigFilePath = $Filepath
            
        }
        catch
        {
            Write-Error "Unable to import $Filepath"
        }    
    }

    
}

# .\Post-Module.ps1
if (Test-Path -Path $Script:Configuration.ConfigFilePath)
{
    Import-SimpleEnv -Filepath $Script:Configuration.ConfigFilePath 
}