bootscript 0.2.1

data/lib/templates/chef/chef-install.ps1.erb

@@ -0,0 +1,126 @@
+echo "Starting Chef installation..."
+
+$ChefVers       = "<%= (defined? chef_version) ? chef_version : '' %>"
+$ChefPath       = "C:\Chef"
+$ChefLog        = "$ChefPath\log\bootscript_log.txt"
+$CreateRAMDisk  = $<%= create_ramdisk.to_s.upcase %>
+$RAMDiskMount   = "<%= ramdisk_mount %>"
+
+function main()
+{
+  try
+  {
+    Create-Chef-Directory-Structure
+    if ($createRAMDisk) { Move-Chef-Secrets-To-Ramdisk }
+    Install-Chef-Client
+    Execute-Chef-Client
+  }
+  catch{
+    write-error $error[0]
+    exit 1
+  }
+}
+
+function Create-Chef-Directory-Structure()
+{
+  try
+  {
+    if (!(Test-Path $ChefPath)) {New-Item $ChefPath -type directory | out-null}
+    foreach($f in @("etc", "bin", "log", "tmp", "var"))
+    {
+      $subdir = "$($ChefPath)\$f"
+      if (!(Test-Path $subdir)) {New-Item $subdir -type directory | out-null}
+    }
+  }
+  catch {throw $error[0]}
+}
+
+function Move-Chef-Secrets-To-Ramdisk()
+{
+  echo "Moving Chef secrets to $RAMDiskMount"
+  Move-Item c:\chef\validation.pem $RAMDiskMount
+  Move-Item c:\chef\encrypted_data_bag_secret $RAMDiskMount
+}
+
+function Install-Chef-Client()
+{
+  echo "Downloading Chef installer..."
+  $sourceFile = "C:\chef-client.msi"
+  $wc = new-object System.Net.WebClient
+  try
+  {
+    $installerURL = Chef-URL
+    echo "Downloading $installerURL -> $sourceFile"
+    $wc.DownloadFile($installerURL, $sourceFile)
+    if ((test-path  $sourceFile) -ne $true){ throw "File not found: $sourceFile" }
+    echo "Installing Chef installer ($sourceFile) with msiexec..."
+    Execute-Command("msiexec /qn /i $sourceFile")
+  }
+  catch{
+    throw $error[0]
+  }
+}
+
+function Chef-Url()
+{
+  $major_rev = [System.Environment]::OSVersion.Version.Major
+  $minor_rev = [System.Environment]::OSVersion.Version.Minor
+  $winrev    = "$major_rev.$minor_rev"
+  $arch      = "x86_64"
+  if     ($winrev -eq "5.1") { $machineos = "2003" }
+  elseif ($winrev -eq "6.0") { $machineos = "2008" }
+  elseif ($winrev -eq "6.1") { $machineos = "2008r2" }
+  elseif ($winrev -eq "6.2") { $machineos = "2012" }
+  else   { throw "ERROR: Windows Server 2003, 2008 or 2012 required" }
+  $url = "https://www.opscode.com/chef/download?p=windows&pv=$machineos&m=$arch"
+  if ($ChefVers -ne "") { $url = "$url&v=$ChefVers" }
+  return $url
+}
+
+function Execute-Chef-Client()
+{
+  try
+  {
+    $Env:Path = "$Env:Path;C:\opscode\chef\bin;C:\opscode\chef\embedded\bin"
+
+    echo "Performing initial convergence..."
+    $tinyRunlist = "recipe[chef-client::config],recipe[chef-client::service]"
+    $logOptions = "-l info -L $ChefLog"
+    Execute-Command("chef-client --once --no-color $logOptions -o $tinyRunlist")
+
+    echo "Performing full convergence..."
+    Execute-Command("chef-client --once --no-color $logOptions")
+
+    echo "Initial Chef runs completed - see $ChefLog"
+  }
+  catch
+  {
+    echo "Chef client execution failed"
+    echo "Error was: $error[0]"
+    throw $error[0]
+  }
+}
+
+function Execute-Command($cmd)
+{
+  if ($cmd -ne "")
+  {
+    Try {
+      echo "Running: $cmd"
+      $Env:_THIS_CMD = $cmd
+      $proc = Start-Process -FilePath c:\windows\system32\cmd.exe `
+        -ArgumentList "/C", "%_THIS_CMD%" `
+        -Verbose -Debug -Wait -Passthru
+      do { start-sleep -Milliseconds 500 }
+      until ($proc.HasExited)
+      echo "Finished: $cmd"
+    }
+    Catch {
+      echo "Failed: $cmd"
+      echo "Error was: $error[0]"
+      throw $error[0]
+    }
+  }
+}
+
+main

data/lib/templates/chef/chef-install.sh.erb

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+# Installs chef-client via the ombnibus installer (with minimal dependencies),
+# and tries to converge twice: first, with just this runlist -
+#     recipe[chef-client::config],recipe[chef-client::service]
+# ; and then again with the full runlist.
+set -e
+test $UID == 0 || (echo "Error: must run as root"; exit 1)
+echo "Installing Chef with ${0}..."
+
+######### STEP 0: CONFIG, rendered by bootscript gem
+NODE_NAME="<%= chef_attributes['chef_client']['config']['node_name'] %>"
+CHEF_URL="<%= chef_attributes['chef_client']['config']['chef_server_url'] %>"
+VALIDATION_PEM='<%= ramdisk_mount %>/chef/validation.pem'
+DATABAG_SECRET='<%= ramdisk_mount %>/chef/encrypted_data_bag_secret'
+CHEF_VERSION="<%= (defined? chef_version) ? chef_version : '' %>"
+CHEF_INITIAL_RUNLIST="<%=
+  (defined? chef_initial_runlist) ? chef_initial_runlist : '' %>"
+OMNIBUS_INSTALLER_URL="http://opscode.com/chef/install.sh"
+CHEF_BIN="/usr/bin/chef-client" # Unix Chef omnibus always symlinks here
+PID_FILE="/var/run/chef/client.pid"
+
+######### STEP 1: MOVE CHEF SECRETS INTO PLACE
+chmod 0600 "$VALIDATION_PEM"
+if ! [ "$VALIDATION_PEM" == "/etc/chef/validation.pem" ] ; then
+  ln -sf "$VALIDATION_PEM" "/etc/chef/validation.pem"
+fi
+if [ -e "$DATABAG_SECRET" ] ; then
+  chmod 0600 "$DATABAG_SECRET"
+  if ! [ "$DATABAG_SECRET" == "/etc/chef/encrypted_data_bag_secret" ] ; then
+    ln -sf "$DATABAG_SECRET" "/etc/chef/encrypted_data_bag_secret"
+  fi
+fi
+
+######### STEP 2: CONFIGURE OPERATING SYSTEM AND INSTALL DEPENDENCIES
+echo "Performing package update..."
+export DEBIAN_FRONTEND=noninteractive
+apt-get update -y
+echo "Installing build-essential and curl..."
+apt-get --force-yes -y install build-essential curl
+
+######### STEP 3: INSTALL CHEF VIA OMNIBUS INSTALLER
+echo "Downloading Chef..."
+installer=$(basename $OMNIBUS_INSTALLER_URL)
+if ! (which $CHEF_BIN >/dev/null 2>&1) ; then
+  if (which curl >/dev/null 2>&1); then
+    curl -L -o $installer $OMNIBUS_INSTALLER_URL
+  else
+    echo "Cannot find curl - cannot download Chef!"
+  fi
+fi
+cmd="bash $installer"
+if ! [ "$CHEF_VERSION" == "" ] ; then
+  cmd="$cmd -v ${CHEF_VERSION}"
+fi
+echo "Installing Chef..."
+$cmd
+rm -f $installer
+
+######### STEP 4: INITIAL, ONE-PASS CHEF CONVERGENCE
+echo "Performing initial convergence..."
+cmd="$CHEF_BIN --once --no-color"
+if [[ "$CHEF_INITIAL_RUNLIST" != "" ]] ; then
+  cmd="$cmd -o $CHEF_INITIAL_RUNLIST"
+fi
+echo $cmd
+$cmd
+
+######### STEP 5: SIGNAL SERVICE TO CONVERGE
+echo "Signalling chef service to converge..."
+killall -USR1 chef-client || echo "  (...no chef client service detected)"
+
+echo "Done."

data/lib/templates/chef/chef_client.conf.erb

@@ -0,0 +1,9 @@
+<% %w{node_name chef_server_url validation_client_name environment}.each do |param| %>
+<% if chef_attributes['chef_client']['config'][param] %>
+<%= param %> '<%= chef_attributes['chef_client']['config'][param] %>'
+<% end %>
+<% end %>
+chef_dir = "<%= platform =~ /windows/i ? '/chef' : '/etc/chef' %>"
+Dir.glob(File.join(chef_dir, "client.d", "*.rb")).each do |conf|
+  Chef::Config.from_file(conf)
+end

data/lib/templates/chef/json_attributes.rb.erb

@@ -0,0 +1,4 @@
+attributes_file = "#{::File.dirname(__FILE__)}/../attributes.json"
+if ::File.exists? attributes_file
+  json_attribs attributes_file
+end

data/lib/templates/chef/ramdisk_secrets.rb.erb

@@ -0,0 +1,2 @@
+validation_key "<%= ramdisk_mount %>/validation.pem"
+# data bag decryption secret is at <%= ramdisk_mount %>/encrypted_data_bag_secret

