train-mcp 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a08c9d219a7e937c92cbbc3c3ae38f868c9ac3adb90be0ecf782b415eaeed112
+  data.tar.gz: 51224500bc66531999c9054cfc4942ef0f98de8e0660d11ce7f1a96865ad6031
+SHA512:
+  metadata.gz: add388bc2c9f1233df822d5f6a5d4f905f3a920bbfa1c64364358f352ed2f1ee499b66f7d8ffedaf638457cf45661d8dbd3335d157db9b299207c781bb05fee6
+  data.tar.gz: 92eaf18316dbfc37af3578f36fd8e60c1e865678218404f6feb07e192c2d3f0100c0b4f5e4ee692fb516c547275c93fb520d8e3b4cf15d27c6a6c29bb38a6495

data/Gemfile

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+source "https://rubygems.org"
+
+# This is Gemfile, which is used by bundler
+# to ensure a coherent set of gems is installed.
+# This file lists dependencies needed when outside
+# of a gem (the gemspec lists deps for gem deployment)
+
+# Bundler should refer to the gemspec for any dependencies.
+gemspec
+
+gem "train-core", [">= 1.7.5", "< 4.0"]
+group :development do
+  gem "pry"
+  gem "bundler"
+  gem "byebug"
+  gem "minitest"
+  gem "mocha"
+  gem "m"
+  gem "rake"
+  gem "chefstyle"
+  gem "rubocop"
+end

data/README.md

@@ -0,0 +1,28 @@
+## Inspec Train Plugin for NTT Managed Cloud Platform
+
+This plugin allows Chef Inspec to connect to the NTT MAnaged CLoud Platform API for validation of cloud resources.   
+
+### Usage
+
+For local testing, just run `gem build train-mcp.gemspec` , then install the plugin using the command `inspec plugin install <path to gem file created above>`.   
+You need 4 Environment variables set at present:
+
+* MCP_USER (username for Managed Cloud Platform)
+* MCP_PASSWORD (password for the above account)
+* MCP_ORG (Organization ID for MCP)
+* MCP_ENDPOINT (APi endpoint based on your region. See below for an example)
+   
+Example MCP Endpoint : https://api-au.dimensiondata.com/oec/0.9
+For different regions, change the api-au in the address above to your desired region (api-na, api-eu etc).
+In the future, the region will be able to be passed to Train by using mcp://<region> when you are executing controls. This is coming soon...
+
+To validate you have a connection, run `inspec detect -t mcp://` and you should receive the following output:
+
+```
+ Platform Details ──────────────────────────────
+
+Name:      mcp
+Families:  cloud, api
+Release:   0.1.2
+```
+

data/lib/train-mcp.rb

@@ -0,0 +1,21 @@
+# This file is known as the "entry point."
+# This is the file Train will try to load if it
+# thinks your plugin is needed.
+
+# The *only* thing this file should do is setup the
+# load path, then load plugin files.
+
+# Next two lines simply add the path of the gem to the load path.
+# This is not needed when being loaded as a gem; but when doing
+# plugin development, you may need it.  Either way, it's harmless.
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+# It's traditional to keep your gem version in a separate file, so CI can find it easier.
+require "train-mcp/version"
+
+# A train plugin has three components: Transport, Connection, and Platform.
+# Transport acts as the glue.
+require "train-mcp/transport"
+require "train-mcp/platform"
+require "train-mcp/connection"

data/lib/train-mcp/connection.rb

@@ -0,0 +1,43 @@
+
+require 'train'
+require 'cloudcontrol'
+
+# Push platform detection out to a mixin, as it tends
+# to develop at a different cadence than the rest
+require 'train-mcp/platform'
+
+require 'mixlib/shellout'
+require 'ostruct'
+
+module TrainPlugins
+  module Mcp
+    class Connection < Train::Plugins::Transport::BaseConnection
+      include TrainPlugins::Mcp::Platform
+      def initialize(options)
+        super(options)
+        @uuid = mcp_client.account.myaccount
+      end
+
+      def mcp_client
+        klass = ::CloudControl::Client
+        return klass.new(@options[:url],
+            @options[:org_id],
+            @options[:user],
+            @options[:pass])
+        # @cache[:api_call][klass.to_s.to_sym] ||= klass.new(url: @options[:url], user: @options[:user], pass: @options[:pass], org_id: @options[:org_id])
+      end
+
+      def mcp_resource(klass, args)
+        klass.new(args)
+      end
+
+      def unique_identifier
+        @uuid = mcp_client.account.myaccount.org_id.to_json
+      end
+      # TODO: determine exactly what this is used for
+      def uri
+        "mcp://#{@options[:url]}"
+      end
+    end
+  end
+end

data/lib/train-mcp/platform.rb

