vagrant-service-manager 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a07e2bb53c36d17f60301f92f65614e1ad0a0a53
-  data.tar.gz: 74b02d8dc2bdcdc63097538aca9de66de0169f04
+  metadata.gz: 85d5930d50032ff227fe63924f9e96e3f43877d0
+  data.tar.gz: 1960b2b1b233f3154b5c80961e56f9a8ad94a60b
 SHA512:
-  metadata.gz: 6992490bc94977e327eab53a6feda53715e3df022a18e443340f7be9601d560ab257a4941f2982eee52672609a59c517f156c96f58316ce5eef74185fbb66351
-  data.tar.gz: 25d843b9d45177b669eb8764c0e95366b83576bee53e03fceedc7deaf0c6af37d1da59e0f5b40091cf54fe8e6737f7b305f777349b0a3deaeac51708adbcb6cc
+  metadata.gz: c4a8326b93fbebe49b33f562bf569af44a1136f3d21cb33a7bef8ff0d14ff7e85eb73a160bd419c446c6bc7130860a24f26075176e2767186f1661d385897d61
+  data.tar.gz: 58fb6c65fad2cb6d46295d65f3322fb193a003ed073873e388563ed2798af29bb1f8a40a5390580db2bf49ce95a546f0b21e0eaeddb32be8c56f0e53176e7795

data/.ci/ansible/roles/centos/tasks/main.yml

@@ -19,8 +19,9 @@
       - gcc
       - kernel-devel
 
-- name: Install VirtualBox
-  yum: name=http://download.virtualbox.org/virtualbox/rpm/rhel/7/x86_64/VirtualBox-5.0-5.0.8_103449_el7-1.x86_64.rpm state=present
+# TODO enable when we test against VirtualBox as well
+#- name: Install VirtualBox
+#  yum: name=http://download.virtualbox.org/virtualbox/rpm/rhel/7/x86_64/VirtualBox-5.0-5.0.8_103449_el7-1.x86_64.rpm state=present
 
 - name: start-enable-libvirtd
   service: name=libvirtd state=started enabled=yes

data/.ci/jenkins-execute-script.py

@@ -64,15 +64,17 @@ for host in data['hosts']:
 
     # setup the environment
     setup_cmd  = 'cd vagrant-service-manager && '
-    setup_cmd += 'gem install bundler -v 1.10.0 && '
+    setup_cmd += 'gem install bundler && '
     setup_cmd += 'bundle install --no-color'
     execute_on_host(host, setup_cmd, "Unable to setup Ruby environment")
 
     # run build and features
     build_cmd  = 'cd vagrant-service-manager && '
-    build_cmd += 'bundle exec rake build && '
-    build_cmd += 'bundle exec rake get_adb[\'libvirt\'] && '
-    build_cmd += 'bundle exec rake features CUCUMBER_OPTS=\'-p ci\' PROVIDER=libvirt'
+    build_cmd += 'bundle exec rake rubocop && '
+    build_cmd += 'bundle exec rake test && '
+    build_cmd += 'bundle exec rake features CUCUMBER_OPTS=\'-p ci\' PROVIDER=libvirt BOX=adb,cdk && '
+    build_cmd += 'bundle exec rake build'
+
     execute_on_host(host, build_cmd, "Tests failures")
 
     done_nodes_url = "%s/Node/done?key=%s&sside=%s" % (url_base, api_key, data['ssid'])

data/.gitignore

@@ -15,3 +15,4 @@ Gemfile.lock
 tmp
 build
 pkg
+.boxes

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'build/**/*'
+
+# Offense count: 57
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'Rakefile'

data/.rubocop_todo.yml

@@ -0,0 +1,55 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-07-09 23:34:13 +0200 using RuboCop version 0.41.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'features/support/env.rb'
+    - 'test/vagrant-service-manager/binary_handlers/adb_openshift_binary_handler_test.rb'
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/vagrant-service-manager/service.rb'
+
+# Offense count: 13
+Metrics/AbcSize:
+  Max: 53
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 209
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 28
+
+# Offense count: 13
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 96
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 111
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 38
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+Style/FileName:
+  Exclude:
+    - 'lib/vagrant-service-manager.rb'

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 # Changelog
 
