vanagon 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6faf9b7a2f17d4a0d10d3e9a050d066ba92ab7a0
-  data.tar.gz: 112f2f90afafb386461ec92ed67238fefddcf76d
+  metadata.gz: 8a3414d151dd4f8f7162a06b6dfe3a5dc8c9b066
+  data.tar.gz: 944acf2e2cfa169c60f3072d05a5add5c03ac25c
 SHA512:
-  metadata.gz: 8edf1722f845927b0ba7858b077bd3c57908f7395beee779aa068552ea7c5e46d7a827416b201b275fb90c947438162f1a0f42004a85662b1716a8e9f264161f
-  data.tar.gz: 85a5e28c1954033d3120d3e4ee72582f413982762ba430d3e1ebaa0e38127cfb994d3edfdaf921392a76fd7737ff5a6176469b006ff0a63905da653ed37a2607
+  metadata.gz: d88e78e71ccdd7f878141dc0b26d741bbef71b9f9c21e8cc8f766bf241bc8c317c6090e9781508f812d17dddc46e8af42f39d38274618934d4871de498eecf45
+  data.tar.gz: 0152bcaa044f2c8f939a7c8bb4434801d023397d7d156692f6648a55bceca6958a3182577fd6b4492999712cb07ce7eaef017e7c7150cf2205153ddd318750e7

data/README.md

@@ -30,10 +30,10 @@ components, then rebuild the project and test the installed artifacts.
 
 Runtime Requirements
 ---
-Vanagon is self-contained. A recent version of ruby should be all that is
-required. Beyond that, ssh, rsync and git are also required on the host, and
-ssh-server and rsync is required on the target (package installation for the
-target can be customized in the platform config for the target).
+Vanagon is self-contained. A recent version of ruby (2.1 or greater) should be
+all that is required. Beyond that, ssh, rsync and git are also required on the
+host, and ssh-server and rsync is required on the target (package installation
+for the target can be customized in the platform config for the target).
 
 Configuration and Usage
 ---

data/lib/vanagon/component.rb

@@ -12,7 +12,7 @@ class Vanagon
     attr_accessor :settings, :platform, :patches, :requires, :service, :options
     attr_accessor :directories, :replaces, :provides, :cleanup_source
     attr_accessor :sources, :preinstall_actions, :postinstall_actions
-    attr_accessor :preremove_actions, :postremove_actions
+    attr_accessor :preremove_actions, :postremove_actions, :license
 
     # Loads a given component from the configdir
     #

data/lib/vanagon/component/dsl.rb

@@ -158,8 +158,7 @@ class Vanagon
       # @param default_file [String] path to the default file relative to the source
       # @param service_name [String] name of the service
       # @param service_type [String] type of the service (network, application, system, etc)
-      # @param service_hash [Hash] hash of options to parse for the service
-      def install_service(service_file, default_file = nil, service_name = @component.name, service_type: nil, service_hash: nil)
+      def install_service(service_file, default_file = nil, service_name = @component.name, service_type: nil)
         case @component.platform.servicetype
         when "sysv"
           target_service_file = File.join(@component.platform.servicedir, service_name)
@@ -185,7 +184,8 @@ class Vanagon
           # Return here because there is no file to install, just a string read in
           return
         when "windows"
-          @component.service = OpenStruct.new(name: service_name, options: service_hash)
+          @component.service = OpenStruct.new(:id => "#{service_name.gsub(/[^A-Za-z0-9]/, '').upcase}", :service_file => service_file)
+          # return here as we are just collecting the name of the service file to put into the harvest filter list.
           return
         else
           fail "Don't know how to install the #{@component.platform.servicetype}. Please teach #install_service how to do this."
@@ -387,6 +387,10 @@ class Vanagon
         end
         @component.postremove_actions << OpenStruct.new(:pkg_state => pkg_state, :scripts => scripts)
       end
+
+      def license(license)
+        @component.license = license
+      end
     end
   end
 end

data/lib/vanagon/component/source/http.rb

@@ -101,7 +101,7 @@ class Vanagon
             when ".tar.gz", ".tgz"
               return "gunzip -c '#{@file}' | '#{tar}' xf -"
             when ".zip"
-              return "unzip '#{@file}'"
+              return "unzip '#{@file}' || 7za x -r -tzip -o'#{File.basename(@file, ".zip")}' '#{@file}'"
             end
           else
             # Extension does not appear to be an archive

data/lib/vanagon/engine/local.rb

@@ -1,40 +1,35 @@
+require 'vanagon/engine/base'
 require 'vanagon/utilities'
 require 'vanagon/errors'
-require 'benchmark'
 
 class Vanagon
   class Engine
-    class Local
-      attr_accessor :target
+    class Local < Base
 
       def initialize(platform, target = nil)
-        @platform = platform
-        @target = "local machine"
+        @target = target || "local machine"
         @name = 'local'
-      end
+        super
 
-      # Dispatches the command for execution
-      def dispatch(command)
-        puts Benchmark.measure { local_command(command, @workdir) }
+        # We inherit a set of required attributes from Base,
+        # and rather than instantiate a new empty array for
+        # required attributes, we can just clear out the
+        # existing ones.
+        @required_attributes.clear
       end
 
-      # Steps needed to tear down or clean up the system after the build is
-      # complete
-      def teardown
-      end
-
-      # This method will take care of validation and target selection all at
-      # once as an easy shorthand to call from the driver
-      def startup(workdir)
-        @workdir = workdir
-        script = @platform.provisioning.join(' && ')
-        dispatch(script)
+      # Dispatches the command for execution
+      def dispatch(command, return_output = false)
+        Vanagon::Utilities.local_command(command, return_command_output: return_output)
       end
 
       def ship_workdir(workdir)
