train-habitat 0.1.1 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b8186bbf0eb9865517415f2f9270625140b5881b
-  data.tar.gz: f9680ef5db5b308a52c27efb2c4baa054de253db
+SHA256:
+  metadata.gz: d517d6acec8b0d954a94a128af818ce58f1e5c7795bc4b00d1cde1d2d13b8bee
+  data.tar.gz: f2c33469c6461d34b50b0f1b484c89148b939604c1343a92e798ff6f98d9950a
 SHA512:
-  metadata.gz: 49a883505104ab0e9c69356e9bbea5ab46663a11c4fb9be12ba599172e506c7c5ea7c8708639a0f58cb46fc3079e17c71abe6843cb5a257a721b3410fc9b265d
-  data.tar.gz: ac1de8ee00ae2ba8c5bdd087784f699b084d6c87f31047ae822e9fe683a3a76ef16ec70f29f9d539773e0903ea11fd845fe8ef745832e4b146a1a59dff7f1055
+  metadata.gz: 867c09352706b078b177328ac37483e55042e0b59babf46718b856313b63556a0d5c6722f39a92bd2a800b34c5c444cac40c7604b13d598e689ca1f57115d97c
+  data.tar.gz: c20278d657b5c68ad2f3d4bb7f07d67f6038cd4055fe7e4d45d03ec1ac89637b59820416fecabbf220543d3932eefe478c9f821ffb106c8e9a5c3ff5585f67f2

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2018 Chef Software Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/train-habitat.rb

@@ -3,7 +3,7 @@
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-require 'train-habitat/version'
-require 'train-habitat/transport'
-require 'train-habitat/platform'
-require 'train-habitat/connection'
+require_relative "train-habitat/version"
+require_relative "train-habitat/transport"
+require_relative "train-habitat/platform"
+require_relative "train-habitat/connection"

data/lib/train-habitat/connection.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'json'
-require 'train-habitat/httpgateway'
-require 'train-habitat/platform'
-require 'train-habitat/transport'
+require "net/http" unless defined?(Net::HTTP)
+require "json" unless defined?(JSON)
+require_relative "httpgateway"
+require_relative "platform"
+require_relative "transport"
 
 module TrainPlugins
   module Habitat
@@ -27,7 +27,7 @@ module TrainPlugins
       end
 
       def api_options_provided?
-        have_transport_options_with_prefix?('api')
+        have_transport_options_with_prefix?("api")
       end
 
       def cli_options_provided?
@@ -41,11 +41,18 @@ module TrainPlugins
         raise CliNotAvailableError(cli_tranport_names) unless cli_options_provided?
 
         # TODO: - leverage exec_options to add things like JSON parsing, ENV setting, etc.
-        cli_connection.run_command(hab_path + ' ' + command)
+        cli_connection.run_command(hab_path + " " + command)
+      end
+
+      # See #run_command in BaseConnection.
+      def run_command_via_connection(*args)
+        raise CliNotAvailableError(cli_tranport_names) unless cli_options_provided?
+
+        cli_connection.run_command(*args)
       end
 
       def hab_path
-        '/bin/hab'
+        "/bin/hab"
       end
 
       def habitat_api_client
@@ -53,9 +60,9 @@ module TrainPlugins
           # Send all options beginning with api_ to the HTTPGateway, stripping the prefix
           api_options = {}
           transport_options.each do |option_name, option_value|
-            next unless option_name.to_s.start_with? 'api_'
+            next unless option_name.to_s.start_with? "api_"
 
-            api_options[option_name.to_s.sub(/^api_/, '').to_sym] = option_value
+            api_options[option_name.to_s.sub(/^api_/, "").to_sym] = option_value
           end
           HTTPGateway.new(api_options)
         end
@@ -69,14 +76,14 @@ module TrainPlugins
         end
 
         valid_cli_prefixes = TrainPlugins::Habitat::Transport.cli_transport_prefixes.keys.map(&:to_s)
-        seen_cli_options = transport_options.keys.map(&:to_s).select { |n| n.start_with?('cli_') }
+        seen_cli_options = transport_options.keys.map(&:to_s).select { |n| n.start_with?("cli_") }
 
         # All seen CLI options must start with a recognized prefix
         options_by_prefix = {}
         seen_cli_options.each do |option|
           prefix = valid_cli_prefixes.detect { |p| option.start_with?(p) }
           unless prefix
