vagrant-service-manager 1.1.0 → 1.2.0

data/lib/vagrant-service-manager/installer.rb

@@ -0,0 +1,49 @@
+module VagrantPlugins
+  module ServiceManager
+    class Installer
+      def initialize(type, machine, env, options)
+        @type = type
+        @machine = machine
+        @env = env
+        @box_version = options.delete(:box_version)
+
+        validate_prerequisites
+        binary_handler_class = Object.const_get(handler_class)
+        @binary_handler = binary_handler_class.new(machine, env, { type: @type }.merge(options))
+      end
+
+      def handler_class
+        "#{ServiceManager.name}::#{@box_version.upcase}#{@type.capitalize}BinaryHandler"
+      end
+
+      def install
+        unless PluginUtil.binary_downloaded?(@binary_handler.path)
+          @binary_handler.binary_exists = false
+          @binary_handler.install
+        end
+
+        @binary_handler.print_message
+      end
+
+      private
+
+      def validate_prerequisites
+        if @box_version == 'cdk'
+          @env.ui.info I18n.t('servicemanager.commands.install_cli.unsupported_box')
+          exit 126
+        end
+
+        if @type == :kubernetes
+          @env.ui.info I18n.t('servicemanager.commands.install_cli.kube_not_supported')
+          exit 126
+        end
+
+        unless PluginUtil.service_running?(@machine, @type.to_s)
+          @env.ui.info I18n.t('servicemanager.commands.install_cli.service_not_enabled',
+                              service: @type)
+          exit 126
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-service-manager/plugin.rb

@@ -5,8 +5,8 @@ require_relative 'service'
 module VagrantPlugins
   module ServiceManager
     class Plugin < Vagrant.plugin('2')
-      name "service-manager"
-      description "Service manager for services inside vagrant box."
+      name 'service-manager'
+      description 'Service manager for services inside vagrant box.'
 
       command 'service-manager' do
         require_relative 'command'

data/lib/vagrant-service-manager/plugin_logger.rb

@@ -14,7 +14,7 @@ module VagrantPlugins
       @debug = true
     end
 
-    def self.set_logger(logger)
+    def self.logger=(logger)
       @logger = logger
     end
 
@@ -24,7 +24,7 @@ module VagrantPlugins
 
     def self.debug(message = nil)
       if debug_mode?
-        message = "#{command}" if message.nil?
+        message = command.to_s if message.nil?
         logger.debug "[ service-manager: #{message} ]"
       end
     end

data/lib/vagrant-service-manager/plugin_util.rb

@@ -1,7 +1,6 @@
 module VagrantPlugins
   module ServiceManager
     module PluginUtil
-
       def self.service_class(service)
         SERVICES_MAP[service]
       end
@@ -35,7 +34,7 @@ module VagrantPlugins
         return false if Dir["#{path}/*"].empty?
 
         # check validity of certs
-        Dir[path + "/*"].each do |f|
+        Dir[path + '/*'].each do |f|
           guest_file_path = "#{DOCKER_PATH}/#{File.basename(f)}"
           guest_sha = machine.guest.capability(:sha_id, guest_file_path)
           return false if sha_id(File.read(f)) != guest_sha
@@ -94,10 +93,19 @@ module VagrantPlugins
         ui.error e.message.squeeze
       end
 
+      def self.execute_once(machine, ui, command)
+        machine.communicate.sudo(command) do |_, data|
+          PluginLogger.debug
+          return data.chomp
+        end
+      rescue StandardError => e
+        ui.error e.message.squeeze
+      end
+
       def self.print_shell_configure_info(ui, command = '')
-        label = if OS.unix?
+        label = if !Vagrant::Util::Platform.windows?
                   'unix_configure_info'
-                elsif OS.windows_cygwin?
+                elsif Vagrant::Util::Platform.cygwin?
                   'windows_cygwin_configure_info'
                 end
 
@@ -109,14 +117,29 @@ module VagrantPlugins
       def self.env_label(script_readable)
         if script_readable
           'script_readable'
-        elsif OS.unix?
+        elsif !Vagrant::Util::Platform.windows?
           'non_windows'
-        elsif OS.windows_cygwin?
+        elsif Vagrant::Util::Platform.cygwin?
           'windows_cygwin'
         else
           'windows'
         end
       end
+
+      def self.binary_downloaded?(path)
+        File.file?(path)
+      end
+
+      def self.format_path(path)
+        if Vagrant::Util::Platform.cygwin?
+          path[0..1] = '' # Remove drive letter and colon from path
+          "/cygdrive/c#{path}"
+        elsif Vagrant::Util::Platform.windows?
+          windows_path(path).chop
+        else
+          path
+        end
+      end
     end
   end
 end

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

