promotion 1.2.1 → 1.3.0

data/CHANGELOG

@@ -1,7 +1,13 @@
+
+== Version 1.3.0
+- Added generation of newsyslog.conf
+- Added some more examples into the shell generated by mkdeploy
+- eliminated ERB, replacing it with plain text generation
+
 == Version 1.2.1
 - Added Clear attribute to Folder.
-- Fixed crontab generation. crontabs are generated completely - prior 
-  contents is not preserved (due to the nature of crontabs) 
+- Fixed crontab generation. crontabs are generated completely - prior
+  contents is not preserved (due to the nature of crontabs)
 
 == Version 1.2.0
 - Make Promotion a better gem citizen by making the installation of executables

data/bin/mkdeploy

@@ -29,6 +29,7 @@ template =<<-EOT
     <Files Owner="root" Group="wheel" Mode="0644" Source="conf">
         <File>/etc/my.cnf</File>
         <File>/etc/myapp.conf</File>
+        <Link Owner="root" Group="bin" Mode="0640" Target="/home/myapp/bak">/var/myappbak</Link>
     </Files>
     <Files Owner="root" Group="wheel" Mode="0750" Source="sbin">
         <File>/usr/local/sbin/up!</File>
@@ -36,7 +37,14 @@ template =<<-EOT
         <File>/usr/local/sbin/push!</File>
     </Files>
     <Allfiles Group="bin" Mode="0644" Owner="root" Source="conf">/var/axonsec/conf</Allfiles>
+    <Sudoers>
+      <UserPrivilege Password="false" Runas="admin" User="richard">/sbin/halt -p</UserPrivilege>
+    </Sudoers>
     <Daemon Flags="" Priority="10" User="_myapp" />
+    <Environment>
+      <Variable Comment="Set up for Java" Name="JAVA_HOME">/usr/local/lib/jdk-1.7.0</Variable>
+      <Alias Name="ll">ls -la </Alias>
+    </Environment>
     <Crontab>
         <Schedule User="root" Hour="2" Minute="7"
             Comment="Backup the entire database at 2:07am each morning">
@@ -44,6 +52,8 @@ template =<<-EOT
         </Schedule>
     </Crontab>
     <Database>/usr/local/bin/mysql</Database>
+    <Newsyslog Owner="_myapp" Group="_myapp" Mode="0640" Count="10" When="D02"
+      Zip="false" Binary="true">/var/myapp/logs/myapp.log</Newsyslog>
 </Specification>
 EOT
 

data/lib/promotion/application.rb

@@ -27,9 +27,8 @@ class Application
 	# Promotes an application into production.
 	def promote()
 		enforcer = Promotion::Enforcer.new(@appname)
-		generator = Promotion::Generator.new()
 		enforcer.start()
-		generator.start()
+		Generator::start()
 		$log.info("Application #{@appname} successfully promoted.")
 	end
 

data/lib/promotion/config.rb

@@ -22,6 +22,8 @@ module Files
 	Sudoers = "/etc/sudoers"
 	# system path to rc.conf.local
 	Rc_conf = "/etc/rc.conf.local"
+	# system path to newsyslog.conf
+	Newsyslog = "/etc/newsyslog.conf"
 	# path to useradd executable
 	Useradd = "/usr/sbin/useradd"
 	# path to groupadd executable
@@ -36,13 +38,14 @@ end
 
 # A section of the configuration file that contains ERB template filenames
 module Templates
-	# filename for Profile template
+	# filename for template for /etc/profile
 	Profile = "profile.erb"
-	# filename for Rc_conf template
+	# filename for template for /etc/rc.conf.local
 	Rc_conf = "rc.conf.local.erb"
-	# filename for Sudoers template
+	# filename for template for /etc/sudoers
 	Sudoers = "sudoers.erb"
 	# filename for Crontab template
 	Crontab = "crontab.erb"
+	# filename for template for /etc/newsyslog.conf
+	Newsyslog = "newsyslog.conf.erb"
 end
-

data/lib/promotion/generator.rb

@@ -1,56 +1,36 @@
-require 'erb'
 require 'rexml/document'
