vagrant-service-manager 1.1.0 → 1.2.0

data/features/install-cli.feature

@@ -0,0 +1,58 @@
+Feature: Command behavior of client side tools installation
+  service-manager should correctly verify behavior of install-cli command
+
+  @install_cli
+  Scenario Outline: Boot and install client side tools
+    Given box is <box>
+    And provider is <provider>
+    And a file named "Vagrantfile" with:
+    """
+    begin
+      require 'vagrant-libvirt'
+    rescue LoadError
+      # NOOP
+    end
+
+    Vagrant.configure('2') do |config|
+      config.vm.box = '<box>'
+      config.vm.box_url = 'file://../../.boxes/<box>-<provider>.box'
+      config.vm.network :private_network, ip: '<ip>'
+      config.vm.synced_folder '.', '/vagrant', disabled: true
+      config.servicemanager.services = 'docker'
+    end
+    """
+
+    When I successfully run `bundle exec vagrant up --provider <provider>`
+    And I successfully run `bundle exec vagrant service-manager install-cli --help`
+    Then the exit status should be 0
+    And stdout from "bundle exec vagrant service-manager install-cli --help" should contain:
+    """
+    Install the client binary for the specified service
+
+    Usage: vagrant service-manager install-cli [service] [options]
+
+    Service:
+      A supported service. For example: docker, kubernetes or openshift.
+
+    Options:
+          -h, --help         print this help
+
+    Example:
+          vagrant service-manager install-cli docker
+    """
+
+    When I run `bundle exec vagrant service-manager install-cli`
+    Then the exit status should be 126
+    And stdout from "bundle exec vagrant service-manager install-cli" should match /Service name missing/
+
+    When I run `bundle exec vagrant service-manager install-cli docker --cli-version 111.222.333`
+    Then the exit status should be 126
+
+    When I run `bundle exec vagrant service-manager install-cli docker`
+    Then the exit status should be 0
+    And the binary "docker" should be installed
+
+    Examples:
+      | box   | provider   | ip          |
+      | adb   | virtualbox | 10.10.10.42 |
+      | adb   | libvirt    | 10.10.10.42 |

data/features/openshift.feature

@@ -15,7 +15,7 @@ Feature: Command output from various OpenShift related commands
 
     Vagrant.configure('2') do |config|
       config.vm.box = '<box>'
-      config.vm.box_url = 'file://../boxes/<box>-<provider>.box'
+      config.vm.box_url = 'file://../../.boxes/<box>-<provider>.box'
       config.vm.network :private_network, ip: '<ip>'
       config.vm.synced_folder '.', '/vagrant', disabled: true
       config.servicemanager.services = 'docker'
@@ -65,6 +65,7 @@ Feature: Command output from various OpenShift related commands
     export OPENSHIFT_URL=https://<ip>:8443
     export OPENSHIFT_WEB_CONSOLE=https://<ip>:8443/console
     export DOCKER_REGISTRY=hub.openshift.rhel-cdk.<ip>.xip.io
+
     # run following command to configure your shell:
     # eval "$(vagrant service-manager env)"
     """

data/features/service-operation.feature

@@ -15,7 +15,7 @@ Feature: Command output from service operations like stop/start/restart
 
     Vagrant.configure('2') do |config|
       config.vm.box = '<box>'
-      config.vm.box_url = 'file://../boxes/<box>-<provider>.box'
+      config.vm.box_url = 'file://../../.boxes/<box>-<provider>.box'
       config.vm.network :private_network, ip: '<ip>'
       config.vm.synced_folder '.', '/vagrant', disabled: true
       config.servicemanager.services = 'docker'
@@ -23,7 +23,80 @@ Feature: Command output from service operations like stop/start/restart
     """
 
     When I successfully run `bundle exec vagrant up --provider <provider>`
