iapi-idlc-sdk-pfm 1.0.4

data/lib/iapi-idlc-sdk-pfm/helpers.rb

@@ -0,0 +1,49 @@
+module Pfm
+  # Module of common functions that are used frequently in every namespace
+  module Helpers
+    module_function
+
+    # Runs given commands using mixlib-shellout
+    #
+    # @param command_args [String] the system command to run
+    def system_command(*command_args)
+      cmd = Mixlib::ShellOut.new(*command_args)
+      cmd.run_command
+      err(cmd.stderr)
+      msg(cmd.stdout)
+      cmd
+    end
+
+    # Print the given string to stderr
+    #
+    # @param message [String] the string to print
+    def err(message)
+      stderr.print("#{message}\n")
+    end
+
+    # Print the given string to stdout
+    #
+    # @param message [String] the string to print
+    def msg(message)
+      stdout.print("#{message}\n")
+    end
+
+    # Only prints the given string to stdout when the environment variable
+    # DEBUG = true
+    #
+    # @param message [String] the string to print
+    def debug(message)
+      stdout.print("#{message}\n") if ENV['DEBUG']
+    end
+
+    private
+
+    def stdout
+      $stdout
+    end
+
+    def stderr
+      $stderr
+    end
+  end
+end

data/lib/iapi-idlc-sdk-pfm/settings.rb

@@ -0,0 +1,205 @@
+module Pfm
+  # == +PFM+ Settings
+  # Top level settings defined and loaded here. This class loads the user config file
+  # located at +.pfm/config+
+  #
+  # +AWS_REGION+ <em>default -> 'us-east-1'</em>
+  #
+  # * The AWS region to work in. This will eventually become the AWS_REGION environment variable and can be used with other AWS API operations.
+  #
+  # +RUBOCOP_RULES_FILE+ <em>default -> '.rubocop.yml'</em>
+  #
+  # * Set the path to the global +.rubocop.yml+ rules file. This file will be used for all server builds when running syntax checks.
+  #
+  # +FOODCRITIC_RULES_FILE+ <em>default -> '.foodcritic'</em>
+  #
+  # * Set the path to the global +.foodcritic+ rules file. This file will be used for all server builds when running semantics checks.
+  #
+  # +BUILD_BASE_DIR+ <em>default -> 'builds'</em>
+  #
+  # * Set the root path to the builds directory. This should be where top level server builds are located. Ex:
+  #     .
+  #     ├── builds
+  #     │   ├── app-axpdb
+  #     │   └── app-axpwa
+  #
+  # +INF_BASE_DIR+ <em>default -> 'inf'</em>
+  #
+  # * Set the path to the top level infrastructure directory. Ex:
+  #     .
+  #     ├── inf
+  #     │   ├── env
+  #     │   ├── tasks
+  #     │   └── tf
+  #
+  # +PUBLISH_BUCKET+ <em>default -> ''</em>
+  #
+  # * The top level bucket where deployment packages are stored in S3.
+  #
+  # +PUBLISH_PREFIX+ <em>default -> ''</em>
+  #
+  # * The prefix to the deployment package storage location. Ex:
+  #   +s3://PUBLISH_BUCKET/PUBLISH_PREFIX/package.name+
+  #
+  # +PACKER_VERSION+ <em>default -> 'default from packer/binary'
+  #
+  # * The version of Hashicorp Packer to use for builds
+  #
+  # +TERRAFORM_VERSION+ <em>default -> 'default from terraform/binary'
+  #
+  # * The version of Hashicorp Terraform to use for deployments
+  #
+  # Note that if you change these settings from the default, be sure you commit
+  # the +.pfm/config+ file.
+  #
+  # == Example Configuration File
+  # An example +.pfm/config+ file might look like this:
+  #     ---
+  #     AWS_REGION: 'us-east-1'
+  #     RUBOCOP_RULES_FILE: '.pfm/.rubocop.yml'
+  #     FOODCRITIC_RULES_FILE: '.pfm/.foodcritic'
+  #     BUILD_BASE_DIR: 'builds'
+  #     INF_BASE_DIR: 'inf'
+  #     PUBLISH_BUCKET: 'dev-publish'
+  #     PUBLISH_PREFIX: 'axp'
+  #     PACKER_VERSION: '1.0.4'
+  #     TERRAFORM_VERSION: '0.8.7'
+  class Settings
+    # Defines an individual setting
+    class Setting
+      attr_reader :value
+
+      def initialize(value, required = false)
+        @value = value
+        @required = required
+      end
+
+      def required?
+        @required
+      end
+
+      def defined?
+        !@value.nil?
+      end
+
+      def to_s
+        @value.to_s
+      end
+    end
+
+    # @return [Map] returns the map of Pfm::Settings::Setting objects
+    attr_reader :settings
+    attr_reader :config_directory
+    attr_reader :run_dir
+
+    def initialize(expand = false)
+      @run_dir = Dir.pwd
+      @config_directory = config_dir
+      @expand = expand
+
+      @settings = {}
+
+      # Required
+      @settings['AWS_REGION'] = Setting.new(ENV['AWS_REGION'], true)
+      @settings['RUBOCOP_RULES_FILE'] = Setting.new('.rubocop.yml', true)
+      @settings['FOODCRITIC_RULES_FILE'] = Setting.new('.foodcritic', true)
+      @settings['BUILD_BASE_DIR'] = Setting.new('builds', true)
+      @settings['INF_BASE_DIR'] = Setting.new('inf', true)
+      @settings['PACKER_VERSION'] = Setting.new(::Packer::Binary.config.version, true)
+      @settings['TERRAFORM_VERSION'] = Setting.new(::Terraform::Binary.config.version, true)
+
+      # Optional Defaults
+      @settings['PUBLISH_BUCKET'] = Setting.new('')
+      @settings['PUBLISH_PREFIX'] = Setting.new('')
+
+      load_config
+    end
+
+    # load the config file and resolve file paths if set
+    def load_config
+      if config_exists?
+        require 'yaml'
+        YAML.load_file(config_file).each do |key, value|
+          msg("WARNING: unrecognized config key: '#{key}'") unless @settings.key? key
+          next unless @settings.key? key
+
+          required = @settings[key].required?
+          @settings[key] = Setting.new(value, required)
+        end
+
+        # Also load each setting into the environment
+        @settings.each { |key, setting| ENV[key] = setting.value }
+
+        # Resolve paths if set
+        resolve_paths if @expand
+      else
+        create_config
+        load_config
+      end
+    end
+
+    # Saves a new configuration to disk
+    # @param settings [Map<Pfm::Settings::Setting>] a new map of Pfm::Settings::Setting objects
+    def save_config(settings)
+      @settings = settings
+
+      write_config
+    end
+
+    # returns a simple map of Pfm::Settings.settings[key] => Pfm::Settings.setting[key].to_s
+    # @return [Map<String>]
+    def settings_strings
+      map = {}
+      @settings.each do |key, setting|
+        map[key] = setting.to_s
+      end
+
+      map
+    end
+
+    private
+
+    # create the config directory and file if they don't already exist
+    def create_config
+      return if config_exists?
+
+      FileUtils.mkdir_p config_dir
+      FileUtils.touch config_file
+
+      write_config
+    end
+
+    # expands variables like '.' and '~' in settings values paths
+    def resolve_paths
+      @settings.each do |key, setting|
+        required = @settings[key].required?
+        @settings[key] = Setting.new(File.realpath(setting.value), required) if File.exist? setting.value
+      end
+    end
+
+    # writes the @settings attribute to disk
+    def write_config
+      config_string = '---'
+
+      @settings.each do |key, setting|
+        config_string += "\n#{key}: '#{setting.value}'"
+      end
+
+      config_string += "\n"
+
+      File.open(config_file, 'w') { |file| file.write(config_string) }
+    end
+
+    def config_exists?
+      File.exist? config_file
+    end
+
+    def config_dir
+      "#{@run_dir}/.pfm"
+    end
+
+    def config_file
+      "#{config_dir}/config"
+    end
+  end
+end

