pleaserun 0.0.1

data/lib/pleaserun/platform/sysv.rb

@@ -0,0 +1,12 @@
+require "pleaserun/platform/base"
+require "pleaserun/namespace"
+
+class PleaseRun::Platform::SYSV < PleaseRun::Platform::Base
+  def files
+    return Enumerator::Generator.new do |out|
+      out.yield [ safe_filename("/etc/init.d/{{ name }}"), render_template("init.d"), 0755 ]
+      out.yield [ safe_filename("/etc/default/{{ name }}"), render_template("default") ]
+    end
+  end
+end
+

data/lib/pleaserun/platform/upstart.rb

@@ -0,0 +1,11 @@
+require "pleaserun/platform/base"
+
+class PleaseRun::Platform::Upstart < PleaseRun::Platform::Base
+  def files
+    return Enumerator::Generator.new do |out|
+      out.yield [ safe_filename("/etc/init/{{ name }}.conf"), render_template("init.conf") ]
+      out.yield [ safe_filename("/etc/init.d/{{ name }}"), render_template("init.d.sh"), 0755 ]
+    end
+  end
+end
+

data/pleaserun.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  files = %x{git ls-files}.split("\n")
+
+  spec.name = "pleaserun"
+  spec.version = "0.0.1"
+  spec.summary = "pleaserun"
+  spec.description = "pleaserun"
+  spec.license = "Apache 2.0"
+
+  # Note: You should set the version explicitly.
+  spec.add_dependency "cabin", ">0" # for logging. apache 2 license
+  spec.add_dependency "clamp"
+  spec.add_dependency "cabin"
+  spec.add_dependency "stud"
+  spec.add_dependency "mustache"
+  spec.add_dependency "insist"
+
+  spec.files = files
+  spec.require_paths << "lib"
+  spec.bindir = "bin"
+  spec.executables = "pleaserun"
+
+  spec.authors = ["Jordan Sissel"]
+  spec.email = ["jls@semicomplete.com"]
+  #spec.homepage = "..."
+end
+

data/spec/pleaserun/configurable_spec.rb