-    And I successfully run `bundle exec vagrant service-manager status`
+    And I successfully run `bundle exec vagrant service-manager status --help`
+    Then the exit status should be 0
+    And stdout from "bundle exec vagrant service-manager status --help" should contain:
+    """
+    Usage: vagrant service-manager status [service] [options]
+
+    Options:
+          -h, --help         print this help
+
+    If a service is provided, only that service is reported.
+    If no service is provided only supported orchestrators are reported.
+
+    Example:
+          vagrant service-manager status openshift
+    """
+
+    And I successfully run `bundle exec vagrant service-manager stop --help`
+    Then the exit status should be 0
+    And stdout from "bundle exec vagrant service-manager stop --help" should contain:
+    """
+    stops the service
+
+    Usage: vagrant service-manager stop <service> [options]
+
+    Service:
+        A service provided by sccli. For example:
+         docker, kubernetes, openshift etc
+
+    Options:
+          -h, --help         print this help
+
+    Examples:
+      vagrant service-manager stop docker
+    """
+
+    And I successfully run `bundle exec vagrant service-manager start --help`
+    Then the exit status should be 0
+    And stdout from "bundle exec vagrant service-manager start --help" should contain:
+    """
+    starts the service
+
+    Usage: vagrant service-manager start <service> [options]
+
+    Service:
+        A service provided by sccli. For example:
+         docker, kubernetes, openshift etc
+
+    Options:
+          -h, --help         print this help
+
+    Examples:
+      vagrant service-manager start docker
+    """
+
+    And I successfully run `bundle exec vagrant service-manager restart --help`
+    Then the exit status should be 0
+    And stdout from "bundle exec vagrant service-manager restart --help" should contain:
+    """
+    restarts the service
+
+    Usage: vagrant service-manager restart <service> [options]
+
+    Service:
+        A service provided by sccli. For example:
+         docker, kubernetes, openshift etc
+
+    Options:
+          -h, --help         print this help
+
+    Examples:
+      vagrant service-manager restart docker
+    """
+
+    When I successfully run `bundle exec vagrant service-manager status`
     Then stdout from "bundle exec vagrant service-manager status" should contain "docker - running"
     Then stdout from "bundle exec vagrant service-manager status" should contain "openshift - stopped"
     Then stdout from "bundle exec vagrant service-manager status" should contain "kubernetes - stopped"
@@ -35,7 +108,7 @@ Feature: Command output from service operations like stop/start/restart
     Then the exit status should be 126
     And stderr from "bundle exec vagrant service-manager status abcd" should contain:
     """
-    Unkown service 'abcd'.
+    Unknown service 'abcd'.
     Supported services are docker, openshift, kubernetes etc.
     """
 

data/features/support/env.rb

@@ -1,5 +1,6 @@
 require 'aruba/cucumber'
 require 'komenda'
+require 'find'
 
 ###############################################################################
 # Aruba config and Cucumber hooks
@@ -19,12 +20,15 @@ end
 After do |_scenario|
   if File.exist?(File.join(aruba.config.working_directory, 'Vagrantfile'))
     Komenda.run('bundle exec vagrant destroy -f', cwd: aruba.config.working_directory, fail_on_fail: true)
-    if ENV.has_key?('CUCUMBER_RUN_PROVIDER')
-      # if we have more than one provider we need to wait between scenarios in order to allow for proper cleanup/shutdown
-      # of virtualization framework
+    if ENV.key?('CUCUMBER_RUN_PROVIDER')
+      # if we have more than one provider we need to wait between scenarios in order to allow for
+      # proper cleanup/shutdown of virtualization framework
       sleep 10
     end
   end
+
+  # Remove the created Vagrant home dir
+  FileUtils.rmtree(ENV['VAGRANT_HOME']) if File.directory? ENV['VAGRANT_HOME']
 end
 
 ###############################################################################
@@ -59,19 +63,21 @@ end
 # Some shared step definitions
 ##############################################################################
 Given /provider is (.*)/ do |current_provider|
-  requested_provider =  ENV.has_key?('PROVIDER') ? ENV['PROVIDER']: 'virtualbox'
+  requested_provider = ENV.key?('PROVIDER') ? ENV['PROVIDER'] : 'virtualbox'
 
   unless requested_provider.include?(current_provider)
-    #puts "Skipping scenario '#{@scenario_name}' for provider '#{current_provider}', since this provider is not explicitly enabled via environment variable 'PROVIDER'"
+    # puts "Skipping scenario '#{@scenario_name}' for provider '#{current_provider}', since this
+    # provider is not explicitly enabled via environment variable 'PROVIDER'"
     skip_this_scenario
   end
 end
 
 Given /box is (.*)/ do |current_box|
-  requested_box =  ENV.has_key?('BOX') ? ENV['BOX']: 'adb'
+  requested_box = ENV.key?('BOX') ? ENV['BOX'] : 'adb'
 
   unless requested_box.include?(current_box)
-    #puts "Skipping scenario '#{@scenario_name}' for box '#{current_box}', since this box is not explicitly enabled via environment variable 'BOX'"
+    # puts "Skipping scenario '#{@scenario_name}' for box '#{current_box}', since this box is not explicitly
+    # enabled via environment variable 'BOX'"
     skip_this_scenario
   end
 end
