Module/Stig.TechnologyRole/Stig.TechnologyRole.psm1
|
# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. using module .\..\Common\Common.psm1 using module .\..\Stig.TechnologyVersion\Stig.TechnologyVersion.psm1 # Header <# .SYNOPSIS This class describes a TechnologyRole .DESCRIPTION The TechnologyRole class describes a TechnologyRole, the definition of the specific application or portion of an application that the Stig applies to. The TechnologyRole is one of a few Technology focused classes that work together to form a complete description of the Stig required by the user or application creating the StigData instance. .PARAMETER Name The name of a role of technology of the Stig to select .PARAMETER TechnologyVersion The TechnologyVersion instance for the selected role .EXAMPLE $technologyRole = [TechnologyRole]::new([string] $Name, [TechnologyVersion] $TechnologyVersion) .NOTES This class requires PowerShell v5 or above. #> Class TechnologyRole { [string] $Name [TechnologyVersion] $TechnologyVersion <# .DESCRIPTION The available roles for each version of technology currently in PowerStig #> static $ValidateSet = @" 2012R2 = DNS, DC, MS, IISSite, IISServer All = ADDomain, ADForest, FW, IE11, DotNet4, OracleJRE8, Outlook2013, Excel2013, Word2013, PowerPoint2013, FireFox 2012 = Instance, Database 10 = Client "@ #region Constructors <# .SYNOPSIS DO NOT USE - For testing only .DESCRIPTION A parameterless constructor for TechnologyRole. To be used only for build/unit testing purposes as Pester currently requires it in order to test static methods on powershell classes #> TechnologyRole () { Write-Warning "This constructor is for build testing only." } <# .SYNOPSIS A constructor for TechnologyRole. Returns a ready to use instance of TechnologyRole. .DESCRIPTION A constructor for TechnologyRole. Returns a ready to use instance of TechnologyRole. .PARAMETER Name The name of a role of technology of the Stig to select .PARAMETER TechnologyVersion The TechnologyVersion instance for the selected role #> TechnologyRole ([string] $Name, [TechnologyVersion] $TechnologyVersion) { $this.Name = $Name $TechnologyVersion.Validate() $this.TechnologyVersion = $TechnologyVersion if (!($this.Validate())) { throw("The specified Role name is not valid. Please check for available Roles.") } } #endregion #region Methods <# .SYNOPSIS Validates the provided name .DESCRIPTION This method validates that the provided name for the TechnologyRole is available for a given TechnologyVersion in PowerStig #> [bool] Validate () { $roles = [TechnologyRole]::Available($this.TechnologyVersion.Name) if ($roles -contains $this.Name) { return $true } else { Write-Warning -Message "The Roles currently available within PowerStig for $($this.TechnologyVersion.Name) include:`n$($roles -join "`n")" return $false } } <# .SYNOPSIS Returns available TechnologyRoles .DESCRIPTION This method returns TechnologyRoles for a given TechnologyVersion name currently available in PowerStig .PARAMETER TechnologyVersion The TechnologyVersion name #> static [string[]] Available ([string] $TechnologyVersion) { $roles = ConvertFrom-StringData -StringData $([TechnologyRole]::ValidateSet) if ($roles.$TechnologyVersion) { return $roles.$TechnologyVersion.Split(',').Trim() } else { throw("No Roles are available for the Version you have specified. Please check available Versions and run again.") } } #endregion } # Footer $exclude = @($MyInvocation.MyCommand.Name,'Template.*.txt') foreach ($supportFile in Get-ChildItem -Path $PSScriptRoot -Exclude $exclude) { Write-Verbose "Loading $($supportFile.FullName)" . $supportFile.FullName } Export-ModuleMember -Function '*' -Variable '*' |