promotion 1.0.7

data/lib/promotion/generator.rb

@@ -0,0 +1,207 @@
+require 'erb'
+require 'rexml/document'
+require 'fileutils'
+
+module Promotion	# :nodoc:
+
+# Generator generates the system-wide files that can only be assembled by taking into
+# account all of the applications that are deployed (ie. found in the staging area).
+#
+# Such files as /etc/profile, /etc/sudoers, and crontabs might receive contributions
+# from a several apps. For example, /etc/profile might need to set an environment variable
+# like JAVA_HOME and MYAPP_BASE.
+class Generator
+
+	# Returns the XML specification for the selected application
+	attr_accessor :specs
+
+	# Creates a new Generator.
+	#
+	# Note that if any generated file contains a line starting with the +marker+
+	# (eg. "#---promotion---"), we preserve the contents up to that point, and replace
+	# the contents from that point onwards.
+	def initialize()
+		@specs = []
+		@marker = "#---promotion---"	# add this marker to a config file to preserve the contents before it
+	end
+
+	# Gathers the specs for all applications in the staging area, then generate:
+	# - /etc/profile
+	# - /etc/rc.conf.local
+	# - /etc/sudoers
+	# - /var/cron/tabs/*
+	def start()
+		$log.info("\n#{'_'*40}\nGenerating common environment files")
+		gather_specs()
+		generate_standard("Profile")
+		generate_standard("Rc_conf")
+		generate_sudoers()
+		generate_crontab()
+	end
+
+	# Gathers specs from all deployment descriptors in folders with the staging area
+	def gather_specs()
+		begin
+			search = Folders::Staging + "/*/" + Files::Spec
+			$log.debug("Searching for application specs with Dir[#{search}]")
+			specfiles = Dir[search]
+			specfiles.each { |filename|
+				specfile = File.new(filename, File::RDONLY)
+				doc = REXML::Document.new(specfile)
+				@specs << doc.root
+				specfile.close()
+			}
+			return(specs)
+		rescue => e
+			$log.error("Error while gathering application specs\n#{e.message}" + e.backtrace.join("\n"))
+			exit 1
+		end
+	end
+
+	# Convenience method to create an ERB generator based on the template corresponding
+	# to a name. For example, if +sym+ is "Profile", we use the filename Templates::Profile
+	# as the template.
+	#
+	# Returns the ERB generator
+	def generator_for(sym)
+		begin
+			templateFilename = File.expand_path(Templates.const_get(sym), Folders::Templates)
+			raise "Missing template for #{sym}" unless File.exists?(templateFilename)
+			$log.debug("Generating with template #{templateFilename}")
+			templateFile = File.new(templateFilename, File::RDONLY)
+			template = templateFile.read
+		ensure
+			templateFile.close() unless templateFile.nil? || templateFile.closed?
+		end
+		generator = ERB.new(template, nil, '<>')
+		return(generator)
+	end
+
+	# Convenience method to generate content for a system file, preserving the content
+	# up to the +marker+, and appending the generated content.
+	#
+	# Returns a string of the new content for the file
+	def contents_for(sym, generator, definedBinding)
+		generatedContents = generator.result(definedBinding)
+		begin
+			originalContents = IO.readlines(Files.const_get(sym),"")[0].split(@marker)[0]
+		rescue
+			originalContents = ""
+		end
+		newContents = [originalContents, @marker, generatedContents].join("\n")
+		return(newContents)
+	end
+
+	# Sometimes we need to run a process on the new content in a temporary file
+	# instead of writing the content directly to a new file (eg. visudo)
+	def write_temp_file_for(sym, newContents)
+		begin
+			tempFilename = Files.const_get(sym)+".tmp"
+			tempFile = File.new(tempFilename, File::WRONLY | File::CREAT | File::TRUNC)
+			tempFile.puts(newContents)
+		ensure
+			tempFile.close unless tempFile.nil? || tempFile.closed?
+		end
+		return(tempFilename)
+	end
+
+	# Write the approved contents to the system file
+	def write_file_for(sym, newContents)
+		begin
+			generatedFilename = Files.const_get(sym)
+			generatedFile = File.new(generatedFilename, File::WRONLY | File::CREAT | File::TRUNC)
+			generatedFile.puts(newContents)
+			$log.info("Generated #{sym} written to #{generatedFilename}.")
+		ensure
+			generatedFile.close unless generatedFile.nil? || generatedFile.closed?
+		end
+	end
+
+	# Convenience method for standard configuration files:
+	# - creates a generator using the relevant template
+	# - generate the new contents
+	# - write the contents to the system file
+	# This is useful when the system file can be written directly without an intermediate
+	# checking step (such as visudo).
+	def generate_standard(sym)
+		begin
+			generator = generator_for(sym)
+			newContents = contents_for(sym, generator, binding)
+			write_file_for(sym, newContents)
+		rescue => e
+			$log.error("Error occurred while generating #{sym}\n#{e.message}" + e.backtrace.join("\n"))
+			exit 1
+		end
+	end
+
+	# The sudoers file must be verified by the visudo command
+	def generate_sudoers()
+		begin
+			generator = generator_for("Sudoers")
+			newContents = contents_for("Sudoers", generator, binding)
+			tempFilename = write_temp_file_for("Sudoers", newContents)
+			$log.info("Checking temporary sudoers written to #{tempFilename}.")
+			visudoResults = `#{Files::Visudo} -c -f #{tempFilename}`
+			if visudoResults =~ /parsed OK/
+				$log.info("visudo confirms that sudoers syntax is correct.")
+			else
+				$log.error(visudoResults)
+				raise
+			end
+			write_file_for("Sudoers", newContents)
+			FileUtils.rm_f(tempFilename)
+			$log.info("New sudoers written to #{Files::Sudoers}")
+		rescue => e
+			$log.error("Error occurred while generating sudoers\n#{e.message}" + e.backtrace.join("\n"))
+			exit 1
+		end
+	end
+
+	# The crontab for each user must be deployed using the crontab tool so this
+	# method cannot use the convenience methods because the filenames are user-specific
+	def generate_crontab()
+		begin
+			schedules = {}  # keyed on user, value is array of schedule elements
+			@specs.each { |spec|
+				spec.elements.each("/Specification/Crontab/Schedule") { |sched|
+					user = sched.attributes["User"]
+					schedules[user] = [] unless schedules.has_key?(user)
+					schedules[user] << sched
+				}
+			}
+			generator = generator_for("Crontab")
+			schedules.each { |user, crontablist|
+				generatedContents = generator.result(binding)
+				userCrontab = File.expand_path(user, Folders::Crontabs)
+				begin
+					originalContents = IO.readlines(userCrontab,"")[0].split(@marker)[0]
+				rescue
+					originalContents = ""
+				end
+				newContents = [originalContents, @marker, generatedContents].join("\n")
+				begin
+					tempFilename = user + ".tmp"
+					tempFile = File.new(tempFilename, File::WRONLY | File::CREAT | File::TRUNC)
+					tempFile.puts(newContents)
+				ensure
+					tempFile.close unless tempFile.nil? || tempFile.closed?
+				end
+				$log.info("Checking temporary crontab written to #{tempFilename}.")
+				crontabResults = `#{Files::Crontab} -u #{user} #{tempFilename}`
+				if crontabResults == ""
+					$log.info("crontab confirms that crontab syntax is correct for user #{user}.")
+				else
+					$log.error(crontabResults)
+					raise
+				end
+				FileUtils.rm_f(tempFilename)
+				$log.info("New crontab installed for user #{user}")
+			}
+		rescue => e
+			$log.error("Error occurred while generating crontab\n#{e.message}" + e.backtrace.join("\n"))
+			exit 1
+		end
+	end
+
+end
+end

