vagrant-service-manager 1.1.0 → 1.2.0

data/Rakefile

@@ -1,33 +1,40 @@
 require 'bundler/gem_tasks'
 require 'rake/clean'
+require 'rake/testtask'
 require 'cucumber/rake/task'
+require 'rubocop/rake_task'
 require 'mechanize'
 require 'fileutils'
 require 'yaml'
 require 'launchy'
-
-CDK_DOWNLOAD_URL='https://access.redhat.com/downloads/content/293/ver=2/rhel---7/2.0.0/x86_64/product-software'
-CDK_BOX_BASE_NAME='rhel-cdk-kubernetes-7.2-23.x86_64.vagrant'
-
-CDK_DOWNLOAD_URL_NIGHTLY='http://cdk-builds.usersys.redhat.com/builds/nightly/latest-build'
-
-ADB_DOWNLOAD_URL='http://cloud.centos.org/centos/7/atomic/images'
-ADB_BOX_BASE_NAME='AtomicDeveloperBundle-2.1.0-CentOS7'
+require 'date'
 
 CLOBBER.include('pkg')
 CLEAN.include('build')
 
+BOX_DIR = '.boxes'.freeze
+
 task :init do
   FileUtils.mkdir_p 'build'
 end
 
-task :clean_for_testing do
-  FileUtils.rm_rf ['build/aruba', 'build/vagrant.d', 'build/features_report.html']
+desc 'Removes all cached box files'
+task :clean_boxes do
+  FileUtils.rmtree '.boxes'
+end
+
+RuboCop::RakeTask.new
+
+# Default unit test task
+desc 'Run all unit tests'
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'test'
 end
 
 # Cucumber acceptance test tasks
 Cucumber::Rake::Task.new(:features)
-task :features => [:init, :clean_for_testing]
+task features: [:clean, :init, :get_boxes]
 
 namespace :features do
   desc 'Opens the HTML Cucumber test report'
@@ -36,39 +43,226 @@ namespace :features do
   end
 end
 
-desc 'Download latest publicly released / latest nightly build of CDK Vagrant box using the specified provider (default \'virtualbox\', \'false\')'
-task :get_cdk, [:provider, :nightly] do |t, args|
-  provider = args[:provider].nil? ? 'virtualbox' : args[:provider]
-  use_nightly = args[:nightly].nil? ? false : !!(args[:nightly] =~ /true/)
-  agent = Mechanize.new
-  agent.follow_meta_refresh = true
+desc 'Download the required Vagrant boxes for the Cucumber tests'
+task get_boxes: :init do
+  box_dir = File.join(File.dirname(__FILE__), BOX_DIR)
 