-## Unreleased
+## v1.2.0 Jul 14, 2016
+
+- Issue #331: Update expectation for DOCKER_API_VERSION in cucumber test
+- Issue #323: Add note about default download location of client binaries in README documentation
+- Issue #321: `install-cli docker` errors "Download URL is not accessible" blocker bug
+- Issue #312: install-cli commands throws an error when trying to install Kubernetes CLI bug
+- Issue #291: Update doc example for env to reflect new changes documentation
+- Issue #289: Remove Vagrantfile in root of repository
+- Issue #287: Remove unnecessary TODO file from repo
+- Issue #285: Use native methods to detect host platform instead of OS module
+- Issue #282: Add build status to README build
+- Issue #281: The ADB/CDK download rake tasks should be made proper Rake tasks build enhancement
+- Issue #278: Missing acceptance tests for command like status, service operations test
+- Issue #275: Typo in `vagrant service-manager env --help` command output text bug
+- Issue #270: DOCKER_API_VERSION not set properly on Windows bug
+- Issue #262: Update CI setup configuration
+- Issue #252: Cosmetic bug: vagrant service-manager box ip --script-readable
+- Issue #207: Remove vagrant-service-manager.spec and stop publishing gem as rpm
+- Issue #196: Introduce unit test harness test
+- Issue #93: Implement style guide based test using rubocop test
+- Issue #90: Add install-cli command enhancement focus:devex
+- Issue #20: --force should force redownloading the TLS certificates documentation
 
 ## v1.1.0 Jun 08, 2016
 - Updated README to make Installation Instructions clearer @bexelbie

data/CONTRIBUTING.adoc

@@ -49,7 +49,7 @@ using the issue key you are working on. If there is not already an issue
 covering the work you want to do, create one (see
 link:#submitting-issues[submitting issues]). Assuming for example you
 will be working from the master branch and working on the GitHub issue
-123 : `git checkout -b issue-123 master`
+123 : `git checkout -b fix-123 master`
 
 === Code
 
@@ -59,8 +59,8 @@ section in the link:README.md[README] to get started.
 === Commit
 
 * Make commits of logical units.
-* Be sure to use the GitHub issue key in the commit message, eg
-`Issue #123 ...`.
+* Be sure to use the GitHub issue key in the commit message, eg `Fix #123 ...`.
+* Make sure your code conforms to the coding style
 * Make sure you have added the necessary tests for your changes.
 * Make sure you have added appropriate documentation updates.
 * Run _all_ the tests to assure nothing else was accidentally broken.
@@ -85,10 +85,10 @@ example work-flow assuming issue 123 from above:
 
 -------------------------------------------------------------------------
 # Create a local branch for the pull request
-$ git checkout -b issue-123 master
+$ git checkout -b fix-123 master
 
 # Pull the changes
-$ git pull <remote of the pull request> issue-123
+$ git pull <remote of the pull request> fix-123
 
 # If necessary rebase changes on master to ensure we have a fast forward.
 $ git rebase -i master
@@ -97,7 +97,7 @@ $ git rebase -i master
 
 # Merge changes into master
 $ git checkout master
-$ git merge issue-123
+$ git merge fix-123
 
 # Push to origin
 $ git push origin master

data/Gemfile

@@ -3,16 +3,24 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'vagrant',      git: 'https://github.com/mitchellh/vagrant.git'
-  gem 'rake'
-  gem 'vagrant-libvirt'  if RUBY_PLATFORM =~ /linux/i
-  gem 'fog-libvirt', '0.0.3'  if RUBY_PLATFORM =~ /linux/i # https://github.com/pradels/vagrant-libvirt/issues/568
+  gem 'vagrant',
+      git: 'git://github.com/mitchellh/vagrant.git',
+      ref: 'v1.8.4'
+  gem 'vagrant-libvirt'              if RUBY_PLATFORM =~ /linux/i
+  gem 'fog-libvirt', '0.0.3'         if RUBY_PLATFORM =~ /linux/i # https://github.com/pradels/vagrant-libvirt/issues/568
   gem 'mechanize'
   gem 'json'
   gem 'cucumber', '~> 2.1'
   gem 'aruba', '~> 0.13'
   gem 'komenda', '~> 0.1.6'
   gem 'launchy'
+  gem 'rake', '10.4.2'
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'mocha'
 end
 
 group :plugins do

data/README.adoc

@@ -7,8 +7,8 @@ easier access to the features and services provided by the
 https://github.com/projectatomic/adb-atomic-developer-bundle[Atomic
 Developer Bundle (ADB)]. It provides setup information, including
 environment variables and certificates, required to access services
