pleaserun 0.0.1

data/spec/pleaserun/platform/sysv_spec.rb

@@ -0,0 +1,133 @@
+require "testenv"
+require "pleaserun/platform/sysv"
+
+describe PleaseRun::Platform::SYSV do
+  let(:start) { "/etc/init.d/#{subject.name} start" }
+  let(:stop) { "/etc/init.d/#{subject.name} stop" }
+  let(:status) { "/etc/init.d/#{subject.name} status" }
+  let(:restart) { "/etc/init.d/#{subject.name} restart" }
+
+  it "inherits correctly" do
+    insist { PleaseRun::Platform::SYSV.ancestors }.include?(PleaseRun::Platform::Base)
+  end
+
+  context "#files" do
+    subject do
+      runner = PleaseRun::Platform::SYSV.new("ubuntu-12.04")
+      runner.name = "fancypants"
+      next runner
+    end
+
+    let(:files) { subject.files.collect { |path, content| path } }
+
+    it "emits a file in /etc/init.d/" do
+      insist { files }.include?("/etc/init.d/fancypants")
+    end
+    it "emits a file in /etc/default/" do
+      insist { files }.include?("/etc/default/fancypants")
+    end
+  end
+
+  context "deployment" do
+    partytime = superuser? && File.directory?("/etc/init.d")
+    it "cannot be attempted", :if => !partytime do
+      pending("we are not the superuser") unless superuser?
+      pending("no /etc/init.d/ directory found") unless File.directory?("/etc/init.d")
+    end
+
+    context "as the super user", :if => partytime do
+      subject { PleaseRun::Platform::SYSV.new("ubuntu-12.04") }
+
+      before do
+        subject.name = "example"
+        subject.user = "root"
+        subject.program = "/bin/ping"
+        subject.args = [ "127.0.0.1" ]
+
+        activate(subject)
+      end
+
+      after do
+        system_quiet("/etc/init.d/#{subject.name} stop")
+        subject.files.each do |path, content|
+          File.unlink(path) if File.exist?(path)
+        end
+
+        # TODO(sissel): Remove the logs, too.
+        #log = "/var/log/example.log"
+        #File.unlink(log) if File.exist?(log)
+      end
+
+      it "should install" do
+        insist { File }.exist?("/etc/init.d/#{subject.name}")
+      end
+
+      it "should start" do
+        # Status should fail before starting
+        status_stopped
+        starts
+      end
+
+      it "should stop" do
+        status_stopped
+        starts
+        stops
+      end
+
+      context "with failing prestart" do
+        before do
+          subject.prestart = "false"
+          activate(subject)
+        end
+
+        it "should fail to start" do
+          insist { starts }.fails
+        end
+
+        context "with PRESTART=no" do
+          before { ENV["PRESTART"] = "no" }
+          after { ENV["PRESTART"] = nil }
+          it "should start" do
+            starts
+          end
+        end
+
+        it "should stop" do
+          # Force a start
+          ENV["PRESTART"] = "no"
+          starts
+          ENV["PRESTART"] = nil
+          stops
+        end
+
+        it "should fail to restart" do
+          ENV["PRESTART"] = "no"
+          starts
+          ENV["PRESTART"] = nil
+          insist { restarts }.fails
+        end
+      end
+
+      context "with a successful prestart" do
+        before do
+          subject.prestart = "echo hello world"
+          activate(subject)
+        end
+
+        it "should start" do
+          starts
+        end
+
+        it "should restart" do
+          # Force start
+          ENV["PRESTART"] = "no"
+          starts
+          ENV["PRESTART"] = nil
+
+          # Restart should succeed
+          restarts
+        end
+      end
+    end # as the super user
+  end # real tests
+end

data/spec/pleaserun/platform/upstart_spec.rb