@@ -0,0 +1,215 @@
+require "testenv"
+require "pleaserun/configurable"
+
+describe PleaseRun::Configurable::Facet do
+  subject { PleaseRun::Configurable::Facet  }
+
+  it "should have nil value by default" do
+    facet = subject.new(:name, "description")
+    insist { facet.value }.nil?
+  end
+
+  context "#name" do
+    subject { PleaseRun::Configurable::Facet.new(:hello, "world") }
+    it "returns the name" do
+      insist { subject.name } == :hello
+    end
+  end
+
+  context "#description" do
+    subject { PleaseRun::Configurable::Facet.new(:hello, "world") }
+    it "returns the description" do
+      insist { subject.description } == "world"
+    end
+  end
+
+  context "#value=" do
+    it "returns the given value" do
+      facet = subject.new(:name, "description")
+
+      # Check return value of assignment
+      insist { facet.value = 3 } == 3
+
+      # Check return value of read
+      insist { facet.value } == 3
+    end
+
+    it "invokes the validation block when value is set" do
+      count = 0
+      facet = subject.new(:name, "description") do
+        validate do |v| 
+          count += 1
+          insist { v } == 3
+        end
+      end
+      insist { count } == 0
+      insist { facet.value }.nil?
+      facet.value = 3
+      insist { facet.value } == 3
+      insist { count } == 1
+    end
+
+    it "invokes the munger" do
+      count = 0
+      facet = subject.new(:name, "description") do
+        munge do |v|
+          count += 1
+          next v.to_s
+        end
+      end
+
+      insist { count } == 0
+      facet.value = 1000
+      insist { facet.value } == "1000"
+      facet.value = "hello"
+      insist { facet.value } == "hello"
+      facet.value = { "foo" => "bar" }
+      insist { facet.value } == '{"foo"=>"bar"}'
+      insist { count } == 3
+    end
+
+    it "invokes munger prior to validation" do
+      order = []
+      facet = subject.new(:name, "description") do
+        validate do |v|
+          order << :validate
+          insist { v.is_a?(Array) }
+        end
+        munge do |v|
+          order << :munge
+          if !v.is_a?(Array)
+            next [v]
+          else
+            v
+          end
+        end
+      end
+
+      facet.value = "hello"
+      insist { facet.value } == [ "hello" ]
+      insist { order } == [ :munge, :validate ]
+    end
+  end
+  
+  context "#set?" do
+    it "returns false if value isn't set" do
+      facet = subject.new(:name, "description")
+      reject { facet }.set?
+    end
+    it "returns false if value isn't set and we have a default" do
+      facet = subject.new(:name, "description", :default => 100)
+      reject { facet }.set?
+      insist { facet.value } == 100
+    end
+    it "returns true if value is set" do
+      facet = subject.new(:name, "description")
+      reject { facet }.set?
+      facet.value = "hello"
+      insist { facet }.set?
+    end
+  end
+
+  context "with :default => ..." do
+    it "uses default when no value is set" do
+      facet = subject.new(:name, "description", :default => 4)
+      insist { facet.value } == 4
+      facet.value = 5
+      insist { facet.value } == 5
+    end
+
+    it "fails if default is invalid" do
+      insist do
+        facet = subject.new(:name, "description", :default => 4) do
+          validate do |v|
+            insist { v } != 4
+          end
+        end
+      end.raises(PleaseRun::Configurable::ValidationError)
+    end
+    
+    it "succeeds if default is valid" do
+      facet = subject.new(:name, "description", :default => 4) do
+        validate do |v|
+          insist { v } == 4
+        end
+      end
+    end
+  end
+
+  context "attribute" do
+    subject do
+      next Class.new do
+        include PleaseRun::Configurable
+        attribute :whatever, "whatever"
+      end
+    end
+
+    it "creates accessor methods" do
+      foo = subject.new
+      insist { foo }.respond_to?(:whatever)
+      insist { foo }.respond_to?(:whatever=)
+      insist { foo }.respond_to?(:whatever?)
+    end
+
+    it "doesn't share values with other instances" do
+      foo1 = subject.new
+      foo2 = subject.new
+      foo1.whatever = "fancy"
+      insist { foo1.whatever } != foo2.whatever
+    end
+
+    context "#<attribute>?" do
+      it "returns false if the value isn't set" do
+        reject { subject.new }.whatever?
+      end
+      it "returns true if the value is set" do
+        foo = subject.new
+        reject { foo }.whatever?
+        foo.whatever = "pants"
+        insist { foo }.whatever?
+      end
+    end
+
+    context "via configurable_setup" do
+      subject do
+        next Class.new do
+          include PleaseRun::Configurable
+          attribute :whatever, "whatever", :default => "Hello"
+
+          def initialize(something)
+            @something = something
+            configurable_setup
+          end
+        end
+      end
+
+      it "creates accessor methods" do
+        foo = subject.new(1234)
+        insist { foo }.respond_to?(:whatever)
+        insist { foo }.respond_to?(:whatever=)
+        insist { foo.whatever } == "Hello"
+      end
+    end
+
+    context "validation" do
+      subject do
+        next Class.new do
+          include PleaseRun::Configurable
+          attribute :number, "something" do
+            validate do |v|
+              insist { v }.is_a?(Numeric)
+            end
+          end
+        end
+      end
+
+      it "fails if it raises an exception" do
+        insist { subject.new.number = "hello" }.raises(PleaseRun::Configurable::ValidationError)
+      end
+
+      it "succeeds if no exception is raised" do
+        subject.new.number = 33
+      end
+    end
+  end
+end

data/spec/pleaserun/mustache_methods_spec.rb