-provided by the ADB and is a must have for most ADB users.
-
+provided by the ADB and is a must have for most ADB users. +
+ +
 This plugin makes it easier to use the ADB with host-based tools such as
 Eclipse and the docker and kubernetes CLI commands. Details on how to
 use ADB with this plugin can be found in the
@@ -19,15 +19,15 @@ Documentation].
 toc::[]
 '''
 
-== Installation
+== Status
 
-The plugin is distributed as both a Ruby Gem and via RPM using the
-Fedora COPR system.
+[[img-build-status]]
+image::https://ci.centos.org/buildStatus/icon?job=vagrant-service-manager[link="https://ci.centos.org/job/vagrant-service-manager"]
 
-=== Installing from a RubyGems
+== Installation
 
-The vagrant-service-manager
-https://rubygems.org/gems/vagrant-service-manager[gem] is available on
+The vagrant-service-manager plugin is distributed as a Ruby Gem.
+The https://rubygems.org/gems/vagrant-service-manager[gem] is available on
 https://rubygems.org[RubyGems] and can be installed via the standard
 Vagrant plugin installation method:
 
@@ -35,17 +35,6 @@ Vagrant plugin installation method:
 $ vagrant plugin install vagrant-service-manager
 ------------------------------------------------
 
-=== Installing from RPM
-
-The
-https://copr.fedorainfracloud.org/coprs/nshaikh/vagrant-service-manager/builds/[Copr
-build] is accessible via the standard COPR access/install method:
-
-----------------------------------------------------------------------------------
-$ dnf copr enable nshaikh/vagrant-service-manager
-$ dnf --enablerepo=nshaikh-vagrant-service-manager install vagrant-service-manager
-----------------------------------------------------------------------------------
-
 == Usage
 
 === Example execution of the plugin
@@ -55,7 +44,7 @@ $ dnf --enablerepo=nshaikh-vagrant-service-manager install vagrant-service-manag
 ----------------------------------------------
 vagrant plugin install vagrant-service-manager
 ----------------------------------------------
-2.  Download the relevant Vagrantfile for your
+1.  Download the relevant Vagrantfile for your
 https://github.com/projectatomic/adb-atomic-developer-bundle[ADB]
 vagrant box, from the
 https://github.com/projectatomic/adb-atomic-developer-bundle/tree/master/components/centos[repository].
@@ -63,12 +52,12 @@ For further details on the usage of custom Vagrantfiles designed for
 specific use cases, refer to the
 https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/using.rst[Usage
 Documentation].
-3.  Start the ADB vagrant box using `vagrant up`. For detailed
+1.  Start the ADB vagrant box using `vagrant up`. For detailed
 instructions consult the
 https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/installing.rst[Installation
 Documentation].
 +
-*Note:* When the vagrant-service-manager plugin is loaded and a box is
+*Note:* When the vagrant-service-manager plugin is loaded and an ADB box is
 started using the VirtualBox provider, the user needs to add a routable
 non NAT network interface declaration in the Vagrantfile. If the user
 does not provide a network declaration in the Vagrantfile, a private
@@ -80,10 +69,11 @@ DHCP network is added by default and a warning is displayed.
 $ vagrant service-manager env docker
 # Set the following environment variables to enable access to the
 # docker daemon running inside of the vagrant virtual machine:
-export DOCKER_HOST=tcp://172.28.128.4:2376
+export DOCKER_HOST=tcp://172.28.128.182:2376
 export DOCKER_CERT_PATH=/foo/bar/.vagrant/machines/default/virtualbox/docker
 export DOCKER_TLS_VERIFY=1
-export DOCKER_API_VERSION=1.21
+export DOCKER_API_VERSION=1.20
+
 # run following command to configure your shell:
 # eval "$(vagrant service-manager env docker)"
 ----------------------------------------------------------------------------
@@ -100,55 +90,63 @@ will also re-download the certificates onto the host machine.
 The following section lists the available commands for the plugin and
 their explanation:
 
+1.  `vagrant service-manager [command] [--help | -h]`
++
+Displays the possible commands, options and other relevant information
+for the vagrant-service-manager plugin. If a `command` is specified,
+only the help relevant to that command is displayed.
+
 1.  `vagrant service-manager env [service] [--script-readable]`
 +
 Displays connection information for all active services in the box in a
-manner that can be evaluated in a shell. If a `service` is specified,
-only the information for that service is displayed. When
-`--script-readable` is specified the output is in `key=value` format.
-The supported services are: Docker; OpenShift.
-
-1.  `vagrant service-manager box [command]`
+manner that can be evaluated in a shell. +
+If a `service` is specified, only the information for that service is displayed.
+The supported services are: Docker, OpenShift. +
+When `--script-readable` is specified the output is in `key=value` format. +
+In the case of the _docker_ service, the required TLS certificates for securing the Docker
+communication will be regenerated and copied to the host as part of the command execution.
+If existing certificates are found to be invalid, they get regenerated.
+
+1.  `vagrant service-manager box [command] [--script-readable]`
 +
 Displays box related information like release version, IP etc.
-
-1.  `vagrant service-manager box version [--script-readable]`
 +
-Displays the version and release information of the running VM. When
-`--script-readable` is specified the output is in `key=value` format.
+The possible options for `command` are:
 
-1.  `vagrant service-manager box ip`
+* `version`: Displays the version and release information of the running VM.
+* `ip`: Displays the routable IP address of the running VM.
 +
-Displays the routable IP address of the running VM.
+When `--script-readable` is specified the output is in `key=value` format.
 
-1.  `vagrant service-manager status [service]`
+1.  `vagrant service-manager [operation] [service]`
++
+Manages the life cycle of a service.
 +
-Lists services and their running state. If a `service` is specified only
+The possible options for `operation` are:
+
+  * `status`: Lists services and their running state. If a `service` is specified only
 the status of that service is displayed. If no service is provided then
 only supported orchestrators are reported.
-
-1.  `vagrant service-manager [operation] [service]`
+  * `start`: Start the given service in the box.
+  * `stop`: Stop the given service in the box.
+  * `restart`: Restart the given service in the box.
 +
-where `operation` could be:
+The supported options for `service` are `docker` and `openshift`.
 
-  * `restart` : Restart the given service in the box.
-  * `start`   : Start the given service in the box.
-  * `stop`    : Stop the given service in the box.
+1. `vagrant service-manager install-cli [service]`
 +
-and `service` could be `docker`, `openshift`, `kubernetes` etc.
-
-1.  `vagrant service-manager [command] [--help | -h]`
+Install the client binary for the specified `service`. Binaries are per default downloaded to
+`$VAGRANT_HOME/data/service-manager/bin/<service>/<cli-version>`, where `$VAGRANT_HOME` defaults to
+`.vagrant.d` in your home directory.
 +
-Displays the possible commands, options and other relevant information
-for the vagrant-service-manager plugin. If a `command` is specified,
-only the help relevant to that command is displayed.
+The supported options for `service` are `docker` and `openshift`.
 
 [[debug-flag]]
 ==== Debug Flag
 
 Append `--debug` flag to enable debug mode.
 
-_Note_: Debug output from `vagrant-service-manager` is prepended with
+*Note:* Debug output from `vagrant-service-manager` is prepended with
 the following string:
 
 `DEBUG command: [ service-manager: <command name / log message> ]`
@@ -182,27 +180,56 @@ have IPv4 addresses, the address on eth2 is used.
 
 === Setup
 
-After cloning the repository, install the http://bundler.io/[Bundler]
+1. After cloning the repository, install the http://bundler.io/[Bundler]
 gem:
-
++
 ---------------------
 $ gem install bundler
 ---------------------
 
-Then setup your project dependencies:
-
+1. Then setup your project dependencies:
++
 ----------------
 $ bundle install
 ----------------
 
-The build is driven via rake. All build related tash should be executed
+1. The build is driven via `rake`. All build related tasks should be executed
 in the Bundler environment, e.g. `bundle exec rake clean`. You can get a
 list of available Rake tasks via:
-
++
 ---------------------
 $ bundle exec rake -T
 ---------------------
 
+=== Code style
+
+As most other open-source projects, vagrant-service-manager has a set of conventions
+about how to write code for it. It follows the
+https://github.com/bbatsov/ruby-style-guide[Ruby Style Guide].
+
+You can verify that your changes adhere to this style using the http://batsov.com/rubocop[RuboCop] Rake task:
+
+--------------------------
+$ bundle exec rake rubocop
+--------------------------
+
+=== Unit tests
+
+The source contains a set of http://ruby-doc.org/stdlib-2.0.0/libdoc/minitest/rdoc/MiniTest.html[Minitest]
+unit tests. They can be run as follows:
+
+To run the entire test suite:
+
+------------------------
+$ bundle exec rake test
+------------------------
+
+To run a single test:
+
+-------------------------------------------------
+$ bundle exec rake test TEST=<path to test file>
+-------------------------------------------------
+
 === Acceptance tests
 
 The source also contains a set of https://cucumber.io/[Cucumber]
@@ -212,26 +239,33 @@ acceptance tests. They can be run via:
 $ bundle exec rake features
 ---------------------------
 
-_NOTE_: Only Linux OS is supported at present.
-
-The tests assume that the ADB and CDK box files are available under
-_build/boxes/adb-<provider>.box_ resp
-_build/boxes/cdk-<provider>.box_. You can either copy the box files
-manually or use the _get_adb_ resp. _get_cdk_ Rake tasks.
+*Note:* This Cucumber tests do not run on Windows, pending resolution of
+https://github.com/projectatomic/vagrant-service-manager/issues/213[Issue #213].
 
-Per default only the scenarios for ADB in combination with the
-VirtualBox provider are run. However, you can also run against CDK
+Per default, only the scenarios for ADB in combination with the
+VirtualBox provider are run. However, you can also run the tests against CDK
 and/or use the Libvirt provider using the environment variables _BOX_
-resp _PROVIDER_:
+and _PROVIDER_ respectively:
 
 -----------------------------------------------------
 # Run tests against CDK using Libvirt
 $ bundle exec rake features BOX=cdk PROVIDER=libvirt
 
-# Run against ADB and CDK (boxes are comma seperated)
+# Run against ADB and CDK (boxes are comma separated)
 $ bundle exec rake features BOX=cdk,adb
+
+# Run against ADB and CDK using VirtualBox and Libvirt
+$ bundle exec rake features BOX=cdk,adb PROVIDER=libvirt,virtualbox
 -----------------------------------------------------
 
+The _features_ task will transparently download the required Vagrant
+boxes and cache them in _.boxes_. The cache can be cleared
+via the _clean_boxes_ task.
+
+Using the variable _NIGHTLY=true_ you can make sure that the
+latest nightly build of the CDK is used (VPN access required).
+Per default the latest public release of the CDK is used.
+
 You can also run a single feature specifying the explicit feature file
 to use:
 
@@ -239,8 +273,8 @@ to use:
 $ bundle exec rake features FEATURE=features/<feature-filename>.feature
 -----------------------------------------------------------------------
 
-After test execution the Cucumber test reports can be found under
-_build/features_report.html_. They can also be opened via
+After test execution, the Cucumber test reports can be found under
+_build/features_report.html_. They can also be opened via:
 
 ---------------------------------------
 $ bundle exec rake features:open_report
@@ -250,7 +284,7 @@ $ bundle exec rake features:open_report
 
 We welcome your input. You can submit issues or pull requests with
 respect to the vagrant-service-manager plugin. Refer to the
-https://github.com/projectatomic/vagrant-service-manager/blob/master/CONTRIBUTING.md[contributing
+https://github.com/projectatomic/vagrant-service-manager/blob/master/CONTRIBUTING.adoc[contributing
 guidelines] for detailed information on how to contribute to this
 plugin.