@@ -1,9 +1,10 @@
+require_relative 'service_base'
 # Loads all services
 Dir["#{File.dirname(__FILE__)}/services/*.rb"].each { |f| require_relative f }
 
 module VagrantPlugins
   module ServiceManager
-    SUPPORTED_BOXES = ['adb', 'cdk']
+    SUPPORTED_BOXES = %w(adb cdk).freeze
 
     class Service
       def initialize(app, env)
@@ -22,10 +23,10 @@ module VagrantPlugins
           # docker service needs to be started by default for ADB and CDK box
           @docker_hook.execute
 
-          if @machine.guest.capability(:os_variant) == "cdk" && @services.length == 0
+          if @machine.guest.capability(:os_variant) == 'cdk' && @services.empty?
             # openshift to be started by default for CDK
             @openshift_hook.execute
-          elsif @services.include? "openshift"
+          elsif @services.include? 'openshift'
             # Start OpenShift service if it is configured in Vagrantfile
             @openshift_hook.execute
           end

data/lib/vagrant-service-manager/service_base.rb

@@ -0,0 +1,11 @@
+module VagrantPlugins
+  module ServiceManager
+    class ServiceBase
+      def initialize(machine, _env)
+        @machine = machine
+        @env = machine.env
+        @ui = @env.ui
+      end
+    end
+  end
+end

data/lib/vagrant-service-manager/services/docker.rb

@@ -1,13 +1,13 @@
 module VagrantPlugins
   module ServiceManager
-    class Docker
+    class Docker < ServiceBase
       # Hard Code the Docker port because it is fixed on the VM
       # This also makes it easier for the plugin to be cross-provider
       PORT = 2376
 
-      def initialize(machine, ui)
-        @machine = machine
-        @ui = ui
+      def initialize(machine, env)
+        super(machine, env)
+        @service_name = 'docker'
       end
 
       def execute
@@ -21,55 +21,55 @@ module VagrantPlugins
         end
       end
 
-      def self.status(machine, ui, service)
-        PluginUtil.print_service_status(ui, machine, service)
+      def status
+        PluginUtil.print_service_status(@ui, @machine, @service_name)
       end
 
-      def self.info(machine, ui, options = {})
-        if PluginUtil.service_running?(machine, 'docker')
-          options[:secrets_path] = PluginUtil.host_docker_path(machine)
-          options[:guest_ip] = PluginUtil.machine_ip(machine)
+      def info(options = {})
+        if PluginUtil.service_running?(@machine, @service_name)
+          options[:secrets_path] = PluginUtil.host_docker_path(@machine)
+          options[:guest_ip] = PluginUtil.machine_ip(@machine)
 
           # Verify valid certs and copy if invalid
-          unless PluginUtil.certs_present_and_valid?(options[:secrets_path], machine)
+          unless PluginUtil.certs_present_and_valid?(options[:secrets_path], @machine)
             # Log the message prefixed by #
-            PluginUtil.copy_certs_to_host(machine, options[:secrets_path], ui, true)
+            PluginUtil.copy_certs_to_host(@machine, options[:secrets_path], @ui, true)
           end
 
-          docker_api_version_cmd = "docker version --format '{{.Server.APIVersion}}'"
-          unless machine.communicate.test(docker_api_version_cmd)
+          api_version_cmd = "docker version --format '{{.Server.APIVersion}}'"
+          unless @machine.communicate.test(api_version_cmd)
             # fix for issue #152: Fallback to older Docker version (< 1.9.1)
-            docker_api_version_cmd.gsub!(/APIVersion/, 'ApiVersion')
-          end
-
-          PluginLogger.debug
-          machine.communicate.execute(docker_api_version_cmd) do |type, data|
-            options[:api_version] = data.chomp if type == :stdout
+            api_version_cmd.gsub!(/APIVersion/, 'ApiVersion')
           end
 
+          options[:api_version] = PluginUtil.execute_once(@machine, @ui, api_version_cmd)
           # Display the information, irrespective of the copy operation
-          print_env_info(ui, options)
+          print_env_info(@ui, options)
         else
-          ui.error I18n.t('servicemanager.commands.env.service_not_running',
-                          name: 'Docker')
+          @ui.error I18n.t('servicemanager.commands.env.service_not_running',
+                           name: @service_name)
           exit 126
         end
       end
 
