pleaserun 0.0.27 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5da0f7988a9947a210cbb3fec5070dd95f874e8d
-  data.tar.gz: 75791509553c575a50dd55ed77aced3e924142cc
+SHA256:
+  metadata.gz: 0c919527f537b698a9d75f42af43888ae2c7bd823b3ff1903676a1aae61a2b74
+  data.tar.gz: 6cc96e8f6d67f4632350c8ec84ff095f81aeea6efc1aeb5191864f2f246bd40b
 SHA512:
-  metadata.gz: 3639a10e3e0f7df7d3de587173706c872e814461185f83b3b242a496d9bb94dbb2e7b8b57be4935494f01d1aece22126b9a5a0cf194109d48797d9a2f93eb588
-  data.tar.gz: 03331a51f9dd499f01dcc76e1d60d1578a5b5027d757f339712a7a6168923809e55d1e52cd24743ae86e23a495f769bf512f303b94dee55bc2a6eeb2c7e20641
+  metadata.gz: 3ffe5a71f474861354e56f4e33c719d85dba13514b8b0139a9e9e20f04d98655531f0043b1f6d4289c71a2d86cb660bff68e09f898eca454566ad4877aa3af16
+  data.tar.gz: fc73e14185be3732651e2f8c1d04acb96f37599b9b70b23f29a63a0232b4f672e04c784fce3ba501e89194c52aa610d5c439a4e8874e0309525173317a3f401b

data/CHANGELOG.asciidoc

@@ -1,5 +1,19 @@
 = Pleaserun Changes and Releases
 
+== 0.0.31 (March 17, 2020)
+  * Fixed a code error preventing `runit` in pleaserun from working (#143, #145)
+
+== 0.0.30 (August 7, 2017)
+  * Released without changelog ???
+
+== 0.0.29 (April 17, 2017)
+  * `pleaserun --version` will now write the version of pleaserun and exit. (#125)
+
+== 0.0.28 (February 6, 2017)
+  * sysv and upstart will now `set -a` before loading /etc/default and
+    /etc/sysconfig files. This is to bring them in line with what users are
+    asking me as well as with what systemd does with these files. (#121)
+
 == 0.0.27 (November 4, 2016)
   * Fix a bug where upstart jobs would fail to run if the job's user was not root.
   * upstart: Add nice and limit_open_files support for Upstart 0.6.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pleaserun (0.0.27)
+    pleaserun (0.0.31)
       cabin (> 0)
       clamp
       dotenv
@@ -13,58 +13,46 @@ GEM
   remote: https://rubygems.org/
   specs:
     cabin (0.9.0)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    clamp (1.1.1)
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    dotenv (2.1.1)
-    ffi (1.9.6)
-    ffi (1.9.6-java)
-    flores (0.0.3)
+    clamp (1.3.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    ffi (1.15.0)
+    flores (0.0.7)
     formatador (0.2.5)
-    guard (2.12.4)
+    guard (2.16.2)
       formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
-    guard-rspec (4.5.0)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hitimes (1.2.2)
-    hitimes (1.2.2-java)
     insist (1.0.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)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     mustache (0.99.8)
-    nenv (0.2.0)
-    net-ssh (2.9.2)
-    notiffany (0.0.6)
+    nenv (0.3.0)
+    net-ssh (6.1.0)
+    notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
     peach (0.5.1)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry (0.10.1-java)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-      spoon (~> 0.0)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     rspec (3.0.0)
       rspec-core (~> 3.0.0)
       rspec-expectations (~> 3.0.0)
@@ -78,16 +66,10 @@ GEM
       rspec-support (~> 3.0.0)
     rspec-support (3.0.4)
     shellany (0.0.1)
-    slop (3.6.0)
-    spoon (0.0.4)
-      ffi
-    stud (0.0.22)
-    thor (0.19.1)
-    timers (4.0.1)
-      hitimes
+    stud (0.0.23)
+    thor (1.1.0)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
@@ -100,4 +82,4 @@ DEPENDENCIES
   rspec (~> 3.0.0)
 
 BUNDLED WITH
-   1.13.5
+   2.1.2

data/Makefile

@@ -1,5 +1,5 @@
 GEMSPEC=$(shell ls *.gemspec)
-VERSION=$(shell awk -F\" '/spec.version/ { print $$2 }' $(GEMSPEC))
+VERSION=$(shell awk -F\" '/VERSION =/ { print $$2 }' lib/pleaserun/version.rb)
 NAME=$(shell awk -F\" '/spec.name/ { print $$2 }' $(GEMSPEC))
 GEM=$(NAME)-$(VERSION).gem
 

data/README.md

@@ -1,12 +1,18 @@
 # Please, Run!
 
-Pleaserun is a tool to generate startup scripts for the wasteland of sorrow
-that is process launchers.
+Pleaserun is a tool to generate startup scripts and service definitions. It targets
+service managers such as systemd, Upstart, launchd, sysv init, and runit.
 
 Ideally, you should be able to specify a configuration of how to run a given
 service command (like apache, syslog-ng, whatever), and this tool should
 be able to spit out a script or config file for your target platform.
 
+## Project Principles
+
+* Community: If a newbie has a bad time, it's a bug.
+* Engineering: Make it work, then make it right, then make it fast.
+* Capabilities: If it doesn't do a thing today, we can make it do it tomorrow.
+
 ## What's going on here?
 
 With pleaserun, you can generate the following launchers/scripts/whatever:
@@ -17,7 +23,7 @@ With pleaserun, you can generate the following launchers/scripts/whatever:
 * runit
 * sysv init
 
-Want more? It's easy to add things. [File an issue](../../issues/) and ask away!
+Want more? I want it to be easy to add things and invite you to [file an issue](../../issues/) with your ideas.
 
 ## Installation
 
@@ -151,3 +157,7 @@ Please enjoy running things! If you are not enjoying this program, then somethin
 If you are having a bad time, it is a bug!
 
 All contributions welcome (bug reports, feature requests, bug fixes, new features, etc!)
+
+# Code of Conduct
+
+This project has a code of conduct and uses the [Contributor Covenant](CODE_OF_CONDUCT.md).

data/lib/pleaserun/cli.rb

@@ -4,6 +4,7 @@ require "clamp"
 require "cabin"
 require "stud/temporary"
 
+require "pleaserun/version"
 require "pleaserun/platform/base"
 require "pleaserun/installer"
 require "pleaserun/errors"
@@ -63,7 +64,7 @@ class PleaseRun::CLI < Clamp::Command # rubocop:disable ClassLength
 
   def help # rubocop:disable MethodLength
     return <<-HELP
-Welcome to pleaserun!
+Welcome to pleaserun version #{PleaseRun::VERSION}!
 
 This program aims to help you generate 'init' scripts/configs for various
 platforms. The simplest example takes only the command you wish to run.
@@ -103,6 +104,16 @@ are made. If it fails, nagios will not start. Yay!
     # rubocop:enable MethodLength
   end
 
+  def run(args)
+    # Short circuit for a `fpm --version` or `fpm -v` short invocation that 
+    # is the user asking us for the version of fpm.
+    if args == [ "-v" ] || args == [ "--version" ]
+      puts PleaseRun::VERSION
+      return 0
+    end
+    super
+  end
+
   def execute
     setup_logger
     setup_defaults
@@ -175,9 +186,12 @@ are made. If it fails, nagios will not start. Yay!
       PleaseRun::Installer.install_actions(runner) if install_actions?
     else
       target = install_prefix || Stud::Temporary.directory
-      actions_script = File.join(target, "install_actions.sh")
       PleaseRun::Installer.install_files(runner, target, overwrite?)
-      PleaseRun::Installer.write_actions(runner, actions_script)
+
+      if install_actions?
+        actions_script = File.join(target, "install_actions.sh")
+        PleaseRun::Installer.write_actions(runner, actions_script)
+      end
     end
     return 0
   end # def run_human

data/lib/pleaserun/platform/base.rb

@@ -88,7 +88,7 @@ class PleaseRun::Platform::Base
 
   attribute :environment_file, "A file containing environment variables to export for your application" do
     validate do |env|
-      insist { env }.is_a?(File)
+      insist { env }.is_a?(String)
     end
   end
 

data/lib/pleaserun/platform/runit.rb

@@ -6,8 +6,8 @@ require "pleaserun/platform/base"
 # Learn what runit is here: http://smarden.org/runit/
 class PleaseRun::Platform::Runit < PleaseRun::Platform::Base
   attribute :service_path, "The path runit service directory",
-            :default => "/service" do |path|
-    validate do
+            :default => "/service" do
+    validate do |path|
       insist { path }.is_a?(String)
     end
   end

data/lib/pleaserun/version.rb

@@ -0,0 +1,3 @@
+module PleaseRun
+  VERSION = "0.0.32"
+end

data/pleaserun.gemspec

@@ -1,8 +1,9 @@
+require File.join(File.dirname(__FILE__), "lib/pleaserun/version")
 Gem::Specification.new do |spec|
   files = File.read(__FILE__)[/^__END__$.*/m].split("\n")[1..-1]
 
   spec.name = "pleaserun"
-  spec.version = "0.0.27"
+  spec.version = PleaseRun::VERSION
   spec.summary = "pleaserun"
   spec.description = "pleaserun"
   spec.license = "Apache 2.0"
@@ -53,6 +54,7 @@ lib/pleaserun/platform/systemd.rb
 lib/pleaserun/platform/sysv.rb
 lib/pleaserun/platform/upstart.rb
 lib/pleaserun/user/base.rb
+lib/pleaserun/version.rb
 pleaserun.gemspec
 spec/pleaserun/cli_spec.rb
 spec/pleaserun/configurable_spec.rb

data/templates/systemd/default/program.service

@@ -22,5 +22,9 @@ WorkingDirectory={{{chdir}}}
 {{/nice}}{{#limit_open_files}}LimitNOFILE={{{limit_open_files}}}
 {{/limit_open_files}}
 
+# When stopping, how long to wait before giving up and sending SIGKILL?
+# Keep in mind that SIGKILL on a process can cause data loss.
+TimeoutStopSec=infinity
+
 [Install]
 WantedBy=multi-user.target

data/templates/sysv/default/default

@@ -1,3 +1,3 @@
 {{#all_environment_variables}}
-export {{key}}={{#shell_quote}}{{value}}{{/shell_quote}}
+{{key}}={{#shell_quote}}{{value}}{{/shell_quote}}
 {{/all_environment_variables}}

data/templates/sysv/default/init.sh

@@ -42,8 +42,12 @@ nice="{{{nice}}}"
 # The default behavior is to simply log a message "program stop failed; still running"
 KILL_ON_STOP_TIMEOUT=0
 
+# When loading default and sysconfig files, we use `set -a` to make
+# all variables automatically into environment variables.
+set -a
 [ -r {{{default_file}}} ] && . {{{default_file}}}
 [ -r {{{sysconfig_file}}} ] && . {{{sysconfig_file}}}
+set +a
 
 [ -z "$nice" ] && nice=0
 
@@ -63,9 +67,11 @@ start() {
       all support switching users and it invokes execve immediately after chrooting. }}
 
   # Ensure the log directory is setup correctly.
-  [ ! -d "{{{ log_directory }}}" ] && mkdir "{{{ log_directory }}}"
-  chown "$user":"$group" "{{{ log_directory }}}"
-  chmod 755 "{{{ log_directory }}}"
+  if [ ! -d "{{{ log_directory }}}" ]; then 
+    mkdir "{{{ log_directory }}}"
+    chown "$user":"$group" "{{{ log_directory }}}"
+    chmod 755 "{{{ log_directory }}}"
+  fi
 
   {{#prestart}}
   if [ "$PRESTART" != "no" ] ; then

data/templates/upstart/0.6.5/default

@@ -1,3 +1,3 @@
 {{#all_environment_variables}}
-export {{key}}={{#shell_quote}}{{value}}{{/shell_quote}}
+{{key}}={{#shell_quote}}{{value}}{{/shell_quote}}
 {{/all_environment_variables}}

data/templates/upstart/0.6.5/init.conf

@@ -38,7 +38,11 @@ end script
 {{/prestart}}
 
 script
+  # When loading default and sysconfig files, we use `set -a` to make
+  # all variables automatically into environment variables.
+  set -a
   [ -r "{{{default_file}}}" ] && . "{{{default_file}}}"
   [ -r "{{{sysconfig_file}}}" ] && . "{{{sysconfig_file}}}"
+  set +a
   exec chroot --userspec {{{user}}}:{{{group}}} {{{chroot}}} {{{program}}} {{{shell_args}}} >> {{ log_path_stdout }} 2>> {{ log_path_stderr }}
 end script

data/templates/upstart/default/default

@@ -1,3 +1,3 @@
 {{#all_environment_variables}}
-export {{key}}={{#shell_quote}}{{value}}{{/shell_quote}}
+{{key}}={{#shell_quote}}{{value}}{{/shell_quote}}
 {{/all_environment_variables}}

data/templates/upstart/default/init.conf

@@ -45,6 +45,14 @@ limit stack {{{limit_stack_size}}} {{{limit_stack_size}}}
 setuid {{{user}}}
 setgid {{{group}}}
 
+# Set a really really large kill timeout
+# By default, upstart has a kill timeout of 5 seconds.
+# If the program is being stopped, but hasn't finished by the time this 'kill
+# timeout' has expired, then upstart will destroy the process with SIGKILL.
+# SIGKILL is a way to cause data loss, so we try to disable this feature by
+# default.
+kill timeout 99999999
+
 {{#prestart}}
 pre-start script
   {{{ prestart }}}
@@ -60,7 +68,11 @@ end script
 {{/prestart}}
 
 script
+  # When loading default and sysconfig files, we use `set -a` to make
+  # all variables automatically into environment variables.
+  set -a
   [ -r {{{default_file}}} ] && . {{{default_file}}}
   [ -r {{{sysconfig_file}}} ] && . {{{sysconfig_file}}}
+  set +a
   exec {{{program}}} {{{shell_args}}}
 end script

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pleaserun
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.32
 platform: ruby
 authors:
 - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cabin
@@ -129,6 +129,7 @@ files:
 - lib/pleaserun/platform/sysv.rb
 - lib/pleaserun/platform/upstart.rb
 - lib/pleaserun/user/base.rb
+- lib/pleaserun/version.rb
 - pleaserun.gemspec
 - spec/pleaserun/cli_spec.rb
 - spec/pleaserun/configurable_spec.rb
@@ -180,10 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: pleaserun
 test_files: []
-has_rdoc: