mixlib-install 0.7.1 → 0.8.0.alpha.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44b48b3b10f12bd9546d4d5c24c8b1dc632b215b
-  data.tar.gz: 34b56d0d2c05de9adba3e9e91d40783c040b43e1
+  metadata.gz: 1988cb752e5752ed1b0c356f95c821e1d3376570
+  data.tar.gz: 4a85a7442cc38bc55df9136f736eea91d6bd7bcd
 SHA512:
-  metadata.gz: e2a3813bcc897d90da0ada2c2c94910d5da49ce624d8ec930996556e768bfa8bf51aa5969ddd7bd89910287777ac700ab6b82092862dead759ed0a9bd8889ebe
-  data.tar.gz: b5efb4ed22f94acbc36d13a948d49465394e9581b1a7aa2ef8aae1a596f851144ee29760816dc90faf437112ffec448d9c0eddfee95149fd528aa3a9bba35cd2
+  metadata.gz: 5464fd31ead9f86d3665c156cafe93b72ca7413fa7f34911aaee22bfcbf9ed9ed2858ae78064387a7f49db5d0b5e04e4498107a1a1d8012ee2f77f10b5655472
+  data.tar.gz: b3867d25ee74bb1d72e418a135dfe7b881601fec995319ca139f7e9721da37d749340570055dc1901de55b9682bb5e22de10404861346af4202d9a3bacb1d8df

data/.gitignore

@@ -8,3 +8,6 @@
 /spec/reports/
 /tmp/
 tags
