promotion 1.3.0 → 1.3.1

data/CHANGELOG

@@ -1,5 +1,4 @@
-
-== Version 1.3.0
+== Version 1.3.1
 - Added generation of newsyslog.conf
 - Added some more examples into the shell generated by mkdeploy
 - eliminated ERB, replacing it with plain text generation

data/lib/promotion/generator/crontab.rb

@@ -0,0 +1,69 @@
+module Promotion
+module Generator
+module Crontab
+
+  # The crontab for each user must be deployed using the crontab tool
+  def self.generate(specs)
+    sym = "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
+				}
+			}
+			schedules.each { |user, crontablist|
+				generatedContents = self.contents(user, crontablist)
+				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 accumulate the cron-generated warning messages at the top of the file
+				ensure
+					tempFile.close unless tempFile.nil? || tempFile.closed?
+				end
+				$log.info("Checking temporary crontab written to #{tempFilename}.")
+				crontabResults = `#{Files::Crontab} -u #{user} #{tempFilename}`
+				if $?.exitstatus == 0
+					$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
+
+  # Generates the contents for /var/cron/tabs/{user}, containing scheduled jobs
+  def self.contents(user, crontablist)
+    contents = []
+    contents << "# /var/cron/tabs/#{user} - #{user}'s crontab \n#\n"
+    contents << "#minute hour    mday    month   wday    command\n#\n\n"
+    crontablist.each { |sched|
+      if sched.attributes["Comment"]
+        contents << "#______________________________\n"
+        contents << "#{sched.attributes["Comment"]} \n"
+      end
+      minute = sched.attributes["Minute"] || "*"
+      hour   = sched.attributes["Hour"]   || "*"
+      mday   = sched.attributes["DayOfMonth"] || "*"
+      month  = sched.attributes["Month"]  || "*"
+      wday   = sched.attributes["DayOfWeek"] || "*"
+      cmd    = (sched.elements["Command"].cdatas[0]).value().strip()
+      contents << minute + "\t" + hour + "\t" + mday + "\t" + month + "\t" + wday + "\t" + cmd + "\n"
+    }
+    return(contents.join(""))
+  end
+
+end
+end
+end

data/lib/promotion/generator/newsyslog.rb

@@ -0,0 +1,51 @@
+module Promotion
+module Generator
+module Newsyslog
+
+  # Writes the Newsyslog configuration
+  def self.generate(specs)
+    sym = "Newsyslog"
+		begin
+			originalContents = Promotion::Generator::original_contents_for(sym)
+      newContents = originalContents + Marker + contents(specs)
+			Promotion::Generator::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
+
+  # Generates the contents for /etc/newsyslog.conf, which controls rolling and retention of logs
+  def self.contents(specs)
+    contents = []
+    contents << "# This section of the file should not be edited\n"
+    contents << "# It was generated by the promotion application and will be overwritten\n"
+    contents << "# when the next promotion occurs.\n"
+    contents << "# The previous section will be preserved\n\n"
+    contents << "# Filename								Owner:Group			Mode   Count  Size   When     Flags\n"
+    specs.each { |spec|
+      spec.elements.each("/Specification/Newsyslog") { |nsl|
+        contents << "%-40s" % nsl.text()
+        owner = nsl.attributes["Owner"]
+        group = nsl.attributes["Group"]
+        if owner.nil? or group.nil?
+            og = ""
+        else
+            og = owner + ":" + group
+        end
+        contents << "%-20s" % og
+        contents << "%-7s" % (nsl.attributes["Mode"] || "0640")
+        contents << "%-7s" % (nsl.attributes["Count"] || "*")
+        contents << "%-7s" % (nsl.attributes["Size"] || "*")
+        contents << "%-9s" % (nsl.attributes["When"] || "*")
+        contents << "Z" if (nsl.attributes["Zip"] || "true") == "true"
+        contents << "B" if (nsl.attributes["Binary"] || "false") == "true"
+        contents << "\n"
+      }
+    }
+    return(contents.join(""))
+  end
+
+end
+end
+end

data/lib/promotion/generator/profile.rb

@@ -0,0 +1,43 @@
+module Promotion
+module Generator
+module Profile
+
+  # Writes the system profile
+  def self.generate(specs)
+    sym = "Profile"
+		begin
+      originalContents = Promotion::Generator::original_contents_for(sym)
+      newContents = originalContents + Marker + contents(specs)
+			Promotion::Generator::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
+
+  # Generates the contents for /etc/profile, containing environment variables and aliases
+  def self.contents(specs)
+    contents = []
+    contents << "# This section of the file should not be edited\n"
+    contents << "# It was generated by the promotion application and will be overwritten\n"
+    contents << "# when the next promotion occurs.\n"
+    contents << "# The previous section will be preserved\n"
+    specs.each { |spec|
+      spec.elements.each("/Specification/Environment") { |env|
+        env.elements.each("Variable") { |var|
+          t = var.cdatas.length > 0 ? var.cdatas[0].to_s() : var.text()
+          contents << "export #{var.attributes["Name"]}=\"#{t}\" \n"
+        }
+        env.elements.each("Alias") { |ali|
+          contents << "# #{ali.attributes["Comment"]}\n" if ali.attributes["Comment"]
+          t = ali.cdatas.length > 0 ? ali.cdatas[0].to_s() : ali.text()
+          contents << "alias #{ali.attributes["Name"]}='#{t}' \n"
+        }
+      }
+    }
+    return(contents.join(""))
+  end
+
+end
+end
+end

data/lib/promotion/generator/rcconf.rb

@@ -0,0 +1,48 @@
+module Promotion
+module Generator
+module Rcconf
+
+  # Writes the system file /etc/rc.conf.local
+  def self.generate(specs)
+    sym = "Rc_conf"
+		begin
+			originalContents = Promotion::Generator::original_contents_for(sym)
+      newContents = originalContents + Marker + contents(specs)
+			Promotion::Generator::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
+
+  # Generates the contents for /etc/rc.conf.local, containing instructions for running daemons
+  def self.contents(specs)
+    contents = []
+    contents << "# This section of the file should not be edited\n"
+    contents << "# It was generated by the promotion application and will be overwritten\n"
+    contents << "# when the next promotion occurs.\n"
+    contents << "# The previous section will be preserved\n"
+    contents << "# ---------------------------\n"
+    contents << "# generated application flags\n"
+    daemonSpecs = specs.reject {|s| s.elements["/Specification/Daemon"].nil? }
+    daemonSpecs.sort!() { |a, b|
+      ap = a.elements["/Specification/Daemon"].attributes["Priority"].to_i || 10
+      bp = b.elements["/Specification/Daemon"].attributes["Priority"].to_i || 10
+      ap <=> bp
+    }
+    pkgScripts = []
+    daemonSpecs.each { |spec|
+      name = spec.attributes["Name"]
+      flags = spec.elements["/Specification/Daemon"].attributes["Flags"]
+      contents << "#{name}_flags=\"#{flags}\" \n"
+      pkgScripts << name
+    }
+    contents << "# rc.d(8) packages scripts\n"
+    contents << "# started in the specified order and stopped in reverse order\n"
+    contents << "pkg_scripts=\"#{pkgScripts.join(" ")}\" \n"
+    return(contents.join(""))
+  end
+
+end
+end
+end

data/lib/promotion/generator/sudoers.rb

@@ -0,0 +1,55 @@
+module Promotion
+module Generator
+module Sudoers
+
+  # Writes the sudoers file after testing it with visudo
+  def self.generate(specs)
+    sym = "Sudoers"
+		begin
+      originalContents = Promotion::Generator::original_contents_for(sym)
+      newContents = originalContents + Marker + contents(specs)
+			tempFilename = Promotion::Generator::write_file_for(sym, newContents, true)
+			$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
+			Promotion::Generator::write_file_for("Sudoers", newContents)
+			FileUtils.rm_f(tempFilename)
+		rescue => e
+			$log.error("Error occurred while generating sudoers\n#{e.message}" + e.backtrace.join("\n"))
+			exit 1
+		end
+  end
+
+  # Generates the contents for /etc/sudoers, containing environment variables and aliases
+  def self.contents(specs)
+    contents = []
+    contents << "# This section of the file should not be edited\n"
+    contents << "# It was generated by the promotion application and will be overwritten\n"
+    contents << "# when the next promotion occurs.\n"
+    contents << "# The previous section will be preserved\n\n"
+    contents << "Defaults timestamp_timeout=55\n\n"
+    contents << "root    ALL = (ALL) ALL \n"
+    contents << "# people in group wheel may run all commands \n"
+    contents << "%wheel  ALL = (ALL) ALL \n\n"
+    contents << "# Generated user privilege specifications \n"
+    specs.each { |spec|
+      spec.elements.each("/Specification/Sudoers/UserPrivilege") { |priv|
+        contents << "%-16s" % priv.attributes["User"]
+        contents << " ALL = "
+        contents << "(#{priv.attributes["Runas"]}) " if priv.attributes["Runas"]
+        pwd = (priv.attributes["Password"] || "false").downcase() == "true"
+        contents <<  (pwd ? " " : "NOPASSWD: ")
+        contents << "#{priv.text().strip()} \n"
+      }
+    }
+    return(contents.join(""))
+  end
+
+end
+end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: promotion
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 3
-  - 0
-  version: 1.3.0
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Richard Kernahan
@@ -65,10 +65,11 @@ files:
 - 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
+- lib/promotion/generator/crontab.rb
+- lib/promotion/generator/newsyslog.rb
+- lib/promotion/generator/profile.rb
+- lib/promotion/generator/rcconf.rb
+- lib/promotion/generator/sudoers.rb
 - .yardopts
 - promotion.xsd
 - CHANGELOG

data/lib/promotion/erb/crontab.erb

@@ -1,19 +0,0 @@
-#
-# /var/cron/tabs/<%= user %> - <%= user %>'s crontab
-#
-#minute hour    mday    month   wday    command
-#
-<% crontablist.each do |sched| %>
-<% if sched.attributes["Comment"] %>
-#______________________________
-# <%= sched.attributes["Comment"] %>
-<% end %>
-<% minute = sched.attributes["Minute"] || "*" %>
-<% hour   = sched.attributes["Hour"]   || "*" %>
-<% mday   = sched.attributes["DayOfMonth"] || "*" %>
-<% month  = sched.attributes["Month"]  || "*" %>
-<% wday   = sched.attributes["DayOfWeek"] || "*" %>
-<% cmd    = (sched.elements["Command"].cdatas[0]).value().strip() %>
-<%= minute + "\t" + hour + "\t" + mday + "\t" + month + "\t" + wday + "\t" + cmd %>
-
-<% end %>

data/lib/promotion/erb/profile.erb

@@ -1,17 +0,0 @@
-# This section of the file should not be edited
-# It was generated by the promotion application and will be overwritten
-# when the next promotion occurs.
-# The previous section will be preserved
-<% @specs.each do |spec|
-	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 %>"<% 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"]
-%><% end %>
-alias <%= ali.attributes["Name"] %>='<%= t %>' <%
-end
-end
-end %>

