idlc-sdk-pfm 1.0.0.pre.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e06db05b04105a042039112e0424544589134df5
+  data.tar.gz: bb28fc80e37768c1e348e0f2344a2d50809f1739
+SHA512:
+  metadata.gz: 3028af844527847d29f0790603ee88c1ca1e99a6102ae0d4144a33744c7c63f8a02ab24c0d4840b4ff0c87ded6a76efd5c282d981ba351fd1fee58f4130f3613
+  data.tar.gz: 8872731f018eb25b4a24061e7df5a00a951f1abf544d2b1552e1363628c5b3b0aa928bfa152666e62266a40e62158874fec4eafdaa4c3480830eec1727f39fb3

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+/.pfm
+/builds
+/inf
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/.yardopts

@@ -0,0 +1,3 @@
+-
+CHANGELOG.md
+docs/GettingStarted.md

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in idlc-sdk-pfm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nathan Cazell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Idlc::Sdk::Pfm
+
+Provides the pfm executable for idlc-sdk. This gem is part of the IDLC SDK
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'idlc-sdk-pfm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install idlc-sdk-pfm
+
+## Usage
+
+See the {file:docs/GettingStarted.md Getting Started Guide} for PFM executable usage.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/idlc-sdk-pfm.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/pfm

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+Kernel.trap(:INT) { print("\n"); exit 1 }
+
+require 'bundler/setup'
+require 'idlc-sdk-pfm'
+
+Pfm::CLI.new(ARGV.clone).run

data/docs/GettingStarted.md