+        FileUtils.cp_r(Dir.glob("#{workdir}/*"), "#{@remote_workdir}")
       end
 
       def retrieve_built_artifact
+        FileUtils.mkdir_p("output")
+        FileUtils.cp_r(Dir.glob("#{@remote_workdir}/output/*"), "output/")
       end
     end
   end

data/lib/vanagon/optparse.rb

@@ -8,7 +8,7 @@ class Vanagon
         :configdir => ['-c', '--configdir DIR', 'Configs dir (defaults to $pwd/configs)'],
         :target => ['-t HOST', '--target HOST', 'Configure a target machine for build and packaging (defaults to grabbing one from the pooler)'],
         :engine => ['-e ENGINE', '--engine ENGINE', "A custom engine to use (defaults to the pooler) [base, local, docker, pooler currently supported]"],
-        :skipcheck => ['--skipcheck', 'Ship the `check` stage when building components'],
+        :skipcheck => ['--skipcheck', 'Skip the `check` stage when building components'],
         :preserve => ['-p', '--preserve', 'Whether to tear down the VM on success or not (defaults to false)'],
         :verbose => ['-v', '--verbose', 'Verbose output (does nothing)'],
       }

data/lib/vanagon/platform/windows.rb

@@ -53,8 +53,68 @@ class Vanagon
       # @param name [String] name of the project
       # @param binding [Binding] binding to use in evaluating the packaging templates
       def generate_msi_packaging_artifacts(workdir, name, binding)
-        FileUtils.mkdir_p(File.join(workdir, "wix"))
-        erb_file(File.join(VANAGON_ROOT, "resources/windows/wix/service.component.wxs.erb"), File.join(workdir, "wix", "service.#{name}.wxs"), false, { :binding => binding })
+        # Copy the project specific files first
+        copy_from_project("./resources/windows/wix", workdir)
+        merge_defaults_from_vanagon(File.join(VANAGON_ROOT, "resources/windows/wix"), "#{workdir}/wix")
+        process_templates("#{workdir}/wix", binding)
+      end
+
+      # Method to recursively copy from a source project resource directory
+      # to a destination (wix) work directory.
+      # strongly suspect the original cp_r command would have done all of this.
+      #
+      # @param proj_resources [String] Project Resource File directory
+      # @param destination [String] Destination directory
+      # @param verbose [String] True or false
+      def copy_from_project(proj_resources, destination, verbose: false)
+        FileUtils.cp_r(proj_resources, destination, :verbose => verbose)
+      end
+
+      # Method to merge in the files from the Vanagon (generic) directories.
+      # Project Specific files take precedence, so since these are copied prior
+      # to this function, then this merge operation will ignore existing files
+      #
+      # @param vanagon_root [String] Vanagon wix resources directory
+      # @param destination [String] Destination directory
+      # @param verbose [String] True or false
+      def merge_defaults_from_vanagon(vanagon_root, destination, verbose: false)
+        # Will use this Pathname object for relative path calculations in loop below.
+        vanagon_path = Pathname.new(vanagon_root)
+        files = Dir.glob(File.join(vanagon_root, "**/*.*"))
+        files.each do |file|
+          # Get Pathname for incoming file using Pathname library
+          src_pathname = Pathname.new(file).dirname
+          # This Pathname method allows us to effectively "subtract" the leading vanagon_path
+          # from the source filename path. This gives us a pathname fragment that we can
+          # then append to the target directory, preserving the files place in the directory
+          # tree relative to the parent.
+          # See following article for example:
+          # http://stackoverflow.com/questions/12093770/ruby-removing-parts-a-file-path
+          # and http://ruby-doc.org/stdlib-2.1.0/libdoc/pathname/rdoc/Pathname.html#method-i-relative_path_from
+          dest_pathname_fragment = src_pathname.relative_path_from(vanagon_path)
+          target_dir = File.join(destination, dest_pathname_fragment.to_s)
+          # Create the target directory if necessary.
+          FileUtils.mkdir_p(target_dir) unless File.exists?(target_dir)
+          # Skip the file copy if either target file or ERB equivalent exists.
+          # This means that any files already in place in the work directory as a
+          # result of being copied from the project specific area will not be
+          # overritten.
+          next if File.exists?(Pathname.new(target_dir) + File.basename(file))
+          next if File.exists?(Pathname.new(target_dir) + File.basename(file, ".erb"))
+          FileUtils.cp(file, target_dir, :verbose => verbose)
+        end
+      end
+
+      # Method to transform ERB templates in the work directory.
+      #
+      # @param workdir [String] working directory to stage the evaluated templates in
+      # @param binding [Binding] binding to use in evaluating the packaging templates
+      def process_templates(wixworkdir, binding)
+        files = Dir.glob(File.join(wixworkdir, "**/*.erb"))
+        files.each do |file|
+          erb_file(file, File.join(File.dirname(file), File.basename(file, ".erb")), false, { :binding => binding })
+          FileUtils.rm(file)
+        end
       end
 
       # Method to generate the files required to build a nuget package for the project
@@ -103,23 +163,34 @@ class Vanagon
       # @return [Array] list of commands required to build an msi package for the given project from a tarball
       def generate_msi_package(project)
         target_dir = project.repo ? output_dir(project.repo) : output_dir