+.ruby-version
+.kitchen/
+.kitchen.local.yml

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+This project is maintained by the contribution guidelines identified for
+  [chef](https://github.com/chef/chef) project. You can find the guidelines here:
+
+https://github.com/chef/chef/blob/master/CONTRIBUTING.md
+
+Pull requests in this project are merged when they have two :+1:s from maintainers.
+
+## Maintainers
+
+
+- [Thom May](https://github.com/thommay)
+- [Patrick Wright](https://github.com/patrick-wright)
+- [Serdar Sutay](https://github.com/sersut)
+- [Seth Chisamore](https://github.com/schisamo)

data/Gemfile

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
 
 gem "finstyle"
+
 gemspec

data/README.md

@@ -1,34 +1,43 @@
 # Mixlib::Install
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mixlib/install`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
+## Usage
 
+### Get URL for specific platform and package version
 ```ruby
-gem 'mixlib-install'
+options = {
+  channel: :current,
+  product_name: 'chef',
+  product_version: :latest,
+  platform: 'mac_os_x',
+  platform_version: '10.9',
+  architecture: 'x86_64'
+}
+
+artifact = Mixlib::Install.new(options).artifact_info
+# => ArtifactInfo
+
+artifact.url
+# => "http://opscode-omnibus-packages-current.s3.amazonaws.com/mac_os_x/10.9/x86_64/chef-12.5.1%2B20151009083009-1.dmg"
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install mixlib-install
-
-## Usage
+### Get list of artifacts for all platforms given a package version
+```ruby
+options = {
+  channel: :current,
+  product_name: 'chef',
+  product_version: :latest
+}
 
-TODO: Write usage instructions here
+artifacts = Mixlib::Install.new(options).artifact_info
+# => Array<ArtifactInfo>
 
-## Development
+artifacts.first.url
+# => "http://opscode-omnibus-packages-current.s3.amazonaws.com/mac_os_x/10.9/x86_64/chef-12.5.1%2B20151009083009-1.dmg"
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Test
+Some tests are tagged `:unstable` and can only run when connected to Chef's internal network.  These are excluded by default.  To run the `:unstable` tests run: `bundle exec rspec --tag unstable`.
 
 ## Contributing
 

data/Rakefile

@@ -3,13 +3,17 @@ require "finstyle"
 require "rubocop/rake_task"
 require "rspec/core/rake_task"
 
-task default: :spec
+task default: :test
 
 desc "Run specs"
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
+desc "Run rubocop"
 RuboCop::RakeTask.new do |task|
   task.options << "--display-cop-names"
 end
+
+desc "Run all tests"
+task test: [:rubocop, :spec]

data/acceptance/.gitignore

@@ -0,0 +1,2 @@
+local-mode-cache/
+nodes/

data/acceptance/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem "mixlib-install", path: "../"
+gem "test-kitchen", github: "sersut/test-kitchen"
+gem "chef-acceptance", github: "chef/chef-acceptance"
+gem "pry"
+
+group(:development) do
+  gem "kitchen-vagrant"
+end

data/acceptance/Gemfile.lock

@@ -0,0 +1,57 @@
+GIT
+  remote: git://github.com/chef/chef-acceptance.git
+  revision: 2d1a192851a3731cb61f794d155ad2b156cdaec5
+  specs:
+    chef-acceptance (0.2.0)
+      thor (~> 0.19)
+
+GIT
+  remote: git://github.com/sersut/test-kitchen.git
+  revision: 5e4fa6baff5d51dc983be3f7b67ffe1bcbf2a8d2
+  specs:
+    test-kitchen (1.4.3.dev.0)
+      mixlib-install (~> 0.7)
+      mixlib-shellout (>= 1.2, < 3.0)
+      net-scp (~> 1.1)
+      net-ssh (~> 2.7, < 2.10)
+      safe_yaml (~> 1.0)
+      thor (~> 0.18)
+
+PATH
+  remote: ../
+  specs:
+    mixlib-install (0.8.0)
+      artifactory (~> 2.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    artifactory (2.3.1)
+    coderay (1.1.0)
+    kitchen-vagrant (0.19.0)
+      test-kitchen (~> 1.4)
+    method_source (0.8.2)
+    mixlib-shellout (2.2.3)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chef-acceptance!
+  kitchen-vagrant
+  mixlib-install!
+  pry
+  test-kitchen!
+
+BUNDLED WITH
+   1.10.6

data/acceptance/current/.acceptance/acceptance-cookbook/.chef/config.rb

@@ -0,0 +1 @@
+cookbook_path File.join(File.dirname(__FILE__), '..', '..')

data/acceptance/current/.acceptance/acceptance-cookbook/metadata.rb

@@ -0,0 +1 @@
+name 'acceptance-cookbook'

data/acceptance/current/.acceptance/acceptance-cookbook/recipes/destroy.rb

@@ -0,0 +1,3 @@
+execute 'kitchen destroy' do
+  cwd File.join(File.dirname(__FILE__), "../../../../../../../..")
+end

data/acceptance/current/.acceptance/acceptance-cookbook/recipes/provision.rb

@@ -0,0 +1 @@
+log 'provision recipe'

data/acceptance/current/.acceptance/acceptance-cookbook/recipes/verify.rb

@@ -0,0 +1,3 @@
+execute 'kitchen verify' do
+  cwd File.join(File.dirname(__FILE__), "../../../../../../../..")
+end

data/acceptance/current/.kitchen.yml

@@ -0,0 +1,45 @@
+driver:
+  name: vagrant
+  forward_agent: yes
+  customize:
+    cpus: 2
+    memory: 1024
+
+provisioner:
+  name: chef_zero
+  product_name: chef
+  product_version: latest
+  channel: current
+
+platforms:
+  - name: centos-6.5
+    run_list:
+  # - name: debian-7.4
+  #   run_list:
+  # - name: freebsd-10.0
+  #   run_list:
+  - name: ubuntu-14.04
+    run_list:
+  # - name: macosx-10.10
+  #   driver:
+  #     box: chef/macosx-10.10 # private
+  # - name: windows-7-professional
+  #   provisioner:
+  #     name: windows_chef_zero
+  #     require_chef_omnibus: 11.12.4
+  #   driver:
+  #     box: chef/windows-7-professional # private
+
+suites:
+  - name: mixlib-install-chef
+    provisioner:
+      product_name: chef
+      product_version: latest
+      channel: current
+    run_list:
+  # - name: mixlib-install-chefdk
+  #   provisioner:
+  #     product_name: chefdk
+  #     product_version: latest
+  #     channel: current
+  #   run_list:

data/lib/mixlib/install.rb

@@ -1,5 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
+# Author:: Patrick Wright (<patrick@chef.io>)
 # Copyright:: Copyright (c) 2015 Chef, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -16,200 +17,76 @@
 # limitations under the License.
 #
 
-require "mixlib/install/util"
-require "cgi"
+require "mixlib/versioning"
+
+require "mixlib/install/backend"
+require "mixlib/install/options"
+require "mixlib/install/generator"
 
 module Mixlib
   class Install
-    attr_accessor :version
-
-    attr_accessor :powershell
-
-    attr_accessor :prerelease
-
-    attr_accessor :nightlies
-
-    attr_accessor :install_flags
-
-    attr_accessor :endpoint
 
-    attr_accessor :root
+    attr_reader :options
 
-    attr_accessor :use_sudo
-
-    attr_reader :sudo_command
-
-    def sudo_command=(cmd)
-      if cmd.nil?
-        @use_sudo = false
-      else
-        @sudo_command = cmd
-      end
+    def initialize(options = {})
+      @options = Options.new(options)
     end
 
-    attr_accessor :http_proxy
-    attr_accessor :https_proxy
-
-    attr_accessor :omnibus_url
-    attr_accessor :install_msi_url
-
-    VALID_INSTALL_OPTS = %w(omnibus_url
-                            endpoint
-                            http_proxy
-                            https_proxy
-                            install_flags
-                            install_msi_url
-                            nightlies
-                            prerelease
-                            project
-                            root
-                            use_sudo
-                            sudo_command)
-
-    def initialize(version, powershell = false, opts = {})
-      @version = version || "latest"
-      @powershell = powershell
-      @http_proxy = nil
-      @https_proxy = nil
-      @install_flags = nil
-      @prerelease = false
-      @nightlies = false
-      @endpoint = "metadata"
-      @omnibus_url = "https://www.chef.io/chef/install.sh"
-      @use_sudo = true
-      @sudo_command = "sudo -E"
-
-      @root = if powershell
-        "$env:systemdrive\\opscode\\chef"
-      else
-        "/opt/chef"
-      end
-
-      parse_opts(opts)
+    #
+    # Fetch artifact metadata information
+    #
+    # @return [ArtifactInfo] fetched artifact data
+    #
+    def artifact_info
+      Backend.info(options)
     end
 
+    #
+    # Returns an install script for the given options
+    #
+    # @return [String] script for installing with given options
+    #
     def install_command
-      vars = if powershell
-        install_command_vars_for_powershell
-      else
-        install_command_vars_for_bourne
-      end
-      shell_code_from_file(vars)
+      Generator.install_command(options)
     end
 
-    private
-
-    # Generates the install command variables for Bourne shell-based
-    # platforms.
     #
-    # @return [String] shell variable lines
-    # @api private
-    def install_command_vars_for_bourne
-      flags = %w[latest true nightlies].include?(version) ? "" : "-v #{CGI.escape(version)}"
-      flags << " " << "-n" if nightlies
-      flags << " " << "-p" if prerelease
-      flags << " " << install_flags if install_flags
-
-      [
-        shell_var("chef_omnibus_root", root),
-        shell_var("chef_omnibus_url", omnibus_url),
-        shell_var("install_flags", flags.strip),
-        shell_var("pretty_version", Util.pretty_version(version)),
-        shell_var("sudo_sh", sudo("sh")),
-        shell_var("version", version)
-      ].join("\n")
-    end
-
-    # Generates the install command variables for PowerShell-based platforms.
+    # Returns the base installation directory for the given options
     #
-    # @param version [String] version string
-    # @param metadata_url [String] The metadata URL for the Chef Omnitruck API server
-    # @param omnibus_root [String] The base directory the project is installed to
-    # @return [String] shell variable lines
-    # @api private
-    def install_command_vars_for_powershell
-      [
-        shell_var("chef_omnibus_root", root),
-        shell_var("msi", "$env:TEMP\\chef-#{version}.msi"),
-      ].tap { |vars|
-        if install_msi_url
-          vars << shell_var("chef_msi_url", install_msi_url)
-        else
-          vars << shell_var("chef_metadata_url", windows_metadata_url)
-          vars << shell_var("pretty_version", Util.pretty_version(version))
-          vars << shell_var("version", version)
-        end
-      }.join("\n")
-    end
-
-    def validate_opts!(opt)
-      err_msg = ["#{opt} is not a valid option",
-                 "valid options are #{VALID_INSTALL_OPTS.join(' ')}"].join(',')
-      fail ArgumentError, err_msg unless VALID_INSTALL_OPTS.include?(opt.to_s)
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    def parse_opts(opts)
-      opts.each do |opt, setting|
-        validate_opts!(opt)
-        case opt.to_s
-        when 'project', 'endpoint'
-          self.endpoint = metadata_endpoint_from_project(setting)
-        else
-          send("#{opt.to_sym}=", setting)
-        end
-      end
-    end
-
-    def shell_code_from_file(vars)
-      fn = File.join(
-        File.dirname(__FILE__),
-        %w[.. .. support],
-        "install_command"
-      )
-      Util.shell_code_from_file(vars, fn, powershell,
-                                http_proxy: http_proxy, https_proxy: https_proxy)
-    end
-
-    # Builds a shell variable assignment string for the required shell type.
+    # @return [String] the installation directory for the project
     #
-    # @param name [String] variable name
-    # @param value [String] variable value
-    # @return [String] shell variable assignment
-    # @api private
-    def shell_var(name, value)
-      Util.shell_var(name, value, powershell)
-    end
-
-    # @return the correct Chef Omnitruck API metadata endpoint, based on project
-    def metadata_endpoint_from_project(project = nil)
-      if project.nil? || project.downcase == "chef"
-        "metadata"
-      else
-        "metadata-#{project.downcase}"
-      end
+    def root
+      # TODO: Support root as "$env:systemdrive\\opscode\\chef" when on windows.
+      # This only works for chef and chefdk but they are the only projects
+      # we are supporting as of now.
+      "/opt/#{options.product_name}"
     end
 
-    def windows_metadata_url
-      base = if omnibus_url =~ %r{/install.sh$}
-        "#{File.dirname(omnibus_url)}/"
+    #
+    # Returns the current version of the installed product.
+    # Returns nil if the product is not installed.
+    #
+    def current_version
+      # Note that this logic does not work for products other than
+      # chef & chefdk since version-manifest is created under the
+      # install directory which can be different than the product name (e.g.
+      # chef-server -> /opt/opscode). But this is OK for now since
+      # chef & chefdk are the only supported products.
+      version_manifest_file = "/opt/#{options.product_name}/version-manifest.json"
+      if File.exist? version_manifest_file
+        JSON.parse(File.read(version_manifest_file))["build_version"]
       end
-
-      url = "#{base}#{endpoint}"
-      url << "?p=windows&m=x86_64&pv=2008r2" # same package for all versions
-      url << "&v=#{CGI.escape(version.to_s.downcase)}"
-      url << "&prerelease=true" if prerelease
-      url << "&nightlies=true" if nightlies
-      url
     end
 
-    # Conditionally prefixes a command with a sudo command.
     #
-    # @param command [String] command to be prefixed
-    # @return [String] the command, conditionaly prefixed with sudo
-    # @api private
-    def sudo(script)
-      use_sudo ? "#{sudo_command} #{script}" : script
+    # Returns true if an upgradable version is available, false otherwise.
+    #
+    def upgrade_available?
+      return true if current_version.nil?
+
+      available_ver = Mixlib::Versioning.parse(artifact_info.first.version)
+      current_ver = Mixlib::Versioning.parse(current_version)
+      (available_ver > current_ver)
     end
   end
 end