pleaserun 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 078f5cb3064f6af68bcba84c9f3c8e2abe1ef5b9
-  data.tar.gz: c177ec491cc431d1ee25c871011134e23dab6b03
+  metadata.gz: 3ee1d62691f6064b630454f2f65776ae4fc03292
+  data.tar.gz: b9e3a4a126870684145ad4ca60e0e773987bc434
 SHA512:
-  metadata.gz: b8ca3e5ddffab1005cd0cdac1868900f4a2b937d56278312f5cfe15f0bd5db2ed102051a040b0b3b39dcbab213adaf3686f30eb69ec9272ad9f0e7cda6077ce1
-  data.tar.gz: b8f05cf1372f519fe586bfd72ab3d4e2c543c3cf391329ad19cf96954becbe056d2e107291c6f6e9aa0b37139be36d84972361125de521bbff6ec06f3d95ab1d
+  metadata.gz: ab49602841e860eda3ff79c3c9f2231765667df1606bdd371f490a8beade5b1f07350e21c7ed70dcf300283df336d624f802843a1b43c88a72eee7866b41a6a1
+  data.tar.gz: 7a2c5fe40bbcc62f791c8c9a1f4e34dfc9a10abbe7afaa3e823abb0d122146a1b9593a8e68c83699c91b91f7c09da077dc0d11e79f58c006fc498b9fd8445e17

data/CHANGELOG.asciidoc

@@ -1,5 +1,16 @@
 = Pleaserun Changes and Releases
 