-      def self.print_env_info(ui, options)
+      private
+
+      def print_env_info(ui, options)
         PluginLogger.debug("script_readable: #{options[:script_readable] || false}")
 
         label = PluginUtil.env_label(options[:script_readable])
-        options[:secrets_path] = PluginUtil.windows_path(options[:secrets_path]) unless OS.unix?
+
+        if Vagrant::Util::Platform.windows?
+          options[:secrets_path] = PluginUtil.windows_path(options[:secrets_path])
+        end
         message = I18n.t("servicemanager.commands.env.docker.#{label}",
                          ip: options[:guest_ip], port: PORT, path: options[:secrets_path],
                          api_version: options[:api_version])
         # Puts is used to escape and render the back slashes in Windows path
-        message = puts(message) if OS.windows?
+        message = puts(message) if Vagrant::Util::Platform.windows?
         ui.info(message)
-        unless options[:script_readable] || options[:all]
-          PluginUtil.print_shell_configure_info(ui, ' docker')
-        end
+        return if options[:script_readable] || options[:all]
+        PluginUtil.print_shell_configure_info(ui, ' docker')
       end
     end
   end

data/lib/vagrant-service-manager/services/kubernetes.rb

@@ -1,20 +1,20 @@
 module VagrantPlugins
   module ServiceManager
-    class Kubernetes
-      def initialize(machine, ui)
-        @machine = machine
-        @ui = ui
+    class Kubernetes < ServiceBase
+      def initialize(machine, env)
+        super(machine, env)
+        @service_name = 'kubernetes'
       end
 
       def execute
         # TODO: Implement execute method
       end
 
-      def self.status(machine, ui, service)
-        PluginUtil.print_service_status(ui, machine, service)
+      def status
+        PluginUtil.print_service_status(@ui, @machine, @service_name)
       end
 
-      def self.info(machine, ui, options = {})
+      def info(options = {})
         # TODO: Implement info method
       end
     end

data/lib/vagrant-service-manager/services/open_shift.rb

@@ -1,11 +1,11 @@
 module VagrantPlugins
   module ServiceManager
-    class OpenShift
-      OPENSHIFT_PORT = 8443
+    class OpenShift < ServiceBase
+      PORT = 8443
 
-      def initialize(machine, ui)
-        @machine = machine
-        @ui = ui
+      def initialize(machine, env)
+        super(machine, env)
+        @service_name = 'openshift'
         @extra_cmd = build_extra_command
       end
 
@@ -14,39 +14,39 @@ module VagrantPlugins
         PluginUtil.execute_and_exit_on_fail(@machine, @ui, command)
       end
 
-      def self.status(machine, ui, service)
-        PluginUtil.print_service_status(ui, machine, service)
+      def status
+        PluginUtil.print_service_status(@ui, @machine, @service_name)
       end
 
-      def self.docker_registry_host(machine)
-        url = ''
-        PluginLogger.debug
-        command = \
-          "sudo oc --config=/var/lib/openshift/openshift.local." +
-          "config/master/admin.kubeconfig get route/docker-registry " +
-          "-o template --template={{.spec.host}}"
-        machine.communicate.execute(command) do |type, data|
-          url << data.chomp if type == :stdout
-        end
-        url
-      end
-
-      def self.info(machine, ui, options = {})
+      def info(options = {})
         options[:script_readable] ||= false
 
-        if PluginUtil.service_running?(machine, 'openshift')
-          options[:url] = "https://#{PluginUtil.machine_ip(machine)}:#{OPENSHIFT_PORT}"
+        if PluginUtil.service_running?(@machine, 'openshift')
+          options[:url] = "https://#{PluginUtil.machine_ip(@machine)}:#{PORT}"
           options[:console_url] = "#{options[:url]}/console"
-          options[:docker_registry] = docker_registry_host(machine)
-          print_info(ui, options)
+          options[:docker_registry] = docker_registry_host
+          print_info(options)
         else
-          ui.error I18n.t('servicemanager.commands.env.service_not_running',
-                          name: 'OpenShift')
+          @ui.error I18n.t('servicemanager.commands.env.service_not_running',
+                           name: 'OpenShift')
           exit 126
         end
       end
 
-      def self.print_info(ui, options)
+      private
+
+      def build_extra_command
+        cmd = ''
+        CONFIG_KEYS.select { |e| e[/^openshift_/] }.each do |key|
+          unless @machine.config.servicemanager.send(key).nil?
+            env_name = key.to_s.gsub(/openshift_/, '').upcase
+            cmd += "#{env_name}='#{@machine.config.servicemanager.send(key)}' "
+          end
+        end
+        cmd.chop
+      end
+
+      def print_info(options)
         PluginLogger.debug("script_readable: #{options[:script_readable] || false}")
 
         label = PluginUtil.env_label(options[:script_readable])