data/lib/promotion.rb

@@ -0,0 +1,8 @@
+# Promotion Module includes:
+# - Promotion::Application
+# - Promotion::Enforcer
+# - Promotion::Generator
+# - Promotion::Evolver
+# and the configuration modules found in promotion/config.rb
+module Promotion
+end

data/promotion.xsd

@@ -0,0 +1,323 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<xsd:schema targetNamespace="http://finalstep.com.au/promotion/v100"
+	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns="http://finalstep.com.au/promotion/v100">
+
+	<xsd:element name="Specification">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="Description" />
+				<xsd:element ref="Groups" minOccurs="0" maxOccurs="1" />
+				<xsd:element ref="Users" minOccurs="0" maxOccurs="1" />
+				<xsd:element ref="Folders" minOccurs="0" maxOccurs="unbounded" />
+				<xsd:element ref="Files" minOccurs="0" maxOccurs="unbounded" />
+				<xsd:element ref="Allfiles" minOccurs="0" maxOccurs="unbounded" />
+				<xsd:element ref="Zipfile" minOccurs="0" maxOccurs="unbounded" />
+				<xsd:element ref="Sudoers" minOccurs="0" maxOccurs="1" />
+				<xsd:element ref="Daemon" minOccurs="0" maxOccurs="1" />
+				<xsd:element ref="Environment" minOccurs="0" maxOccurs="1" />
+				<xsd:element ref="Crontab" minOccurs="0" maxOccurs="1" />
+				<xsd:element ref="Database" minOccurs="0" maxOccurs="1" />
+			</xsd:sequence>
+			<xsd:attribute name="Name" type="xsd:NMTOKEN" use="required" />
+			<xsd:attribute name="Title" type="xsd:string" use="required" />
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Description">
+		<xsd:complexType mixed="true" />
+	</xsd:element>
+
+	<xsd:element name="Groups">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="Group" minOccurs="1" maxOccurs="unbounded" />
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Group">
+		<xsd:complexType>
+			<xsd:attribute name="Name" type="xsd:NMTOKEN" use="required" />
+			<xsd:attribute name="Gid" type="xsd:integer" use="required" />
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Users">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="User" minOccurs="1" maxOccurs="unbounded" />
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="User">
+		<xsd:complexType>
+			<xsd:attribute name="Uid" type="xsd:integer" use="required" />
+			<xsd:attribute name="Name" type="xsd:NMTOKEN" use="required" />
+			<xsd:attribute name="Gid" type="xsd:integer" use="required" />
+			<xsd:attribute name="Class" type="xsd:NMTOKEN" use="required" />
+			<xsd:attribute name="Home" type="xsd:string" use="required" />
+			<xsd:attribute name="Gecos" type="xsd:string" use="required" />
+			<xsd:attribute name="Shell" type="SHELL" use="required" />
+			<xsd:attribute name="Groups" type="xsd:string" use="optional" />
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Folders">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="Folder" minOccurs="1" maxOccurs="unbounded" />
+			</xsd:sequence>
+			<xsd:attributeGroup ref="FolderAttributes" />
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Folder">
+		<xsd:complexType>
+			<xsd:simpleContent>
+				<xsd:extension base="xsd:normalizedString">
+					<xsd:attributeGroup ref="FolderAttributes" />
+					<xsd:attribute name="Clear" type="xsd:boolean" use="optional" />
+				</xsd:extension>
+			</xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Files">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="File"  minOccurs="1" maxOccurs="unbounded" />
+				<xsd:element ref="Link" minOccurs="0" maxOccurs="unbounded" />
+			</xsd:sequence>
+			<xsd:attributeGroup ref="FileAttributes"/>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Allfiles">
+		<xsd:complexType>
+			<xsd:simpleContent>
+				<xsd:extension base="xsd:normalizedString">
+					<xsd:attributeGroup ref="FileAttributes"/>
+				</xsd:extension>
+			</xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="File">
+		<xsd:complexType>
+			<xsd:simpleContent>
+				<xsd:extension base="xsd:normalizedString">
+					<xsd:attributeGroup ref="FileAttributes" />
+					<xsd:attribute name="Empty" type="xsd:boolean" use="optional" />
+					<xsd:attribute name="Overwrite" type="xsd:boolean" default="true" />
+					<xsd:attribute name="Backup" type="xsd:boolean" default="false" />
+				</xsd:extension>
+			</xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Link">
+		<xsd:complexType>
+			<xsd:simpleContent>
+				<xsd:extension base="xsd:normalizedString">
+					<xsd:attributeGroup ref="FolderAttributes"/>
+					<xsd:attribute name="Target" type="xsd:normalizedString"/>
+				</xsd:extension>
+			</xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Zipfile">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="Zip"  minOccurs="1" maxOccurs="1"/>
+				<xsd:element ref="Source" minOccurs="1" maxOccurs="unbounded" />
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Zip">
+		<xsd:complexType>
+			<xsd:simpleContent>
+				<xsd:extension base="xsd:normalizedString">
+					<xsd:attributeGroup ref="FolderAttributes" />
+				</xsd:extension>
+			</xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Source">
+		<xsd:complexType>
+			<xsd:simpleContent>
+				<xsd:extension base="xsd:normalizedString" />
+			</xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Sudoers">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="UserPrivilege" minOccurs="1" maxOccurs="unbounded" />
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="UserPrivilege">
+		<xsd:complexType>
+			<xsd:simpleContent>
+				<xsd:extension base="xsd:string">
+					<xsd:attribute name="User" type="xsd:NMTOKEN" use="required" />
+					<xsd:attribute name="Password" type="xsd:boolean" use="optional" default="false"/>
+					<xsd:attribute name="Runas" type="xsd:NMTOKEN" use="optional" />
+				</xsd:extension>
+			</xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Daemon">
+		<xsd:complexType>
+			<xsd:attributeGroup ref="ExecutionAttributes"/>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Command">
+		<xsd:simpleType>
+			<xsd:restriction base="xsd:string" />
+		</xsd:simpleType>
+	</xsd:element>
+
+	<xsd:element name="Environment">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:choice>
+					<xsd:element ref="Variable" minOccurs="0" maxOccurs="unbounded" />
+					<xsd:element ref="Alias" minOccurs="0" maxOccurs="unbounded" />
+				</xsd:choice>
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Variable">
+		<xsd:complexType>
+			 <xsd:simpleContent>
+			 	<xsd:extension base="xsd:string">
+					<xsd:attribute name="Name" type="xsd:NMTOKEN" use="required" />
+					<xsd:attribute name="Comment" type="xsd:string" use="optional" />
+			 	</xsd:extension>
+			 </xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Alias">
+		<xsd:complexType>
+			 <xsd:simpleContent>
+			 	<xsd:extension base="xsd:string">
+					<xsd:attribute name="Name" type="xsd:NMTOKEN" use="required" />
+					<xsd:attribute name="Comment" type="xsd:string" use="optional" />
+			 	</xsd:extension>
+			 </xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Crontab">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="Schedule" minOccurs="1" maxOccurs="unbounded" />
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Schedule">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element ref="Command" minOccurs="1" maxOccurs="1" />
+			</xsd:sequence>
+			<xsd:attribute name="User" type="xsd:NMTOKEN" use="required" />
+			<xsd:attribute name="Minute" type="MINUTE" use="optional" />
+			<xsd:attribute name="Hour" type="HOUR" use="optional" />
+			<xsd:attribute name="DayOfMonth" type="DAYOFMONTH" use="optional" />
+			<xsd:attribute name="Month" type="MONTH" use="optional" />
+			<xsd:attribute name="DayOfWeek" type="DAYOFWEEK" use="optional" />
+			<xsd:attribute name="Comment" type="xsd:string" use="optional" />
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:element name="Database">
+		<xsd:complexType>
+			<xsd:simpleContent>
+			 	<xsd:extension base="xsd:string">
+					<xsd:attribute name="database" type="xsd:string" use="optional"/>
+				</xsd:extension>
+			</xsd:simpleContent>
+		</xsd:complexType>
+	</xsd:element>
+
+	<xsd:attributeGroup name="FolderAttributes">
+		<xsd:attribute name="Group" type="xsd:NMTOKEN" use="optional" default="bin"/>
+		<xsd:attribute name="Owner" type="xsd:NMTOKEN" use="optional" default="root"/>
+		<xsd:attribute name="Mode" type="MODE" use="optional" default="0640"/>
+	</xsd:attributeGroup>
+
+	<xsd:attributeGroup name="FileAttributes">
+		<xsd:attribute name="Source" type="xsd:string" use="optional" />
+		<xsd:attributeGroup ref="FolderAttributes"/>
+	</xsd:attributeGroup>
+
+	<xsd:attributeGroup name="ExecutionAttributes">
+		<xsd:attribute name="Priority" type="xsd:nonNegativeInteger" use="optional" />
+		<xsd:attribute name="Flags" type="xsd:string" use="required" />
+		<xsd:attribute name="User" type="xsd:string" use="required" />
+	</xsd:attributeGroup>
+
+	<xsd:simpleType name="MODE">
+		<xsd:restriction base="xsd:string">
+			<xsd:pattern value="[0-7]{4}"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+
+	<xsd:simpleType name="SHELL">
+		<xsd:restriction base="xsd:string">
+			<xsd:enumeration value="/sbin/nologin" />
+			<xsd:enumeration value="/bin/ksh" />
+		</xsd:restriction>
+	</xsd:simpleType>
+
+	<xsd:simpleType name="MINUTE">
+		<xsd:restriction base="xsd:integer">
+		<xsd:minInclusive value="0"/>
+		<xsd:maxInclusive value="59"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+
+	<xsd:simpleType name="HOUR">
+		<xsd:restriction base="xsd:integer">
+		<xsd:minInclusive value="0"/>
+		<xsd:maxInclusive value="23"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+
+	<xsd:simpleType name="DAYOFMONTH">
+		<xsd:restriction base="xsd:integer">
+		<xsd:minInclusive value="1"/>
+		<xsd:maxInclusive value="31"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+
+	<xsd:simpleType name="MONTH">
+		<xsd:restriction base="xsd:integer">
+		<xsd:minInclusive value="1"/>
+		<xsd:maxInclusive value="12"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+
+	<xsd:simpleType name="DAYOFWEEK">
+		<xsd:restriction base="xsd:integer">
+		<xsd:minInclusive value="0"/>
+		<xsd:maxInclusive value="7"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+
+</xsd:schema>

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: promotion
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 7
+  version: 1.0.7
+platform: ruby
+authors: 
+- Richard Kernahan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-19 00:00:00 Z
+dependencies: []
+
+description: "\t\tThe Promotion tool is designed to make it easy and quick to deploy an application\n\
+  \t\tinto production. Originally built for use with OpenBSD, it can be used on an *nix\n\
+  \t\tsystem by adjusting a few paths (in <code>config.rb</code>).\n\n\
+  \t\tTo deploy or install an application you just need to copy a few files into place, right?\n\
+  \t\tWell, the folders need to be there first of course, oh and the permissions need to be set,\n\
+  \t\tand I guess we need the right users set up before file ownerships can be set correctly,\n\
+  \t\twhich means we need groups before that ... ok, so there is more to it than copying a few files.\n\n\
+  \t\tThere are also system-wide settings that may need to be modified to support an application,\n\
+  \t\tsuch as environment variables in <code>/etc/profile</code>, <code>/etc/sudoers</code>,\n\
+  \t\tstartup scripts in <code>/etc/rc.conf.local</code>, and <code>/var/cron/tabs/*</code> cron jobs.\n\n\
+  \t\tPromotion handles all of this based on an XML deployment descriptor for each application,\n\
+  \t\tallowing rapid, reliable redeployment with a single line command. It also manages database\n\
+  \t\tschema migration.\n"
+email: rec.dev@finalstep.com.au
+executables: []
+
+extensions: 
+- ext/promotion/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- bin/promote
+- bin/evolve
+- bin/devolve
+- ext/promotion/extconf.rb
+- lib/promotion.rb
+- lib/promotion/application.rb
+- lib/promotion/config.rb
+- lib/promotion/enforcer.rb
+- lib/promotion/evolver.rb
+- lib/promotion/generator.rb
+- lib/promotion/erb/crontab.erb
+- lib/promotion/erb/profile.erb
+- lib/promotion/erb/rc.conf.local.erb
+- lib/promotion/erb/sudoers.erb
+- .yardopts
+- deploy.xml
+- promotion.xsd
+- CHANGELOG
+- README
+- VERSION
+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  "
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: promotion
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Promotion makes it possible to repeatedly deploy an application in a fast and reliable way.
+test_files: []
+
+has_rdoc: "true"