+== 0.0.13  (April 30, 2015)
+  * Now supports MRI 1.9.3 (Vincent Janelle)
+  * cli: New flag --install-prefix. This lets you tell pleaserun what directory to write things.
+  * cli: New flag --[no-]install-actions. If enabled, will run any required installation actions in order to signal the local system to load your newly created service.
+  * upstart: now only generates the .conf file, not the init script,
+    since it's not needed.
+  * sysv: Add ulimit support
+  * detection: Amazon Linux is now detected and, because it is based on RHEL6, defaults to Upstart 0.6.5 (Bob Miller, #68)
+  * misc: The ohai gem is now optional. Ohai is incompatible with JRuby, so I don't want to require it by default. The ohai gem will still be used, if present, during platform detection.
+  * cli: New flag --sysv-log-path. This lets you set the path for the sysv platform to log its output.
+
 == 0.0.4 (March 5, 2014)
   * cli: Autodetect OSX and use launchd 
 

data/Gemfile

@@ -7,4 +7,6 @@ group :development do
   gem "guard-rspec"
   gem "net-ssh"
   gem "peach"
+  gem "flores"
+  gem "ohai"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pleaserun (0.0.10)
+    pleaserun (0.0.12)
       cabin (> 0)
       clamp
       insist
@@ -19,6 +19,12 @@ GEM
     diff-lcs (1.2.5)
     ffi (1.9.6)
     ffi (1.9.6-java)
+    ffi-yajl (2.1.0)
+      libyajl2 (~> 1.2)
+    ffi-yajl (2.1.0-java)
+      ffi (~> 1.5)
+      libyajl2 (~> 1.2)
+    flores (0.0.3)
     formatador (0.2.5)
     guard (2.12.4)
       formatador (>= 0.2.4)
@@ -37,18 +43,37 @@ GEM
     hitimes (1.2.2)
     hitimes (1.2.2-java)
     insist (1.0.0)
+    ipaddress (0.8.0)
+    libyajl2 (1.2.0)
     listen (2.8.5)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
     lumberjack (1.0.9)
     method_source (0.8.2)
+    mime-types (2.5)
+    mixlib-cli (1.5.0)
+    mixlib-config (2.1.0)
+    mixlib-log (1.6.0)
+    mixlib-shellout (2.0.1)
     mustache (0.99.8)
     nenv (0.2.0)
     net-ssh (2.9.2)
     notiffany (0.0.6)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    ohai (8.3.0)
+      ffi (~> 1.9)
+      ffi-yajl (>= 1.1, < 3.0)
+      ipaddress
+      mime-types (~> 2.0)
+      mixlib-cli
+      mixlib-config (~> 2.0)
+      mixlib-log
+      mixlib-shellout (~> 2.0)
+      rake (~> 10.1)
+      systemu (~> 2.6.4)
+      wmi-lite (~> 1.0)
     peach (0.5.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
@@ -59,6 +84,7 @@ GEM
       method_source (~> 0.8.1)
       slop (~> 3.4)
       spoon (~> 0.0)
+    rake (10.4.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
@@ -79,18 +105,22 @@ GEM
     spoon (0.0.4)
       ffi
     stud (0.0.19)
+    systemu (2.6.5)
     thor (0.19.1)
     timers (4.0.1)
       hitimes
+    wmi-lite (1.0.0)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
+  flores
   guard
   guard-rspec
   net-ssh
+  ohai
   peach
   pleaserun!
   rspec (~> 3.0.0)

data/lib/pleaserun/configurable.rb

@@ -35,6 +35,13 @@ module PleaseRun::Configurable
     end
   end # def self.included
 
+  def validate
+    # validate the value of each attribute
+    self.class.attributes.each do |attribute|
+      attribute.validate(send(attribute.name))
+    end
+  end
+
   def configurable_setup
     @attributes = {}
     self.class.ancestors.each do |ancestor|

data/lib/pleaserun/namespace.rb

@@ -1,2 +1,3 @@
 PleaseRun = Module.new
 PleaseRun::Platform = Module.new
+PleaseRun::User = Module.new

data/lib/pleaserun/user/base.rb

@@ -0,0 +1,65 @@
+require "pleaserun/namespace"
+
+class PleaseRun::User::Base
+  include PleaseRun::Configurable
+  include PleaseRun::MustacheMethods
+
+  InvalidTemplate = Class.new(StandardError)
+
+  STRING = proc do
+    validate do |v|
+      insist { v }.is_a?(String)
+    end
+  end
+
+  STRING_OR_NIL = proc do
+    validate do |v|
+      begin
+        insist { v }.is_a?(String)
+      rescue Insist::Failure
+        begin
+          insist { v }.nil?
+        rescue Insist::Failure
+          raise Insist::Failure, "Expected #{v} to be a String or nil value."
+        end
+      end
+    end
+  end
+
+  attribute :name, "The user name", &STRING
+  attribute :platform, "The platform name", &STRING
+  attribute :version, "The platform version", &STRING_OR_NIL
+
+  def render_installer
+    render_template("installer.sh")
+  end
+
+  def render_remover
+    render_template("remover.sh")
+  end
+
+  # Get the template path for this platform.
+  def template_path
+    return File.expand_path(File.join(File.dirname(__FILE__), "../../../templates/user/", platform))
+  end # def template_path
+
+  def render_template(name)
+    possibilities = [ 
+      File.join(template_path, "default", name),
+      File.join(template_path, name)
+    ]
+    possibilities.unshift(File.join(template_path, version, name)) if version
+
+    possibilities.each do |path|
+      next unless File.readable?(path) && File.file?(path)
+      return render(File.read(path))
+    end
+
+    raise InvalidTemplate, "Could not find template file for '#{name}'. Tried all of these: #{possibilities.inspect}"
+  end # def render_template
+
+  # Render a text input through Mustache based on this object.
+  def render(text)
+    return Mustache.render(text, self)
+  end # def render
+end # class PleaseRun::User

data/pleaserun.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
-  files = `git ls-files`.split("\n")
+  files = File.read(__FILE__)[/^__END__$.*/m].split("\n")[1..-1]
 
   spec.name = "pleaserun"
-  spec.version = "0.0.12"
+  spec.version = "0.0.13"
   spec.summary = "pleaserun"
   spec.description = "pleaserun"
   spec.license = "Apache 2.0"
@@ -23,3 +23,59 @@ Gem::Specification.new do |spec|
   spec.email = ["jls@semicomplete.com"]
   spec.homepage = "https://github.com/jordansissel/pleaserun"
 end
+
+# Files list, populate it with `git ls-files | grep -v gitignore`
+__END__
+.rubocop.yml
+CHANGELOG.asciidoc
+Gemfile
+Gemfile.lock
+Guardfile
+LICENSE
+Makefile
+README.md
+bin/pleaserun
+examples/runit.rb
+lib/pleaserun/cli.rb
+lib/pleaserun/configurable.rb
+lib/pleaserun/detector.rb
+lib/pleaserun/errors.rb
+lib/pleaserun/installer.rb
+lib/pleaserun/mustache_methods.rb
+lib/pleaserun/namespace.rb
+lib/pleaserun/platform/base.rb
+lib/pleaserun/platform/launchd.rb
+lib/pleaserun/platform/runit.rb
+lib/pleaserun/platform/systemd.rb
+lib/pleaserun/platform/sysv.rb
+lib/pleaserun/platform/upstart.rb
+lib/pleaserun/user/base.rb
+pleaserun.gemspec
+spec/pleaserun/cli_spec.rb
+spec/pleaserun/configurable_spec.rb
+spec/pleaserun/mustache_methods_spec.rb
+spec/pleaserun/platform/base_spec.rb
+spec/pleaserun/platform/launchd_spec.rb
+spec/pleaserun/platform/systemd_spec.rb
+spec/pleaserun/platform/sysv_spec.rb
+spec/pleaserun/platform/upstart_spec.rb
+spec/pleaserun/user/base_spec.rb
+spec/shared_examples.rb
+spec/testenv.rb
+templates/launchd/10.9
+templates/launchd/default/program.plist
+templates/runit/log
+templates/runit/run
+templates/systemd/default/prestart.sh
+templates/systemd/default/program.service
+templates/sysv/default
+templates/sysv/lsb-3.1/default
+templates/sysv/lsb-3.1/init.sh
+templates/upstart/0.6.5/init.conf
+templates/upstart/0.6.5/init.d.sh
+templates/upstart/1.10
+templates/upstart/1.5/init.conf
+templates/upstart/1.5/init.d.sh
+templates/upstart/default
+templates/user/linux/default/installer.sh
+templates/user/linux/default/remover.sh

data/spec/pleaserun/platform/sysv_spec.rb

@@ -9,7 +9,7 @@ describe PleaseRun::Platform::SYSV do
   context "deployment", :sysv => true do
     etc_initd_writable = File.lstat("/etc/init.d").writable? rescue false
     if !etc_initd_writable
-      it "cannot write to /etc/init.d, so there's no deployment test to do. You'll need to run this as root, probably. Be careful, if you do run this as root."
+      it "cannot write to /etc/init.d, so there's no deployment test to do. To run these tests, you'll need to run this as root, and preferrably in a vm or other temporary system"
     else
       it_behaves_like PleaseRun::Platform do
         let(:skip) { "Cannot write to /etc/init.d" } unless etc_initd_writable

data/spec/pleaserun/user/base_spec.rb

@@ -0,0 +1,116 @@
+require "testenv"
+require "pleaserun/user/base"
+require "English"
+require "etc"
+require "stud/temporary"
+
+describe PleaseRun::User::Base do
+  subject(:user) { PleaseRun::User::Base.new }
+  describe "defaults" do
+    it "should fail validation because there is no name" do
+      expect { user.validate }.to(raise_error(PleaseRun::Configurable::ValidationError))
+    end
+  end
+
+  [:name, :platform, :version].each do |attribute|
+    let(:method) { "#{attribute}=".to_sym }
+    context "###{attribute}=" do
+      let(:value) { Flores::Random.text(1..10) }
+      it "accepts a string" do
+        expect { user.send(method, value) }.not_to(raise_error)
+      end
+    end
+  end
+
+  # Things that can be set to nil
+  [:version].each do |attribute|
+    let(:method) { "#{attribute}=".to_sym }
+    context "###{attribute}=" do
+      let(:value) { nil }
+      it "accepts nil" do
+        expect { user.send(method, value) }.not_to(raise_error)
+      end
+    end
+  end
+
+  describe "rendering" do
+    let(:platform) { "linux" }
+    let(:name) { "example" }
+    before do
+      user.name = name
+      user.platform = platform
+    end
+
+    [:name, :platform].each do |attribute|
+      it "should have expected #{attribute}" do
+        expected = send(attribute) # get the name, platform, whatever
+        expect(user.send(attribute)).to(be == expected)
+      end
+    end
+
+    it "should pass validation" do
+      expect { user.validate }.not_to(raise_error)
+    end
+
+    context "#render_installer" do
+      subject(:render) { user.render_installer }
+      it "should be a String" do
+        expect(render).to(be_a(String))
+      end
+    end
+
+    context "#render_remover" do
+      subject(:render) { user.render_remover }
+      it "should be a String" do
+        expect(render).to(be_a(String))
+      end
+    end
+  end
+
+  describe "integration" do
+    let(:platform) { "linux" }
+    let(:name) { "example" }
+    let(:installer) { Stud::Temporary.pathname }
+    let(:remover) { Stud::Temporary.pathname }
+    let(:userinfo) { Etc.getpwnam(name) }
+
+    before do
+      user.name = name
+      user.platform = platform
+      File.write(installer, user.render_installer)
+      File.write(remover, user.render_remover)
+    end
+
+    after do
+      File.unlink(remover)
+      File.unlink(installer)
+    end
+
+    context "installer" do
+      it "should create the user" do
+        expect(system("sh", installer)).to(be_truthy)
+
+        # Look up the user
+        expect { userinfo }.not_to(raise_error)
+        expect(userinfo.name).to(be == name)
+      end
+    end
+
+    context "remover" do
+      before do
+        system("sh", installer)
+      end
+      it "should remove the user" do
+        system("sh", remover)
+        # User lookup should fail because the user doesn't exist
+        expect { userinfo }.to(raise_error(ArgumentError))
+      end
+    end
+
+    after do
+      # Ensure the user is gone after the test.
+      system("userdel #{name} > /dev/null 2>&1")
+    end
+
+  end
+end

data/spec/testenv.rb

@@ -2,6 +2,7 @@ require "English" # for $CHILD_STATUS
 require "pleaserun/namespace"
 require "insist"
 require "shared_examples"
+require "flores/rspec"
 
 def superuser?
   return Process::UID.eid == 0
@@ -73,6 +74,7 @@ end
 
 RSpec.configure do |config|
   config.include Helpers
+  Flores::RSpec.configure(config)
 
   config.filter_run_excluding(
     :systemd => !(superuser? && platform?("linux") && program?("systemctl") && File.directory?("/lib/systemd")),

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

@@ -57,7 +57,7 @@ start() {
     {{{ulimit_shell}}}
     cd \"$chdir\"
     exec \"$program\" $args
-  " >> {{{ sysv_log }}}.log 2>> {{{ sysv_log }}}.err &
+  " >> {{{ sysv_log }}}.stdout 2>> {{{ sysv_log }}}.stderr &
 
   # Generate the pidfile from here. If we instead made the forked process
   # generate it there will be a race condition between the pidfile writing

data/templates/user/linux/default/installer.sh

@@ -0,0 +1,13 @@
+user_check() {
+  getent passwd "$1" > /dev/null 2>&1
+}
+
+user_create() {
+  # Create a system user. A system user is one within the system uid range and
+  # has no expiration
+  useradd -r "$1"
+}
+
+if ! user_check "{{{ name }}}" ; then
+  user_create "{{{ name }}}"
+fi

data/templates/user/linux/default/remover.sh

@@ -0,0 +1,11 @@
+user_check() {
+  getent passwd "$1" > /dev/null 2>&1
+}
+
+user_remove() {
+  userdel "$1"
+}
+
+if user_check "{{{ name }}}" ; then
+  user_remove "{{{ name }}}"
+fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pleaserun
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cabin
@@ -88,7 +88,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.asciidoc
 - Gemfile
@@ -112,6 +111,7 @@ files:
 - lib/pleaserun/platform/systemd.rb
 - lib/pleaserun/platform/sysv.rb
 - lib/pleaserun/platform/upstart.rb
+- lib/pleaserun/user/base.rb
 - pleaserun.gemspec
 - spec/pleaserun/cli_spec.rb
 - spec/pleaserun/configurable_spec.rb
@@ -121,6 +121,7 @@ files:
 - spec/pleaserun/platform/systemd_spec.rb
 - spec/pleaserun/platform/sysv_spec.rb
 - spec/pleaserun/platform/upstart_spec.rb
+- spec/pleaserun/user/base_spec.rb
 - spec/shared_examples.rb
 - spec/testenv.rb
 - templates/launchd/default/program.plist
@@ -134,6 +135,8 @@ files:
 - templates/upstart/0.6.5/init.d.sh
 - templates/upstart/1.5/init.conf
 - templates/upstart/1.5/init.d.sh
+- templates/user/linux/default/installer.sh
+- templates/user/linux/default/remover.sh
 homepage: https://github.com/jordansissel/pleaserun
 licenses:
 - Apache 2.0
@@ -155,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: pleaserun

data/.gitignore

@@ -1,4 +0,0 @@
-.rspec_system/
-.*.sw*
-.vagrant
-.bundle