@@ -0,0 +1,299 @@
+# @title Getting Started Guide
+
+## `pfm` Executable
+Bundled with this gem is an executable `pfm`. The `pfm` executable is a command-line tool that does the following:
+
+  * Generates server build repositories, templates, and default cookbooks
+  * Builds images with Packer from existing server build repositories
+  * Validates server build repositories, templates, and cookbooks
+
+The following commands are available in PFM 0.3.x (see pfm -h for a full list):
+
+```
+Usage:
+    pfm -h/--help
+    pfm -v/--version
+    pfm command [arguments...] [options...]
+
+
+Available Commands:
+    generate   Generate a new server build, repository, cookbooks, etc.
+    build      Build a specified server template
+    validate   Test & validate a server build
+    exec       Runs the command in context of the embedded ruby
+    configure  Run initial setup and configuration
+    plan       Show the infrastructure plan
+    apply      Apply the infrastructure plan
+    destroy    Destroy all managed infrastructure
+    format     format infrastructure code
+```
+
+### Configuring `pfm`
+#### `.pfm/` Options Directory
+The `pfm` executable will automatically generate a default config file located at `.pfm/config`. It will set sensible defaults, that should work for most implementations. You can change these settings by editing the file directly or running `pfm configure`.
+
+See available settings in {Pfm::Settings}
+
+### `pfm` Commands
+#### pfm generate server-build
+Use the `pfm generate server-build` subcommand to generate server build repositories/templates.
+
+##### Syntax
+```
+$ pfm generate server-build NAME [options]
+```
+
+##### Options
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output from the generator
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+To generate a server build repositories, run a command similar to:
+
+```
+$ pfm generate server-build app-axpwa
+```
+
+
+#### pfm build
+Use the `pfm build` subcommand to build server images (using Packer) from existing build repositories & templates (previously generated from `pfm generate`)
+
+##### Syntax
+```
+$ pfm build BUILD_NAME [options]
+```
+
+##### Options
+This subcommand has the following options:
+
+`-a VERSION`, `--app-release VERSION`
+  - Application Version Number to build
+
+`-n`, `--build-number NUMBER`
+  - Override the build number. Default is ENV::BUILD_NUMBER
+
+`-t`, `--build-template TEMPLATE`
+  - The Packer Build Template to use. The default template file is `build.json`. This file should reside in the root of the server build directory.
+
+`-m`, `--build-metadata METADATA_FILE`
+  - The build metadata file to use. The default metadata file is `metadata`. This file should reside in the root of the server build directory.
+
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output from the generator
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+To build a server repositories/template, run a command similar to:
+
+```
+$ pfm build app-axpwa -a 3.1.0.1585
+```
+
+#### pfm validate server-build
+Use the `pfm validate server-build` subcommand to validate a server build repository. This will run various tools such as Foodcritic, Rubocop, and ChefSpec against the build repo. Reports & Artifacts are generated and stored in `.pfm/tests/{reports,artifacts}`
+
+##### Syntax
+```
+$ pfm validate server-build BUILD_NAME [options]
+```
+
+##### Options
+`-t`, `--build-template TEMPLATE`
+  - The Build Template to use. Default is `build.json`
+
+`-m`, `--build-metadata METADATA_FILE`
+  - The build metadata file to use. The default metadata file is `metadata`. This file should reside in the root of the server build directory.
+
+`-c`, `--circle-ci`
+  - Use Circle Ci artifact output directories
+
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output from the generator
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+To validate a build repository, run a command similar to:
+
+```
+$ pfm validate server-build app-axpwa
+```
+#### pfm validate infrastructure
+Use the `pfm validate infrastructure` subcommand to validate a server build repository. This will run various tools such as Foodcritic, Rubocop, and ChefSpec against the build repo. Reports & Artifacts are generated and stored in `.pfm/tests/{reports,artifacts}`
+
+##### Syntax
+```
+$ pfm validate infrastructure [options]
+```
+
+##### Options
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output from the generator
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+To validate a build repository, run a command similar to:
+
+```
+$ pfm validate infrastructure
+```
+
+#### pfm exec
+Use the `pfm exec` subcommand to run arbitrary shell commands with the PATH environment variable and the GEM_HOME and GEM_PATH Ruby environment variables pointed at the Pfm bundle.
+
+##### Syntax
+```
+$ pfm exec SYSTEM_COMMAND [options]
+```
+
+##### Options
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output from the generator
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+None.
+
+#### pfm plan
+Use the `pfm plan` subcommand to plan infrastructure changes before they are executed.
+
+##### Syntax
+```
+$ pfm plan [options]
+```
+
+##### Options
+
+`-a`, `--app-release VERSION`
+  - Application Version Number to Deploy
+
+`-b`, `--server-build BUILD_NUMBER`
+  - The build number of the AMI to deploy
+
+`-l`, `--landscape`
+  - Format the Terraform plan output with `terraform_landscape`
+
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+To plan an infrastructure release with application version number 3.1.0.1654, run a command similar to:
+
+```
+$ pfm plan -a 3.1.0.1654
+```
+
+#### pfm apply
+Use the `pfm apply` subcommand to apply infrastructure changes before they are executed.
+
+##### Syntax
+```
+$ pfm apply [options]
+```
+
+##### Options
+
+`-a`, `--app-release VERSION`
+  - Application Version Number to Deploy
+
+`-b`, `--server-build BUILD_NUMBER`
+  - The build number of the AMI to deploy
+
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+To apply an infrastructure release with application version number 3.1.0.1654, run a command similar to:
+
+```
+$ pfm apply -a 3.1.0.1654
+```
+
+#### pfm destroy
+Use the `pfm destroy` subcommand to destroy a managed environment and all associated resources. THIS CANNOT BE UNDONE
+
+##### Syntax
+```
+$ pfm destroy [options]
+```
+
+##### Options
+
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+To destroy a managed environment
+
+```
+$ pfm destroy
+```
+
+#### pfm format
+Use the `pfm format` subcommand to format an infrastructure repository and associated files to a canonical format.
+
+##### Syntax
+```
+$ pfm format [options]
+```
+
+##### Options
+
+`-h`, `--help`
+  - Show this message
+
+`-V`, `--verbose`
+  - Show detailed output
+
+`-v`, `--version`
+  - Show pfm version
+
+##### Examples
+To format an infrastructure repository's files
+
+```
+$ pfm format
+```