-require 'fileutils'
+require 'promotion/generator/profile'
+require 'promotion/generator/rcconf'
+require 'promotion/generator/newsyslog'
+require 'promotion/generator/sudoers'
+require 'promotion/generator/crontab'
 
-module Promotion	# :nodoc:
+module Promotion
+module Generator
 
-# 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
+  Marker = "#---promotion---"	# add this marker to a config file to preserve the contents before it
 
-  TEMPLATES = File.expand_path("erb", File.dirname(__FILE__))
-
-	# 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()
+  def self.start()
 		$log.info("\n#{'_'*40}\nGenerating common environment files")
-		gather_specs()
-		generate_standard("Profile")
-		generate_standard("Rc_conf")
-		generate_sudoers()
-		generate_crontab()
-	end
+		specs = self.gather_specs()
+		Profile.generate(specs)
+		Rcconf.generate(specs)
+		Newsyslog.generate(specs)
+		Sudoers.generate(specs)
+		Crontab.generate(specs)
+  end
 
 	# Gathers specs from all deployment descriptors in folders with the staging area
-	def gather_specs()
+	def self.gather_specs()
+    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
+				doc = ::REXML::Document.new(specfile)
+				specs << doc.root
 				specfile.close()
 			}
 			return(specs)
@@ -60,145 +40,28 @@ class Generator
 		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)
+	# Write the approved contents to the system file
+	# or a temporary file instead if temp is true.
+	def self.write_file_for(sym, newContents, temp=false)
 		begin
-			templateFilename = File.expand_path(Templates.const_get(sym), 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
+			filename = Files.const_get(sym) + (temp ? ".tmp" : "")
+			f = File.new(filename, File::WRONLY | File::CREAT | File::TRUNC)
+			f.puts(newContents)
+			$log.info("Generated #{sym} written to #{filename}.") unless temp
 		ensure
-			templateFile.close() unless templateFile.nil? || templateFile.closed?
+			f.close unless f.nil? || f.closed?
 		end
-		generator = ERB.new(template, nil, '<>')
-		return(generator)
+		return(filename)
 	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)
+	# Returns a string of the new content for the file up to the +marker+
+	def self.original_contents_for(sym)
 		begin
-			originalContents = IO.readlines(Files.const_get(sym),"")[0].split(@marker)[0]
+			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
-					tempFilename = user + ".tmp"
-					tempFile = File.new(tempFilename, File::WRONLY | File::CREAT | File::TRUNC)
-					tempFile.puts(generatedContents)
-					# previous cron jobs are *NOT* preserved - the tab is competely generated!
-					# otherwise we'll double the crontab each time we run.
-				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
+		return(originalContents)
 	end
 
 end

data/promotion.xsd

@@ -20,6 +20,7 @@
 				<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:element ref="Newsyslog" minOccurs="0" maxOccurs="unbounded" />
 			</xsd:sequence>
 			<xsd:attribute name="Name" type="xsd:NMTOKEN" use="required" />
 			<xsd:attribute name="Title" type="xsd:string" use="required" />
@@ -255,6 +256,23 @@
 		</xsd:complexType>
 	</xsd:element>
 
+	<xsd:element name="Newsyslog">
+		<xsd:complexType>
+			<xsd:simpleContent>
+				<xsd:extension base="xsd:normalizedString">
+					<xsd:attributeGroup ref="FileAttributes" />
+					<xsd:attribute name="Count" type="xsd:integer" use="optional" default="10" />
+					<xsd:attribute name="Size" type="xsd:integer" use="optional" />
+					<xsd:attribute name="When" type="xsd:string" use="optional" default="24" />
+					<!-- treat as $-format if starts with D,W,M; treat as integer if integer
+							else treat as @-format if digits with a 'T' -->
+					<xsd:attribute name="Zip" type="xsd:boolean" use="optional" default="true"/>
+					<xsd:attribute name="Binary" type="xsd:boolean" use="optional" default="false"/>
+				</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"/>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: promotion
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
-  - 1
-  version: 1.2.1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Richard Kernahan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-25 00:00:00 Z
+date: 2012-09-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: log4r