-            raise Train::TransportError, "All Habitat CLI connection options must begin with a recognized prefix (#{valid_cli_prefixes.join(', ')}) - saw #{option}"
+            raise Train::TransportError, "All Habitat CLI connection options must begin with a recognized prefix (#{valid_cli_prefixes.join(", ")}) - saw #{option}"
           end
 
           options_by_prefix[prefix] ||= []
@@ -85,7 +92,7 @@ module TrainPlugins
 
         # Only one prefix may be used (don't mix and match)
         if options_by_prefix.count > 1
-          raise Train::TransportError, "Only one set of Habitat CLI connection options may be used - saw #{options_by_prefix.keys.join(', ')}"
+          raise Train::TransportError, "Only one set of Habitat CLI connection options may be used - saw #{options_by_prefix.keys.join(", ")}"
         end
       end
 
@@ -110,7 +117,7 @@ module TrainPlugins
         seen_cli_transports = {}
         non_specific_options = {} # Things like :logger, :sudo, etc
         transport_options.each do |xport_option_name, xport_option_value|
-          unless xport_option_name.to_s.start_with?('cli_')
+          unless xport_option_name.to_s.start_with?("cli_")
             non_specific_options[xport_option_name] = xport_option_value
             next
           end
@@ -121,7 +128,7 @@ module TrainPlugins
 
             seen_cli_transports[xport_name] ||= {}
             # Remove the prefix from the option and store under transport name
