(GH-489) Install-ChocolateyService feature

src/helpers/chocolateyInstaller.psm1

@@ -36,4 +36,9 @@ Export-ModuleMember -Function `
 	Update-SessionEnvironment,`
 	Get-EnvironmentVariableNames,`
 	Get-EnvironmentVariable,`
-	Set-EnvironmentVariable
+	Set-EnvironmentVariable,`
+	Install-ChocolateyService,`
+	Get-ServiceExistence,`
+	Get-ServiceStatus,`
+	Uninstall-ChocolateyService,`
+	Remove-ChocolateyDirectory

src/helpers/functions/Get-ServiceExistence.ps1

@@ -0,0 +1,6 @@
+function Get-ServiceExistence {
+param(
+  [string] $serviceName = ''
+)
+  Get-WmiObject -Class Win32_Service -Filter "Name='$serviceName'"
+}

src/helpers/functions/Get-ServiceStatus.ps1

@@ -0,0 +1,7 @@
+function Get-ServiceStatus {
+param(
+  [string] $serviceName = ''
+)
+  $serviceStatus = Get-Service -Name $serviceName
+  $serviceStatus.Status
+}

src/helpers/functions/Install-ChocolateyService.ps1

@@ -0,0 +1,102 @@
+function Install-ChocolateyService {
+<#
+.SYNOPSIS
+Installs a service
+
+.DESCRIPTION
+This will install a service
+
+.PARAMETER PackageName
+The name of the package for whom the service will be installed.
+
+.PARAMETER ServiceName
+The name of service which will be used to install and start the service.
+
+.PARAMETER CreateServiceCommand
+The command which installs the service.
+
+.PARAMETER AvailablePort (OPTIONAL)
+The port which needs to be available in order to start the service.
+
+.EXAMPLE
+Install-ChocolateyService 'PACKAGE_NAME' 'SERVICE_NAME' 'INSTALL_COMMAND' 'PORT'
+Install-ChocolateyService "dcm4chee" "DCM4CHEE" "nssm install DCM4CHEE `"java`" -jar `"%DCM4CHEE_HOME%/bin/run.jar"`" "8090"
+Install-ChocolateyService "postgresqlzip" "PostgreSQL" "pg_ctl register -N `"PostgreSQL`" -U `"LocalSystem`" -w" "5432"
+Install-ChocolateyService "apacheds" "ApacheDS" "nssm install ApacheDS `"java`" -jar `"%APACHEDS_HOME%/lib/apacheds-service-${version}.jar`" `"%APACHEDS_HOME%/instances/default`"" "10389"
+Install-ChocolateyService "test" "test" "nssm install test `"$testDirectory\testService.bat`""
+
+.OUTPUTS
+None
+
+.NOTES
+This helper reduces the number of lines one would have to write to install a service to 1 line.
+This method has error handling built into it.
+
+.LINK
+Uninstall-ChocolateyService
+Get-ServiceExistence
+#>
+param(
+  [string] $packageName,
+  [string] $serviceName,
+  [string] $createServiceCommand,
+  [int] $availablePort
+)
+  Write-Debug "Running 'Install-ChocolateyService' for $packageName with serviceName:`'$serviceName`', createServiceCommand: `'$createServiceCommand`', availablePort: `'$availablePort`' ";
+
+  if(!$packageName) {
+    Write-ChocolateyFailure "Install-ChocolateyService" "Missing PackageName input parameter."
+    return
+  }  
+
+  if(!$serviceName) {
+    Write-ChocolateyFailure "Install-ChocolateyService" "Missing ServiceName input parameter."
+    return
+  }  
+
+  if(!$createServiceCommand) {
+    Write-ChocolateyFailure "Install-ChocolateyService" "Missing CreateServiceCommand input parameter."
+    return
+  }  
+
+  $listeningStatePort = Get-NetTCPConnection -State Listen | Where-Object {$_.LocalAddress -eq "0.0.0.0" -and $_.LocalPort -eq "$availablePort"}
+
+  try {
+    Uninstall-ChocolateyService -serviceName "$serviceName"
+
+    try {
+      Write-Host "$packageName service will be installed"
+	  Write-Host $createServiceCommand
+      iex $createServiceCommand
+    } catch {
+      Write-ChocolateyFailure "Install-ChocolateyService" "The createServiceCommand is incorrect: '$_'."
+	  return
+    }
+
+    if($availablePort -and $listeningStatePort) {
+      Write-ChocolateyFailure "Install-ChocolateyService" "$availablePort is in LISTENING state and not available."
+      return
+	}	
+
+    if (Get-ServiceExistence -serviceName "$serviceName") {
+      Write-Host "$packageName service will be started"
+
+	  for ($i=0;$i -lt 12; $i++) {
+	    $serviceStatus = Get-Service -Name $serviceName
+
+		start-service $serviceName
+
+		if ($serviceStatus.Status -eq "running") {
+		  Write-Host "$packageName service has been started"
+		  return
+		}
+		Start-Sleep -s 5
+      }
+    } else {
+      Write-ChocolateyFailure "Install-ChocolateyService" "service $serviceName does not exist."
+      return
+    }	
+  } catch {
+    Write-ChocolateyFailure "Install-ChocolateyService" "There were errors attempting to create the $packageName service. The error message was '$_'."
+  }
+}

src/helpers/functions/Remove-ChocolateyDirectory.ps1

@@ -0,0 +1,10 @@
+function Remove-ChocolateyDirectory {
+param(
+  [string] $directory
+)
+  Write-Host "Directory `"$directory`" will be removed"
+
+  if (Test-Path $directory) {
+    Remove-Item -Recurse -Force $directory
+  }
+}

