Tests/MSFT_xServiceResource.TestHelper.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
<#
    .SYNOPSIS
    Creates a service binary file.
 
    .PARAMETER ServiceName
    The name of the service to create the binary file for.
 
    .PARAMETER ServiceCodePath
    The path to the code for the service to create the binary file for.
 
    .PARAMETER ServiceDisplayName
    The display name of the service to create the binary file for.
 
    .PARAMETER ServiceDescription
    The description of the service to create the binary file for.
 
    .PARAMETER ServiceDependsOn
    Dependencies of the service to create the binary file for.
 
    .PARAMETER ServiceExecutablePath
    The path to write the service executable to.
#>

function New-ServiceBinary
{
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [String]
        $ServiceName,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceCodePath,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceDisplayName,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceDescription,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceDependsOn,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceExecutablePath
    )

    if (Get-Service $ServiceName -ErrorAction Ignore)
    {
        Stop-Service $ServiceName -ErrorAction SilentlyContinue
        Remove-TestService -ServiceName $ServiceName -ServiceExecutablePath $ServiceExecutablePath
    }

    $fileText = Get-Content $ServiceCodePath -Raw
    $fileText = $fileText.Replace("TestServiceReplacementName", $ServiceName)
    $fileText = $fileText.Replace("TestServiceReplacementDisplayName", $ServiceDisplayName)
    $fileText = $fileText.Replace("TestServiceReplacementDescription", $ServiceDescription)
    $fileText = $fileText.Replace("TestServiceReplacementDependsOn", $ServiceDependsOn)
    Add-Type $fileText -OutputAssembly $ServiceExecutablePath -OutputType WindowsApplication -ReferencedAssemblies "System.ServiceProcess", "System.Configuration.Install"
}

<#
    .SYNOPSIS
    Creates a new service for testing.
 
    .PARAMETER ServiceName
    The name of the service to create the binary file for.
 
    .PARAMETER ServiceCodePath
    The path to the code for the service to create the binary file for.
 
    .PARAMETER ServiceDisplayName
    The display name of the service to create the binary file for.
 
    .PARAMETER ServiceDescription
    The description of the service to create the binary file for.
 
    .PARAMETER ServiceDependsOn
    Dependencies of the service to create the binary file for.
 
    .PARAMETER ServiceExecutablePath
    The path to write the service executable to.
#>

function New-TestService
{
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [String]
        $ServiceName,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceCodePath,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceDisplayName,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceDescription,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceDependsOn,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceExecutablePath
    )

    New-ServiceBinary `
        -ServiceName $ServiceName `
        -ServiceCodePath $ServiceCodePath `
        -ServiceDisplayName $ServiceDisplayName `
        -ServiceDescription $ServiceDescription `
        -ServiceDependsOn $ServiceDependsOn `
        -ServiceExecutablePath $ServiceExecutablePath

    if (-not (Test-Path $ServiceExecutablePath))
    {
        throw "Failed to create service executable file."
    }

    $configurationName = "TestServiceConfig"
    $configurationPath = Join-Path -Path (Get-Location) -ChildPath $ServiceName

    Configuration $configurationName
    {
        Import-DscResource -ModuleName xPSDesiredStateConfiguration

        xService Service1
        {
            Name = $ServiceName
            Path = $ServiceExecutablePath
            DisplayName = $ServiceDisplayName
            Description = $ServiceDescription
            Dependencies = $ServiceDependsOn
            StartupType = 'Manual'
            BuiltInAccount = 'LocalSystem'
            State = 'Stopped'
            Ensure = 'Present'
        }
    }

    & $configurationName -OutputPath $configurationPath

    Start-DscConfiguration -Path $configurationPath -Wait -Force -Verbose
}

<#
    .SYNOPSIS
    Retrieves the path to the install utility.
#>

function Get-InstallUtilPath
{
    [CmdletBinding()]
    param ()

    if ($env:Processor_Architecture -ieq 'amd64')
    {
        $frameworkName = "Framework64"
    }
    else
    {
        $frameworkName = "Framework"
    }

    return Join-Path (Resolve-Path "$env:WinDir\Microsoft.Net\$frameworkName\v4*") "installUtil.exe"
}

<#
    .SYNOPSIS
    Removes a service.
 
    .PARAMETER ServiceName
    The name of the service to remove.
 
    .PARAMETER ServiceExecutablePath
    The path to the executable of the service to remove.
#>

function Remove-TestService
{
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [String]
        $ServiceName,

        [Parameter(Mandatory = $true)]
        [String]
        $ServiceExecutablePath
    )

    $installUtility = Get-InstallUtilPath
    & $installUtility /u $ServiceExecutablePath

    Remove-Item $ServiceExecutablePath -Force -ErrorAction SilentlyContinue
    Remove-Item *.InstallLog -Force -ErrorAction SilentlyContinue
    Remove-Item $ServiceName -Force -Recurse -ErrorAction SilentlyContinue
}

Export-ModuleMember -Function `
    New-TestService, `
    Remove-TestService