-  if use_nightly
-    agent.ignore_bad_chunking = true
-    agent.get(CDK_DOWNLOAD_URL_NIGHTLY) do |page|
-      page.links.each do |link|
-        if link.href.match(/.*#{Regexp.quote(provider)}.box$/)
-          download_dir = File.join(File.dirname(__FILE__), 'build', 'boxes')
-          unless File.directory?(download_dir)
-            FileUtils.mkdir_p(download_dir)
-          end
-          agent.pluggable_parser.default = Mechanize::Download
-          puts "Downloading #{CDK_DOWNLOAD_URL_NIGHTLY}/#{link.href}"
-          agent.get(link.href).save(File.join(download_dir, "cdk-#{provider}.box"))
+  requested_providers = ENV.key?('PROVIDER') ? ENV['PROVIDER'].split(',').collect(&:strip) : ['virtualbox']
+  requested_boxes =  ENV.key?('BOX') ? ENV['BOX'].split(',').collect(&:strip) : ['adb']
+  nightly_cdk_builds = ENV.key?('NIGHTLY') ? ENV['NIGHTLY'].eql?('true') : false
+
+  download_tasks = requested_boxes.map do |box|
+    requested_providers.map do |provider|
+      case box
+      when 'cdk'
+        if nightly_cdk_builds
+          NightlyCDKDownloader.new(box_dir, provider)
+        else
+          PublicCDKDownloader.new(box_dir, provider)
         end
+      when 'adb'
+        ADBDownloader.new(box_dir, provider)
+      else
+        raise "Unknown provider #{provider}"
       end
     end
-  else
-    agent.get(CDK_DOWNLOAD_URL) do |page|
+  end.flatten!
+
+  threads = download_tasks.map do |task|
+    Thread.new do
+      task.execute
+    end
+  end
+
+  while threads.any?(&:alive?)
+    pinwheel = %w(| / - \\)
+    4.times do
+      print "\b" + pinwheel.rotate!.first
+      sleep(0.3)
+    end
+  end
+end
+
+# Helper classes for handling of Vagrant box downloading
+class DownloadTask
+  attr_reader :provider
+  attr_reader :box_dir
+  attr_reader :agent
+  attr_reader :meta
+
+  def initialize(box_dir, provider)
+    FileUtils.mkdir_p(box_dir) unless File.directory?(box_dir)
+    @box_dir = box_dir
+    @provider = provider
+
+    @meta_file_name = File.join(box_dir, "#{name}-#{provider}.yml")
+    @meta = read_meta
+
+    @agent = Mechanize.new
+    @agent.follow_meta_refresh = true
+    @agent.ignore_bad_chunking = true
+  end
+
+  def needed?
+    true
+  end
+
+  def execute
+    download if needed?
+  end
+
+  def download
+  end
+
+  def name
+    raise 'Needs to be overridden'
+  end
+
+  def box_file
+    File.join(box_dir, "#{name}-#{provider}.box")
+  end
+
+  def read_meta
+    if File.exist?(@meta_file_name)
+      YAML.load_file(@meta_file_name)
+    else
+      {}
+    end
+  end
+
+  def save_meta
+    File.open(@meta_file_name, 'w+') do |file|
+      file.write(meta.to_yaml)
+    end
+  end
+end
+
+class ADBDownloader < DownloadTask
+  ADB_DOWNLOAD_URL = 'http://cloud.centos.org/centos/7/atomic/images'.freeze
+  ADB_BOX_BASE_NAME = 'AtomicDeveloperBundle'.freeze
+
+  def initialize(box_dir, provider)
+    super(box_dir, provider)
+  end
+
+  def needed?
+    latest_version = versions[-1]
+    if meta.fetch(:current_version, nil).eql?(latest_version) && File.file?(box_file)
+      puts "Using existing ADB box (version #{latest_version}) in #{box_dir}"
+      return false
+    else
+      File.delete(box_file) if File.exist?(box_file)
+      meta[:current_version] = latest_version
+      save_meta
+      true
+    end
+  end
+
+  def download
+    agent.get(ADB_DOWNLOAD_URL) do |page|
+      page.links.each do |link|
+        next unless link.href =~ /#{Regexp.quote(ADB_BOX_BASE_NAME)}-#{Regexp.quote(@meta[:current_version])}-CentOS7-#{Regexp.quote(provider)}.box/i
+        agent.pluggable_parser.default = Mechanize::Download
+        puts "Downloading ADB box #{ADB_DOWNLOAD_URL}/#{link.href}"
+        agent.get(link.href).save(box_file)
+      end
+    end
+  end
 
+  def name
+    'adb'
+  end
+
+  private
+
+  def versions
+    agent.get(ADB_DOWNLOAD_URL) do |page|
+      return page.links.select { |link| link.href =~ /#{Regexp.quote(ADB_BOX_BASE_NAME)}.*/ }
+                 .map { |link| link.href.match(/^.*-(\d+\.\d+.\d+)-.*/i).captures[0] }
+                 .uniq
+                 .sort
+    end
+  end
+end
+
+class NightlyCDKDownloader < DownloadTask
+  CDK_DOWNLOAD_URL_NIGHTLY = 'http://cdk-builds.usersys.redhat.com/builds/nightly'.freeze
+
+  def initialize(box_dir, provider)
+    super(box_dir, provider)
+  end
+
+  def needed?
+    latest_version = versions[-1]
+    if meta.fetch(:current_version, nil).eql?(latest_version) && File.file?(box_file)
+      puts "Using existing CDK box (from #{latest_version}) in #{box_dir}"
+      return false
+    else
+      File.delete(box_file) if File.exist?(box_file)
+      meta[:current_version] = latest_version
+      save_meta
+      true
+    end
+  end
+
+  def download
+    download_base_url = "#{CDK_DOWNLOAD_URL_NIGHTLY}/#{meta[:current_version]}"
+    agent.get(download_base_url) do |page|
+      page.links.each do |link|
+        next unless link.href =~ /.*#{Regexp.quote(provider)}.box$/
+        agent.pluggable_parser.default = Mechanize::Download
+        puts "Downloading #{download_base_url}/#{link.href}"
+        agent.get(link.href).save(box_file)
+      end
+    end
+  end
+
+  def name
+    'cdk'
+  end
+
+  private
+
+  def versions
+    agent.get(CDK_DOWNLOAD_URL_NIGHTLY) do |page|
+      return page.links.select { |link| link.href =~ /\d{1,2}-[a-zA-Z]{3}-\d{4}/ }
+                 .map { |link| link.href.chomp('/') }
+                 .sort { |a, b| DateTime.strptime(a, '%d-%b-%Y') <=> DateTime.strptime(b, '%d-%b-%Y') }
+    end
+  end
+end
+
+class PublicCDKDownloader < DownloadTask
+  CDK_DOWNLOAD_URL = 'https://access.redhat.com/downloads/content/293/ver=2.1/rhel---7/2.1.0/x86_64/product-software'.freeze
+  CDK_BOX_BASE_NAME = 'rhel-cdk-kubernetes-7.2-25.x86_64.vagrant'.freeze
+  LATEST_VERSION = 'v. 2.1.0 for x86_64'.freeze
+
+  def initialize(box_dir, provider)
+    super(box_dir, provider)
+  end
+
+  def needed?
+    if meta.fetch(:current_version, nil).eql?(LATEST_VERSION) && File.file?(box_file)
+      puts "Using existing public releaase CDK box (version #{LATEST_VERSION}) in #{box_dir}"
+      return false
+    else
+      File.delete(box_file) if File.exist?(box_file)
+      meta[:current_version] = LATEST_VERSION
+      save_meta
+      true
+    end
+  end
+
+  def download
+    agent.get(CDK_DOWNLOAD_URL) do |page|
       # Submit first form which is the redirect to login page form
       login_page = page.forms.first.submit
 
       # Submit the login form
-      after_login = login_page.form_with(:name => 'login_form') do |f|
-        username_field = f.field_with(:id => 'username')
+      after_login = login_page.form_with(id: 'kc-form-login') do |f|
+        username_field = f.field_with(id: 'username')
         username_field.value = 'service-manager@mailinator.com'
-        password_field = f.field_with(:id => 'password')
+        password_field = f.field_with(id: 'password')
         password_field.value = 'service-manager'
       end.click_button
 
@@ -76,40 +270,15 @@ task :get_cdk, [:provider, :nightly] do |t, args|
       download_page = after_login.forms.first.submit
 
       download_page.links.each do |link|
-        if link.href =~ /#{Regexp.quote(CDK_BOX_BASE_NAME)}-#{Regexp.quote(provider)}.box/
-          download_dir = File.join(File.dirname(__FILE__), 'build', 'boxes')
-          unless File.directory?(download_dir)
-            FileUtils.mkdir_p(download_dir)
-          end
-          agent.pluggable_parser.default = Mechanize::Download
-          puts "Downloading #{link.href}"
-          agent.get(link.href).save(File.join(download_dir, "cdk-#{provider}.box"))
-        end
+        next unless link.href =~ /#{Regexp.quote(CDK_BOX_BASE_NAME)}-#{Regexp.quote(provider)}.box/
+        agent.pluggable_parser.default = Mechanize::Download
+        puts "Downloading public release CDK #{link.href}"
+        agent.get(link.href).save(box_file)
       end
     end
   end
-end
-task :get_cdk => :init
-
-desc 'Download ADB Vagrant box using the specified provider (default \'virtualbox\')'
-task :get_adb, [:provider] do |t, args|
-  provider = args[:provider].nil? ? 'virtualbox' : args[:provider]
-  agent = Mechanize.new
-  agent.follow_meta_refresh = true
-  agent.get(ADB_DOWNLOAD_URL) do |page|
-    page.links.each do |link|
-      if match = link.href.match(/#{Regexp.quote(ADB_BOX_BASE_NAME)}-(.*).box/)
-        if  match.captures[0].downcase == provider
-          download_dir = File.join(File.dirname(__FILE__), 'build', 'boxes')
-          unless File.directory?(download_dir)
-            FileUtils.mkdir_p(download_dir)
-          end
-          agent.pluggable_parser.default = Mechanize::Download
-          puts "Downloading #{ADB_DOWNLOAD_URL}/#{link.href}"
-          agent.get(link.href).save(File.join(download_dir, "adb-#{provider}.box"))
-        end
-      end
-    end
+
+  def name
+    'cdk'
   end
 end
-task :get_adb => :init

data/features/box-command.feature

@@ -15,7 +15,7 @@ Feature: Command output from box command
 
     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'
@@ -38,9 +38,34 @@ Feature: Command output from box command
           -h, --help         print this help
     """
 
+    When I successfully run `bundle exec vagrant service-manager box --help`
+    Then the exit status should be 0
+    And stdout from "bundle exec vagrant service-manager box --help" should contain:
+    """
+    Usage: vagrant service-manager box <sub-command> [options]
+
+    Sub-Command:
+          version    display version and release information about the running VM
+          ip         display routable IP address of the running VM
+
+    Options:
+          --script-readable  display information in a script readable format
+          -h, --help         print this help
+
+    Examples:
+          vagrant service-manager box version
+          vagrant service-manager box version --script-readable
+          vagrant service-manager box ip
+          vagrant service-manager box ip --script-readable
+    """
+
     When I successfully run `bundle exec vagrant service-manager box ip`
     Then stdout from "bundle exec vagrant service-manager box ip" should contain "<ip>"
 
+    When I successfully run `bundle exec vagrant service-manager box ip --script-readable`
+    Then stdout from "bundle exec vagrant service-manager box ip --script-readable" should contain "IP=<ip>"
+    And stdout from "bundle exec vagrant service-manager box ip --script-readable" should be script readable
+
     Examples:
       | box   | provider   | ip          |
       | cdk   | virtualbox | 10.10.10.42 |

data/features/env-command.feature

@@ -15,7 +15,7 @@ Feature: Command output from env command
 
     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,24 @@ Feature: Command output from env command
     """
 
     When I successfully run `bundle exec vagrant up --provider <provider>`
-    And I successfully run `bundle exec vagrant service-manager env`
+    And I successfully run `bundle exec vagrant service-manager env --help`
+    Then the exit status should be 0
+    And stdout from "bundle exec vagrant service-manager env --help" should contain:
+    """
+    Usage: vagrant service-manager env [object] [options]
+
+    Objects:
+          docker      display information and environment variables for docker
+          openshift   display information and environment variables for openshift
+
+    If OBJECT is omitted, display the information for all active services
+
+    Options:
+          --script-readable  display information in a script readable format.
+          -h, --help         print this help
+    """
+
+    When I successfully run `bundle exec vagrant service-manager env`
     Then stdout from "bundle exec vagrant service-manager env" should be evaluable in a shell
 
     When I successfully run `bundle exec vagrant service-manager env --script-readable`
@@ -34,7 +51,7 @@ Feature: Command output from env command
     And stdout from "bundle exec vagrant service-manager env docker" should contain "export DOCKER_HOST=tcp://<ip>:2376"
     And stdout from "bundle exec vagrant service-manager env docker" should match /export DOCKER_CERT_PATH=.*\/.vagrant\/machines\/cdk\/virtualbox\/docker/
     And stdout from "bundle exec vagrant service-manager env docker" should contain "export DOCKER_TLS_VERIFY=1"
-    And stdout from "bundle exec vagrant service-manager env docker" should contain "export DOCKER_API_VERSION=1.21"
+    And stdout from "bundle exec vagrant service-manager env docker" should match /export DOCKER_API_VERSION=1.2\d/
     And stdout from "bundle exec vagrant service-manager env docker" should match /# eval "\$\(vagrant service-manager env docker\)"/
 
     When I successfully run `bundle exec vagrant service-manager env docker --script-readable`

data/features/help-command.feature

@@ -15,7 +15,7 @@ Feature: Command output from help command
 
     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'
@@ -35,6 +35,7 @@ Feature: Command output from help command
          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
@@ -54,6 +55,7 @@ Feature: Command output from help command
          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
@@ -74,6 +76,7 @@ Feature: Command output from help command
          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