data/idlc-sdk-pfm.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "idlc-sdk-pfm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "idlc-sdk-pfm"
+  spec.version       = Pfm::VERSION
+  spec.authors       = ["Nathan Cazell"]
+  spec.email         = ["nathan.cazell@imageapi.com"]
+
+  spec.summary       = 'IDLC SDK for AWS resources - PFM'
+  spec.description   = 'Provides the pfm executable for idlc-sdk. This gem is part of the IDLC SDK'
+  spec.homepage      = 'https://github.com/nathantcz/idlc-sdk'
+  spec.license       = 'MIT'
+  spec.has_rdoc      = 'yard'
+  spec.executables << 'pfm'
+
+  spec.metadata = {
+    'source_code_uri' => 'https://github.com/nathantcz/idlc-sdk-deploy'
+  }
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|bin)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.48.1'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'yard'
+
+  spec.add_runtime_dependency 'idlc-sdk-core'
+  spec.add_runtime_dependency 'idlc-sdk-build'
+  spec.add_runtime_dependency 'idlc-sdk-deploy'
+  spec.add_runtime_dependency 'chefspec'
+  spec.add_runtime_dependency 'mixlib-cli'
+  spec.add_runtime_dependency 'mixlib-shellout'
+  spec.add_runtime_dependency 'rubocop-junit-formatter'
+  spec.add_runtime_dependency 'rubocop', '0.48.1'
+end

data/lib/idlc-sdk-pfm/builtin_commands.rb

@@ -0,0 +1,11 @@
+Pfm.commands do |c|
+  c.builtin 'generate', :Generate, desc: 'Generate a new server build, repository, cookbooks, etc.'
+  c.builtin 'build', :Build, desc: 'Build a specified server template'
+  c.builtin 'validate', :Validate, desc: 'Test & validate a server build'
+  c.builtin 'exec', :Exec, desc: 'Runs the command in context of the embedded ruby'
+  c.builtin 'configure', :Configure, desc: 'Run initial setup and configuration'
+  c.builtin 'plan', :Plan, desc: 'Show the infrastructure plan'
+  c.builtin 'apply', :Apply, desc: 'Apply the infrastructure plan'
+  c.builtin 'destroy', :Destroy, desc: 'Destroy all managed infrastructure'
+  c.builtin 'format', :Format, desc: 'format infrastructure code'
+end

data/lib/idlc-sdk-pfm/cli.rb

