vagrant-service-manager 1.0.2 → 1.1.0.beta.1

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

@@ -1,4 +1,4 @@
-module Vagrant
+module VagrantPlugins
   module ServiceManager
     class Kubernetes
       def initialize(machine, ui)

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

@@ -1,4 +1,4 @@
-module Vagrant
+module VagrantPlugins
   module ServiceManager
     class OpenShift
       OPENSHIFT_PORT = 8443
@@ -11,7 +11,7 @@ module Vagrant
 
       def execute
         command = "#{@extra_cmd} sccli openshift"
-        Plugin.execute_and_exit_on_fail(@machine, @ui, command)
+        PluginUtil.execute_and_exit_on_fail(@machine, @ui, command)
       end
 
       def self.status(machine, ui, service)
@@ -33,6 +33,8 @@ module Vagrant
       end
 
       def self.print_info(ui, options)
+        PluginLogger.debug("script_readable: #{options[:script_readable] || false}")
+
         label = PluginUtil.env_label(options[:script_readable])
         message = I18n.t("servicemanager.commands.env.openshift.#{label}",
                          openshift_url: options[:url],

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

@@ -1,5 +1,5 @@
-module Vagrant
+module VagrantPlugins
   module ServiceManager
-    VERSION = "1.0.2"
+    VERSION = "1.1.0.beta.1"
   end
 end

data/lib/vagrant-service-manager.rb

@@ -8,7 +8,7 @@ require 'vagrant-service-manager/plugin'
 require 'vagrant-service-manager/command'
 require 'vagrant-service-manager/os'
 
-module Vagrant
+module VagrantPlugins
   module ServiceManager
     # Returns the path to the source of this plugin
     def self.source_root

data/locales/en.yml

@@ -24,7 +24,9 @@ en:
           Commands:
                env          displays connection information for services in the box
                box          displays box related information like version, release, IP etc
-               restart      restarts the given systemd service in the box
+               restart      restarts the given service in the box
+               start        starts the given service in the box
+               stop         stops the given service in the box
                status       list services and their running state
 
           Options:
@@ -54,6 +56,10 @@ en:
                 --script-readable  display information in a script readable format
                 -h, --help         print this help
 
+          Examples:
+                vagrant service-manager box version
+                vagrant service-manager box ip
+                vagrant service-manager box version --script-readable
         status: |-
           Usage: vagrant service-manager status [service] [options]
 
@@ -63,25 +69,22 @@ en:
           If a service is provided, only that service is reported.
           If no service is provided only supported orchestrators are reported.
 
-          Examples:
-                vagrant service-manager box version
-                vagrant service-manager box ip
-                vagrant service-manager box version --script-readable
-
-        restart: |-
-          Restarts the service
+          Example:
+                vagrant service-manager status openshift
+        operation: |-
+          %{operation}s the service
 
-          Usage: vagrant service-manager restart <service> [options]
+          Usage: vagrant service-manager %{operation} <service> [options]
 
           Service:
-              A service provided by sccli or systemd. For example:
-               docker, k8s, or openshift etc.
+              A service provided by sccli. For example:
+               docker, kubernetes, openshift etc
 
           Options:
                 -h, --help         print this help
 
           Examples:
-            vagrant service-manager restart docker
+            vagrant service-manager %{operation} docker
 
       env:
         docker:
@@ -138,8 +141,11 @@ en:
           # eval "$(vagrant service-manager env%{command})"
         service_not_running: |-
           # %{name} service is not running in the vagrant box.
-      restart:
+      operation:
         service_missing: 'Service name missing'
+        sccli_only_support: |-
+          Only sccli services are supported. For example:
+            docker, openshift and kubernetes
 
       status:
         nil: |-

data/plugins/guests/redhat/cap/box_version.rb

@@ -3,17 +3,19 @@ module VagrantPlugins
     module Cap
       class BoxVersion
         # Prints the version of the vagrant box, parses /etc/os-release for version
-        def self.box_version(machine, script_readable)
+        def self.box_version(machine, options = {})
           command = "cat #{OS_RELEASE_FILE} | grep VARIANT"
+
           # TODO: execute efficient command to solve this
           if machine.communicate.test(command) # test if command is exits with code 0
+            PluginLogger.debug
             machine.communicate.execute(command) do |type, data|
               if type == :stderr
                 @env.ui.error(data)
                 exit 126
               end
 
-              return data.chomp if script_readable
+              return data.chomp if options[:script_readable]
               info = Hash[data.delete('"').split("\n").map { |e| e.split('=') }]
               return "#{info['VARIANT']} #{info['VARIANT_VERSION']}"
             end

data/plugins/guests/redhat/cap/machine_ip.rb

@@ -6,9 +6,12 @@ module VagrantPlugins
           # Find the guest IP
           command = "ip -o -4 addr show up |egrep -v ': docker|: lo' |tail -1 | awk '{print $4}' |cut -f1 -d\/"
           ip = ''
+
+          PluginLogger.debug
           machine.communicate.execute(command) do |type, data|
             ip << data.chomp if type == :stdout
           end
+
           ip
         end
       end

data/plugins/guests/redhat/plugin.rb

@@ -1,4 +1,5 @@
 require 'vagrant'
+require File.expand_path('../../../../', __FILE__) + '/lib/vagrant-service-manager/plugin_logger'
 
 module VagrantPlugins
   OS_RELEASE_FILE = '/etc/os-release'

data/vagrant-service-manager.gemspec

@@ -3,7 +3,7 @@ require 'vagrant-service-manager/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'vagrant-service-manager'
-  spec.version       = Vagrant::ServiceManager::VERSION
+  spec.version       = VagrantPlugins::ServiceManager::VERSION
   spec.license       = 'GPL-2.0'
   spec.homepage      = 'https://github.com/projectatomic/vagrant-service-manager'
   spec.summary       = "To provide the user a CLI to configure the ADB/CDK for different use cases and to provide glue between ADB/CDK and the user's developer environment."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-service-manager
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0.beta.1
 platform: ruby
 authors:
 - Brian Exelbierd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies: []
 description: Provides setup information, including environment variables and certificates,
   required to access services provided by ADB/CDK.
@@ -20,23 +20,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".config/cucumber.yml"
 - ".gitattributes"
 - ".gitignore"
 - CHANGELOG.md
-- CONTRIBUTING.md
+- CONTRIBUTING.adoc
 - Gemfile
 - LICENSE
 - MAINTAINERS
-- README.md
+- README.adoc
 - Rakefile
 - TODO
 - Vagrantfile
+- features/box-command.feature
+- features/debug-flag.feature
+- features/env-command.feature
+- features/help-command.feature
+- features/openshift.feature
+- features/service-operation.feature
+- features/status-command.feature
+- features/support/env.rb
 - lib/vagrant-service-manager.rb
 - lib/vagrant-service-manager/action/setup_network.rb
 - lib/vagrant-service-manager/command.rb
 - lib/vagrant-service-manager/config.rb
 - lib/vagrant-service-manager/os.rb
 - lib/vagrant-service-manager/plugin.rb
+- lib/vagrant-service-manager/plugin_logger.rb
 - lib/vagrant-service-manager/plugin_util.rb
 - lib/vagrant-service-manager/service.rb
 - lib/vagrant-service-manager/services/docker.rb
@@ -66,9 +76,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8

data/CONTRIBUTING.md

@@ -1,77 +0,0 @@
-# Contributing to vagrant-service-manager Plugin
-
-The following is a set of guidelines for contributing to the
-vagrant-service-manager plugin, which is hosted in the [Project Atomic
-Organization](https://github.com/projectatomic) on GitHub.
-
-These are just guidelines, please use your best judgement and feel free
-to propose changes to this document in a pull request.
-
-At this point, this document is not complete, but as decisions are made on the
-[container-tools@redhat.com](https://www.redhat.com/mailman/listinfo/container-tools)
-mailing list they will be added to this document.
-
-
-## Submitting Issues
-
-You can submit issues with respect to the vagrant-service-manager plugin [here](https://github.com/projectatomic/vagrant-service-manager/issues/new).Make sure you include all the relevant details pertaining the issue.
-
-Before submitting new issues, it is suggested to check [all existing issues](https://github.com/projectatomic/vagrant-service-manager/issues) in order to avoid duplication.The vagrant-service-manager plugin works closely with the [ADB](https://github.com/projectatomic/adb-atomic-developer-bundle/issues) and the [adb-utils](https://github.com/projectatomic/adb-utils/issues) RPM. You may wish to review the issues in both the repositories as well.
-
-
-## Submitting Pull Requests
-
-* All changes will be made by pull request (PR), even from core
-  committers/maintainers.
-
-* All changes must include appropriate documentation updates.
-
-* All changes must include an entry in the [Changelog document](https://github.com/projectatomic/vagrant-service-manager/blob/master/CHANGELOG.md) in the *Unreleased* section describing the change. Your new entry should be the last entry in the *Unreleased* section and should include your GitHub userid.
-
-* All changes need at least 2 ACKs from maintainers before they will be merged. If
-  the author of the PR is a maintainer, their submission is considered
-  to be the first ACK.  Therefore, PRs from maintainers only need one
-  additional ACK.
-
-  By "2 ACKs" we mean that two maintainers must acknowledge that the change
-  is a good one. The 2<sup>nd</sup> person to ACK the PR should merge the PR with
-  a comment including their agreement.
-
-
-## How to Develop/Test
-
-1. Install the Atomic Developer Bundle (ADB), as
-[documented](https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/installing.rst)
-in the ADB project.  Do not start the box yet.
-
-2. Fork and clone the vagrant-service-manager repository
-
-        git clone https://github.com/projectatomic/vagrant-service-manager
-
-3. Change the directory to vagrant-service-manager `cd vagrant-service-manager`
-
-4. Run `bundle install`
-
-5. Start the box with `bundle exec vagrant up
-
-6. Develop the plugin and test by running `bundle exec vagrant service-manager`
-
-7. When you are ready to build the release, get one of the [repository maintainers](https://github.com/projectatomic/vagrant-service-manager/blob/master/MAINTAINERS) to release the plugin.
-
-
-### How to build the Vagrant plugin using Bundler
-
-You can also use Bundler to build the plugin and install it manually in
-your Vagrant environment
-
-1. Run the commands below inside of the repository:
-
-```
-$ bundle install
-$ bundle exec rake build
-````
-
-2. Install the plugin using:
-
-    vagrant plugin install pkg/<gem name>
-

data/README.md

@@ -1,120 +0,0 @@
-# vagrant-service-manager
-
-* [Objective](#objective)
-* [Example Execution of the Plugin](#example_execution)
-* [Available Commands](#commands)
-* [Exit codes](#exit_codes)
-* [IP Address Detection](#ip_addr)
-* [Getting Involved with the Project](#Contributing)
-* [Builds](#builds)
-
-
-The vagrant-service-manager plugin is designed to enable easier access to the features and services provided by the [Atomic Developer Bundle (ADB)](https://github.com/projectatomic/adb-atomic-developer-bundle). 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.
-
-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 [ADB Documentation](https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/using.rst).
-
-
-## Objective <a name="objective"></a>
-
-The [ADB](https://github.com/projectatomic/adb-atomic-developer-bundle) provides a ready-to-use development environment for container applications. With ADB, developers can dive right into producing complex, multi-container applications.
-
-The vagrant-service-manager provides the user with:
-
-* A CLI to configure the ADB for different use cases and to provide an interface between ADB and the user's development environment.
-* A tool to control and configure the ADB from the
-developer's workstation without having to `ssh` directly into the ADB virtual machine.
-
-
-## Example Execution of the Plugin <a name="example_execution"></a>
-
-1. Install vagrant-service-manager plugin:
- 
-        vagrant plugin install vagrant-service-manager
-
-2. Download the relevant Vagrantfile for your [ADB](https://github.com/projectatomic/adb-atomic-developer-bundle) vagrant box, from the [repository](https://github.com/projectatomic/adb-atomic-developer-bundle/tree/master/components/centos). For further details on the usage of custom Vagrantfiles designed for specific use cases, refer to the [Usage Documentation](https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/using.rst).
-
-3. Start the ADB vagrant box using `vagrant up`. For detailed instructions consult the [Installation Documentation](https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/installing.rst).
-
-	**Note:** When the vagrant-service-manager plugin is loaded and a 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 DHCP network is added by default and a warning is displayed.
-
-4. Run the plugin to get environment variables and certificates:
-
-        $ 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_CERT_PATH=/foo/bar/.vagrant/machines/default/virtualbox/docker
-        export DOCKER_TLS_VERIFY=1
-        export DOCKER_API_VERSION=1.21
-        # run following command to configure your shell:
-        # eval "$(vagrant service-manager env docker)"
-
-	**Note:** The required TLS certificates are copied to the host machine at the time of `vagrant up` itself. Every run of `vagrant service-manager env docker` checks for the validity of the certificates on the host machine by matching the certificates inside the box. If the certificates on the host machine are invalid, this command will also re-download the certificates onto the host machine.
-
-
-## Available Commands <a name="commands"></a>
-
-The following section lists the available commands for the plugin and their explanation:
-
-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.
-
-2. `vagrant service-manager box [command]`
-
-   Displays box related information like release version, IP etc. 
-
-3. `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.
-
-4. `vagrant service-manager box ip` 
-
-   Displays the routable IP address of the running VM. 
-
-5. `vagrant service-manager status [service]` 
-
-   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.
-
-6. `vagrant service-manager restart [service]` 
-
-   Restarts the given service in the box.
-
-7. `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.
-
-
-
-## Exit codes <a name="exit_codes"></a>
-
-The following table lists the plugin's exit codes and their meaning:
-
-Exit Code Number   | Meaning
--------------------|-------------------------------------------------------------------------
-`0`                | No error
-`1`                | Catch all for general errors / Wrong sub-command or option given
-`3`                | Vagrant box is not running and should be running for this command to succeed
-`126`              | A service inside the box is not running / Command invoked cannot execute
-
-
-## IP Address Detection <a name="ip_addr"></a>
-
-There is no standardized way of detecting Vagrant box IP addresses.
-This code uses the last IPv4 address available from the set of configured addresses that are *up*.  i.e. if eth0, eth1, and eth2 are all up and have IPv4 addresses, the address on eth2 is used.
-
-
-## Getting Involved with the Project <a name="Contributing"></a>
-
-We welcome your input. You can submit issues or pull requests with respect to the vagrant-service-manager plugin. Refer to the [contributing guidelines](https://github.com/projectatomic/vagrant-service-manager/blob/master/CONTRIBUTING.md) for detailed information on how to contribute to this plugin.
-
-You can contact us on:
-  * IRC: #atomic and #nulecule on freenode
-  * Mailing List: container-tools@redhat.com
-
-
-## Builds <a name="builds"></a>
-
-- Gem: https://rubygems.org/gems/vagrant-service-manager
-
-- Copr build: https://copr.fedorainfracloud.org/coprs/nshaikh/vagrant-service-manager/builds/