@@ -84,7 +90,7 @@ Then(/^stdout from "([^"]*)" should be script readable$/) do |cmd|
   output_is_script_readable(aruba.command_monitor.find(Aruba.platform.detect_ruby(cmd)).send(:stdout))
 end
 
-Then(/^stdout from "([^"]*)" should match \/(.*)\/$/) do |cmd, regexp|
+Then(%r{^stdout from "([^"]*)" should match /(.*)/$}) do |cmd, regexp|
   aruba.command_monitor.find(Aruba.platform.detect_ruby(cmd)).send(:stdout) =~ /#{regexp}/
 end
 
@@ -95,7 +101,7 @@ end
 Then(/^the service "([^"]*)" should be ([^"]*)$/) do |service, operation|
   run("vagrant ssh -c \"sudo systemctl status #{service}\"")
 
-  if ['running', 'restarted'].include? operation
+  if %w(running restarted).include? operation
     exit_code = 0
     regexp = /Active: active \(running\)/
   elsif operation == 'stopped'
@@ -126,7 +132,7 @@ When(/^the "([^"]*)" service is \*not\* running$/) do |service|
   run("vagrant ssh -c \"sudo systemctl stop #{service}\"")
 
   expect(last_command_started).to have_exit_status(0)
-  step "the \"docker\" service is not running"
+  step 'the "docker" service is not running'
 end
 
 # Note: Only for services supported through systemctl. Not for 'kubernetes'.
@@ -137,3 +143,13 @@ Then(/^have a new pid for "([^"]*)" service$/) do |service|
   stdout = aruba.command_monitor.find(Aruba.platform.detect_ruby(last_command_started)).send(:stdout)
   expect(@service_current_process_id).not_to eq(extract_process_id(stdout))
 end
+
+Then(/^the binary "([^"]*)" should be installed$/) do |binary|
+  binaries = []
+  Find.find("#{ENV['VAGRANT_HOME']}/data/service-manager/bin") do |path|
+    binaries << path if path =~ %r{.*\/#{Regexp.quote(binary)}$} && File.file?(path)
+  end
+
+  expect(binaries.size).to eq(1)
+  expect(File.executable?(binaries[0])).to eq(true)
+end

data/lib/vagrant-service-manager.rb

@@ -6,10 +6,11 @@ end
 
 require 'vagrant-service-manager/plugin'
 require 'vagrant-service-manager/command'
-require 'vagrant-service-manager/os'
 
 module VagrantPlugins
   module ServiceManager
+    SUPPORTED_HOSTS = %w(linux darwin windows).freeze
+
     # Returns the path to the source of this plugin
     def self.source_root
       @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
@@ -17,7 +18,11 @@ module VagrantPlugins
 
     # Temporally load the extra capabilities files for Red Hat
     load(File.join(source_root, 'plugins/guests/redhat/plugin.rb'))
+    # Load the host capabilities files
+    SUPPORTED_HOSTS.each do |host|
+      load(File.join(source_root, "plugins/hosts/#{host}/plugin.rb"))
+    end
     # Default I18n to load the en locale
-    I18n.load_path << File.expand_path("locales/en.yml", source_root)
+    I18n.load_path << File.expand_path('locales/en.yml', source_root)
   end
 end

data/lib/vagrant-service-manager/action/setup_network.rb

@@ -2,7 +2,6 @@ module VagrantPlugins
   module ServiceManager
     module Action
       class SetupNetwork
-
         def initialize(app, env)
           @app = app
           @machine = env[:machine]
@@ -31,7 +30,6 @@ Adding a private network using DHCP
           MSG
           @machine.config.vm.network :private_network, type: :dhcp
         end
-
       end
     end
   end

data/lib/vagrant-service-manager/archive_handlers/tar_handler.rb

@@ -0,0 +1,26 @@
+require 'rubygems/package'
+require 'zlib'
+
+module VagrantPlugins
+  module ServiceManager
+    class TarHandler
+      def initialize(source, dest_binary_path, file_regex)
+        @source = source
+        @dest_binary_path = dest_binary_path
+        @file_regex = file_regex
+      end
+
+      def unpack
+        Gem::Package::TarReader.new(Zlib::GzipReader.open(@source)) do |tar|
+          tar.each do |entry|
+            next unless entry.file? && entry.full_name =~ @file_regex
+
+            dest_directory = File.dirname(@dest_binary_path)
+            FileUtils.mkdir_p(dest_directory) unless File.directory?(dest_directory)
+            File.open(@dest_binary_path, 'wb') { |f| f.print(entry.read) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-service-manager/archive_handlers/zip_handler.rb

@@ -0,0 +1,25 @@
+require 'zip'
+
+module VagrantPlugins
+  module ServiceManager
+    class ZipHandler
+      def initialize(source, dest_binary_path, file_regex)
+        @source = source
+        @dest_binary_path = dest_binary_path
+        @file_regex = file_regex
+      end
+
+      def unpack
+        Zip::File.open(@source) do |zipfile|
+          zipfile.each do |entry|
+            next unless entry.ftype == :file && entry.name =~ @file_regex
+
+            dest_directory = File.dirname(@dest_binary_path)
+            FileUtils.mkdir_p(dest_directory) unless File.directory?(dest_directory)
+            zipfile.extract(entry, @dest_binary_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-service-manager/binary_handlers/adb_binary_handler.rb

@@ -0,0 +1,55 @@
+module VagrantPlugins
+  module ServiceManager
+    class ADBBinaryHandler < BinaryHandler
+      def initialize(machine, env, options)
+        super(machine, env, options)
+      end
+
+      def build_archive_path
+        @archive_file_path = "#{@temp_bin_dir}/#{File.basename(@url)}"
+      end
+
+      def ensure_binary_and_temp_directories
+        FileUtils.mkdir_p(bin_dir) unless File.directory?(bin_dir)
+        FileUtils.mkdir_p(@temp_bin_dir) unless File.directory?(@temp_bin_dir)
+      end
+
+      def download_archive
+        return @skip_download = true if File.exist?(@archive_file_path)
+        Vagrant::Util::Downloader.new(@url, @archive_file_path).download!
+      rescue Vagrant::Errors::DownloaderError => e
+        @ui.error e.message
+        exit 126
+      end
+
+      def prepare_binary
+        tmp_binary_file_path = @archive_file_path
+
+        # If binary is in archive format, extract it
+        if binary_archived?
+          tmp_binary_file_path = "#{archive_dir_name}/#{binary_name}"
+          archive_handler_class.new(@archive_file_path, tmp_binary_file_path, file_regex).unpack
+        end
+
+        FileUtils.cp(tmp_binary_file_path, @path)
+        File.chmod(0o755, @path)
+      rescue StandardError => e
+        @ui.error e.message
+        exit 126
+      end
+
+      def print_message
+        binary_path = PluginUtil.format_path(@path)
+        @ui.info I18n.t(LABEL,
+                        path: binary_path, dir: File.dirname(binary_path), service: @type,
+                        binary: binary_name, when: (@binary_exists ? 'already' : 'now'))
+      end
+
+      private
+
+      def binary_archived?
+        BINARY_ARCHIVE_FORMATS.include? File.extname(@archive_file_path)
+      end
+    end
+  end
+end

data/lib/vagrant-service-manager/binary_handlers/adb_docker_binary_handler.rb

@@ -0,0 +1,38 @@
+module VagrantPlugins
+  module ServiceManager
+    class ADBDockerBinaryHandler < ADBBinaryHandler
+      # Refer https://docs.docker.com/v1.10/engine/installation/binaries
+      DOCKER_BINARY_BASE_URL = 'https://get.docker.com/builds'.freeze
+
+      def initialize(machine, env, options)
+        super(machine, env, options)
+      end
+
+      def build_download_url
+        arch = @machine.env.host.capability(:os_arch)
+        @url = "#{DOCKER_BINARY_BASE_URL}/#{os_type}/#{arch}/docker-#{@version}#{archive_ext}"
+      end
+
+      private
+
+      def os_type
+        if Vagrant::Util::Platform.windows?
+          'Windows'
+        elsif Vagrant::Util::Platform.linux?
+          'Linux'
+        elsif Vagrant::Util::Platform.darwin?
+          'Darwin'
+        end
+      end
+
+      def archive_ext
+        # https://github.com/docker/docker/blob/v1.11.0-rc1/CHANGELOG.md#1110-2016-04-12
+        if @version == 'latest' || Gem::Version.new(@version) > Gem::Version.new('1.10.3')
+          Vagrant::Util::Platform.windows? ? '.zip' : '.tgz'
+        else
+          binary_ext
+        end
+      end
+    end
+  end
+end