Cmdlets/Interface/New-ScriptModule.ps1

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
<#
Copyright 2016 ASOS.com Limited
 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
#>


<#
.NAME
    New-ScriptModule
     
.SYNOPSIS
    Creates a new script module and test file
 
.DESCRIPTION
    To increase consistency between script modules this will create a script module powershell file and Pester test file
    with the necessary boilerplate code needed to function, these files can then be used as a starting point for new development.
     
.PARAMETER Name
    The name of the script module
 
.INPUTS
    None. You cannot pipe objects to New-ScriptModule.
 
.OUTPUTS
    None.
#>

function New-ScriptModule {
    [CmdletBinding()]
    [OutputType("System.String")]
    param(
        [Parameter(Mandatory=$true)][ValidateNotNullOrEmpty()][System.String]$Name,
        [Parameter(Mandatory=$false)][ValidateScript({ Test-Path $_ })][System.String]$Path = $PWD      
    )
     
    $fileName = Join-Path $Path ("{0}.scriptmodule.ps1" -f ($Name -replace '\s', '-'))
    $testFileName = [System.IO.Path]::ChangeExtension($fileName, "Tests.ps1")
      
    if (Test-Path $fileName) {
        throw "Script Module file '$fileName' already exists"
    }
    
    Set-Content -Path $fileName -Value @"
`$ScriptModuleName = "$Name"
`$ScriptModuleDescription = "$Name description"
Set-StrictMode -Version Latest
 
throw "Script Module not implemented"
"@


    Set-Content -Path $testFileName -Value @"
Set-StrictMode -Version Latest
`$here = Split-Path -Parent `$MyInvocation.MyCommand.Path
`$sut = (Split-Path -Leaf `$MyInvocation.MyCommand.Path) -replace '\.Tests\.', '.'
. "`$here\`$sut"
 
Describe "$Name" {
    It "does something useful" {
        `$true | Should Be `$false
    }
}
"@


@"
New Script Module File created: $fileName
Script Module test file: $testFileName
"@

}