@@ -0,0 +1,117 @@
+require "testenv"
+require "pleaserun/platform/upstart"
+
+describe PleaseRun::Platform::Upstart do
+  let(:start) { "initctl start #{subject.name}" }
+  let(:stop) { "initctl stop #{subject.name}" }
+  let(:status) { "initctl status #{subject.name} | egrep -v '#{subject.name} stop/'" }
+  let(:restart) { "initctl restart #{subject.name}" }
+
+  it "inherits correctly" do
+    insist { PleaseRun::Platform::Upstart.ancestors }.include?(PleaseRun::Platform::Base)
+  end
+
+  context "#files" do
+    subject do
+      runner = PleaseRun::Platform::Upstart.new("1.10")
+      runner.name = "fancypants"
+      next runner
+    end
+
+    let(:files) { subject.files.collect { |path, content| path } }
+
+    it "emits a file in /etc/init/" do
+      insist { files }.include?("/etc/init/fancypants.conf")
+    end
+
+    it "emits a file in /etc/init.d/" do
+      insist { files }.include?("/etc/init.d/fancypants")
+    end
+  end
+
+  context "#install_actions" do
+    subject do
+      runner = PleaseRun::Platform::Upstart.new("1.10")
+      runner.name = "fancypants"
+      next runner
+    end
+
+    it "has no install actions" do
+      insist { subject.install_actions }.empty?
+    end
+  end
+
+  context "deployment" do
+    partytime = (superuser? && platform?("linux") && program?("initctl") && File.directory?("/etc/init"))
+    it "cannot be attempted", :if => !partytime do
+      pending("we are not the superuser") unless superuser?
+      pending("platform is not linux") unless platform?("linux")
+      pending("no 'initctl' program found") unless program?("initctl")
+      pending("missing /etc/init/ directory") unless File.directory?("/etc/init")
+    end
+
+    context "as the super user", :if => partytime do
+      subject { PleaseRun::Platform::Upstart.new("1.10") }
+
+      before do
+        subject.name = "example"
+        subject.user = "root"
+        subject.program = "/bin/sh"
+        subject.args = [ "-c", "echo hello world; sleep 5" ]
+        activate(subject)
+      end
+
+      after do
+        system_quiet("initctl stop #{subject.name}")
+        subject.files.each do |path, content|
+          File.unlink(path) if File.exist?(path)
+        end
+
+        # Remove the logs, too.
+        log = "/var/log/upstart/example.log"
+        File.unlink(log) if File.exist?(log)
+      end
+
+      #it "should install" do
+        #system("initctl status #{subject.name}")
+        #status_stopped
+      #end
+
+      it "should start" do
+        starts
+
+        # Starting an already-started job will fail
+        insist { starts }.fails
+
+        status_running
+      end
+
+      it "should stop" do
+        starts
+        stops
+      end
+
+      context "with failing prestart" do
+        before do
+          subject.prestart = "false"
+          activate(subject)
+        end
+
+        it "should fail to start" do
+          insist { starts }.fails
+        end
+      end
+
+      context "with successful prestart" do
+        before do
+          subject.prestart = "true"
+          activate(subject)
+        end
+
+        it "should start" do
+          starts
+        end
+      end
+    end # as the super user
+  end # real tests
+end

data/spec/testenv.rb

@@ -0,0 +1,69 @@
+require "pleaserun/namespace"
+require "insist"
+
+def superuser?
+  return Process::UID.eid == 0
+end
+
+def platform?(name)
+  return RbConfig::CONFIG["host_os"] =~ /^#{name}/
+end
+
+def system_quiet(command)
+  system("#{command} > /dev/null 2>&1")
+end
+
+def sh(command)
+  system_quiet(command)
+  return $?
+end
+
+def program?(name)
+  ENV["PATH"].split(":").each do |path|
+    file = File.join(path, name)
+    return true if File.executable?(file)
+  end
+  return false
+end
+
+def activate(pleaserun)
+  pleaserun.files.each do |path, content, mode=nil|
+    File.write(path, content)
+    File.chmod(mode, path) if mode
+  end
+  pleaserun.install_actions.each do |command|
+    system(command)
+    raise "Command failed: #{command}" unless $?.success?
+  end
+end
+
+module Helpers
+  def starts
+    system_quiet(start); insist { $? }.success?
+    status_running
+  end
+
+  def stops
+    system_quiet(stop); insist { $? }.success?
+    status_stopped
+  end
+
+  def status_running
+    system_quiet(status); insist { $? }.success?
+  end
+
+  def status_stopped
+    system_quiet(status); reject { $? }.success?
+  end
+
+  def restarts
+    starts
+    system_quiet(restart)
+    insist { $? }.success?
+    status_running
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

