naming

README.md

@@ -51,10 +51,10 @@ go build -o service-shark.exe main.go
         Bind argument to environment variable with "env:{VAR_NAME}".
 ```
 
-Exampe
+Example
 ```
 service-shark.exe -name MyService -workdir C:/MyService -cmd java -- -jar MyProg.jar -Xmx1G -myArg "env:TEST_VALUE"
 ```
 Service Shark will run ``java`` with ``-jar MyProg.jar -Xmx1G -myArg "123"`` from ``C:/MyService``.
 
-See [example/test-example-service.ps1](./example/test-example-service.ps1) for a complate example.
+See [example/test-example-service.ps1](./example/test-example-service.ps1) for a complete example.

command/host.go

@@ -11,6 +11,7 @@ import (
 	"github.com/matthiasng/service-shark/service"
 )
 
+// Host implements the service.Program interface to run any command as service
 type Host struct {
 	Arguments cli.Arguments
 	cmd       *exec.Cmd

service/environment.go

@@ -0,0 +1,11 @@
+package service
+
+// Environment contains information about the environment
+// your application is running in.
+type Environment interface {
+	// IsWindowsService reports whether the program is running as a Windows Service.
+	IsWindowsService() bool
+
+	// ExitService can be used to signal a service crash. Service will exit with a user define error code 3.
+	ExitService(error)
+}

service/program.go

@@ -0,0 +1,19 @@
+package service
+
+// Program interface contains Start and Stop methods which are called
+// when the service is started and stopped.
+//
+// The Start methods must be non-blocking.
+//
+// Implement this interface and pass it to the Run function to start your program.
+type Program interface {
+	// Start must be non-blocking.
+	Start(Environment) error
+
+	// Stop is called in response to syscall.SIGINT, syscall.SIGTERM, or when a
+	// Windows Service is stopped.
+	Stop() error
+
+	// Name returns the service name.
+	Name() string
+}

service/run.go

@@ -0,0 +1,40 @@
+package service
+
+import (
+	"os/signal"
+
+	wsvc "golang.org/x/sys/windows/svc"
+)
+
+// Create variables for svc and signal functions so we can mock them in tests
+var svcIsAnInteractiveSession = wsvc.IsAnInteractiveSession
+var svcRun = wsvc.Run
+var signalNotify = signal.Notify
+
+// Run runs an implementation of the Service interface.
+//
+// Run will block until the Windows Service is stopped or Ctrl+C is pressed if
+// running from the console.
+//
+// Stopping the Windows Service and Ctrl+C will call the Service's Stop method to
+// initiate a graceful shutdown.
+//
+// Note that WM_CLOSE is not handled (end task) and the Service's Stop method will
+// not be called.
+func Run(program Program) error {
+	var err error
+
+	interactive, err := svcIsAnInteractiveSession()
+	if err != nil {
+		return err
+	}
+
+	ws := &windowsService{
+		name:          program.Name(),
+		svc:           program,
+		isInteractive: interactive,
+		signalErrChan: make(chan error, 1),
+	}
+
+	return ws.run()
+}

service/service_windows.go

@@ -1,59 +1,15 @@
-// +build windows
-
 package service
 
 import (
 	"os"
-	"os/signal"
-	"path/filepath"
 	"syscall"
 
 	wsvc "golang.org/x/sys/windows/svc"
 )
 
-// Create variables for svc and signal functions so we can mock them in tests
-var svcIsAnInteractiveSession = wsvc.IsAnInteractiveSession
-var svcRun = wsvc.Run
-var signalNotify = signal.Notify
-
-// FixWorkingDirectory changes the working directory to the exeutable directory.
-// The working directory for a Windows Service is C:\Windows\System32 ...
-func FixWorkingDirectory() error {
-	dir := filepath.Dir(os.Args[0])
-	return os.Chdir(dir)
-}
-
-// Run runs an implementation of the Service interface.
-//
-// Run will block until the Windows Service is stopped or Ctrl+C is pressed if
-// running from the console.
-//
-// Stopping the Windows Service and Ctrl+C will call the Service's Stop method to
-// initiate a graceful shutdown.
-//
-// Note that WM_CLOSE is not handled (end task) and the Service's Stop method will
-// not be called.
-func Run(service Service) error {
-	var err error
-
-	interactive, err := svcIsAnInteractiveSession()
-	if err != nil {
-		return err
-	}
-
-	ws := &windowsService{
-		name:          service.Name(),
-		svc:           service,
-		isInteractive: interactive,
-		signalErrChan: make(chan error, 1),
-	}
-
-	return ws.run()
-}
-
 type windowsService struct {
 	name          string
-	svc           Service
+	svc           Program
 	isInteractive bool
 	signalErrChan chan error
 	serviceErr    error

service/service_windows_test.go

@@ -1,5 +1,3 @@
-// +build windows
-
 package service
 
 import (

service/utils.go

@@ -0,0 +1,13 @@
+package service
+
+import (
+	"os"
+	"path/filepath"
+)
+
+// FixWorkingDirectory changes the working directory to the exeutable directory.
+// The working directory for a Windows Service is C:\Windows\System32 ...
+func FixWorkingDirectory() error {
+	dir := filepath.Dir(os.Args[0])
+	return os.Chdir(dir)
+}

service/utils_test.go

@@ -0,0 +1,30 @@
+package service
+
+import (
+	"os"
+	"os/user"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func Test_FixWorkingDirectory(t *testing.T) {
+	require := require.New(t)
+
+	expectedDir := filepath.Dir(os.Args[0])
+
+	usr, err := user.Current()
+	require.NoError(err)
+	require.NotEqual(expectedDir, usr.HomeDir)
+
+	err = os.Chdir(usr.HomeDir)
+	require.NoError(err)
+
+	err = FixWorkingDirectory()
+	require.NoError(err)
+
+	newDir, err := os.Getwd()
+	require.NoError(err)
+	require.Equal(expectedDir, newDir)
+}