foreman-export-allah 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25b411f33ed0f03af45c5792d83455a958257f3a
+  data.tar.gz: d60efe333d9e610f45dd8fe592f1463b93ea7fc3
+SHA512:
+  metadata.gz: 235c50bad12d7c16a0b120bda86968bdaac47502e102b75a5063c7302f5ee61314cca376a961a15f761d3d0cfe54b2981ef628b8787f5994b1e64eac525574b4
+  data.tar.gz: 298c23490a1c5527b13c2e272a105b18b1ba455e5bf0e634d98d33cf43f46525a6be49e491a9762dfe147b5c0038c04aad3040dd6d47c5578ce73db8ab230c0a

data/.gitignore

@@ -0,0 +1,4 @@
+/Gemfile.lock
+/pkg
+/tmp
+/.yardoc

data/History.rdoc

@@ -0,0 +1,9 @@
+== v0.1.0 [2013-01-01] Michael Granger <ged@FaerieMUD.org>
+
+Updated for newer versions of Foreman.
+
+
+== v0.0.1 [2012-04-27] Michael Granger <ged@FaerieMUD.org>
+
+Initial release.
+

data/README.md

@@ -0,0 +1,66 @@
+An exporter for David Dollar's [Foreman](https://github.com/ddollar/foreman)
+that outputs service directories that can be managed by a per-user `svscan`,
+with additional configuration which makes it
+[allah](https://github.com/mpalmer/allah)-compatible.
+
+
+# Prerequisites
+
+* Ruby 2.0.0 or later
+* Foreman
+
+
+# Installation
+
+    $ gem install foreman-export-allah
+
+
+# Usage
+
+To export your Procfile to a `~/service` directory:
+
+    $ foreman export allah ~/service
+
+This will create a `~/service/<app>-<proc>` directory for each `Procfile`
+process. If you have the concurrency set to something > 1 for any of them it
+will create an individual numbered service directory for each one in the
+format: `~/service/<app>-<proc>-<num>`.
+
+Each directory will be generated with a `down` file, which will prevent
+supervise from automatically starting it before you have a chance to look it over.
+After you confirm that everything looks okay, you can start them up just by
+removing `down` on each service, or running `allah start <app>`.
+
+
+# License
+
+Copyright (c) 2012, Michael Granger
+Copyright (c) 2015, Matt Palmer
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+

data/data/foreman-export-allah/templates/log-run.erb

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+<% if self.log %>
+% logdir = Pathname(self.log) + '/' + procdir.basename
+exec multilog t <%= logdir %>
+<% else %>
+exec multilog t ./main
+<% end %>

data/data/foreman-export-allah/templates/run.erb

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+exec 2>&1
+exec envdir ./env <%= process.command %>
+

data/foreman-export-allah.gemspec

@@ -0,0 +1,33 @@
+require 'git-version-bump' rescue nil
+
+Gem::Specification.new do |s|
+	s.name = "foreman-export-allah"
+
+	s.version = GVB.version rescue "0.0.0.1.NOGVB"
+	s.date    = GVB.date    rescue Time.now.strftime("%Y-%m-%d")
+
+	s.platform = Gem::Platform::RUBY
+
+	s.summary  = "Export a Foreman Procfile to allah services"
+
+	s.authors  = ["Matt Palmer"]
+	s.email    = ["theshed+foreman-export-allah@hezmatt.org"]
+	s.homepage = "http://theshed.hezmatt.org/foreman-export-allah"
+
+	s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }
+
+	s.required_ruby_version = ">= 2.0.0"
+
+	s.add_runtime_dependency "foreman", "~> 0.60"
+
+	s.add_development_dependency 'bundler'
+	s.add_development_dependency 'github-release'
+	s.add_development_dependency 'guard-spork'
+	s.add_development_dependency 'guard-rspec'
+	s.add_development_dependency 'pry-byebug'
+	s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
+	# Needed for guard
+	s.add_development_dependency 'rb-inotify', '~> 0.9'
+	s.add_development_dependency 'rspec', "~> 3.0"
+	s.add_development_dependency 'yard'
+end