data/templates/launchd/10.9/program.plist

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>Disabled</key><false/>
+    <key>Label</key><string>{{{ name }}}</string>
+    <key>Program</key><string>{{{ program }}}</string>
+    <key>ProgramArguments</key><array>
+      <string>{{{ program }}}</string>
+      {{{xml_args}}}
+    </array>
+    <key>KeepAlive</key> <true/>
+    <key>StandardOutPath</key> <string>/var/log/{{name}}.out</string>
+    <key>StandardErrorPath</key> <string>/var/log/{{name}}.err</string>
+    <!-- Things to implement eventually.
+    <key>UserName</key><string>{{{ user }}}</string>
+    <key>GroupName</key><string>{{{ group }}}</string>
+    <key>Umask</key><integer>{{{ umask }}}</integer>
+    <key>RootDirectory</key><string>{{{ chroot }}}</string>
+    <key>WorkingDirectory</key><string>{{{ chdir }}}</string>
+    <key>Nice</key><integer>0</integer>
+    <key>SoftResourceLimits</key><dict>
+      <key>Core</key><integer></integer>
+      <key>CPU</key><integer></integer>
+      <key>Data</key><integer></integer>
+      <key>FileSize</key><integer></integer>
+      <key>MemoryLock</key><integer></integer>
+      <key>NumberOfFiles</key><integer></integer>
+      <key>NumberOfProcesses</key><integer></integer>
+      <key>ResidentSetSize</key><integer></integer>
+      <key>Stack</key><integer></integer>
+    </dict>
+    <key>HardResourceLimits</key><dict>
+      <key>Core</key><integer></integer>
+      <key>CPU</key><integer></integer>
+      <key>Data</key><integer></integer>
+      <key>FileSize</key><integer></integer>
+      <key>MemoryLock</key><integer></integer>
+      <key>NumberOfFiles</key><integer></integer>
+      <key>NumberOfProcesses</key><integer></integer>
+      <key>ResidentSetSize</key><integer></integer>
+      <key>Stack</key><integer></integer>
+    </dict>
+      -->
+  </dict>
+</plist>
+

data/templates/runit/log

@@ -0,0 +1,4 @@
+#! /bin/sh
+
+exec svlogd -tt /var/log/{{ name }}
+

data/templates/runit/run