@@ -0,0 +1,13 @@
+# Platform definition file.  This is a good place to separate out any
+# logic regarding the identification of the OS or API at the far end
+# of the connection.
+
+module TrainPlugins::Mcp
+  module Platform
+    def platform
+      Train::Platforms.name("mcp").in_family("cloud")
+      plugin_version = "train-mcp: v#{TrainPlugins::Mcp::VERSION}"
+      force_platform!("mcp", release: TrainPlugins::Mcp::VERSION)
+    end
+  end
+end

data/lib/train-mcp/transport.rb

@@ -0,0 +1,31 @@
+# Train Plugins v1 are usually declared under the TrainPlugins namespace.
+# Each plugin has three components: Transport, Connection, and Platform.
+# We'll only define the Transport here, but we'll refer to the others.
+require "train-mcp/connection"
+require "train"
+require "train/plugins"
+
+module TrainPlugins
+  module Mcp
+    class Transport < Train.plugin(1)
+      name "mcp"
+
+      # The only thing you MUST do in a transport is a define a
+      # connection() method that returns a instance that is a
+      # subclass of BaseConnection.
+      option :user, required: true, default: ENV["MCP_USER"] 
+      option :pass, required: true, default: ENV["MCP_PASSWORD"]
+      option :org_id, required: true, default: ENV["MCP_ORG"]
+      option :url, required: true, default: ENV["MCP_ENDPOINT"]
+      # The options passed to this are undocumented and rarely used.
+      def connection(_instance_opts = nil)
+        # Typical practice is to cache the connection as an instance variable.
+        # Do what makes sense for your platform.
+        # @options here is the parsed options that the calling
+        # app handed to us at process invocation. See the Connection class
+        # for more details.
+        @connection ||= TrainPlugins::Mcp::Connection.new(@options)
+      end
+    end
+  end
+end

data/lib/train-mcp/version.rb

@@ -0,0 +1,10 @@
+# This file exists simply to record the version number of the plugin.
+# It is kept in a separate file, so that your gemspec can load it and
+# learn the current version without loading the whole plugin.  Also,
+# many CI servers can update this file when "version bumping".
+
+module TrainPlugins
+  module Mcp
+    VERSION = '0.2.0'.freeze
+  end
+end

data/train-mcp.gemspec

@@ -0,0 +1,47 @@
+# As plugins are usually packaged and distributed as a RubyGem,
+# we have to provide a .gemspec file, which controls the gembuild
+# and publish process.  This is a fairly generic gemspec.
+
+# It is traditional in a gemspec to dynamically load the current version
+# from a file in the source tree.  The next three lines make that happen.
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "train-mcp/version"
+
+Gem::Specification.new do |spec|
+  # Importantly, all Train plugins must be prefixed with `train-`
+  spec.name          = "train-mcp"
+
+  # It is polite to namespace your plugin under TrainPlugins::YourPluginInCamelCase
+  spec.version       = TrainPlugins::Mcp::VERSION
+  spec.authors       = ["Nigel Wright"]
+  spec.email         = ["nigel.wright@global.ntt"]
+  spec.summary       = "Train Plugin for the NTT Managed Cloud Platform (cloud control)"
+  spec.description   = "Example for implementing a Train plugin.  This simply performs the ROT13 substitution cipher on file content and command output."
+  spec.homepage      = "https://github.com/inspec/train/tree/master/examples/plugin"
+  spec.license       = "Apache-2.0"
+
+  # Though complicated-looking, this is pretty standard for a gemspec.
+  # It just filters what will actually be packaged in the gem (leaving
+  # out tests, etc)
+  spec.files = %w{
+    README.md train-mcp.gemspec Gemfile
+  } + Dir.glob(
+    "lib/**/*", File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+  spec.require_paths = ["lib"]
+
+  # If you rely on any other gems, list them here with any constraints.
+  # This is how `inspec plugin install` is able to manage your dependencies.
+  # For example, perhaps you are writing a thing that talks to AWS, and you
+  # want to ensure you have `aws-sdk` in a certain version.
+
+  # If you only need certain gems during development or testing, list
+  # them in Gemfile, not here.
+  # Do not list inspec as a dependency of the train plugin.
+
+  # All plugins should mention train, > 1.4
+  # spec.add_dependency "train", "~> 3.0"
+  spec.add_dependency 'cloudcontrol_sdk', "0.4.1"
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: train-mcp
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nigel Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cloudcontrol_sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: Example for implementing a Train plugin.  This simply performs the ROT13
+  substitution cipher on file content and command output.
+email:
+- nigel.wright@global.ntt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/train-mcp.rb
+- lib/train-mcp/connection.rb
+- lib/train-mcp/platform.rb
+- lib/train-mcp/transport.rb
+- lib/train-mcp/version.rb
+- train-mcp.gemspec
+homepage: https://github.com/inspec/train/tree/master/examples/plugin
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Train Plugin for the NTT Managed Cloud Platform (cloud control)
+test_files: []