@@ -54,23 +54,24 @@ module VagrantPlugins
                          openshift_url: options[:url],
                          openshift_console_url: options[:console_url],
                          docker_registry: options[:docker_registry])
-        ui.info(message)
-        unless options[:script_readable] || options[:all]
-          PluginUtil.print_shell_configure_info(ui, ' openshift')
-        end
+        @ui.info(message)
+
+        return if options[:script_readable] || options[:all]
+        PluginUtil.print_shell_configure_info(@ui, ' openshift')
       end
 
-      private
+      def docker_registry_host
+        url = ''
+        PluginLogger.debug
+        command = \
+          'sudo oc --config=/var/lib/openshift/openshift.local.' \
+          'config/master/admin.kubeconfig get route/docker-registry ' \
+          '-o template --template={{.spec.host}}'
 
-      def build_extra_command
-        cmd = ''
-        CONFIG_KEYS.select {|e| e[/^openshift_/] }.each do |key|
-          unless @machine.config.servicemanager.send(key).nil?
-            env_name = key.to_s.gsub(/openshift_/,'').upcase
-            cmd += "#{env_name}='#{@machine.config.servicemanager.send(key)}' "
-          end
+        @machine.communicate.execute(command) do |type, data|
+          url << data.chomp if type == :stdout
         end
-        cmd.chop
+        url
       end
     end
   end

data/lib/vagrant-service-manager/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ServiceManager
-    VERSION = "1.1.0"
+    VERSION = '1.2.0'.freeze
   end
 end

data/locales/en.yml

@@ -1,4 +1,10 @@
 en:
+  vagrant:
+    errors:
+      url_validation_error: |-
+        Download URL is not accessible.
+        Possible reason: Invalid version name
+
   servicemanager:
     synopsis: |-
       provides the IP address:port and tls certificate file location for a docker daemon
@@ -28,6 +34,7 @@ en:
                start        starts the given service in the box
                stop         stops the given service in the box
                status       list services and their running state
+               install-cli  install the client binary for the specified service
 
           Options:
                -h, --help   print this help
@@ -40,7 +47,7 @@ en:
                 docker      display information and environment variables for docker
                 openshift   display information and environment variables for openshift
 
-          If OBJECT is ommitted, display the information for all active services
+          If OBJECT is omitted, display the information for all active services
 
           Options:
                 --script-readable  display information in a script readable format.
@@ -58,8 +65,9 @@ en:
 
           Examples:
                 vagrant service-manager box version
-                vagrant service-manager box ip
                 vagrant service-manager box version --script-readable
+                vagrant service-manager box ip
+                vagrant service-manager box ip --script-readable
         status: |-
           Usage: vagrant service-manager status [service] [options]
 
@@ -85,6 +93,19 @@ en:
 
           Examples:
             vagrant service-manager %{operation} docker
+        install_cli: |-
+          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
 
       env:
         docker:
@@ -94,7 +115,7 @@ en:
             setx DOCKER_HOST tcp://%{ip}:%{port}
             setx DOCKER_CERT_PATH %{path}
             setx DOCKER_TLS_VERIFY 1
-            setx DOCKER_API_VERSION=#{api_version}
+            setx DOCKER_API_VERSION %{api_version}
           non_windows: |-
             # Set the following environment variables to enable access to the
             # docker daemon running inside of the vagrant virtual machine:
@@ -151,6 +172,23 @@ en:
           Only sccli services are supported. For example:
             docker, openshift and kubernetes
 
+      install_cli:
+        message: |-
+          # Binary %{when} available at %{path}
+          # run binary as:
+          # %{binary} <command>
+          export PATH=%{dir}:$PATH
+
+          # run following command to configure your shell:
+          # eval "$(VAGRANT_NO_COLOR=1 vagrant service-manager install-cli %{service} | tr -d '\r')"
+        unsupported_box: |-
+          The CDK does not support client binary installs via the 'install-cli' command.
+          Please visit access.redhat.com to download client binaries.
+        service_not_enabled: |-
+          '%{service}' service is not enabled.
+        kube_not_supported: |-
+          Installation of Kubernetes client library via the install-cli command is not supported yet.
+
       status:
         nil: |-
           Configured services:
@@ -158,5 +196,5 @@ en:
           running: running
           stopped: stopped
         unsupported_service: |-
-          Unkown service '%{service}'.
+          Unknown service '%{service}'.
           Supported services are %{services}.