@@ -0,0 +1,17 @@
+#! /bin/sh
+
+# Send stderr to stdout so svlogd catches all output.
+exec 2>&1
+
+PROGRAM={{#quoted}}{{{PROGRAM}}}{{/quoted}}
+# Set up the arguments  (for $@)
+set -- {{{shell_args}}}
+
+{{#shell_continuation}}
+exec chpst
+  -u {{#quoted}}{{{user}}}:{{{group}}}{{/quoted}}
+  {{#chroot}} -/ {{#quoted}}{{{chroot}}}{{/quoted}} {{/chroot}}
+  {{#nice}} -n {{#quoted}}{{{nice}}}{{/quoted}} {{/nice}}
+  "$PROGRAM" "$@"
+{{/shell_continuation}}
+

data/templates/systemd/default/prestart.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+{{{ prestart }}}

data/templates/systemd/default/program.service

@@ -0,0 +1,17 @@
+[Unit]
+{{#description}}
+Description={{{ description }}}
+{{/description}}
+ 
+[Service]
+Type=simple
+User={{{ user }}}
+Group={{{ group }}}
+ExecStart={{{program}}} {{{shell_args}}}
+{{#prestart}}
+ExecStartPre=/lib/systemd/system/{{{name}}}-prestart.sh
+{{/prestart}}
+Restart=always
+
+[Install]
+WantedBy=multi-user.target

data/templates/sysv/lsb-3.1/init.d

@@ -0,0 +1,141 @@
+#!/bin/sh
+# Init script for {{{ name }}}
+# Maintained by {{{ author }}}
+# Generated by pleaserun.
+# Implemented based on LSB Core 3.1:
+#   * Sections: 20.2, 20.3
+#
+### BEGIN INIT INFO
+# Provides:          {{{ name }}}
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: {{{ one_line_description }}}
+# Description:       {{{ description }}}
+### END INIT INFO
+
+PATH=/sbin:/usr/sbin:/bin:/usr/bin
+export PATH
+
+name={{#escaped}}{{#safe_filename}}{{{ name }}}{{/safe_filename}}{{/escaped}}
+program={{#escaped}}{{{ program }}}{{/escaped}}
+args={{{ escaped_args }}}
+pidfile="/var/run/$name.pid"
+
+[ -r /etc/default/$name ] && . /etc/default/$name
+[ -r /etc/sysconfig/$name ] && . /etc/sysconfig/$name
+
+start() {
+  {{! I don't use 'su' here to run as a different user because the process 'su'
+      stays as the parent, causing our pidfile to contain the pid of 'su' not the
+      program we intended to run. Luckily, the 'chroot' program on OSX, FreeBSD, and Linux
+      all support switching users and it invokes execve immediately after chrooting.
+  }}
+
+  {{#prestart}}
+  if [ "$PRESTART" != "no" ] ; then
+    # If prestart fails, abort start.
+    prestart || return $?
+  fi
+  {{/prestart}}
+
+  # Run the program!
+  chroot --userspec {{{user}}}:{{{group}}} {{{chroot}}} sh -c "
+    {{#chdir}}cd {{{chdir}}}{{/chdir}}
+    {{#nice}}nice {{{nice}}}{{/nice}}
+    exec \"$program\" $args
+  " > /var/log/$name.log 2> /var/log/$name.err &
+
+  # Generate the pidfile from here. If we instead made the forked process
+  # generate it there will be a race condition between the pidfile writing
+  # and a process possibly asking for status.
+  echo $! > $pidfile
+
+  echo "$name started."
+  return 0
+}
+
+stop() {
+  # Try a few times to kill TERM the program
+  if status ; then
+    pid=`cat "$pidfile"`
+    echo "Killing $name (pid $pid) with SIGTERM"
+    kill -TERM $pid
+    # Wait for it to exit.
+    for i in 1 2 3 4 5 ; do
+      echo "Waiting $name (pid $pid) to die..."
+      status || break
+      sleep 1
+    done
+    if status ; then
+      echo "$name stop failed; still running."
+    else
+      echo "$name stopped."
+    fi
+  fi
+}
+
+status() {
+  if [ -f "$pidfile" ] ; then
+    pid=`cat "$pidfile"`
+    if kill -0 $pid > /dev/null 2> /dev/null ; then
+      # process by this pid is running.
+      # It may not be our pid, but that's what you get with just pidfiles.
+      # TODO(sissel): Check if this process seems to be the same as the one we
+      # expect. It'd be nice to use flock here, but flock uses fork, not exec,
+      # so it makes it quite awkward to use in this case.
+      return 0
+    else
+      return 2 # program is dead but pid file exists
+    fi
+  else
+    return 3 # program is not running
+  fi
+}
+
+force_stop() {
+  if status ; then
+    stop
+    status && kill -KILL `cat "$pidfile"`
+  fi
+}
+
+{{#prestart}}
+prestart() {
+  {{{ prestart }}}
+
+  status=$?
+
+  if [ $status -gt 0 ] ; then
+    echo "Prestart command failed with code $status. If you wish to skip the prestart command, set PRESTART=no in your environment."
+  fi
+  return $status
+}
+{{/prestart}}
+
+case "$1" in
+  start) status || start ;;
+  stop) stop ;;
+  force-stop) force_stop ;;
+  status) 
+    status
+    code=$?
+    if [ $code -eq 0 ] ; then
+      echo "$name is running"
+    else
+      echo "$name is not running"
+    fi
+    exit $code
+    ;;
+  restart) 
+    {{#prestart}}prestart || exit $?{{/prestart}}
+    stop && start 
+    ;;
+  *)
+    echo "Usage: $SCRIPTNAME {start|stop|force-stop|status|restart}" >&2
+    exit 3
+  ;;
+esac
+
+exit $?