DSCResources/Grani_TopShelf/Grani_TopShelf.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
#region Initialize

function Initialize
{
    # Enum for Ensure
    Add-Type -TypeDefinition @"
        public enum EnsureType
        {
            Present,
            Absent
        }
"@
 -ErrorAction SilentlyContinue
    
    # Import [System.ServiceProcess.ServiceControllerStatus] and other types.....
    Get-Service > $null
}

. Initialize

#endregion

#region Message Definition

$verboseMessages = Data {
    ConvertFrom-StringData -StringData @"
        KillingConcoleTopShelf = Console TopShelf running detected. Killing....
        StoppedServiceMayBeTopShelf = Stopped Service may be TopShelf Service.
        StoppedServiceMayNotBeTopShelf = Stopped Service may NOT be TopShelf Service.
"@

}

$debugMessages = Data {
    ConvertFrom-StringData -StringData @"
        CheckingServicePathAndParameterPathMatching = Checking Service Path equals parameter Path
        PathFound = Successfully found path '{0}'.
        PathNotExist = Be sure you have download or set target path '{0}' in advance.
        ProcessNotFound = Process not found.
        ProcessPathNotDesired = Process path not detected. ProcessPath '{0}', Path '{1}'.
        ServiceNotExists = Service not exist
"@

}

$errorMessages = Data {
    ConvertFrom-StringData -StringData @"
"@

}

#endregion

#region *-TargetResource

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Path,

        [parameter(Mandatory = $true)]
        [System.String]$ServiceName,

        [parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]$Ensure
    )
    
    # validate path is correct.
    ValidatePathExists -Path $Path

    # Check existing is TopShelfService or not
    if (-not (IsServiceExists -Name $ServiceName))
    {
        Write-Debug $debugMessages.ServiceNotExists
        $ensureResult = [EnsureType]::Absent.ToString()
    }
    else
    {
        # service exist. Validate if it is TopShelf Service or not
        if (IsTopShelfServiceValid -Name $ServiceName -Path $Path)
        {
            $ensureResult = [EnsureType]::Present.ToString()
        }
        else
        {
            $ensureResult = [EnsureType]::Absent.ToString()
        }
    }

    $returnValue = @{
        Path = $Path
        ServiceName = $ServiceName
        Ensure = $ensureResult
    }

    return $returnValue
}


function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Path,

        [parameter(Mandatory = $true)]
        [System.String]$ServiceName,

        [parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]$Ensure
    )

    #region Uninstall Service
    if ($Ensure -eq [EnsureType]::Absent.ToString())
    {
        UninstallTopShelfService -Path $Path;
        return;
    }

    #endregion

    #region Install Service

    # Even install process but uninstall is neccesary for in case TopShelf Process path is changed.
    UninstallTopShelfService -Path $Path;

    # Detect TopShelf run as Console
    if ((IsServiceStopped -Name $ServiceName) -and (IsProcessUsing -Path $Path))
    {
        Write-Verbose $verboseMessages.KillingConcoleTopShelf;
        Get-Process -Name $ServiceName | Stop-Process -Force;
    }

    # Install Service
    InstallTopShelfService -Path $Path;
    return;    
    
    #endregion
}


function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Path,

        [parameter(Mandatory = $true)]
        [System.String]$ServiceName,

        [parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]$Ensure
    )

    $result = (Get-TargetResource -Path $Path -ServiceName $ServiceName -Ensure $Ensure).Ensure -eq $Ensure
    return $result
}

#endregion

#region TopShlef helper

function InstallTopShelfService
{
    [CmdletBinding()]
    [OutputType([void])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Path
    )
    
    try
    {
        . $path install | Write-Verbose
    }
    catch
    {
        throw $_
    }
}

function UninstallTopShelfService
{
    [CmdletBinding()]
    [OutputType([void])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Path
    )
    
    try
    {
        . $path uninstall | Write-Verbose
    }
    catch
    {
        throw $_
    }
}

#endregion

#region Service helper

function IsServiceExists
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Name
    )
    
    # Name or DisplayName checking
    return (Get-Service | where {($_.Name -eq $Name) -or ($_.DisplayName -eq $Name)} | measure).Count -ne 0
}

function GetServiceStatusSafe
{
    [CmdletBinding()]
    [OutputType([System.ServiceProcess.ServiceControllerStatus])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Name
    )
    
    # Name or DisplayName checking
    return (Get-Service | where {($_.Name -eq $Name) -or ($_.DisplayName -eq $Name)}).Status
}

function IsServiceRunning
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Name
    )
    
    return (GetServiceStatusSafe -Name $Name) -eq [System.ServiceProcess.ServiceControllerStatus]::Running
}

function IsServiceStopped
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Name
    )
    
    return (GetServiceStatusSafe -Name $Name) -eq [System.ServiceProcess.ServiceControllerStatus]::Stopped
}

function IsTopShelfServiceValid
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Name,

        [parameter(Mandatory = $true)]
        [System.String]$Path
    )
    
    # make sure : this function NOT expecting to pass invalid service. Be sure to filter invalid input in-advance.

    # Check Service Path is valid
    Write-Debug ($debugMessages.CheckingServicePathAndParameterPathMatching);
    if (-not (IsServicePathValid -Name $Name -Path $Path))
    {
        # Service Path != Request Path immediately return false
        return $false;
    }
    return $true;
}

function IsServicePathValid
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Name,

        [parameter(Mandatory = $true)]
        [System.String]$Path
    )

    # Get Service Instance detail
    $service = Get-CimInstance -ClassName Win32_Service | where Name -eq $Name;

    # Service executable Path Check - Pick up exe path. TopShelf Service PathName Format will be :
    # "xxx.exe" -displayname "xxx" -servicename "xxx"
    if ($null -ne $service.PathName)
    {
        $servicePath = $service.PathName.Split(" ") | select -First 1;
        return $servicePath.Replace('"',"") -eq $Path;        
    }
    return $false;
}

#endregion

#region Process helper

function IsProcessUsing
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Path
    )
    
    # pickup process from executable file name
    $processName = (Get-Item -Path $Path).BaseName
    $processInfo = Get-Process | where Name -eq $processName
    
    # validate Process exist - if service stopped, then process will not shown
    if (($processInfo | measure).Count -eq 0)
    {
        Write-Debug ($debugMessages.ProcessNotFound -f $processName)
        return $false
    }

    # validate service path is as desired
    if (($processInfo).Path -ne $Path)
    {
        Write-Debug ($debugMessages.ProcessPathNotDesired -f $processInfo.Path, $Path)
        return $false
    }

    # Name and Path matches TopShelf execute Path
    return $true
}

#endregion

#region Path helder

function ValidatePathExists
{
    [CmdletBinding()]
    [OutputType([Void])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]$Path
    )
    
    if (-not (Test-Path -Path $Path))
    {
        Write-Debug ($debugMessages.PathNotExist -f $Path)
        throw New-Object System.IO.FileNotFoundException
    }
    Write-Debug ($debugMessages.PathFound -f $Path)
}

#endregion

Export-ModuleMember -Function *-TargetResource