erlnixify 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjRmMzY3YmU4NDA2MDMxZjgyMWQ3OWFlZTRiZmNmMDQwNDdiMjAzNQ==
+  data.tar.gz: !binary |-
+    NzgxZTQ3OWU5MGExNGZkM2U2ODY4ZGNmOWY2Yjk1OTJhZTJkNzlkNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjBiYzEyZDYyZjc2ZDY5ZGMwMGEwOTUwMzAyYTBjNTVmMTc1M2I1ZWEyZjhh
+    OTdmOTg5NzJmM2Q2NGE4MjJlNDlhYjFlN2UwNzBjOTgyOWE4NjQwZjBkZmZk
+    MTE3ZjE1YTJiZDk0NzJhN2IyYTIzM2UwNjY2YzBjMjdmY2U4MWI=
+  data.tar.gz: !binary |-
+    OTI3ZmNiMmQ1YmQ0NjYwYTU5NzI4ZjZkNDE4YjU4OTQyNDA4NDVkMDE5YTdi
+    MWE5NTMwMmJjOTgyOTQxZmE1NWE0MjFkZWE2ZThkZDNiMWU4ZTlkZGYxZDBi
+    OTYwOWUzODllMTk5YjEyZTQ1MWVlN2Q0ZWU5YTQ2ODA0NGM2MDg=

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+.yardoc
+.projmake
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CONTRIBUTING.md

