coolaj86/go-serviceman
2
2
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ready for more testing

Browse Source
This commit is contained in:
AJ ONeal 2019-07-02 00:02:09 -06:00
parent 870d149797
commit 20d460c70e
6 changed files with 95 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
installer/dist/Library/LaunchDaemons/_rdns_.plist.tmpl vendored
View File

@ -9,12 +9,10 @@
{{- if .Interpreter }}
<string>{{ .Interpreter }}</string>
{{- end }}
<string>{{ .Local }}/opt/{{ .Name }}/{{ .Exec }}</string>
{{- if .Argv }}
<string>{{ .Exec }}</string>
{{- range $arg := .Argv }}
<string>{{ $arg }}</string>
{{- end }}
{{- end }}
</array>
{{- if .Envs }}
<key>EnvironmentVariables</key>
@ -60,9 +58,11 @@
<dict/>
{{ end -}}
{{ if .Workdir -}}
<key>WorkingDirectory</key>
<string>{{ .Local }}/opt/{{ .Name }}</string>
<string>{{ .Workdir }}</string>
{{ end -}}
<key>StandardErrorPath</key>
<string>{{ .LogDir }}/{{ .Name }}.log</string>
<key>StandardOutPath</key>

18
installer/dist/etc/systemd/system/_name_.service.tmpl vendored
View File

@ -1,20 +1,20 @@
# Pre-req
# sudo mkdir -p {{ .Local }}/opt/{{ .Name }}/ {{ .Local }}/var/log/{{ .Name }}
{{ if not .Local -}}
{{ if .System -}}
{{- if and .User ( ne "root" .User ) -}}
# sudo adduser {{ .User }} --home /opt/{{ .Name }}
# sudo chown -R {{ .User }}:{{ .Group }} /opt/{{ .Name }}/ /var/log/{{ .Name }}
{{- end }}
{{ end -}}
# Post-install
# sudo systemctl {{ if .Local -}} --user {{ end -}} daemon-reload
# sudo systemctl {{ if .Local -}} --user {{ end -}} restart {{ .Name }}.service
# sudo journalctl {{ if .Local -}} --user {{ end -}} -xefu {{ .Name }}
# sudo systemctl {{ if not .System -}} --user {{ end -}} daemon-reload
# sudo systemctl {{ if not .System -}} --user {{ end -}} restart {{ .Name }}.service
# sudo journalctl {{ if not .System -}} --user {{ end -}} -xefu {{ .Name }}
[Unit]
Description={{ .Title }} - {{ .Desc }}
Documentation={{ .URL }}
{{ if not .Local -}}
{{ if .System -}}
After=network-online.target
Wants=network-online.target systemd-networkd-wait-online.service
{{- end }}
@ -33,8 +33,10 @@ User={{ .User }}
Group={{ .Group }}
{{ end -}}
WorkingDirectory={{ .Local }}/opt/{{ .Name }}
ExecStart={{if .Interpreter }}{{ .Interpreter }} {{ end }}{{ .Local }}/opt/{{ .Name }}/{{ .Name }} {{ .Args }}
{{ if .Workdir -}}
WorkingDirectory={{ .Workdir }}
{{ end -}}
ExecStart={{if .Interpreter }}{{ .Interpreter }} {{ end }}{{ .Exec }} {{- range $arg := .Argv }}{{ $arg }} {{- end }}
ExecReload=/bin/kill -USR1 $MAINPID
{{if .Production -}}
@ -80,7 +82,7 @@ NoNewPrivileges=true
{{ end -}}
[Install]
{{ if not .Local -}}
{{ if .System -}}
WantedBy=multi-user.target
{{- else -}}
WantedBy=default.target

30
installer/install.go
View File