src/helpers/functions/Uninstall-ChocolateyService.ps1

@@ -0,0 +1,11 @@
+function Uninstall-ChocolateyService {
+param(
+  [string] $serviceName = ''
+)
+  if (Get-ServiceExistence -serviceName "$serviceName") {
+    Write-Host "$serviceName service already exists and will be removed"
+    stop-service $serviceName
+    $service = Get-ServiceExistence -serviceName "$serviceName"
+    $service.delete()      
+  }
+}

tests/unit/Install-ChocolateyService.Tests.ps1

@@ -0,0 +1,106 @@
+$here = Split-Path -Parent $MyInvocation.MyCommand.Definition
+$common = Join-Path (Split-Path -Parent $here)  '_Common.ps1'
+$base = Split-Path -parent (Split-Path -Parent $here)
+$baseFunctions = "$base\src\helpers\functions"
+. $common
+. "$baseFunctions\Install-ChocolateyService.ps1"
+. "$baseFunctions\Get-ServiceExistence.ps1"
+. "$baseFunctions\Get-ServiceStatus.ps1"
+. "$base\tests\unit\Install-ChocolateyServiceCorrectParameters.Tests.ps1"
+
+$unavailablePort = "135"
+$correctServiceName = "installServiceTest"
+$unavailableServiceName = "unavailableServiceName"
+$testDirectory = "C:\installChocolateyServiceTest"
+
+Describe "Install-ChocolateyService" {
+  Context "When provided parameters are correct the service should be created and started" {	
+	Install-ChocolateyServiceCorrectParameters.Tests -testDirectory "$testDirectory"
+
+	It "service creation should succeed" {
+      Get-ServiceExistence -serviceName "$correctServiceName" | should Be $true
+    }
+
+	It "service start should succeed" {
+      Get-ServiceStatus -serviceName "$correctServiceName" -eq "running" | should Be $true
+    }
+  }
+
+  Context "When provided parameters are correct and service exist it should be removed, subsequently created and started" {	
+	Install-ChocolateyServiceCorrectParameters.Tests -testDirectory "$testDirectory"
+
+	It "service creation should succeed after deletion of previous service" {
+      Get-ServiceExistence -serviceName "$correctServiceName" | should Be $true
+    }
+
+	It "service start should succeed after deletion of previous service" {
+      Get-ServiceStatus -serviceName "$correctServiceName" -eq "running" | should Be $true
+    }
+  }  
+
+  Context "When availablePort parameter is passed to this function and it is in LISTENING state and NOT available" {
+    Mock Write-ChocolateyFailure
+
+	Install-ChocolateyServiceCorrectParameters.Tests -testDirectory "$testDirectory" -availablePort "$unavailablePort"
+
+	It "should return an error" {
+      Assert-MockCalled Write-ChocolateyFailure -parameterFilter { $failureMessage  -eq "$unavailablePort is in LISTENING state and not available." 
+	  Write-Host $failureMessage
+	  }
+    }
+  } 
+
+  Context "When no packageName parameter is passed to this function" {
+    Mock Write-ChocolateyFailure
+
+	Install-ChocolateyService -serviceName "$unavailableServiceName" -createServiceCommand "$unavailableServiceName"
+
+	It "should return an error" {
+	  Assert-MockCalled Write-ChocolateyFailure -parameterFilter { $failureMessage  -eq "Missing PackageName input parameter." }
+	}
+  }
+
+  Context "When no serviceName parameter is passed to this function" {
+	Mock Write-ChocolateyFailure
+
+	Install-ChocolateyService -packageName "$unavailableServiceName" -createServiceCommand "$unavailableServiceName"
+
+	It "should return an error" {
+	  Assert-MockCalled Write-ChocolateyFailure -parameterFilter { $failureMessage  -eq "Missing ServiceName input parameter." }
+	}
+  }
+
+  Context "When no createServiceCommand parameter is passed to this function" {
+    Mock Write-ChocolateyFailure
+
+	Install-ChocolateyService -packageName "$unavailableServiceName" -serviceName "$unavailableServiceName"
+
+	It "should return an error" {
+	  Assert-MockCalled Write-ChocolateyFailure -parameterFilter { $failureMessage  -eq "Missing CreateServiceCommand input parameter." }
+	}
+  }
+
+  Context "When service does not exist" {
+    Mock Write-ChocolateyFailure
+
+	Install-ChocolateyServiceCorrectParameters.Tests -testDirectory "$testDirectory" -serviceName "$unavailableServiceName"
+
+	It "should return an error" {
+	  Assert-MockCalled Write-ChocolateyFailure -parameterFilter { $failureMessage  -eq "service unavailableServiceName does not exist." }
+	}
+  }	
+
+  Context "When createServiceCommand is incorrect" {
+    Mock Write-ChocolateyFailure
+
+	Install-ChocolateyServiceCorrectParameters.Tests -testDirectory "$testDirectory" -createServiceCommand "$unavailableServiceName"
+
+	It "should return an error" {
+	  Assert-MockCalled Write-ChocolateyFailure -parameterFilter { $failureMessage  -eq "The createServiceCommand is incorrect: 'The term 'unavailableServiceName' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.'." }
+	}
+  }
+
+  Uninstall-ChocolateyService -serviceName "$serviceName"
+
+  Remove-ChocolateyDirectory "$testDirectory"
+}

tests/unit/Install-ChocolateyServiceCorrectParameters.Tests.ps1

@@ -0,0 +1,21 @@
+function Install-ChocolateyServiceCorrectParameters.Tests {
+param(
+  [string] $testDirectory,
+  [string] $serviceName = "installServiceTest",
+  [string] $createServiceCommand = "nssm install installServiceTest",
+  [int] $availablePort
+)
+  $testServiceBatPath = "$testDirectory\testService.bat"
+  $testDirectoryExist = Test-Path $testDirectory 
+  $createServiceCommandComplete = "$createServiceCommand `"$testServiceBatPath`""
+
+  `cinst NSSM`
+
+  if (!$testDirectoryExist) {
+    Write-Host "$testDirectory directory does not exist and will be created"
+    New-Item -ItemType Directory -Path $testDirectory
+    Set-Content -Value "ping localhost" -Path $testServiceBatPath
+  }
+
+  Install-ChocolateyService -packageName "$serviceName" -serviceName "$serviceName"  -createServiceCommand "$createServiceCommandComplete" -availablePort "$availablePort"
+}