data/lib/promotion/erb/rc.conf.local.erb

@@ -1,20 +0,0 @@
-# This section of the file is generated by the promotion application
-# DO NOT EDIT THIS SECTION - your changes will be lost
-# You may edit the section before the promotion marker
-#______________________________
-# generated application flags
-<% daemonSpecs = @specs.reject {|s| s.elements["/Specification/Daemon"].nil? } %>
-<% daemonSpecs.sort!() do |a, b| %>
-<%   ap = a.elements["/Specification/Daemon"].attributes["Priority"].to_i || 10 %>
-<%   bp = b.elements["/Specification/Daemon"].attributes["Priority"].to_i || 10 %>
-<%   ap <=> bp %>
-<% end %>
-<% pkgScripts = [] %>
-<% daemonSpecs.each do |spec| %>
-<%= spec.attributes["Name"] %>_flags="<%= spec.elements["/Specification/Daemon"].attributes["Flags"] %>"
-<% pkgScripts << spec.attributes["Name"] %>
-<% end %>
-
-# rc.d(8) packages scripts
-# started in the specified order and stopped in reverse order
-pkg_scripts="<%= pkgScripts.join(" ") %>"

data/lib/promotion/erb/sudoers.erb

@@ -1,22 +0,0 @@
-# This section of the file should not be edited, even with visudo
-# It was generated by the promotion application and will be overwritten
-# when the next promotion occurs.
-# The previous section will be preserved
-
-Defaults timestamp_timeout=55
-
-root    ALL = (ALL) ALL
-# people in group wheel may run all commands
-%wheel  ALL = (ALL) ALL
-
-# Generated user privilege specifications
-<% @specs.each do |spec| %>
-<% spec.elements.each("/Specification/Sudoers/UserPrivilege") do |priv| %>
-<%= sprintf('%-16s', priv.attributes["User"]) %>
-<%= " ALL = " %>
-<% if priv.attributes["Runas"] %>(<%= priv.attributes["Runas"] %>) <% end %>
-<%= (priv.attributes["Password"] || "").downcase() == "true" ? " " : "NOPASSWD: " %>
-<%= priv.text().strip() %>
-
-<% end %>
-<% end %>