promotion 1.1.0 → 1.2.0

data/CHANGELOG

@@ -1,10 +1,14 @@
-Version 1.1.0::
-    Added dependency on log4r. Fixed several broken dependencies caused
-    by converting to a gem.
+== Version 1.2.0
+- Make Promotion a better gem citizen by making the installation of executables
+  an explicit command, as shown in the post-installation message. 
 
-Version 1.0.9::
-    Minor documentation fixes.
+=== Version 1.1.0
+- Added dependency on log4r. 
+- Fixed several broken dependencies caused by converting to a gem.
 
-Version 1.0.8::
-    Added extension to install executables: promote, evolve, devolve.
-    Added mkdeploy executable to create a template deployment descriptor.
+=== Version 1.0.9
+- Minor documentation fixes.
+
+=== Version 1.0.8
+- Added extension to install executables: promote, evolve, devolve.
+- Added mkdeploy executable to create a template deployment descriptor.

data/README

@@ -49,7 +49,10 @@ files that need to be adjusted to enable an application to startup or run proper
 - /var/cron/tabs/*
 
 Promotion generates these files based on the set of all of the deployment descriptors it finds
-in the staging area.
+in the staging area. It will preserve the original contents of the file, and append generated
+contents after the following special demarcation line:
+  #---promotion---
+This respects the need for an administrator to add custom contents (above the line).
 
 An important aspect is that a deployment is *idempotent* - you can do it as many
 times as you like and the result will be the same. This means its safe to make a
@@ -68,8 +71,17 @@ to suit your system's paths.
 
  DO NOT USE ON A PRODUCTION SYSTEM without rigorous testing in a virtual machine first.
 
-Installing promotion automatically creates the /var/staging directory
+Install the promotion gem, which displays a post-installation message:
+
   $ sudo gem install promotion
+
+To install the executables issue the following command:
+
+  $ sudo ruby -rubygems -e "require 'promotion/install'"
+
+This will install the executables (+promote+, +evolve+, +devolve+, +mkdeploy+) and
+create the staging area +/var/staging+.
+
 Now you are ready to use Promotion to deploy other applications.
 
 == Usage
@@ -173,7 +185,7 @@ override the default Mode, Owner, and Group.
 === +Files+
 Finally we can specify how to move the files into place:
   <Files Owner="root" Group="wheel" Mode="0644" Source="conf">
-    <File>/etc/my.cnf</File>
+    <File Backup="true">/etc/my.cnf</File>
     <File>/etc/myapp.conf</File>
   </Files>
   <Files Owner="root" Group="wheel" Mode="0750" Source="sbin">
@@ -192,6 +204,10 @@ This results in Promotion executing a command such as:
 This allows a flatter, more convenient project folder structure, since the deployment descriptor maps
 the files into their proper operating system locations.
 
+Note that the file +my.cnf+ has an extra *Backup* attribute. This makes a backup of the original file
+to +my.cnf-original+ once only. This is a good idea for important original configuration files
+such as snort.conf or httpd.conf. They often have hundreds of comments that are useful for reference.
+
 As for Folders, the Files element can define the default Owner, Group and Mode for all File children.
 
 === +Allfiles+

data/lib/promotion/erb/profile.erb

@@ -6,7 +6,7 @@
 	spec.elements.each("/Specification/Environment") do |env|
 	env.elements.each("Variable") do |var|
 	t = var.cdatas.length > 0 ? var.cdatas[0].to_s() : var.text() %>
-export <%= var.attributes["Name"] %>="<%= t.strip() %>"<% end %>
+export <%= var.attributes["Name"] %>="<%= t %>"<% end %>
 <% env.elements.each("Alias") do |ali|
 	t = ali.cdatas.length > 0 ? ali.cdatas[0].to_s() : ali.text()
 %><% if ali.attributes["Comment"] %><%= "\n# "+ali.attributes["Comment"]

data/lib/promotion/install.rb

@@ -0,0 +1,65 @@
+require 'fileutils'
+
+#______________________
+if Process.euid != 0
+  puts("This script must be run as root")
+  exit 1
+end
+
+#______________________
+# Enable graceful exit especially while seeking input
+["INT", "TERM", "QUIT"].each { |sig|
+  Signal.trap(sig) {
+    puts("")
+    exit(0)
+  }
+}
+
+#______________________
+# display intent
+bindir = File.expand_path("../../bin", File.dirname(__FILE__))
+executables = %w{promote evolve devolve mkdeploy}
+
+puts("Installing Promotion")
+puts("--------------------")
+puts("This procedure will install the following executables:")
+executables.each { |exe|
+  puts(" * #{exe}")
+}
+
+#______________________
+# confirm path to install to
+sbindir = "/usr/local/sbin"
+confirmed = false
+begin
+  print("Install to path [#{sbindir}]: ")
+  answer = gets().chomp()
+  if answer == ""
+    confirmed = true
+  else
+    if File.directory?(answer)
+      confirmed = true
+      sbindir = answer
+    else
+      puts("  Sorry, the directory #{answer} was not found.\n\n")
+    end
+  end
+end until confirmed
+
+#______________________
+# install the executables
+executables.each { |exe|
+  targ = "#{sbindir}/#{exe}"
+  FileUtils.cp("#{bindir}/#{exe}", targ)
+  FileUtils.chown("root", "wheel", targ)
+  FileUtils.chmod(0755, targ)
+  puts(" " + `ls -l #{targ}`)
+}
+
+#______________________
+# create staging area
+staging = "/var/staging"
+puts("Creating staging area /var/staging")
+FileUtils.mkdir_p(staging)
+puts(" " + `ls -ld #{staging}`)
+puts("Done.")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: promotion
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Richard Kernahan
@@ -49,8 +49,8 @@ description: "\t\tThe Promotion tool is designed to make it easy and quick to de
 email: dev.promotion@finalstep.com.au
 executables: []
 
-extensions: 
-- ext/promotion/extconf.rb
+extensions: []
+
 extra_rdoc_files: 
 - README
 files: 
@@ -58,8 +58,8 @@ files:
 - bin/evolve
 - bin/devolve
 - bin/mkdeploy
-- ext/promotion/extconf.rb
 - lib/promotion.rb
+- lib/promotion/install.rb
 - lib/promotion/application.rb
 - lib/promotion/config.rb
 - lib/promotion/enforcer.rb
@@ -70,14 +70,16 @@ files:
 - lib/promotion/erb/rc.conf.local.erb
 - lib/promotion/erb/sudoers.erb
 - .yardopts
-- deploy.xml
 - promotion.xsd
 - CHANGELOG
 - README
 homepage: http://rubygems.org/gems/promotion
 licenses: []
 
-post_install_message: "\n  Executables have been installed in /usr/local/sbin:\n    promote\n    evolve\n    devolve\n    mkdeploy\n  These are not automatically removed by uninstalling the gem.\n  "
+post_install_message: "\n\
+  \t\n  To install the executables (promote, evolve, devolve, mkdeploy)\n  issue the following command:\n\
+  \t$ sudo ruby -rubygems -e \"require 'promotion/install'\"\n\
+  \t\n  "
 rdoc_options: 
 - --title
 - Promotion

data/deploy.xml

@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<Specification Name="promotion" Title="Promotion Manager"
-	xmlns="http://finalstep.com.au/promotion/v100"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://finalstep.com.au/schema/promotion.v100.xsd ../promotion/promotion.xsd">
-	<Description>
-		The promotion manager ensures that the environment for an application
-		is set up correctly, including folder and file permissions and ownership,
-		startup scripts, sudoers privileges and environment variables.
-	</Description>
-	<Folders>
-		<Folder Mode="0770">/var/staging</Folder>
-		<Folder Mode="0770">/var/staging/promotion</Folder>
-		<Folder Clear="true">/usr/local/promotion</Folder>
-		<Folder>/usr/local/promotion/erb</Folder>
-	</Folders>
-	<Files Source="bin" Mode="0755">
-		<File>/usr/local/sbin/promote</File>
-		<File>/usr/local/sbin/evolve</File>
-		<File>/usr/local/sbin/devolve</File>
-	</Files>
-	<Files Source="lib/promotion">
-		<File>/usr/local/promotion/application.rb</File>
-		<File>/usr/local/promotion/config.rb</File>
-		<File>/usr/local/promotion/enforcer.rb</File>
-		<File>/usr/local/promotion/generator.rb</File>
-		<File>/usr/local/promotion/evolver.rb</File>
-	</Files>
-	<Files Source="lib/promotion/erb">
-		<File>/usr/local/promotion/erb/profile.erb</File>
-		<File>/usr/local/promotion/erb/rc.conf.local.erb</File>
-		<File>/usr/local/promotion/erb/sudoers.erb</File>
-		<File>/usr/local/promotion/erb/crontab.erb</File>
-	</Files>
-</Specification>

data/ext/promotion/extconf.rb

@@ -1,25 +0,0 @@
-#!/usr/local/bin/ruby
-# Working directory is the ext/promotion/ folder
-
-# generate Makefile to install binaries
-# Its a sysadmin tool after all, so we'll pretend not to see Eric Hodel
-# frowning on the (ab)use of extconf.rb
-source = "../../bin"
-target = "/usr/local"
-makeContents=<<-EOT
-# Makefile for Promotion
-.PHONY : all
-all :
-.PHONY : install
-install :
-	install -m 0750 -o root -g wheel #{source}/promote #{target}/sbin
-	install -m 0750 -o root -g wheel #{source}/evolve  #{target}/sbin
-	install -m 0750 -o root -g wheel #{source}/devolve #{target}/sbin
-	install -m 0750 -o root -g wheel #{source}/mkdeploy #{target}/sbin
-	install -m 0750 -o root -g wheel -d /var/staging
-EOT
-makefile = File.new("Makefile", "w")
-makefile.puts(makeContents)
-makefile.close()
-# Note that there is no provision for uninstalling these binaries
-# If the gem is uninstalled, the binaries need to be deleted manually