@@ -0,0 +1,139 @@
+Contributing
+============
+
+Introduction
+------------
+
+This document describes the usages and rules to follow when contributing
+to this project.
+
+It uses the uppercase keywords SHOULD for optional but highly recommended
+conditions and MUST for required conditions.
+
+`git` is a distributed source code versioning system. This document refers
+to three different repositories hosting the source code of the project.
+`Your local copy` refers to the copy of the repository that you have on
+your computer. The remote repository `origin` refers to your fork of the
+project's repository that you can find in your GitHub account. The remote
+repository `upstream` refers to the official repository for this project.
+
+Reporting bugs
+--------------
+
+Upon identifying a bug you SHOULD submit a ticket, regardless of your
+plan for fixing it. If you plan to fix the bug, you SHOULD discuss your
+plans to avoid having your work rejected.
+
+Before implementing a new feature, you SHOULD submit a ticket for discussion
+on your plans. The feature might have been rejected already, or the
+implementation might already be decided.
+
+Cloning
+-------
+
+You MUST fork the project's repository to your GitHub account by clicking
+on the `Fork` button.
+
+Then, from your fork's page, copy the `Git Read-Only` URL to your clipboard.
+You MUST perform the following commands in the folder you choose, replacing
+`$URL` by the URL you just copied, `$UPSTREAM_URL` by the `Git Read-Only`
+project of the official repository, and `$PROJECT` by the name of this project.
+
+``` bash
+$ git clone "$URL"
+$ cd $PROJECT
+$ git remote add upstream $UPSTREAM_URL
+```
+
+Branching
+---------
+
+Before starting working on the code, you MUST update to `upstream`. The
+project is always evolving, and as such you SHOULD always strive to keep
+up to date when submitting patches to make sure they can be merged without
+conflicts.
+
+To update the current branch to `upstream`, you can use the following commands.
+
+``` bash
+$ git fetch upstream
+$ git rebase upstream/master
+```
+
+It may ask you to stash your changes, in which case you stash with:
+
+``` bash
+$ git stash
+```
+
+And put your changes back in with:
+
+``` bash
+$ git stash pop
+```
+
+You SHOULD use these commands both before working on your patch and before
+submitting the pull request. If conflicts arise it is your responsability
+to deal with them.
+
+You MUST create a new branch for your work. First make sure you have
+'fetched' `master`
+
+``` bash
+$ git checkout -b $BRANCH upstream/master
+```
+
+You MUST use a an insightful branch name.
+
+If you later need to switch back to an existing branch `$BRANCH`, you can use:
+
+``` bash
+$ git checkout $BRANCH
+```
+
+Source editing
+--------------
+
+The following rules MUST be followed:
+ *  Indentation uses 4 horizontal spaces
+ *  Tabs should not be used
+ *  Do NOT align code; only indentation is allowed
+
+
+The following rules SHOULD be followed:
+ *  Write small functions whenever possible
+ *  Avoid having too many clauses containing clauses containing clauses
+ *  Lines SHOULD NOT span more than 80 columns
+
+When in doubt indentation as performed in the Erlang Emacs Mode is
+correct.
+
+Committing
+----------
+
+You MUST ensure that all commits pass all tests and do not have extra
+Dialyzer warnings.
+
+You MUST put all the related work in a single commit. Fixing a bug is one
+commit, adding a feature is one commit, adding two features is two commits.
+
+You MUST write a proper commit title and message. The commit title MUST be
+at most 72 characters; it is the first line of the commit text. The second
+line of the commit text MUST be left blank. The third line and beyond is the
+commit message. You SHOULD write a commit message. If you do, you MUST make
+all lines smaller than 80 characters. You SHOULD explain what the commit
+does, what references you used and any other information that helps
+understanding your work.
+
+Submitting the pull request
+---------------------------
+
+You MUST push your branch `$BRANCH` to GitHub, using the following command:
+
+``` bash
+$ git push origin $BRANCH
+```
+
+You MUST then submit the pull request by using the GitHub interface to
+the `master` branch. You SHOULD provide an explanatory message and refer
+to any previous ticket related to this patch.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in erlnixify.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,194 @@
+Apache License
+==============
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+------------------------------------------------------------
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use,
+   reproduction, and distribution as defined by Sections 1 through 9
+   of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making
+   modifications, including but not limited to software source code,
+   documentation source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but not
+   limited to compiled object code, generated documentation, and
+   conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work (an
+   example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other
+   modifications represent, as a whole, an original work of
+   authorship. For the purposes of this License, Derivative Works
+   shall not include works that remain separable from, or merely link
+   (or bind by name) to the interfaces of, the Work and Derivative
+   Works thereof.
+
+   "Contribution" shall mean any work of authorship, including the
+   original version of the Work and any modifications or additions to
+   that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright
+   owner or by an individual or Legal Entity authorized to submit on
+   behalf of the copyright owner. For the purposes of this definition,
+   "submitted" means any form of electronic, verbal, or written
+   communication sent to the Licensor or its representatives,
+   including but not limited to communication on electronic mailing
+   lists, source code control systems, and issue tracking systems that
+   are managed by, or on behalf of, the Licensor for the purpose of
+   discussing and improving the Work, but excluding communication that
+   is conspicuously marked or otherwise designated in writing by the
+   copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal
+   Entity on behalf of whom a Contribution has been received by
+   Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have
+   made, use, offer to sell, sell, import, and otherwise transfer the
+   Work, where such license applies only to those patent claims
+   licensable by such Contributor that are necessarily infringed by
+   their Contribution(s) alone or by combination of their
+   Contribution(s) with the Work to which such Contribution(s) was
+   submitted. If You institute patent litigation against any entity
+   (including a cross-claim or counterclaim in a lawsuit) alleging
+   that the Work or a Contribution incorporated within the Work
+   constitutes direct or contributory patent infringement, then any
+   patent licenses granted to You under this License for that Work
+   shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work
+   or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You meet
+   the following conditions:
+
+  (a) You must give any other recipients of the Work or Derivative
+      Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works that
+      You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work, excluding
+      those notices that do not pertain to any part of the Derivative
+      Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one of
+      the following places: within a NOTICE text file distributed as
+      part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and do
+      not modify the License. You may add Your own attribution notices
+      within Derivative Works that You distribute, alongside or as an
+      addendum to the NOTICE text from the Work, provided that such
+      additional attribution notices cannot be construed as modifying
+      the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing
+   the origin of the Work and reproducing the content of the NOTICE
+   file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed
+   to in writing, Licensor provides the Work (and each Contributor
+   provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES
+   OR CONDITIONS OF ANY KIND, either express or implied, including,
+   without limitation, any warranties or conditions of TITLE,
+   NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
+   PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this
+   License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor has
+   been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer, and
+   charge a fee for, acceptance of support, warranty, indemnity, or
+   other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.

data/README.md

@@ -0,0 +1,226 @@
+Erlnixify
+=========
+
+Erlang has the problem that it does not integrate nicely with
+Unix-like systems. It can not be put under things like
+deamon-tools. You can't trap signals and respond appropriately,
+etc. This is a small ruby program that serves as a 'front' to an
+Erlang node. It allows a system like `init.d` or `daemontools` to
+manage Erlnixify and Erlnixify will in-turn manage the Erlang node
+using standard OTP inputs.
+
+For example, when Erlnixify recieves a SIGTERM signal, it will call
+`init:stop()` on the Erlang node. This allows Erlang's release handler
+to do an orderly shutdown of the Erlang Node.
+
+Erlnixify ensures that the Erlang node is up and running and checks
+every few seconds (a configurable value) to see if everything is
+continueing to run correctly. If those checks fail, Erlnixify will
+shut down the Erlang node and then shut itself down so that whatever
+is managing the system can restart.
+
+Erlnixify is designed to simply front the Erlang node. It does not
+provide restarts, log rotation, or anything like that. Those things
+are expected to be provided by the system (daemontools again).
+
+Erlnixify can be configured from the command line or via a config
+file. Command line configuration overrides config file
+configuration. That is, if a configuration value is provided both on
+the command line and in the config file, the value on the command line
+is the one that will be used.
+
+** Erlnixify is designed to manage releases. **
+** For self contained releases that do not have Erlang on the system,
+   you must include `erl_interface` **
+
+
+## Installation
+
+Erlnixify requires ruby 1.9. It does not work on 1.8, but may work on
+2.0+ though it has not been tested.
+
+Add this line to your application's Gemfile:
+
+    gem 'erlnixify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install erlnixify
+
+## Usage
+
+### SYNOPSIS
+
+`erlnixify` [<optional>...] <flags>
+
+### EXAMPLE
+
+The following example shows how to run a bare non-otp erlang
+module. This is *not* the recommended way to do this at all. You
+should be using Erlang releases, however it does work and it does
+illustrate the point.
+
+    erlnixify --name example \
+              --cookie fubachu \
+              --command "erl -setcookie %{cookie} -name %{fullname} -noshell -s my_module start"
+
+The above is enough to get things going with the default
+values. Running a release might be a bit more complicated. Its more
+complicated because you are going to want to provide a custom check
+commands and perhaps custom check intervals.
+
+    erlnixify --name example2 \
+              --cookiefile /etc/example2/mycookiefile \
+              --release /opt/example2 \
+              --command '/opt/example2/bin/example2 -setcookie %{cookie} -name=%{fullname} +Ktrue +B -noinput -shutdown_time 5000 +W w' \
+              --check "example2 check_status" \
+              --checkregex '^ok$' \
+              --checkinterval 100
+
+The above assumes we have a viable OTP Release in the /opt/example2
+directory. We have placed our cookie in a file in
+/etc/example2/mycookiefile and we have a script to start our release
+that lives in the bin directory of the release. We have provided a
+module `example2` with a function `check_status` that takes no
+arguments to check the status of the system. If it returns an `ok`
+everything is good. We are also going to run that check command every
+100 seconds.
+
+
+We could, of course, have put all the above in a config file as well.
+
+    name: example2
+    cookiefile: /etc/example2/mycookiefile
+    release: /opt/example2
+    command: /opt/example2/bin/example2 -setcookie %{cookie} -name=%{fullname} +Ktrue +B -noinput -shutdown_time 5000 +W w
+    check: example2 check_status
+    checkregex: ^ok$
+    checkinterval: 100
+
+Then our Erlnixify could have been much simpler. Assuming our config
+file was at `/etc/example2/erlnixify-config.yaml` or Erlnixify command
+line could have been.
+
+    erlnixify --configfile /etc/example2/erlnixify-config
+
+
+
+### Options
+
+* `-b`, `--release`=<release-root>
+
+   The root directory of the Release that Erlnixify is
+   managing. Erlnixify expects to always be managing a release. This
+   is optional if the `erlang` option is provided.
+
+* `-b`, `--erlang`=<erlang-root>
+
+   The erlang root directory for the system. This only needs to be
+   used if both the `release` option is not specified and the erlang
+   install is in a strange place.
+
+* `-o`, `--home`=<home-dir>
+
+   The home directory that should be set for the running system. This
+   is set by default to the `HOME` directory of the user running
+   erlnixify. However, in instances where that should be different or
+   the user has no `HOME` directory, this option can be provided.
+
+* `-n`, `--name`=<short node name>
+
+   The short node name for this system. This is not
+   optional. Erlnixify uses distributed erlang to manage and control
+   the Erlang system.
+
+* `--fullnode`=<full node name>
+
+  When only `name` is provided, Erlnixify takes the host name of the
+  system as provided by `hostname -f` and concatinates it with the
+  value provided in `name` to come up with a fully qualified host
+  name. The user can use this to override that full name.
+
+* `-m`, `--command`=<node start command>
+
+  This is the command that should be used to start the node. This command may contain variables that will be filled out by the Erlnixify system. Those variables are any one of the following.
+
+  * `release` - as described adove
+  * `erlang` - as described above
+  * `home` - as described above
+  * `name` - as described above
+  * `fullname` - The full name of the Erlang node, either as provided
+    or as discovered by Erlnixify. This value will always be populated
+  * `cookie` - The cookie provided. This value will always be populated
+  * `startuptimeout` - as described belov
+  * `checkinterval` - as described below
+  * `checktimeout` - as described below
+
+* `-k`, `check`=< the command used to check the status of the system>
+
+ This is an erlang module/function call in
+ [erl_call](http://www.erlang.org/doc/man/erl_call.html) format. The
+ default value for this command is `erlang statistics
+ [reductions]`. However, that is not tremendously useful and you
+ really should provide your own.
+
+ * `-r`, `--checkregex`=<regular expression>
+
+  This is a regular expression that is used to check the output of the
+  above mentioned check command. If this regular expression does not
+  match the output of the check command then the command is expected
+  to have failed and the node will be shut down. By default this value
+  is `^{\\d+, \\d+}$`. This matches the default `check` command. If
+  you change the `check` command (and you should) you must change this
+  value to match your expected output otherwise the system will always
+  fail on the first check.
+
+* `-x`, `--cookiefile`=<path to file that contains the cookie>
+
+  If the `cookie` option is set this option is not needed. This should
+  point to a file that contains the cookie that the system should
+  use. That file must contain only the cookie. Be careful that you do
+  not include a trailing newline.
+
+* `-i`, `--cookie`=<cookie value>
+
+  The actual value that Erlnixify should use as a cookie. This isn't
+  needed if the `cookiefile` option is provided.
+
+* `-t`, `--startuptimeout`=<seconds that the node has to startup>
+
+  This is the number of seconds that the node has to startup. If the
+  node is not running in that amount of time Erlnixify will shut it
+  down and exit. The default value is 60.
+
+* `-a`, `--checkinterval`=<seconds between each check>
+
+  The number of seconds between each check. The default value is 30.
+
+
+* `-w`, `--checktimeout`=<seconds that the check command is allowed to run>
+
+  This is the number of seconds that the check command is allowed to
+  run. If the check command takes longer then this number of seconds
+  then Erlnixify will kill the Erlang node and exit.
+
+* `-c`, `--config`=<path to config file>
+
+  The path to a [YAML](http://yaml.org) based config file. The keys
+  are the same as described here for the long version of the
+  options. A config file is optional if the command line options are
+  set instead.
+
+* `-v`, `--version`
+
+  Print out the version of Erlnixify
+
+* `-h`, `--help`
+
+ Print out the help for erlnixify
+
+## Contributing
+
+See [Contributing](https://github.com/erlware/erlnixify/blob/master/CONTRIBUTING.md)<

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require "reek/rake/task"
+require 'cucumber'
+require 'cucumber/rake/task'
+
+task :default => :quality
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.reek_opts = "-c ./reek.yml"
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :console do
+  exec 'irb -I lib -r startingscript.rb'
+end
+
+task :quality => [:reek, :features] do
+end

data/erlnixify.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'erlnixify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "erlnixify"
+  spec.version       = Erlnixify::VERSION
+  spec.authors       = ["Eric Merritt"]
+  spec.email         = ["ericbmerritt@gmail.com"]
+  spec.description   = %q{Erlnixify's purpose is to rectify a problem in Erlang. At the moment
+ the Erlang VM has the problem that it can not react to unix
+signals. This renders it impossible to integrate Erlang into a basic
+unix environment like init.d or daemontools. This ruby project is
+designed to fill that void. It provides a small unix executable whose
+responsibility it is to capture normal unix signals and translate them
+into something that the erlang vm can understand.
+}
+  spec.summary       = %q{An executable to help integrate Erlang Releases with unix sytems}
+  spec.homepage      = ""
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "reek"
+  spec.add_development_dependency "cane"
+  spec.add_development_dependency "cucumber", "~> 1.3.1"
+
+  spec.add_dependency "slop", "~> 3.4.4"
+end