data/lib/foreman/export/allah.rb

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+# vim: set nosta noet ts=4 sw=4:
+#encoding: utf-8
+
+require 'erb'
+require 'logger'
+require 'pathname'
+require 'foreman/export'
+require 'foreman/cli'
+
+
+# A Foreman exporter for allah-enhanced daemontools. This exports processes
+# from the Procfile as a hierarchy of directories intended to be run under
+# the supervision of a per-user svscan.
+#
+# This code is based on `foreman-export-daemontools`, which in turn borrowed
+# some of its code from the 'runit' exporter.
+#
+class Foreman::Export::Allah < Foreman::Export::Base
+	# The data directory in the project if that exists, otherwise the gem datadir
+	DEFAULT_DATADIR = if ENV['FOREMAN_EXPORT_DATADIR']
+			Pathname( ENV['FOREMAN_EXPORT_DATADIR'] )
+		elsif File.directory?( 'data/foreman-export-allah' )
+			Pathname( 'data/foreman-export-allah' )
+		elsif path = Gem.datadir( 'foreman-export-allah' )
+			Pathname( path )
+		else
+			raise ScriptError, "can't find the data directory!"
+		end
+
+	# Directory to look in for personal templates
+	HOME_TEMPLATEDIR = Pathname( "~/.foreman/templates" ).expand_path
+
+	# Pattern used to extract inline env variables from the command
+	ENV_VARIABLE_REGEX = /([a-zA-Z_]+[a-zA-Z0-9_]*)=(\S+)/
+
+
+	##
+	# The data directory for the gem
+	class << self; attr_accessor :datadir; end
+	@datadir = DEFAULT_DATADIR
+
+
+	### Set up the template root
+	def initialize( location, engine, options={} ) # :notnew:
+		super
+		servicedir = self.location or
+			raise Foreman::Export::Exception, "No service directory specified."
+		@servicedir = Pathname( servicedir )
+		@logger = Logger.new( $stderr )
+		@template_search_path = [ HOME_TEMPLATEDIR, DEFAULT_DATADIR + 'templates' ]
+		@template_search_path.unshift( Pathname(options[:template]) ) if options.key?( :template )
+	end
+
+
+	######
+	public
+	######
+
+	##
+	# The list of directories to search in for templates
+	attr_accessor :template_search_path
+
+	##
+	# The Logger object that gets exporter output
+	attr_accessor :logger
+
+
+	### Main API method -- export the loaded Procfile as supervise service directories
+	def export
+		app        = self.app || File.basename( self.engine.directory )
+		user       = self.user || app
+
+		unless @servicedir.exist?
+			say "Creating #{@servicedir}..."
+			@servicedir.mkpath
+		end
+
+	    engine.each_process do |name, process|
+			say "Setting up %s-%s service directories..." % [ app, name ]
+			count   = engine.formation[ name ]
+			say "  concurrency = #{count}"
+			next unless count >= 1
+
+			# Create a numbered service dir for each instance if there are
+			# more than one
+			if count != 1
+				1.upto( count ) do |i|
+					self.write_servicedir( app, name, i, process, true )
+				end
+			else
+				self.write_servicedir( app, name, 1, process )
+			end
+		end
+	end
+
+
+	### Write a supervise directory to +targetdir+
+	def write_servicedir( app, name, num, process, multi = false  )
+		procdir = @servicedir + "#{app}-#{name}#{multi ? "-#{num}" : ''}"
+
+		say "Making directory %s..." % [ procdir ]
+		procdir.mkpath
+
+		# Write the down file to keep the service from spinning up before the user has
+		# a chance to look things over
+		say "  writing the 'down' file"
+		write_file( procdir + 'down', '' )
+
+		# Set up logging
+		say "  setting up logging..."
+		logdir = procdir + 'log'
+		logdir.mkpath
+		logruntmpl = self.load_template( 'log-run' )
+		runfile = logdir + 'run'
+		write_file( runfile, logruntmpl.result(binding()) )
+		runfile.chmod( 0755 )
+
+		# Set up the envdir
+		say "  setting up environment variables..."
+		envdir = procdir + 'env'
+		envdir.mkpath
+        port = engine.port_for( process, num )
+		environment_variables = { 'PORT' => port }.
+			merge( engine.environment ).
+			merge( inline_variables(process.command) )
+		environment_variables.each_pair do |var, env|
+			write_file( envdir + var, env )
+		end
+
+		# Set up the groupfile
+		groupfile = procdir + 'group'
+		write_file(groupfile, "#{app}-#{name}\n#{app}\n")
+
+		# Set up the runfile
+		runtmpl = self.load_template( 'run' )
+		runfile = procdir + 'run'
+		write_file( runfile, runtmpl.result(binding()) )
+		runfile.chmod( 0755 )
+
+	end
+
+
+	### Load the template for the file named +name+, and return it
+	### as an ERB object.
+	def load_template( name )
+		template_name = "#{name}.erb"
+		template = self.template_search_path.
+			map {|dir| dir + template_name }.
+			find {|tmpl| tmpl.exist? }
+
+		template or raise Foreman::Export::Exception,
+			"Can't find the %p template in any of: %p" %
+			[ name, self.template_search_path.map(&:to_s) ]
+
+		erbtmpl = ERB.new( template.read, nil, '<%>' )
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Override to output to the logger instead of STDERR.
+	def say( message )
+		@logger.info( '[foreman export]' ) { message }
+	end
+
+
+	#######
+	private
+	#######
+
+	### Extract the inline environment variables from +command+ and return them as
+	### a Hash.
+	def inline_variables( command )
+		pairs = command.scan( ENV_VARIABLE_REGEX )
+		return Hash[ *pairs.flatten ]
+	end
+
+
+end # Foreman::Export::Daemontools

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: foreman-export-allah
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Palmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foreman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- theshed+foreman-export-allah@hezmatt.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- History.rdoc
+- README.md
+- data/foreman-export-allah/templates/log-run.erb
+- data/foreman-export-allah/templates/run.erb
+- foreman-export-allah.gemspec
+- lib/foreman/export/allah.rb
+homepage: http://theshed.hezmatt.org/foreman-export-allah
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Export a Foreman Procfile to allah services
+test_files: []
+has_rdoc: