omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/packagers/makeself.rb

@@ -0,0 +1,114 @@
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Omnibus
+  class Packager::Makeself < Packager::Base
+    id :makeself
+
+    setup do
+      # Copy the full-stack installer into our scratch directory, accounting for
+      # any excluded files.
+      #
+      # /opt/hamlet => /tmp/daj29013
+      FileSyncer.sync(project.install_dir, staging_dir, exclude: exclusions)
+    end
+
+    build do
+      # Render the post_extract file
+      write_post_extract_file
+
+      # Create the makeself archive
+      create_makeself_package
+    end
+
+    # @see Base#package_name
+    def package_name
+      "#{project.name}-#{project.build_version}_#{project.build_iteration}.#{safe_architecture}.run"
+    end
+
+    #
+    # The path to the makeself script - the default should almost always be
+    # fine!
+    #
+    # @return [String]
+    #
+    def makeself
+      resource_path('makeself.sh')
+    end
+
+    #
+    # The path to the makeself-header script - the default should almost always
+    # be fine!
+    #
+    # @return [String]
+    #
+    def makeself_header
+      resource_path('makeself-header.sh')
+    end
+
+    #
+    # Write the post-extraction file that will be executed upon extraction of
+    # the makeself file.
+    #
+    # @return [void]
+    #
+    def write_post_extract_file
+      render_template(resource_path('post_extract.sh.erb'),
+        destination: File.join(staging_dir, 'post_extract.sh'),
+        mode: 0755,
+        variables: {
+          name:          project.name,
+          friendly_name: project.friendly_name,
+          install_dir:   project.install_dir,
+        }
+      )
+    end
+
+    #
+    # Run the actual makeself command, publishing the generated package.
+    #
+    # @return [void]
+    #
+    def create_makeself_package
+      log.info(log_key) { "Creating makeself package" }
+
+      Dir.chdir(staging_dir) do
+        shellout! <<-EOH.gsub(/^ {10}/, '')
+          #{makeself} \\
+            --header "#{makeself_header}" \\
+            --gzip \\
+            "#{staging_dir}" \\
+            "#{package_name}" \\
+            "#{project.description}" \\
+            "./post_extract.sh"
+        EOH
+      end
+
+      FileSyncer.glob("#{staging_dir}/*.run").each do |makeself|
+        copy_file(makeself, Config.package_dir)
+      end
+    end
+
+    #
+    # The architecture for this makeself package.
+    #
+    # @return [String]
+    #
+    def safe_architecture
+      Ohai['kernel']['machine']
+    end
+  end
+end

data/lib/omnibus/packagers/msi.rb

@@ -0,0 +1,346 @@
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Omnibus
+  class Packager::MSI < Packager::Base
+    id :msi
+
+    setup do
+      # Render the localization
+      write_localization_file
+
+      # Render the msi parameters
+      write_parameters_file
+
+      # Render the source file
+      write_source_file
+
+      # Copy all the staging assets from vendored Omnibus into the resources
+      # directory.
+      create_directory("#{resources_dir}/assets")
+      FileSyncer.glob("#{Omnibus.source_root}/resources/#{id}/assets/*").each do |file|
+        copy_file(file, "#{resources_dir}/assets/#{File.basename(file)}")
+      end
+
+      # Copy all assets in the user's project directory - this may overwrite
+      # files copied in the previous step, but that's okay :)
+      FileSyncer.glob("#{resources_path}/assets/*").each do |file|
+        copy_file(file, "#{resources_dir}/assets/#{File.basename(file)}")
+      end
+    end
+
+    build do
+      # Harvest the files with heat.exe, recursively generate fragment for
+      # project directory
+      Dir.chdir(staging_dir) do
+        shellout! <<-EOH.split.join(' ').squeeze(' ').strip
+          heat.exe dir "#{windows_safe_path(project.install_dir)}"
+            -nologo -srd -gg -cg ProjectDir
+            -dr PROJECTLOCATION
+            -var "var.ProjectSourceDir"
+            -out "project-files.wxs"
+        EOH
+
+        # Compile with candle.exe
+        shellout! <<-EOH.split.join(' ').squeeze(' ').strip
+          candle.exe
+            -nologo
+            #{wix_extension_switches(wix_candle_extensions)}
+            -dProjectSourceDir="#{windows_safe_path(project.install_dir)}" "project-files.wxs"
+            "#{windows_safe_path(staging_dir, 'source.wxs')}"
+        EOH
+
+        # Create the msi, ignoring the 204 return code from light.exe since it is
+        # about some expected warnings
+        shellout! <<-EOH.split.join(' ').squeeze(' ').strip
+          light.exe
+            -nologo
+            -ext WixUIExtension
+            #{wix_extension_switches(wix_light_extensions)}
+            -cultures:en-us
+            -loc "#{windows_safe_path(staging_dir, 'localization-en-us.wxl')}"
+            project-files.wixobj source.wixobj
+            -out "#{windows_safe_path(Config.package_dir, package_name)}"
+        EOH
+      end
+    end
+
+    #
+    # @!group DSL methods
+    # --------------------------------------------------
+
+    #
+    # Set or retrieve the upgrade code.
+    #
+    # @example
+    #   upgrade_code 'ABCD-1234'
+    #
+    # @param [Hash] val
+    #   the UpgradeCode to set
+    #
+    # @return [Hash]
+    #   the set UpgradeCode
+    #
+    def upgrade_code(val = NULL)
+      if null?(val)
+        @upgrade_code || raise(MissingRequiredAttribute.new(self, :upgrade_code, '2CD7259C-776D-4DDB-A4C8-6E544E580AA1'))
+      else
+        unless val.is_a?(String)
+          raise InvalidValue.new(:parameters, 'be a String')
+        end
+
+        @upgrade_code = val
+      end
+    end
+    expose :upgrade_code
+
+    #
+    # Set or retrieve the custom msi building parameters.
+    #
+    # @example
+    #   parameters {
+    #     'MagicParam' => 'ABCD-1234'
+    #   }
+    #
+    # @param [Hash] val
+    #   the parameters to set
+    #
+    # @return [Hash]
+    #   the set parameters
+    #
+    def parameters(val = NULL)
+      if null?(val)
+        @parameters || {}
+      else
+        unless val.is_a?(Hash)
+          raise InvalidValue.new(:parameters, 'be a Hash')
+        end
+
+        @parameters = val
+      end
+    end
+    expose :parameters
+
+    #
+    # Set the wix light extensions to load
+    #
+    # @example
+    #   wix_light_extension 'WixUtilExtension'
+    #
+    # @param [String] extension
+    #   A list of extensions to load
+    #
+    # @return [Array]
+    #   The list of extensions that will be loaded
+    #
+    def wix_light_extension(extension)
+      unless extension.is_a?(String)
+        raise InvalidValue.new(:wix_light_extension, 'be an String')
+      end
+
+      wix_light_extensions << extension
+    end
+    expose :wix_light_extension
+
+    #
+    # Set the wix candle extensions to load
+    #
+    # @example
+    #   wix_candle_extension 'WixUtilExtension'
+    #
+    # @param [String] extension
+    #   A list of extensions to load
+    #
+    # @return [Array]
+    #   The list of extensions that will be loaded
+    #
+    def wix_candle_extension(extension)
+      unless extension.is_a?(String)
+        raise InvalidValue.new(:wix_candle_extension, 'be an String')
+      end
+
+      wix_candle_extensions << extension
+    end
+    expose :wix_candle_extension
+
+    #
+    # @!endgroup
+    # --------------------------------------------------
+
+    # @see Base#package_name
+    def package_name
+      "#{project.name}-#{project.build_version}-#{project.build_iteration}.msi"
+    end
+
+    #
+    # The path where the MSI resources will live.
+    #
+    # @return [String]
+    #
+    def resources_dir
+      File.expand_path("#{staging_dir}/Resources")
+    end
+
+    #
+    # Write the localization file into the staging directory.
+    #
+    # @return [void]
+    #
+    def write_localization_file
+      render_template(resource_path('localization-en-us.wxl.erb'),
+        destination: "#{staging_dir}/localization-en-us.wxl",
+        variables: {
+          name:          project.name,
+          friendly_name: project.friendly_name,
+          maintainer:    project.maintainer,
+        }
+      )
+    end
+
+    #
+    # Write the parameters file into the staging directory.
+    #
+    # @return [void]
+    #
+    def write_parameters_file
+      render_template(resource_path('parameters.wxi.erb'),
+        destination: "#{staging_dir}/parameters.wxi",
+        variables: {
+          name:            project.name,
+          friendly_name:   project.friendly_name,
+          maintainer:      project.maintainer,
+          upgrade_code:    upgrade_code,
+          parameters:      parameters,
+          version:         msi_version,
+          display_version: msi_display_version,
+        }
+      )
+    end
+
+    #
+    # Write the source file into the staging directory.
+    #
+    # @return [void]
+    #
+    def write_source_file
+      paths = []
+
+      # Remove C:/
+      install_dir = project.install_dir.split('/')[1..-1].join('/')
+
+      # Grab all parent paths
+      Pathname.new(install_dir).ascend do |path|
+        paths << path.to_s
+      end
+
+      # Create the hierarchy
+      hierarchy = paths.reverse.inject({}) do |hash, path|
+        hash[File.basename(path)] = path.gsub(/[^[:alnum:]]/, '').upcase + 'LOCATION'
+        hash
+      end
+
+      # The last item in the path MUST be named PROJECTLOCATION or else space
+      # robots will cause permanent damage to you and your family.
+      hierarchy[hierarchy.keys.last] = 'PROJECTLOCATION'
+
+      # If the path hierarchy is > 1, the customizable installation directory
+      # should default to the second-to-last item in the hierarchy. If the
+      # hierarchy is smaller than that, then just use the system drive.
+      wix_install_dir = if hierarchy.size > 1
+        hierarchy.to_a[-2][1]
+      else
+        'WINDOWSVOLUME'
+      end
+
+      render_template(resource_path('source.wxs.erb'),
+        destination: "#{staging_dir}/source.wxs",
+        variables: {
+          name:          project.name,
+          friendly_name: project.friendly_name,
+          maintainer:    project.maintainer,
+          hierarchy:     hierarchy,
+
+          wix_install_dir: wix_install_dir,
+        }
+      )
+    end
+
+    #
+    # Parse and return the MSI version from the {Project#build_version}.
+    #
+    # A project's +build_version+ looks something like:
+    #
+    #     dev builds => 11.14.0-alpha.1+20140501194641.git.94.561b564
+    #                => 0.0.0+20140506165802.1
+    #
+    #     rel builds => 11.14.0.alpha.1 || 11.14.0
+    #
+    # The MSI version spec expects a version that looks like X.Y.Z.W where
+    # X, Y, Z & W are all 32 bit integers.
+    #
+    # @return [String]
+    #
+    def msi_version
+      versions = project.build_version.split(/[.+-]/)
+      "#{versions[0]}.#{versions[1]}.#{versions[2]}.#{project.build_iteration}"
+    end
+
+    #
+    # The display version calculated from the {Project#build_version}.
+    #
+    # @see #msi_version an explanation of the breakdown
+    #
+    # @return [String]
+    #
+    def msi_display_version
+      versions = project.build_version.split(/[.+-]/)
+      "#{versions[0]}.#{versions[1]}.#{versions[2]}"
+    end
+
+    #
+    # Returns the extensions to use for light
+    #
+    # @return [Array]
+    #   the extensions that will be loaded for light
+    #
+    def wix_light_extensions
+      @wix_light_extensions ||= []
+    end
+
+    #
+    # Returns the extensions to use for candle
+    #
+    # @return [Array]
+    #   the extensions that will be loaded for candle
+    #
+    def wix_candle_extensions
+      @wix_candle_extensions ||= []
+    end
+
+    #
+    # Takes an array of wix extension names and creates a string
+    # that can be passed to wix to load those.
+    #
+    # for example,
+    # ['a', 'b'] => "-ext 'a' -ext 'b'"
+    #
+    # @return [String]
+    #
+    def wix_extension_switches(arr)
+      "#{arr.map {|e| "-ext '#{e}'"}.join(' ')}"
+    end
+  end
+end