data/lib/templates/windows_footer.bat.erb

@@ -0,0 +1,4 @@
+main
+}.Invoke($args)
+<% if add_script_tags %></script>
+<% end %>

data/lib/templates/windows_header.bat.erb

@@ -0,0 +1,18 @@
+<% if add_script_tags %><script>
+<% end -%>@@echo off
+:CheckPowerShellExecutionPolicy
+@@FOR /F "tokens=*" %%i IN ('powershell -noprofile -command Get-ExecutionPolicy') DO Set PSExecMode=%%i
+@@if /I "%PSExecMode%"=="unrestricted" goto :RunPowerShellScript
+
+@@NET FILE 1>NUL 2>NUL
+@@if not "%ERRORLEVEL%"=="0" (
+@@echo Elevation required to change PowerShell execution policy from [%PSExecMode%] to Unrestricted
+@@powershell -NoProfile -Command "start-process -Wait -Verb 'RunAs' -FilePath 'powershell.exe' -ArgumentList '-NoProfile Set-ExecutionPolicy Unrestricted'" ) else (
+@@powershell -NoProfile Set-ExecutionPolicy Unrestricted )
+
+:RunPowerShellScript
+@@set POWERSHELL_BAT_ARGS=%*
+@@if defined POWERSHELL_BAT_ARGS set POWERSHELL_BAT_ARGS=%POWERSHELL_BAT_ARGS:"=\"%
+@@PowerShell -Command Invoke-Expression $('$args=@(^&{$args} %POWERSHELL_BAT_ARGS%);'+[String]::Join([Environment]::NewLine,$((Get-Content '%~f0') -notmatch '^^@@^|^^:'))) > c:\bootscript.log 2>&1 & goto :EOF
+
+{

data/spec/bootscript/chef_spec.rb

@@ -0,0 +1,48 @@
+require 'bootscript'
+include Bootscript
+
+describe Chef do
+
+  describe :files do
+    context "given a set of ERB template vars" do
+      erb_vars = {
+        ramdisk_mount:        '/mount/myramdisk',
+        chef_validation_pem:  'MYPEM',
+        chef_databag_secret:  'SECRET',
+      }
+      it "returns a Hash mapping locations on the boot target to local data" do
+        Chef.files(erb_vars).should be_a Hash
+      end
+      it "maps the Chef Validation data into place on the target's RAMdisk" do
+        Chef.files(erb_vars)[
+          "#{erb_vars[:ramdisk_mount]}/chef/validation.pem"
+        ].should be erb_vars[:chef_validation_pem]
+      end
+      it "maps the Chef data bag secret into place on the target's RAMdisk" do
+        Chef.files(erb_vars)[
+          "#{erb_vars[:ramdisk_mount]}/chef/encrypted_data_bag_secret"
+        ].should be erb_vars[:chef_databag_secret]
+      end
+    end
+  end
+
+  describe :included? do
+    desired_key = :chef_validation_pem
+    context "given a set of ERB template vars with key :#{desired_key}" do
+      it "returns true" do
+        Chef.included?(chef_validation_pem: 'SOME DATA').should be true
+      end
+    end
+    context "given a set of ERB template vars without key :#{desired_key}" do
+      it "returns false" do
+        Chef.included?({}).should be false
+      end
+    end
+    context "given nothing" do
+      it "returns false" do
+        Chef.included?().should be false
+      end
+    end
+  end
+
+end

data/spec/bootscript/script_spec.rb

@@ -0,0 +1,126 @@
+require 'bootscript'
+require 'logger'    # for testing logging functionality
+require 'tmpdir'    # for unpacking Script archives
+include Bootscript # for brevity
+
+describe Script do
+
+  #### TEST SETUP
+  before :each do
+    @script = Script.new()
+  end
+
+  #### TEST PUBLIC INSTANCE MEMBER VARIABLES
+
+  it "has a public @data_map Hash, for mapping local data to the boot target" do
+    Script.new().should respond_to(:data_map)
+    Script.new().data_map.should be_a Hash
+  end
+
+  it "exposes a Ruby Logger as its public @log member, to adjust log level" do
+    Script.new().should respond_to(:log)
+    Script.new().log.should be_a Logger
+  end
+
+  #### TEST PUBLIC METHODS
+
+  describe :initialize do
+    context "when invoked with a logger" do
+      it "sets the BootScript's @log to the passed Logger object" do
+        my_logger = Logger.new(STDOUT)
+        Script.new(my_logger).log.should be my_logger
+      end
+    end
+    context "when invoked with no logger" do
+      it "assigns a default Logger the BootScript's @log" do
+        Script.new().log.should be_a Logger
+      end
+    end
+  end
+
+  describe :generate do
+    # test arguments / arity
+    it "accepts an (optional) Hash of template vars" do
+      expect{@script.generate}.to_not raise_error
+      expect{@script.generate({some_key: :some_value})}.to_not raise_error
+    end
+    it "accepts an (optional) destination for the generated text" do
+      File.open('/dev/null', 'w') do |outfile|  # write to nowhere!
+        expect{@script.generate({}, outfile)}.to_not raise_error
+      end
+    end
+    # test output format
+    it "produces a Bash script" do
+      @script.generate.lines.first.chomp.should eq '#!/usr/bin/env bash'
+    end
+    # test stripping of empty lines and comments
+    context "when invoked with :strip_comments = true (the default)" do
+      it "strips all empty lines and comments from the output" do
+        lines = @script.generate.lines.to_a
+        lines[1..lines.count].each do |line|
+          line.should_not match /^#/
+          line.should_not match /^\s+$/
+        end
+      end
+    end
+    context "when invoked with :strip_comments = false" do
+      it "leaves empty lines and comments in the output" do
+        lines = @script.generate(strip_comments: false).lines.to_a
+        lines.select{|l| l =~ /^\s+$/}.count.should be > 0  # check empty lines
+        lines.select{|l| l =~ /^#/}.count.should be > 1     # check comments
+      end
+    end
+
+    # test rendering of built-in variables into built-in templates
+    vars = {create_ramdisk: false, ramdisk_size: 5,
+      ramdisk_mount: '/secrets', update_os: false}
+    vars.keys.each do |var|
+      it "renders template variable :#{var} as Bash variable #{var.upcase}" do
+        rendered_config = Unpacker.new(Script.new.generate(vars)).config
+        vars[var].to_s.should eq rendered_config[var.upcase.to_s]
+      end
+    end
+    # test rendering of custom templates
+    it "renders custom templates into place with correct ERB values" do
+      @script.data_map = {'/hello.sh' => 'echo Hello, <%= my_name %>.'}
+      text = @script.generate(my_name: 'H. L. Mencken')
+      Dir.mktmpdir do |tmp_dir| # do unarchiving in a temp dir
+        Unpacker.new(text).unpack_to tmp_dir
+        File.exists?("#{tmp_dir}/hello.sh").should == true
+        File.read("#{tmp_dir}/hello.sh").should eq 'echo Hello, H. L. Mencken.'
+      end
+    end
+    # test raw file copying
+    it "copies non-template files directly into the generated archive" do
+      # insert this test file itself into the BootScript's archive!    :-/
+      @script.data_map = {File.basename(__FILE__) => File.new(__FILE__)}
+      Dir.mktmpdir do |tmp_dir| # do unarchiving in a temp dir
+        target_file = "#{tmp_dir}/#{File.basename(__FILE__)}"
+        Unpacker.new(@script.generate).unpack_to tmp_dir
+        File.exists?(target_file).should == true
+        File.read(target_file).should eq File.read(__FILE__)
+      end
+    end
+    # test return values
+    context "when invoked without any output destination" do
+      it "returns the rendered text of the BootScript" do
+        rendered_text = @script.generate
+        rendered_text.should be_a String
+        rendered_text.lines.first.chomp.should eq '#!/usr/bin/env bash'
+        rendered_text.lines.should include("__ARCHIVE_FOLLOWS__\n")
+      end
+    end
+    context "when invoked with a custom output destination" do
+      it "returns the number of bytes written to the destination" do
+        bytes_written, script_size = 0, @script.generate.bytes.count
+        File.open('/dev/null', 'w') do |outfile|
+          bytes_written = @script.generate({}, outfile)
+        end
+        bytes_written.should be_a Fixnum
+        bytes_written.should == script_size
+      end
+    end
+
+  end
+
+end

data/spec/bootscript/uu_writer_spec.rb

@@ -0,0 +1,30 @@
+require 'bootscript'
+include Bootscript # for brevity
+
+describe UUWriter do
+
+  #### TEST PUBLIC INSTANCE MEMBER VARIABLES
+
+  it "exposes a the number of bytes written as an integer" do
+    UUWriter.new(nil).should respond_to(:bytes_written)
+    UUWriter.new(nil).bytes_written.should be_a Fixnum
+  end
+
+  #### TEST PUBLIC METHODS
+
+  describe :initialize do
+    it "sets bytes_written to zero" do
+      UUWriter.new(nil).bytes_written.should == 0
+    end
+  end
+
+  describe :write do
+    it "writes the uuencoded version of its argument to its output member" do
+      destination = StringIO.open("", 'w')
+      UUWriter.new(destination).write("Encode me!")
+      destination.close
+      destination.string.should == ["Encode me!"].pack('m')
+    end
+  end
+
+end