@@ -0,0 +1,46 @@
+require "testenv"
+require "pleaserun/mustache_methods"
+
+class MustacheMethodTester
+  include PleaseRun::MustacheMethods
+
+  def whatever
+    return "hello world"
+  end
+
+  def args
+    [ "hello world", "fancy pants"]
+  end
+
+  def render(s)
+    return s
+  end
+end
+
+describe PleaseRun::MustacheMethods do
+  subject { MustacheMethodTester.new }
+
+  context "{{shell_args}}" do
+    it "should escape multiple arguments via quoting" do
+      insist { subject.shell_args } == "\"hello world\" \"fancy pants\""
+    end
+  end
+
+  context "{{shell_quote}}" do
+    it "quotes with spaces correctly" do
+      insist { subject.shell_quote("hello world") } == "\"hello world\""
+    end
+    it "escapes $" do
+      insist { subject.shell_quote("$") } == "\"\\$\""
+    end
+  end
+
+  context "{{shell_continuation}}" do
+    let(:input) { "hello\nworld\nfizzle" }
+      
+    it "should render correctly" do
+      insist { subject.shell_continuation(input) } == "hello \\\nworld \\\nfizzle"
+    end
+  end
+  context "{{quoted}}"
+end

data/spec/pleaserun/platform/base_spec.rb

@@ -0,0 +1,27 @@
+require "testenv"
+require "pleaserun/platform/base"
+
+describe PleaseRun::Platform::Base do
+  context "default" do
+    subject { PleaseRun::Platform::Base.new("example") }
+    it "#name should be nil" do
+      insist { subject.name }.nil?
+    end
+
+    it "#args should be nil" do
+      insist { subject.args }.nil?
+    end
+
+    it "#program should be nil" do
+      insist { subject.program }.nil?
+    end
+
+    it "#user should be root" do
+      insist { subject.user } == "root"
+    end
+
+    it "#group should be root" do
+      insist { subject.group } == "root"
+    end
+  end
+end

data/spec/pleaserun/platform/launchd_spec.rb

@@ -0,0 +1,93 @@
+require "testenv"
+require "pleaserun/platform/launchd"
+
+describe PleaseRun::Platform::LaunchD do
+  it "inherits correctly" do
+    insist { PleaseRun::Platform::LaunchD.ancestors }.include?(PleaseRun::Platform::Base)
+  end
+
+  context "#files" do
+    subject do
+      runner = PleaseRun::Platform::LaunchD.new("10.9")
+      runner.name = "fancypants"
+      next runner
+    end
+
+    let(:files) { subject.files.collect { |path, content| path } }
+
+    it "emits a file in /Library/LaunchDaemons" do
+      insist { files }.include?("/Library/LaunchDaemons/fancypants.plist")
+    end
+  end
+
+  context "#install_actions" do
+    subject do
+      runner = PleaseRun::Platform::LaunchD.new("10.9")
+      runner.name = "fancypants"
+      next runner
+    end
+
+    it "runs 'launchctl load'" do
+      insist { subject.install_actions }.include?("launchctl load /Library/LaunchDaemons/fancypants.plist")
+    end
+  end
+
+  context "deployment" do
+    partytime = (superuser? && platform?("darwin"))
+    it "cannot be attempted", :if => !partytime do
+      pending("we are not the superuser") unless superuser?
+      pending("platform is not darwin") unless platform?("darwin")
+    end
+
+    context "as the super user", :if => partytime do
+      subject { PleaseRun::Platform::LaunchD.new("10.9") }
+
+      before do
+        subject.name = "example"
+        subject.user = "root"
+        subject.program = "/bin/sh"
+        subject.args = [ "-c", "echo hello world; sleep 5" ]
+
+        subject.files.each do |path, content|
+          File.write(path, content)
+        end
+        subject.install_actions.each do |command|
+          system(command)
+          raise "Command failed: #{command}" unless $?.success?
+        end
+      end
+
+      after do
+        system_quiet("launchctl stop #{subject.name}")
+        system_quiet("launchctl unload /Library/LaunchDaemons/#{subject.name}.plist")
+        subject.files.each do |path, content|
+          File.unlink(path) if File.exist?(path)
+        end
+
+        # Remove the logs, too.
+        [ "/var/log/#{subject.name}.out", "/var/log/#{subject.name}.err" ].each do |log|
+          File.unlink(log) if File.exist?(log)
+        end
+      end
+
+      it "should install" do
+        system_quiet("launchctl list #{subject.name}")
+        insist { $? }.success?
+      end
+
+      it "should start" do
+        system_quiet("launchctl start #{subject.name}")
+        insist { $? }.success?
+        system_quiet("launchctl list #{subject.name}")
+        insist { $? }.success?
+      end
+
+      it "should stop" do
+        system_quiet("launchctl start #{subject.name}")
+        insist { $? }.success?
+        system_quiet("launchctl stop #{subject.name}")
+        insist { $? }.success?
+      end
+    end
+  end # real tests
+end