@@ -0,0 +1,150 @@
+module Pfm
+  class CLI
+    include Mixlib::CLI
+    include Pfm::Helpers
+
+    banner(<<-BANNER)
+Usage:
+    pfm -h/--help
+    pfm -v/--version
+    pfm command [arguments...] [options...]
+BANNER
+
+    option :version,
+           short: '-v',
+           long: '--version',
+           description: 'Show pfm version',
+           boolean: true
+
+    option :help,
+           short: '-h',
+           long: '--help',
+           description: 'Show this message',
+           boolean: true
+
+    option :verbose,
+           short:        '-V',
+           long:         '--verbose',
+           description:  'Show detailed output',
+           boolean:      true,
+           default:      false
+
+    attr_reader :argv
+
+    def initialize(argv)
+      @argv = argv
+      super() # mixlib-cli #initialize doesn't allow arguments
+    end
+
+    def run
+      subcommand_name, *subcommand_params = argv
+
+      ENV['DEBUG'] = true if verbose?
+
+      #
+      # Runs the appropriate subcommand if the given parameters contain any
+      # subcommands.
+      #
+      if subcommand_name.nil? || option?(subcommand_name)
+        handle_options
+      elsif have_command?(subcommand_name)
+        subcommand = instantiate_subcommand(subcommand_name)
+        exit_code = subcommand.run_with_default_options(subcommand_params)
+        exit normalized_exit_code(exit_code)
+      else
+        err "Unknown command `#{subcommand_name}'."
+        show_help
+        exit 1
+      end
+    rescue OptionParser::InvalidOption => e
+      err(e.message)
+      show_help
+      exit 1
+    end
+
+    # If no subcommand is given, then this class is handling the CLI request.
+    def handle_options
+      parse_options(argv)
+      if config[:version]
+        show_version
+      else
+        show_help
+      end
+      exit 0
+    end
+
+    def show_version
+      msg("Pfm Version: #{Pfm::VERSION}")
+    end
+
+    def show_help
+      msg(banner)
+      msg("\nAvailable Commands:")
+
+      justify_length = subcommands.map(&:length).max + 2
+      subcommand_specs.each do |name, spec|
+        msg("    #{name.ljust(justify_length)}#{spec.description}")
+      end
+    end
+
+    def exit(n)
+      Kernel.exit(n)
+    end
+
+    def commands_map
+      Pfm.commands_map
+    end
+
+    def have_command?(name)
+      commands_map.have_command?(name)
+    end
+
+    def subcommands
+      commands_map.command_names
+    end
+
+    def subcommand_specs
+      commands_map.command_specs
+    end
+
+    def option?(param)
+      param =~ /^-/
+    end
+
+    def verbose?
+      @config[:verbose]
+    end
+
+    def instantiate_subcommand(name)
+      commands_map.instantiate(name)
+    end
+
+    private
+
+    def normalized_exit_code(maybe_integer)
+      if maybe_integer.is_a?(Integer) && (0..255).cover?(maybe_integer)
+        maybe_integer
+      else
+        0
+      end
+    end
+
+    # Find PATH or Path correctly if we are on Windows
+    def path_key
+      env.keys.grep(/\Apath\Z/i).first
+    end
+
+    # upcase drive letters for comparison since ruby has a String#capitalize function
+    def drive_upcase(path)
+      if Chef::Platform.windows? && path[0] =~ /^[A-Za-z]$/ && path[1, 2] == ':\\'
+        path.capitalize
+      else
+        path
+      end
+    end
+
+    def env
+      ENV
+    end
+  end
+end

data/lib/idlc-sdk-pfm/command/apply.rb

@@ -0,0 +1,71 @@
+require 'idlc-sdk-pfm/command/base'
+require 'mixlib/shellout'
+
+module Pfm
+  module Command
+    class Apply < Base
+      banner 'Usage: pfm apply [options]'
+
+      option :app_release,
+             short:        '-a VERSION',
+             long:         '--app-release VERSION',
+             description:  'Application Version Number to Deploy',
+             default:      ''
+
+      option :server_build,
+             short:        '-b NUMBER',
+             long:         '--server-build NUMBER',
+             description:  'Server Build Number to Deploy',
+             default:      ENV['SERVER_BUILD']
+
+      def initialize
+        super
+        @params_valid = true
+        @errors = []
+      end
+
+      def run(params)
+        @params = params
+        read_and_validate_params
+
+        if params_valid?
+          deploy_setup
+          apply
+          # @workspace.cleanup causing bundler issues
+          0
+        else
+          @errors.each { |error| err("Error: #{error}") }
+          parse_options(params)
+          msg(opt_parser)
+          1
+        end
+      rescue DeploymentFailure => e
+        err("ERROR: #{e.message}\n")
+        1
+      end
+
+      def apply
+        Terraform::Binary.get("-update #{@workspace.tmp_dir}")
+        Terraform::Binary.apply(@workspace.tmp_dir.to_s) || raise
+        Terraform::Binary.remote('push')
+      rescue
+        raise DeploymentFailure, 'Finished with errors'
+      end
+
+      def read_and_validate_params
+        arguments = parse_options(@params)
+
+        @params_valid = case arguments.size
+                        when 0
+                          true
+                        else
+                          false
+                        end
+      end
+
+      def params_valid?
+        @params_valid
+      end
+    end
+  end
+end