@ -3,6 +3,7 @@
package installer
import (
"fmt"
"os"
"path/filepath"
"strings"
@ -58,7 +59,7 @@ type Config struct {
Interpreter string `json:"interpreter"` // i.e. node, python
Exec string `json:"exec"`
Argv []string `json:"argv"`
Args string `json:"-"`
Workdir string `json:"workdir"`
Envs map[string]string `json:"envs"`
User string `json:"user"`
Group string `json:"group"`
@ -78,22 +79,16 @@ func Install(c *Config) error {
if "" == c.Exec {
c.Exec = c.Name
}
c.Args = strings.Join(c.Argv, " ")
// TODO handle non-system installs
// * ~/.local/opt/watchdog/watchdog
// * ~/.local/share/watchdog/var/log/
// * ~/.config/watchdog/watchdog.json
if !c.System {
home, err := os.UserHomeDir()
if nil != err {
fmt.Fprintf(os.Stderr, "Unrecoverable Error: %s", err)
os.Exit(4)
return err
}
c.home = home
c.Local = filepath.Join(c.home, ".local")
c.LogDir = filepath.Join(c.home, ".local", "share", c.Name, "var", "log")
} else {
c.LogDir = "/var/log/" + c.Name
c.home = home
}
}
err := install(c)
@ -119,10 +114,15 @@ func IsPrivileged() bool {
func WhereIs(exec string) (string, error) {
exec = filepath.ToSlash(exec)
if strings.Contains(exec, "/") {
// filepath.Clean(exec)
// it's a path (don't allow filenames with slashes)
// TODO stat
return exec, nil
// it's a path (so we don't allow filenames with slashes)
stat, err := os.Stat(exec)
if nil != err {
return "", err
}
if stat.IsDir() {
return "", fmt.Errorf("'%s' is not an executable file", exec)
}
return filepath.Abs(exec)
}
return whereIs(exec)
}

2
installer/install_darwin.go
View File

@ -49,7 +49,7 @@ func install(c *Config) error {
// Write the file out
// TODO rdns
plistName := c.Name + ".plist"
plistName := c.ReverseDNS + ".plist"
plistPath := filepath.Join(plistDir, plistName)
if err := ioutil.WriteFile(plistPath, rw.Bytes(), 0644); err != nil {
fmt.Println("Use 'sudo' to install as a privileged system service.")

8
installer/static/ab0x.go
View File

File diff suppressed because one or more lines are too long

65
serviceman.go
View File

@ -34,17 +34,19 @@ func main() {
}
}
conf.Argv = args
conf.Args = strings.Join(conf.Argv, " ")
force := false
forUser := false
forSystem := false
flag.StringVar(&conf.Title, "title", "", "a human-friendly name for the service")
flag.StringVar(&conf.Desc, "desc", "", "a human-friendly description of the service (ex: Foo App)")
flag.StringVar(&conf.Name, "name", "", "a computer-friendly name for the service (ex: foo-app)")
flag.StringVar(&conf.URL, "url", "", "the documentation on home page of the service")
//flag.StringVar(&conf.Workdir, "workdir", "", "the directory in which the service should be started")
flag.StringVar(&conf.ReverseDNS, "rdns", "", "a plist-friendly Reverse DNS name for launchctl (ex: com.example.foo-app)")
flag.BoolVar(&forSystem, "system", false, "attempt to install system service as an unprivileged/unelevated user")
flag.BoolVar(&forUser, "user", false, "install user space / user mode service even when admin/root/sudo/elevated")
flag.BoolVar(&force, "force", false, "if the interpreter or executable doesn't exist, or things don't make sense, try anyway")
flag.StringVar(&conf.User, "username", "", "run the service as this user")
flag.StringVar(&conf.Group, "groupname", "", "run the service as this group")
flag.BoolVar(&conf.PrivilegedPorts, "cap-net-bind", false, "this service should have access to privileged ports")
@ -54,6 +56,7 @@ func main() {
if forUser && forSystem {
fmt.Println("Pfff! You can't --user AND --system! What are you trying to pull?")
os.Exit(1)
return
}
if forUser {
conf.System = false
@ -66,15 +69,20 @@ func main() {
n := len(args)
if 0 == n {
fmt.Println("Usage: serviceman install ./foo-app -- --foo-arg")
os.Exit(1)
os.Exit(2)
return
}
execpath, err := installer.WhereIs(args[0])
if nil != err {
fmt.Fprintf(os.Stderr, "Error: '%s' could not be found.", args[0])
os.Exit(1)
fmt.Fprintf(os.Stderr, "Error: '%s' could not be found.\n", args[0])
if !force {
os.Exit(3)
return
}
} else {
args[0] = execpath
}
conf.Exec = args[0]
args = args[1:]
@ -93,7 +101,54 @@ func main() {
conf.Title = conf.Name
}
if "" == conf.ReverseDNS {
conf.ReverseDNS = "com.example." + conf.Name
// technically should be something more like "com.example." + conf.Name,
// but whatever
conf.ReverseDNS = conf.Name
}
if !conf.System {
home, err := os.UserHomeDir()
if nil != err {
fmt.Fprintf(os.Stderr, "Unrecoverable Error: %s", err)
os.Exit(4)
return
}
conf.Local = filepath.Join(home, ".local")
conf.LogDir = filepath.Join(home, ".local", "share", conf.Name, "var", "log")
} else {
conf.LogDir = "/var/log/" + conf.Name
}
// Check to see if Exec exists
// /whatever => must exist exactly
// ./whatever => must exist in current or WorkDir(TODO)
// whatever => may also exist in {{ .Local }}/opt/{{ .Name }}/{{ .Exec }}
_, err = os.Stat(conf.Exec)
if nil != err {
bad := true
if !strings.Contains(filepath.ToSlash(conf.Exec), "/") {
optpath := filepath.Join(conf.Local, "/opt", conf.Name, conf.Exec)
_, err := os.Stat(optpath)
if nil == err {
bad = false
fmt.Fprintf(os.Stderr, "Using '%s' for '%s'\n", optpath, conf.Exec)
conf.Exec = optpath
}
}
if bad {
// TODO look for it in WorkDir?
fmt.Fprintf(os.Stderr, "Error: '%s' could not be found.\n", conf.Exec)
if !force {
os.Exit(5)
return
}
execpath, err := filepath.Abs(conf.Exec)
if nil == err {
conf.Exec = execpath
}
fmt.Fprintf(os.Stderr, "Using '%s' anyway.\n", conf.Exec)
}
}
fmt.Printf("\n%#v\n\n", conf)