data/spec/pleaserun/platform/systemd_spec.rb

@@ -0,0 +1,119 @@
+require "testenv"
+require "pleaserun/platform/systemd"
+
+describe PleaseRun::Platform::Systemd do
+  let(:start) { "systemctl start #{subject.name}.service" }
+  let(:stop) { "systemctl stop #{subject.name}.service" }
+  let(:status) { "systemctl show #{subject.name} | grep -q SubState=running" }
+  let(:restart) { "systemctl restart #{subject.name}.service" }
+
+  it "inherits correctly" do
+    insist { PleaseRun::Platform::Systemd.ancestors }.include?(PleaseRun::Platform::Base)
+  end
+
+  context "#files" do
+    subject do
+      runner = PleaseRun::Platform::Systemd.new("default")
+      runner.name = "fancypants"
+      runner.program = "/bin/true"
+      next runner
+    end
+
+    let(:files) { subject.files.collect { |path, content| path } }
+
+    it "emits a file in /lib/systemd/system" do
+      insist { files }.include?("/lib/systemd/system/fancypants.service")
+    end
+  end
+
+  context "#install_actions" do
+    subject do
+      runner = PleaseRun::Platform::Systemd.new("default")
+      runner.name = "fancypants"
+      next runner
+    end
+
+    it "invokes systemctl to reload" do
+      insist { subject.install_actions }.include?("systemctl --system daemon-reload")
+    end
+  end
+
+  context "deployment" do
+    partytime = (superuser? && platform?("linux") && program?("systemctl") && File.directory?("/lib/systemd"))
+    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 'systemctl' program found") unless program?("systemctl")
+      pending("missing /lib/systemd directory") unless File.directory?("/lib/systemd")
+    end
+
+    context "as the super user", :if => partytime do
+      subject { PleaseRun::Platform::Systemd.new("default") }
+
+      before do
+        subject.name = "hurray"
+        subject.user = "root"
+        subject.program = "/bin/sh"
+        subject.args = [ "-c", "echo hello world; sleep 5" ]
+        activate(subject)
+        
+        # monkeypatch StartLimitInterval=0 into the .service file to avoid
+        # being throttled by systemd during these tests.
+        # Fixes https://github.com/jordansissel/pleaserun/issues/11
+        path = "/lib/systemd/system/#{subject.name}.service"
+        File.write(path, File.read(path).sub(/^\[Service\]$/, "[Service]\nStartLimitInterval=0"))
+      end
+
+      after do
+        system_quiet("systemctl stop #{subject.name}")
+        subject.files.each do |path, content|
+          File.unlink(path) if File.exist?(path)
+        end
+      end
+
+      #it "should install" do
+        #system("systemctl status #{subject.name}")
+        #status_stopped
+      #end
+
+      it "should start" do
+        starts
+        status_running
+      end
+
+      it "should stop" do
+        starts
+        stops
+      end
+
+      it "should start and stop" do
+        5.times do
+          starts
+          stops
+        end
+      end
+
+      context "with failing prestart" do
+        before do
+          subject.prestart = "#!/bin/sh\nfalse\n"
+          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