data/lib/iapi-idlc-sdk-pfm/validator.rb

@@ -0,0 +1,52 @@
+module Pfm
+  module Validator
+    # This is here to hold attr_accessor data for Validator context variables
+    class Context
+      def self.add_attr(name)
+        @attributes ||= []
+
+        unless @attributes.include?(name)
+          @attributes << name
+          attr_accessor(name)
+        end
+      end
+
+      def self.reset
+        return if @attributes.nil?
+
+        @attributes.each do |attr|
+          remove_method(attr)
+        end
+
+        @attributes = nil
+      end
+    end
+
+    def self.reset
+      @context = nil
+    end
+
+    def self.context
+      @context ||= Context.new
+    end
+
+    def self.add_attr_to_context(name, value = nil)
+      sym_name = name.to_sym
+      Pfm::Validator::Context.add_attr(sym_name)
+      Pfm::Validator::TemplateHelper.delegate_to_app_context(sym_name)
+      context.public_send("#{sym_name}=", value)
+    end
+
+    module TemplateHelper
+      def self.delegate_to_app_context(name)
+        define_method(name) do
+          Pfm::Validator.context.public_send(name)
+        end
+      end
+
+      def year
+        Time.now.year
+      end
+    end
+  end
+end

data/lib/iapi-idlc-sdk-pfm/version.rb

@@ -0,0 +1,4 @@
+module Pfm
+  build_number = ENV.fetch('BUILD_NUMBER', '0')
+  VERSION = "1.0.#{build_number}"
+end

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

@@ -0,0 +1,27 @@
+require 'mixlib/cli'
+require 'mixlib/shellout'
+require 'packer/binary'
+require 'terraform/binary'
+
+require 'iapi-idlc-sdk-core'
+require 'iapi-idlc-sdk-build'
+require 'iapi-idlc-sdk-deploy'
+
+require 'iapi-idlc-sdk-pfm/version'
+require 'iapi-idlc-sdk-pfm/settings'
+require 'iapi-idlc-sdk-pfm/helpers'
+require 'iapi-idlc-sdk-pfm/cli'
+require 'iapi-idlc-sdk-pfm/commands_map'
+require 'iapi-idlc-sdk-pfm/builtin_commands'
+
+# Default region
+ENV['AWS_REGION'] = 'us-east-1' unless ENV['AWS_REGION']
+
+# Load config file as mapp of strings ex. SETTINGS[ 'AWS_REGION' ] = 'us-east-1'
+SETTINGS = Pfm::Settings.new(true).settings_strings
+
+# Global repository version file
+REPO_VERSION_FILE = 'version'.freeze
+
+# Load the current repository version number
+REPO_VERSION = Idlc::Utility.set_global_version(REPO_VERSION_FILE)