-            seen_cli_transports[xport_name][xport_option_name.to_s.sub(/^#{prefix}_/, '').to_sym] = xport_option_value
+            seen_cli_transports[xport_name][xport_option_name.to_s.sub(/^#{prefix}_/, "").to_sym] = xport_option_value
           end
         end
 

data/lib/train-habitat/httpgateway.rb

@@ -1,5 +1,5 @@
-require 'uri'
-require 'net/http'
+require "uri" unless defined?(URI)
+require "net/http" unless defined?(Net::HTTP)
 
 module TrainPlugins
   module Habitat
@@ -23,7 +23,7 @@ module TrainPlugins
         uri.path = path
         headers = {}
         unless auth_token.nil?
-          headers['Authorization'] = 'Bearer ' + auth_token # Set bearer token, see https://www.habitat.sh/docs/using-habitat/#authentication
+          headers["Authorization"] = "Bearer " + auth_token # Set bearer token, see https://www.habitat.sh/docs/using-habitat/#authentication
         end
 
         conn = Net::HTTP.start(uri.host, uri.port)

data/lib/train-habitat/illegal_state_error.rb

@@ -20,12 +20,12 @@ end
 
 class CliNotAvailableError < IllegalStateError
   def initialize(_cli_tranport_names)
-    super("No CLI-capable connection options passed - use one of #{cli_transport_names.join(', ')} option sets")
+    super("No CLI-capable connection options passed - use one of #{cli_transport_names.join(", ")} option sets")
   end
 end
 
 class MultipleCliTransportsError < IllegalStateError
   def initialize(_cli_tranport_names)
-    super("Too many CLI-capable transports specified - only one may be used at a time.  Saw: #{cli_transport_names.join(', ')}.")
+    super("Too many CLI-capable transports specified - only one may be used at a time.  Saw: #{cli_transport_names.join(", ")}.")
   end
 end

data/lib/train-habitat/platform.rb

@@ -4,8 +4,8 @@ module TrainPlugins
   module Habitat
     module Platform
       def platform
-        Train::Platforms.name('habitat').in_family('api')
-        force_platform!('habitat', release: TrainPlugins::Habitat::VERSION)
+        Train::Platforms.name("habitat").in_family("api")
+        force_platform!("habitat", release: TrainPlugins::Habitat::VERSION)
       end
     end
   end

data/lib/train-habitat/transport.rb

@@ -1,11 +1,11 @@
-require 'train'
-require 'train/plugins'
-require 'train-habitat/connection'
+require "train"
+require "train/plugins"
+require_relative "connection"
 
 module TrainPlugins
   module Habitat
     class Transport < Train.plugin(1)
-      name 'habitat'
+      name "habitat"
 
       # The train-habitat plugins is a chimeric plugin, meaning it uses
       # multiple ways of connecting to its target. A user must specifiy
@@ -14,8 +14,8 @@ module TrainPlugins
 
       # For service listings and health, specify supervisor api options.
       # https://www.habitat.sh/docs/using-habitat/#monitor-services-through-the-http-api
-      option :api_url, required: false, desc: 'The url at which a Habitat Supervisor exposes its HTTP Gateway API'
-      option :api_auth_token, required: false, desc: 'A bearer token which may be used to authenticate to the Supervisor HTTP Gateway'
+      option :api_url, required: false, desc: "The url at which a Habitat Supervisor exposes its HTTP Gateway API"
+      option :api_auth_token, required: false, desc: "A bearer token which may be used to authenticate to the Supervisor HTTP Gateway"
 
       def self.cli_transport_prefixes
         {

data/lib/train-habitat/version.rb

@@ -2,6 +2,6 @@
 
 module TrainPlugins
   module Habitat
-    VERSION = '0.1.1'
+    VERSION = "0.2.22"
   end
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: train-habitat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.22
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: train
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: Allows applications using Train to speak to Habitat.
 email:
 - inspec@chef.io
@@ -65,8 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- README.md
+- LICENSE
 - lib/train-habitat.rb
 - lib/train-habitat/connection.rb
 - lib/train-habitat/httpgateway.rb
@@ -74,7 +53,6 @@ files:
 - lib/train-habitat/platform.rb
 - lib/train-habitat/transport.rb
 - lib/train-habitat/version.rb
-- train-habitat.gemspec
 homepage: https://github.com/inspec/train-habitat
 licenses:
 - Apache-2.0
@@ -94,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Habitat API Transport for Train

data/Gemfile

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-  gem 'byebug', '~> 11.0'
-  gem 'm', '~> 1.5'
-  gem 'minitest', '~> 5.11'
-  gem 'mocha', '~> 1.8'
-  gem 'pry', '~> 0.11'
-  gem 'rake', '~> 12.3'
-  gem 'rubocop', '~> 0.59'
-end

data/README.md

@@ -1,163 +0,0 @@
-# Train-Habitat
-
-`train-habitat` is a Train plugin and is used as a Train Transport to connect to Habitat installations.
-
-## To Install this as a User
-
-You will need InSpec v2.3 or later.
-
-Simply run:
-
-```
-$ inspec plugin install train-habitat
-```
-
-## Using train-habitat from InSpec
-
-As `train-habitat` takes potentially many options, it is simplest to list the options in your `~/.inspec/config.json` file, then used the named set of options with `-t`.
-
-For example, if your config file contains:
-
-```
-{
-  "file_version": "1.1",
-  "credentials": {
-    "habitat": {
-      "dev-hab": {
-        "api_url": "http://dev-hab.my-corp.io",
-        "cli_ssh_host": "dev-hab.my-corp.io"
-      },
-      "prod-hab": {
-        "api_url": "https://prod-hab.my-corp.io",
-        "api_auth_token": "opensesame"
-      },
-    }
-  }
-}
-```
-
-Using this configuration, you could execute:
-
-```
-$ inspec exec some-profile -t habitat://dev-hab
-# Or
-$ inspec exec some-profile -t habitat://prod-hab
-```
-
-You may also pass `--config some-file.json` to use a config file at a different location.
-
-See the next section for the full list of options you may use with a `habitat` credential set in your configuration.
-
-## Using train-habitat from Ruby
-
-The options that may be passed to `Train.create` are listed below.
-
-### Dual-mode transport
-
-Because Habitat exposes some facts by its HTTP Gateway API, and some facts by its CLI tool `hab`, this Train Transport has three modes of operation:
-
- * Using only the HTTP API (no ability to query packages, but rich ability to query rings)
- * Using only the `hab` CLI command (limitations TBD)
- * Using both (full capabilities)
-
-When creating a `train-habitat` Connection, there are thus two sets of options, prefixed with `api_` and `cli_` respectively. You must provide at least one set.
-
-### API-Mode options
-
-API-mode options are used to connect to a Habitat Supervisor running with an exposed HTTP Gateway. They are prefixed with `api_`.
-
-```ruby
-Train.create(:habitat, api_url: 'http://my-hab.my-company.io:9631')
-```
-
-#### api_url
-
-Required for API-mode use. This is an HTTP or HTTPS URL that identifies a Supervisor HTTP Gateway.  If the port is omitted from the URL, the API standard port of 9631 is assumed; to use port 80, specify it explicitly.
-
-#### api_auth_token
-
-The supervisor may be configured to require a [Bearer Token Authorization](https://www.habitat.sh/docs/using-habitat/#monitor-services-through-the-http-api), in which the client and the gateway use a pre-shared secret. Use this option to specify the secret.
-
-### CLI Mode options
-
-CLI options are more varied, and are entirely dependent on the underlying transport chosen to reach the CLI. For example, if there were a supported transport named 'radio' that took options 'channel' and 'band', specify them to train-habitat like this:
-
-```ruby
-Train.create(:habitat, {cli_radio_band: 'VHF', cli_radio_channel: 23})
-```
-
-`train-habitat` identifies the underlying "sub-transport" using the prefixes of the provided options. For example, if you pass an option named `cli_ssh_host`, `train-habitat` will recognize that you intend to use the SSH transport to connect to a location that has access to the `hab` CLI tool.
-
-You may specify many options referring to the same sub-transport (such as credentials), but it is an error to specify more than one CLI sub-transport.
-
-Currently supported CLI transports include:
- * SSH
-
-Plans for future support include (in approximate order):
- * WinRM
- * Local
- * Docker
-
-#### General Options
-
-Any options not prefixed with `cli_` or `api_` are also passed to the CLI transport. This means you can use generic Train connection options such as the `sudo` and `shell` sets of options (see [train source code](https://github.com/inspec/train/blob/71679307903fc8853e09abd93f3901c83800e019/lib/train/extras/command_wrapper.rb#L31)), as well as `logger`.
-
-#### SSH Options
-
-`train-habitat` can accept any option that the Train SSH Transport accepts if the prefix `cli_ssh_` is added. This includes:
-
- * `cli_ssh_host` - String hostname or IP address
- * `cli_ssh_user` - String user to connect as
- * `cli_ssh_key_files` - Array of paths to private key files to use
-
-Other options are available; see [train source code](https://github.com/inspec/train/blob/71679307903fc8853e09abd93f3901c83800e019/lib/train/transports/ssh.rb#L45) for details.
-
-## Development
-
-### Testing
-```
-# Install development tools
-$ gem install bundler
-$ bundle install
-
-# Running style checker
-bundle exec rake lint
-
-# Running unit tests
-bundle exec rake test:unit
-
-# Running integration tests (requires Vagrant and VirtualBox)
-bundle exec rake test:integration
-```
-
-## Contributing
-
-1. Fork it
-1. Create your feature branch (git checkout -b my-new-feature)
-1. Commit your changes (git commit -sam 'Add some feature')
-1. Push to the branch (git push origin my-new-feature)
-1. Create new Pull Request
-
-## License
-
-| **Author:**          | Paul Welch
-
-| **Author:**          | David McCown
-
-| **Author:**          | Clinton Wolfe
-
-| **Copyright:**       | Copyright (c) 2018-2019 Chef Software Inc.
-
-| **License:**         | Apache License, Version 2.0
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

data/train-habitat.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'train-habitat/version'
-
-Gem::Specification.new do |spec|
-  spec.name        = 'train-habitat'
-  spec.version     = TrainPlugins::Habitat::VERSION
-  spec.authors     = ['Chef InSpec Team']
-  spec.email       = ['inspec@chef.io']
-  spec.summary     = 'Habitat API Transport for Train'
-  spec.description = 'Allows applications using Train to speak to Habitat.'
-  spec.homepage    = 'https://github.com/inspec/train-habitat'
-  spec.license     = 'Apache-2.0'
-
-  spec.files = %w{
-    README.md train-habitat.gemspec Gemfile
-  } + Dir.glob(
-    'lib/**/*', File::FNM_DOTMATCH
-  ).reject { |f| File.directory?(f) }
-  spec.require_paths = ['lib']
-
-  # All plugins should mention train, > 1.4
-  spec.add_dependency 'train', '>= 1.7.5', '< 3.0'
-
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-end