-        cg_name = "compfiles"
-        dir_ref = "INSTALLDIR"
+        cg_name = "ProductComponentGroup"
+        wix_extensions =  "-ext WiXUtilExtension -ext WixUIExtension"
+        candle_flags =  "-dPlatform=#{@architecture} -arch #{@architecture} #{wix_extensions}"
+        # Enable verbose mode for the moment (will be removed for production)
+        # localisation flags to be added
+        light_flags = "-v -cultures:en-us #{wix_extensions}"
         # Actual array of commands to be written to the Makefile
         ["mkdir -p output/#{target_dir}",
-        "mkdir -p $(tempdir)/staging",
-        "gunzip -c #{project.name}-#{project.version}.tar.gz | '#{@tar}' -C '$(tempdir)/staging' --strip-components 1 -xf -",
-        # Run the Heat command in a single pass
-        # Heat command documentation at: http://wixtoolset.org/documentation/manual/v3/overview/heat.html
-        #   dir <directory> - Traverse directory to find all sub-files and directories.
-        #   -ke             - Keep Empty directories
-        #   -cg             - Component Group Name
-        #   -gg             - Generate GUIDS now
-        #   -dr             - Directory reference to root directories (cannot contains spaces e.g. -dr MyAppDirRef)
-        #   -sreg           - Suppress registry harvesting.
-        #   -var <variable> - Substitute File/@Source="SourceDir" with a preprocessor or a wix variable
-        "cd $(tempdir); \"$$WIX/bin/heat.exe\" dir staging -v -ke -indent 2 -cg #{cg_name} -gg -dr #{dir_ref} -sreg -var var.StageDir -out wix/#{project.name}-harvest.wxs",
-        ]
+          "mkdir -p $(tempdir)/{SourceDir,wix/wixobj}",
+          "#{@copy} -r wix/* $(tempdir)/wix/",
+          "gunzip -c #{project.name}-#{project.version}.tar.gz | '#{@tar}' -C '$(tempdir)/SourceDir' --strip-components 1 -xf -",
+          # Run the Heat command in a single pass
+          # Heat command documentation at: http://wixtoolset.org/documentation/manual/v3/overview/heat.html
+          #   dir <directory> - Traverse directory to find all sub-files and directories.
+          #   -ke             - Keep Empty directories
+          #   -cg             - Component Group Name
+          #   -gg             - Generate GUIDS now
+          #   -srd            - Suppress root element generation, we want to reference the default root element
+          #                     TARGETDIR in the project.wxs file, not a newly generated one.
+          #   -sreg           - Suppress registry harvesting.
+          "cd $(tempdir); \"$$WIX/bin/heat.exe\" dir SourceDir -v -ke -indent 2 -cg #{cg_name} -gg -srd -t wix/filter.xslt -sreg -out wix/#{project.name}-harvest.wxs",
+          # Apply Candle command to all *.wxs files - generates .wixobj files in wix directory.
+          # cygpath conversion is necessary as candle is unable to handle posix path specs
+          "cd $(tempdir)/wix/wixobj; for wix_file in `find $(tempdir)/wix -name \'*.wxs\'`; do \"$$WIX/bin/candle.exe\" #{candle_flags} $$(cygpath -aw $$wix_file) || exit 1; done",
+          # run all wix objects through light to produce the msi
+          # the -b flag simply points light to where the SourceDir location is
+          "cd $(tempdir)/wix/wixobj; \"$$WIX/bin/light.exe\" #{light_flags} -b $$(cygpath -aw $(tempdir)) -out $$(cygpath -aw $(workdir)/output/#{target_dir}/#{msi_package_name(project)}) *.wixobj",
+          ]
       end
 
       # Method to derive the msi (Windows Installer) package name for the project.

data/lib/vanagon/utilities.rb

@@ -266,14 +266,33 @@ class Vanagon
 
     # Runs the command on the local host
     #
-    # @param command [String] command to run on the target
-    # @return [true] Returns true if the command was successful
+    # @param command [String] command to run locally
+    # @param return_command_output [Boolean] whether or not command output should be returned
+    # @return [true, String] Returns true if the command was successful or the
+    #                        output of the command if return_command_output is true
     # @raise [RuntimeError] If the command fails an exception is raised
-    def local_command(command, workdir)
-      puts "Executing '#{command}' locally in #{workdir}"
-      Kernel.system(command, :chdir => workdir)
-      $?.success? or raise "Local command (#{command}) failed."
+    def local_command(command, return_command_output: false)
+      clean_environment do
+        puts "Executing '#{command}' locally"
+        if return_command_output
+          ret = %x(#{command}).chomp
+          if $?.success?
+            return ret
+          else
+            raise "Local command (#{command}) failed."
+          end
+        else
+          Kernel.system(command)
+          $?.success? or raise "Local command (#{command}) failed."
+        end
+      end
+    end
+
+    def clean_environment(&block)
+      return Bundler.with_clean_env { yield } if defined?(Bundler)
+      yield
     end
+    private :clean_environment
 
     # Helper method that takes a template file and runs it through ERB
     #

data/resources/rpm/project.spec.erb

@@ -118,10 +118,10 @@ done
 %pre
 # Save state so we know later if this is an upgrade or an install
 mkdir -p %{_localstatedir}/lib/rpm-state/%{name}
-if [ $1 -eq 1 ] ; then
+if [ "$1" -eq 1 ] ; then
   touch %{_localstatedir}/lib/rpm-state/%{name}/install
 fi
-if [ $1 -eq 2 ] ; then
+if [ "$1" -gt 1 ] ; then
   touch %{_localstatedir}/lib/rpm-state/%{name}/upgrade
 fi
 
@@ -132,12 +132,12 @@ fi
 <%- end -%>
 
 # Run preinstall scripts on install if defined
-if [ $1 -eq 1 ] ; then
+if [ "$1" -eq 1 ] ; then
   <%= get_preinstall_actions("install") %>
 fi
 
 # Run preinstall scripts on upgrade if defined
-if [ $1 -eq 2 ] ; then
+if [ "$1" -gt 1 ] ; then
   <%= get_preinstall_actions("upgrade") %>
 fi
 
@@ -146,14 +146,9 @@ fi
 <%- if @platform.is_aix? || (@platform.is_el? && @platform.os_version.to_i == 4) -%>
 ## EL-4 and AIX RPM don't have %posttrans, so we'll put them here
 # Run postinstall scripts on install if defined
-if [ $1 -eq 1 ] ; then
+if [ "$1" -eq 1 ] ; then
   <%= get_postinstall_actions("install") %>
 fi
-
-# Run postinstall scripts on upgrade if defined
-if [ $1 -eq 2 ] ; then
-  <%= get_postinstall_actions("upgrade") %>
-fi
 <%- end -%>
 <%- get_services.each do |service| -%>
   # switch based on systemd vs systemv vs smf vs aix
@@ -178,12 +173,12 @@ fi
 
 %postun
 # Run post-uninstall scripts on upgrade if defined
-if [ $1 -eq 1 ] ; then
+if [ "$1" -eq 1 ] ; then
   <%= get_postremove_actions("upgrade") %>
 fi
 
 # Run post-uninstall scripts on removal if defined
-if [ $1 -eq 0 ] ; then
+if [ "$1" -eq 0 ] ; then
   <%= get_postremove_actions("removal") %>
 fi
 
@@ -197,26 +192,30 @@ fi
       %systemd_postun_with_restart <%= service.name %>.service
     <%- end -%>
   <%- elsif @platform.servicetype == "sysv" -%>
-    if [ $1 -ge 1 ]; then
+    if [ "$1" -eq 1 ]; then
       /sbin/service <%= service.name %> condrestart || :
     fi
   <%- elsif @platform.servicetype == "aix" -%>
-    if  [ $1 -eq 0 ]; then
+    if  [ "$1" -eq 0 ]; then
       /usr/bin/rmssys -s <%= service.name -%> > /dev/null 2>&1 || :
       /usr/sbin/rmitab <%= service.name -%> > /dev/null 2>&1 || :
     fi
+    # Run postinstall scripts on upgrade if defined
+    if [ "$1" -eq 1 ] ; then
+      <%= get_postinstall_actions("upgrade") %>
+    fi
   <%- end -%>
 <%- end -%>
 
 
 %preun
 # Run pre-uninstall scripts on upgrade if defined
-if [ $1 -eq 1 ] ; then
+if [ "$1" -eq 1 ] ; then
   <%= get_preremove_actions("upgrade") %>
 fi
 
 # Run pre-uninstall scripts on removal if defined
-if [ $1 -eq 0 ] ; then
+if [ "$1" -eq 0 ] ; then
   <%= get_preremove_actions("removal") %>
 fi
 
@@ -228,12 +227,14 @@ fi
       %systemd_preun <%= service.name %>.service
     <%- end -%>
   <%- elsif @platform.servicetype == "sysv" -%>
-    if [ $1 = 0 ]; then
+    if [ "$1" -eq 0 ]; then
       /sbin/service <%= service.name %> stop >/dev/null 2>&1 || :
       chkconfig --del <%= service.name %> || :
     fi
   <%- elsif @platform.servicetype == "aix" -%>
-    /usr/bin/stopsrc -s <%= service.name -%> > /dev/null 2>&1 || :
+    if [ "$1" -eq 0 ]; then
+      /usr/bin/stopsrc -s <%= service.name -%> > /dev/null 2>&1 || :
+    fi
   <%- end -%>
 <%- end -%>
 

data/resources/windows/nuget/chocolateyInstall.ps1

@@ -23,6 +23,14 @@ foreach ($destination in $lines) {
     # we assume it is an empty directory and simply create one in its place. There is
     # a possibility that this will hide an error where there is actually a missing
     # file. However, this is such a slim possibity, this action was deemed safe.
-    New-Item -ItemType directory -Path "$destination"
+    if (Test-Path -path "$destination") {
+      if (Test-Path -path "$destination" -pathType container) {
+        Write-Debug "Directory '$destination' already exists"
+      } else {
+        Throw "File '$destination' exists and is not a directory, cannot proceed with install"
+      }
+    } else {
+      New-Item -ItemType directory -Path "$destination"
+    }
   }
 }

data/resources/windows/wix/componentrefs.wxs.erb

@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='windows-1252'?>
+<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi' xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
+
+  <Fragment>
+    <ComponentGroup Id="ServiceListGroup">
+      <%- get_services.each do |service| -%>
+      <ComponentGroupRef Id="Service_<%= service.id %>" />
+      <%- end -%>
+    </ComponentGroup>
+  </Fragment>
+</Wix>

data/resources/windows/wix/filter.xslt.erb

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsl:stylesheet version="1.0"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:wix="http://schemas.microsoft.com/wix/2006/wi">
+  <!-- https://ahordijk.wordpress.com/2013/03/26/automatically-add-references-and-content-to-the-wix-installer/ -->
+  <!-- http://www.chriskonces.com/using-xslt-with-heat-exe-wix-to-create-windows-service-installs/ -->
+  <xsl:output method="xml" indent="yes" />
+  <!--<xsl:strip-space elements="*"/>-->
+  <xsl:template match="@*|node()">
+    <xsl:copy>
+      <xsl:apply-templates select="@*|node()"/>
+    </xsl:copy>
+  </xsl:template>
+  <!-- Filter out all Service File Executables from the Harvest (heat) run as these are specified in the transformed service.components.wxs file -->
+  <!-- The list of component service files are collected in an array so that a set of unique names can be extracted -->
+  <%- service_files = Array.new -%>
+  <%- get_services.each do |service| -%>
+    <%- service_files << service.service_file -%>
+  <%- end -%>
+  <%- service_files.uniq.each do |service_file| -%>
+    <xsl:template match="wix:Component[wix:File[@Source='<%= service_file %>']]" />
+  <%- end -%>
+</xsl:stylesheet>

data/resources/windows/wix/project.wxs.erb

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="windows-1252"?>
+<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi" xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
+  <Product
+    Id="*"
+    UpgradeCode="<%= settings[:upgrade_code] %>"
+    Name="<%= settings[:product_name] %>"
+    Language="1033"
+    Codepage="1252"
+    Version="<%= @version.sub(/\.g[0-9a-z]{7}$/, '') %>"
+    Manufacturer="<%= settings[:company_name] %>" >
+
+    <Package
+      InstallerVersion="300"
+      InstallScope="perMachine"
+      Description="<%= "#{settings[:product_id]}#{@platform.architecture == "x64" ? " (64-bit)" : ""}" %> Installer"
+      Comments="<%= @homepage %>"
+      Compressed="yes"
+      Platform="<%= @platform.architecture %>"
+    />
+
+    <MajorUpgrade AllowDowngrades="yes" />
+    <Media Id="1" Cabinet="<%= settings[:product_id] %>.cab" EmbedCab="yes" CompressionLevel="high" />
+
+    <Feature Id="<%= settings[:product_id] %>Runtime" Title="<%= settings[:product_id] %> Runtime" Level="1">
+      <!-- We can add all components by referencing this one thing -->
+      <ComponentGroupRef Id="ProductComponentGroup" />
+      <ComponentGroupRef Id="RegistryComponentGroup" />
+      <ComponentGroupRef Id="ServiceListGroup" />
+    </Feature>
+    <!-- We will use DirectoryRef at the project level to hook in the project directory structure -->
+    <Directory Id='TARGETDIR' Name='SourceDir' />
+
+  </Product>
+</Wix>

data/resources/windows/wix/registryEntries.wxs.erb

@@ -0,0 +1,18 @@
+<?xml version='1.0' encoding='windows-1252'?>
+<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi' xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
+  <Fragment>
+    <ComponentGroup Id="RegistryComponentGroup">
+        <Component Id="RegistryEntriesArchitectureDependent" Directory="TARGETDIR" Guid="E6D5AF4F-ACC4-4D11-AFCE-299A9ED2152C" Win64="<%= settings[:win64] %>" Permanent="yes">
+          <RegistryKey Root="HKLM" Key="SOFTWARE\<%= settings[:company_name] %>\<%= settings[:product_name] %>" ForceCreateOnInstall="yes" >
+            <RegistryValue Type="integer" Value="0"/>
+            <%- if @platform.architecture == "x64" -%>
+            <RegistryValue Name="RememberedInstallDir" Type="string" Value="[INSTALLDIR_X86]" />
+            <RegistryValue Name="RememberedInstallDir64" Type="string" Value="[INSTALLDIR]" KeyPath="yes" />
+            <%- else %>
+            <RegistryValue Name="RememberedInstallDir" Type="string" Value="[INSTALLDIR]"  KeyPath="yes" />
+            <%- end -%>
+          </RegistryKey>
+        </Component>
+    </ComponentGroup>
+  </Fragment>
+</Wix>

data/spec/fixtures/wix/resources/windows/wix/file-1.wxs

@@ -0,0 +1 @@
+# Wix Test File 1

data/spec/fixtures/wix/resources/windows/wix/file-2.wxs

@@ -0,0 +1 @@
+# Wix Test File 2

data/spec/fixtures/wix/resources/windows/wix/file-3.wxs.erb

@@ -0,0 +1 @@
+# ERB Wix Test File 3

data/spec/fixtures/wix/resources/windows/wix/file-4.wxs.erb

@@ -0,0 +1 @@
+# ERB Wix Test File 4

data/spec/fixtures/wix/resources/windows/wix/include/include-sample-1.wxs

@@ -0,0 +1 @@
+# Sample Include file

data/spec/fixtures/wix/resources/windows/wix/project.filter.xslt.erb

@@ -0,0 +1 @@
+# Null ERB File for testing

data/spec/fixtures/wix/resources/windows/wix/project.wxs

@@ -0,0 +1,2 @@
+# Test file for Vanagon/Wix unit testing.
+# This file will "over-ride" the generic Product.wix.erb file

data/spec/fixtures/wix/resources/windows/wix/ui/ui-sample-1.wxs

@@ -0,0 +1 @@
+# This is a sample UI wxs file

data/spec/lib/vanagon/component/dsl_spec.rb

@@ -5,12 +5,12 @@ require 'json'
 describe 'Vanagon::Component::DSL' do
   let (:component_block) {
 "component 'test-fixture' do |pkg, settings, platform|
-  pkg.load_from_json('spec/fixures/component/test-fixture.json')
+  pkg.load_from_json('spec/fixtures/component/test-fixture.json')
 end" }
 
   let (:invalid_component_block) {
 "component 'test-fixture' do |pkg, settings, platform|
-  pkg.load_from_json('spec/fixures/component/invalid-test-fixture.json')
+  pkg.load_from_json('spec/fixtures/component/invalid-test-fixture.json')
 end" }
 
   let (:dummy_platform_sysv) {
@@ -405,7 +405,7 @@ end" }
 
     it 'reads from a file when the OS is AIX for services' do
       comp = Vanagon::Component::DSL.new('service-test', {}, dummy_platform_aix)
-      comp.install_service('spec/fixures/component/mcollective.service', nil, 'mcollective')
+      comp.install_service('spec/fixtures/component/mcollective.service', nil, 'mcollective')
       expect(comp._component.service.name).to eq('mcollective')
       expect(comp._component.service.service_command).to include('/opt/puppetlabs/puppet/bin/ruby')
       expect(comp._component.service.service_command).not_to include("\n")

data/spec/lib/vanagon/engine/hardware_spec.rb

@@ -4,7 +4,11 @@ require 'vanagon/platform'
 require 'logger'
 
 # Haus, I added this, cause it prevented errors.
-@@logger = Logger.new('/dev/null')
+class Vanagon
+  class Driver
+    @@logger = Logger.new('/dev/null')
+  end
+end
 
 describe 'Vanagon::Engine::Hardware' do
 

data/spec/lib/vanagon/engine/local_spec.rb

@@ -0,0 +1,27 @@
+require 'vanagon/engine/local'
+
+describe 'Vanagon::Engine::Local' do
+  let (:platform) {
+    plat = Vanagon::Platform::DSL.new('debian-6-i386')
+    plat.instance_eval("platform('debian-6-i386') {  }")
+    plat._platform
+  }
+
+  describe '#validate_platform' do
+    it 'succeeds' do
+      expect(Vanagon::Engine::Local.new(platform).validate_platform).to be(true)
+    end
+  end
+
+  describe '#dispatch' do
+    it 'execs successfully' do
+      engine = Vanagon::Engine::Local.new(platform)
+      expect(engine.dispatch('true')).to be(true)
+    end
+
+    it 'returns the result if return_output is true' do
+      engine = Vanagon::Engine::Local.new(platform)
+      expect(engine.dispatch('true', true)).to eq('')
+    end
+  end
+end

data/spec/lib/vanagon/platform/windows_spec.rb

@@ -1,5 +1,20 @@
 require 'vanagon/platform'
 
+# These constants are defined for the purpose of the project/generic file merge tests
+# to point these directories to test areas under the /tmp directory.
+# This allows individual test cases to be specified accurately.
+# The actual resources/windows/wix files under vanagon are avoided, as the necessary
+# data structures are not available under the test conditions causing failures in the
+# ERB template translation
+
+WORK_BASE = "/tmp/vanwintest"
+VANAGON_ROOT = "#{WORK_BASE}/generic"
+PROJ_ROOT = "#{WORK_BASE}/project"
+WORKDIR = "#{WORK_BASE}/workdir"
+# Admittedly this might not be the best placed statement, but my limited rspec
+# started to defeat me when it came to using "let" for wixtestfiles
+WIXTESTFILES = File.expand_path("./spec/fixtures/wix/resources/windows/wix")
+
 describe "Vanagon::Platform::Windows" do
   platforms =[
     {
@@ -10,6 +25,7 @@ describe "Vanagon::Platform::Windows" do
       :output_dir             => "windows/x64",
       :output_dir_with_target => "windows/thing/x64",
       :target_user            => "Administrator",
+      :projname               => "test-proj",
       :block                  => %Q[ platform "windows-2012r2-x64" do |plat| end ]
     },
   ]
@@ -38,6 +54,113 @@ describe "Vanagon::Platform::Windows" do
           expect(cur_plat._platform.target_user).to eq(plat[:target_user])
         end
       end
+
+      describe '#generate_msi_packaging_artifacts' do
+        before(:each) do
+          # Create Workdir and temp root directory
+          FileUtils.mkdir_p("#{WORKDIR}/wix")
+          FileUtils.mkdir_p("#{VANAGON_ROOT}/resources/windows/wix")
+          FileUtils.mkdir_p("#{PROJ_ROOT}/resources/windows/wix")
+          # Switch directory so that project specific folder points to tmp area
+          @pwd = Dir.pwd
+          Dir.chdir(PROJ_ROOT)
+        end
+        after(:each) do
+          # Cleanup the complete work directory tree
+          FileUtils.rm_rf("#{WORK_BASE}")
+          Dir.chdir(@pwd)
+        end
+
+        it "Copies Wix File from product specific directory to output directory" do
+          # setup source directories and run artifact generation
+          FileUtils.cp("#{WIXTESTFILES}/file-1.wxs", "#{PROJ_ROOT}/resources/windows/wix/file-1.wxs")
+          cur_plat._platform.generate_msi_packaging_artifacts(WORKDIR, plat[:projname], binding)
+          # check the result
+          expect(File).to exist("#{WORKDIR}/wix/file-1.wxs")
+        end
+
+        it "Copies Wix File from Vanagon directory to work directory" do
+          # setup source directories and run artifact generation
+          FileUtils.cp("#{WIXTESTFILES}/file-1.wxs", "#{VANAGON_ROOT}/resources/windows/wix/file-1.wxs")
+          cur_plat._platform.generate_msi_packaging_artifacts(WORKDIR, plat[:projname], binding)
+          # check the result
+          expect(File).to exist("#{WORKDIR}/wix/file-1.wxs")
+        end
+
+        it "Picks Project Specific Wix File in favour of Generic Wix file" do
+          # setup source directories and run artifact generation
+          FileUtils.cp("#{WIXTESTFILES}/file-1.wxs", "#{PROJ_ROOT}/resources/windows/wix/file-wix.wxs")
+          FileUtils.cp("#{WIXTESTFILES}/file-2.wxs", "#{VANAGON_ROOT}/resources/windows/wix/file-wix.wxs")
+          cur_plat._platform.generate_msi_packaging_artifacts(WORKDIR, plat[:projname], binding)
+          # check the result
+          expect(FileUtils.compare_file("#{WIXTESTFILES}/file-1.wxs", "#{WORKDIR}/wix/file-wix.wxs")).to be_truthy
+        end
+
+        it "Picks Project Specific Wix File in favour of Generic ERB file" do
+          # setup source directories and run artifact generation
+          FileUtils.cp("#{WIXTESTFILES}/file-1.wxs", "#{PROJ_ROOT}/resources/windows/wix/file-wix.wxs")
+          FileUtils.cp("#{WIXTESTFILES}/file-3.wxs.erb", "#{VANAGON_ROOT}/resources/windows/wix/file-wix.wxs.erb")
+          cur_plat._platform.generate_msi_packaging_artifacts(WORKDIR, plat[:projname], binding)
+          # check the result
+          expect(FileUtils.compare_file("#{WIXTESTFILES}/file-1.wxs", "#{WORKDIR}/wix/file-wix.wxs")).to be_truthy
+        end
+
+        it "Picks Project Specific ERB File in favour of Generic Wix file" do
+          # setup source directories and run artifact generation
+          FileUtils.cp("#{WIXTESTFILES}/file-3.wxs.erb", "#{PROJ_ROOT}/resources/windows/wix/file-wix.wxs.erb")
+          FileUtils.cp("#{WIXTESTFILES}/file-2.wxs", "#{VANAGON_ROOT}/resources/windows/wix/file-wix.wxs")
+          cur_plat._platform.generate_msi_packaging_artifacts(WORKDIR, plat[:projname], binding)
+          # check the result
+          expect(FileUtils.compare_file("#{WIXTESTFILES}/file-3.wxs.erb", "#{WORKDIR}/wix/file-wix.wxs")).to be_truthy
+        end
+
+        it "Picks Project Specific ERB File in favour of Generic ERB file" do
+          # setup source directories and run artifact generation
+          FileUtils.cp("#{WIXTESTFILES}/file-3.wxs.erb", "#{PROJ_ROOT}/resources/windows/wix/file-wix.wxs.erb")
+          FileUtils.cp("#{WIXTESTFILES}/file-4.wxs.erb", "#{VANAGON_ROOT}/resources/windows/wix/file-wix.wxs.erb")
+          cur_plat._platform.generate_msi_packaging_artifacts(WORKDIR, plat[:projname], binding)
+          # check the result
+          expect(FileUtils.compare_file("#{WIXTESTFILES}/file-3.wxs.erb", "#{WORKDIR}/wix/file-wix.wxs")).to be_truthy
+        end
+
+        it "Copies Hierarchy of files from Product Specific Directory to output directory with ERB translation as necessary" do
+          # setup source directories and run artifact generation
+          FileUtils.cp_r("#{WIXTESTFILES}/", "#{PROJ_ROOT}/resources/windows/", :verbose => true)
+          cur_plat._platform.generate_msi_packaging_artifacts(WORKDIR, plat[:projname], binding)
+          # check the result
+          expect(File).to exist("#{WORKDIR}/wix/file-1.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/file-2.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/file-3.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/file-4.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/project.filter.xslt")
+          expect(File).to exist("#{WORKDIR}/wix/project.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/include/include-sample-1.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/ui/ui-sample-1.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/ui/bitmaps/bitmap.bmp")
+          expect(File).not_to exist("#{WORKDIR}/wix/project.filter.xslt.erb")
+          expect(File).not_to exist("#{WORKDIR}/wix/file-3.wxs.erb")
+          expect(File).not_to exist("#{WORKDIR}/wix/file-4.wxs.erb")
+        end
+
+        it "Copies Hierarchy of files from vanagon directory to output directory with ERB translation as necessary" do
+          # setup source directories and run artifact generation
+          FileUtils.cp_r("#{WIXTESTFILES}/", "#{VANAGON_ROOT}/resources/windows/", :verbose => true)
+          cur_plat._platform.generate_msi_packaging_artifacts(WORKDIR, plat[:projname], binding)
+          # check the result
+          expect(File).to exist("#{WORKDIR}/wix/file-1.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/file-2.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/file-3.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/file-4.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/project.filter.xslt")
+          expect(File).to exist("#{WORKDIR}/wix/project.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/include/include-sample-1.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/ui/ui-sample-1.wxs")
+          expect(File).to exist("#{WORKDIR}/wix/ui/bitmaps/bitmap.bmp")
+          expect(File).not_to exist("#{WORKDIR}/wix/project.filter.xslt.erb")
+          expect(File).not_to exist("#{WORKDIR}/wix/file-3.wxs.erb")
+          expect(File).not_to exist("#{WORKDIR}/wix/file-4.wxs.erb")
+        end
+      end
     end
   end
 end

data/spec/lib/vanagon/utilities_spec.rb

@@ -41,6 +41,17 @@ describe "Vanagon::Utilities" do
     end
   end
 
+  describe '#local_command' do
+    it 'runs commands in an unpolluted environment' do
+      cmd = lambda { |arg| %(echo 'if [ "$#{arg}" = "" ]; then exit 0; else exit 1; fi' | /bin/sh) }
+      vars = %w(BUNDLE_BIN_PATH BUNDLE_GEMFILE)
+      vars.each do |var|
+        Vanagon::Utilities.local_command(cmd.call(var))
+        expect($?.exitstatus).to eq(0)
+      end
+    end
+  end
+
   describe "#is_git_repo?" do
     let(:dir) { Dir.mktmpdir }
     after(:each) { FileUtils.rm_rf(dir) }

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+RSpec.configure do |c|
+  c.before do
+    allow($stdout).to receive(:puts)
+    allow($stderr).to receive(:puts)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanagon
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -132,10 +132,22 @@ files:
 - resources/windows/nuget/chocolateyInstall.ps1
 - resources/windows/nuget/chocolateyUninstall.ps1
 - resources/windows/nuget/project.nuspec.erb
-- resources/windows/wix/service.component.wxs.erb
-- spec/fixures/component/invalid-test-fixture.json
-- spec/fixures/component/mcollective.service
-- spec/fixures/component/test-fixture.json
+- resources/windows/wix/componentrefs.wxs.erb
+- resources/windows/wix/filter.xslt.erb
+- resources/windows/wix/project.wxs.erb
+- resources/windows/wix/registryEntries.wxs.erb
+- spec/fixtures/component/invalid-test-fixture.json
+- spec/fixtures/component/mcollective.service
+- spec/fixtures/component/test-fixture.json
+- spec/fixtures/wix/resources/windows/wix/file-1.wxs
+- spec/fixtures/wix/resources/windows/wix/file-2.wxs
+- spec/fixtures/wix/resources/windows/wix/file-3.wxs.erb
+- spec/fixtures/wix/resources/windows/wix/file-4.wxs.erb
+- spec/fixtures/wix/resources/windows/wix/include/include-sample-1.wxs
+- spec/fixtures/wix/resources/windows/wix/project.filter.xslt.erb
+- spec/fixtures/wix/resources/windows/wix/project.wxs
+- spec/fixtures/wix/resources/windows/wix/ui/bitmaps/bitmap.bmp
+- spec/fixtures/wix/resources/windows/wix/ui/ui-sample-1.wxs
 - spec/lib/makefile_spec.rb
 - spec/lib/vanagon/common/pathname_spec.rb
 - spec/lib/vanagon/common/user_spec.rb
@@ -148,6 +160,7 @@ files:
 - spec/lib/vanagon/engine/base_spec.rb
 - spec/lib/vanagon/engine/docker_spec.rb
 - spec/lib/vanagon/engine/hardware_spec.rb
+- spec/lib/vanagon/engine/local_spec.rb
 - spec/lib/vanagon/engine/pooler_spec.rb
 - spec/lib/vanagon/optparse_spec.rb
 - spec/lib/vanagon/platform/deb_spec.rb
@@ -161,6 +174,7 @@ files:
 - spec/lib/vanagon/project_spec.rb
 - spec/lib/vanagon/utilities/shell_utilities_spec.rb
 - spec/lib/vanagon/utilities_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/puppetlabs/vanagon
 licenses:
 - Apache-2.0
@@ -198,6 +212,7 @@ test_files:
 - spec/lib/vanagon/engine/base_spec.rb
 - spec/lib/vanagon/engine/docker_spec.rb
 - spec/lib/vanagon/engine/hardware_spec.rb
+- spec/lib/vanagon/engine/local_spec.rb
 - spec/lib/vanagon/engine/pooler_spec.rb
 - spec/lib/vanagon/optparse_spec.rb
 - spec/lib/vanagon/platform/deb_spec.rb

data/resources/windows/wix/service.component.wxs.erb

@@ -1,55 +0,0 @@
-<?xml version='1.0' encoding='windows-1252'?>
-<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi' xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
-  <Fragment>
-  <%- get_services.each do |service| -%>
-    <%- service.options.each do |component| -%>
-    <DirectoryRef Id="<%= component[:directory_ref] %>">
-      <Component Id='<%= component[:id] %>' Guid="<%= component[:guid] %>" <%= "Win64=\"#{component[:win64]}\"" unless component[:win64].nil? %>>
-        <%- unless component[:conditions].nil? -%>
-          <%- component[:conditions].each do |condition| -%>
-        <Condition>
-          <%= condition %>
-        </Condition>
-          <%- end -%>
-        <%- end -%>
-        <File Id="<%= component[:file][:id] %>" KeyPath="yes" Source="<%= component[:file][:source] %>" />
-        <ServiceInstall Id="<%= component[:serviceinstall][:id] %>"
-          Account="[PUPPET_AGENT_ACCOUNT_DOMAIN]\[PUPPET_AGENT_ACCOUNT_USER]"
-          Password="[PUPPET_AGENT_ACCOUNT_PASSWORD]"
-          Description="<%= component[:serviceinstall][:description] %>"
-          DisplayName="<%= component[:serviceinstall][:displayname] %>"
-          Interactive="no"
-          Name="<%= component[:serviceinstall][:name] %>"
-          Start="<%= component[:serviceinstall][:start] %>"
-          Type="ownProcess"
-          ErrorControl="normal"
-          Vital="yes"
-          <%- unless component[:serviceinstall][:arguments].nil? -%>
-          Arguments="<%= component[:serviceinstall][:arguments] %>"
-          <%- end -%>
-        />
-        <%- unless component[:registries].nil? -%>
-        <RegistryKey Root="<%= component[:registries][:root] %>" Key="<%= component[:registries][:key] %>">
-        <%- unless component[:registries][:values].nil? -%>
-          <%- component[:registries][:values].each do |value|  -%>
-          <RegistryValue Name="<%= value[:name] %>" Value="<%= value[:value] %>" Type="<%= value[:type] %>" <%= "Action=\"#{value[:action]}\"" unless value[:action].nil? %> />
-          <%- end -%>
-        <%- end -%>
-        <%- unless component[:registries][:keys].nil? -%>
-          <%- component[:registries][:keys].each do |key| -%>
-          <RegistryKey Key="<%= key[:name] %>">
-            <%- key[:values].each do |value| -%>
-            <RegistryValue <%= "Name=\"#{value[:name]}\"" unless value[:name].nil? %> Value="<%= value[:value] %>" Type="<%= value[:type] %>" />
-            <%- end -%>
-          </RegistryKey>
-          <%- end -%>
-        <%- end -%>
-        </RegistryKey>
-        <%- end -%>
-        <ServiceControl Id="<%= component[:servicecontrol][:id] %>" <%= "Start=\"#{component[:servicecontrol][:start]}\"" unless component[:servicecontrol][:start].nil? %> Stop="both" Remove="uninstall" Name="<%= component[:servicecontrol][:name] %>" Wait="yes" />
-      </Component>
-    </DirectoryRef>
-    <%- end -%>
-  <%- end -%>
-  </Fragment>
-</Wix>