auster 0.2.2

data/lib/cfer/auster/cfer_evaluator.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "cfer"
+
+module Cfer
+  module Core
+    class Resource
+      # TODO: we need a better way to inject general helpers.
+
+      def cfize(text, capture_regexp: nil)
+        Cfer::Auster::CferHelpers.cfize(text, capture_regexp: capture_regexp)
+      end
+    end
+  end
+
+  module Auster
+    class CloudFormationError < RuntimeError; end
+
+    class CferEvaluator
+      include Cfer::Auster::Logging::Mixin
+
+      def initialize(path:, stack_name:, parameters:, metadata:, client_options: {}, stack_options: {})
+        raise "path must be a String" unless path.is_a?(String)
+        raise "path must be a directory" unless File.directory?(path)
+
+        raise "stack_name must be a String" unless stack_name.is_a?(String)
+
+        raise "parameters must be a Hash" unless parameters.is_a?(Hash)
+
+        parameters[:AusterOptions] ||= {}
+
+        @stack_name = stack_name
+        @stack_options = stack_options
+        @cfer_client = Cfer::Cfn::Client.new(client_options.merge(stack_name: stack_name, region: parameters[:AWSRegion]))
+        @cfer_stack = Cfer::Core::Stack.new(
+          stack_options.merge(
+            client: @cfer_client, include_base: path, parameters: parameters,
+            force_s3: !!parameters[:AusterOptions][:S3Path],
+            s3_path: parameters[:AusterOptions][:S3Path]
+          )
+        )
+
+        require_rb = File.join(path, "require.rb")
+        parameters_rb = File.join(path, "parameters.rb")
+        outputs_rb = File.join(path, "outputs.rb")
+
+        global_helpers_dir = File.join(path, "../../../cfer-helpers")
+        global_helpers = Dir["#{global_helpers_dir}/**/*.rb"].reject { |f| File.basename(f).start_with?("_") }
+        helpers_dir = File.join(path, "helpers")
+        helpers = Dir["#{helpers_dir}/**/*.rb"].reject { |f| File.basename(f).start_with?("_") }
+        defs_dir = File.join(path, "defs")
+
+        @cfer_stack.extend Cfer::Auster::CferHelpers
+        @cfer_stack.build_from_block do
+          self[:Metadata][:Auster] = metadata
+
+          global_helpers.each do |helper_file|
+            eval_file helper_file
+          end
+
+          helpers.each do |helper_file|
+            eval_file helper_file
+          end
+
+          [require_rb, parameters_rb, outputs_rb].each do |file|
+            f = file.gsub(path, ".")
+            include_template f if File.file?(file)
+          end
+
+          Dir["#{defs_dir}/**/*.rb"].each do |def_file|
+            f = def_file.gsub(path, ".")
+            include_template f
+          end
+        end
+      end
+
+      def converge!(block: true)
+        # because it isn't actually redundant...
+        # rubocop:disable Style/RedundantBegin
+        begin
+          @cfer_stack.converge!(@stack_options)
+          tail! if block
+        rescue Aws::CloudFormation::Errors::ValidationError => err
+          if err.message == "No updates are to be performed."
+            logger.info "CloudFormation has no updates to perform."
+          else
+            logger.error "Error (#{err.class.name}) in converge: #{err.message}"
+            raise err
+          end
+        end
+      end
+
+      def destroy!(block: true)
+        @cfer_client.delete_stack(stack_name: @stack_name)
+        tail! if block
+      end
+
+      def tail!(throw_if_failed: true)
+        tail_start = DateTime.now
+        has_shown_bar = false
+        has_failed = false
+
+        @cfer_client.tail(number: 0, follow: true) do |event|
+          has_failed = true if event.timestamp >= tail_start && event.resource_status.include?("FAILED")
+          if event.timestamp >= tail_start && !has_shown_bar
+            logger.info "CFN >> ----- CURRENT RUN START -----"
+            has_failed = false
+            has_shown_bar = true
+          end
+          logger.info "CFN >> %-30s %-40s %-20s %s" % [
+            event.resource_status, event.resource_type,
+            event.logical_resource_id, event.resource_status_reason
+          ]
+        end
+
+        raise "Operation failed. Please check the log." if has_failed && throw_if_failed
+        nil
+      end
+
+      def generate_json
+        JSON.pretty_generate(@cfer_stack)
+      end
+    end
+  end
+end

data/lib/cfer/auster/cfer_helpers.rb

@@ -0,0 +1,71 @@
+module Cfer
+  module Auster
+    module CferHelpers
+      CFIZER_DEFAULT_CAPTURE_REGEXP = /C\{(?<directive>.*?)\}/
+
+      def eval_file(filename)
+        instance_eval IO.read(filename), filename
+      end
+
+      def import(name)
+        { "Fn::ImportValue" => _exported_name(name) }
+      end
+
+      def export(name, value)
+        output name, value, Export: { Name: _exported_name(name) }
+      end
+
+      def _exported_name(name)
+        "#{parameters[:PlanID]}--#{name}"
+      end
+
+      def cfize(text, capture_regexp: nil)
+        CferHelpers.cfize(text, capture_regexp: capture_regexp)
+      end
+
+      def self.cfize(text, capture_regexp: nil)
+        raise "'text' must be a string." unless text.is_a?(String)
+
+        capture_regexp ||= CFIZER_DEFAULT_CAPTURE_REGEXP
+
+        raise "'capture_regexp' must be a Regexp." unless capture_regexp.is_a?(Regexp)
+        raise "'capture_regexp' must include a 'contents' named 'directive'." \
+          unless capture_regexp.named_captures.key?("directive")
+
+        working = []
+        until working[-2] == "" && working[-1] == "" do
+          if working.empty?
+            working = text.partition(capture_regexp)
+          else
+            working[-1] = working[-1].partition(capture_regexp)
+            working = working.flatten
+          end
+        end
+
+        cfizer = Cfizer.new
+        Cfizer::Fn.join("", working.map do |token|
+          match = capture_regexp.match(token)
+          if match.nil?
+            token
+          else
+            cfizer.cfize(match["directive"])
+          end
+        end.reject { |t| t == ""})
+      end
+
+      class Cfizer
+        begin
+          include Cfer::Core::Functions
+        rescue NameError => _
+          # we need to fall back to the old Cfer setup
+          include Cfer::Core
+          include Cfer::Cfn
+        end
+
+        def cfize(directive)
+          instance_eval directive
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/_shared.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require "cri"
+require "logger"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.base_options(cmd)
+        cmd.instance_eval do
+          flag :v, :verbose, "sets logging to DEBUG" do |_, _|
+            Cfer::Auster::Logging.logger.level = Logger::DEBUG
+          end
+        end
+      end
+
+      def self.standard_options(cmd)
+        cmd.instance_eval do
+          CLI.base_options(cmd)
+
+          flag :h, :help, "show help for this command" do |_, cmd|
+            puts cmd.help
+            Kernel.exit 0
+          end
+
+          option :l, :"log-level",
+                 "Configures the verbosity of the Auster and Cfer loggers. (default: info)",
+                 argument: :required
+
+          option :p, :"plan-path",
+                 "The path to the Auster plan repo that should be used (otherwise searches from pwd)",
+                 argument: :required
+        end
+      end
+
+      def self.repo_from_options(opts, &block)
+        require "cfer/auster/repo"
+
+        repo =
+          if opts[:"plan-path"]
+            Cfer::Auster::Repo.new(opts[:"plan-path"])
+          else
+            Cfer::Auster::Repo.discover_from_cwd
+          end
+
+        block.call(repo)
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/destroy.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require "cri"
+
+require "cfer/auster/cli/_shared"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.destroy
+        Cri::Command.define do
+          name "destroy"
+          usage "destroy aws-region/config-set count-or-tag"
+          description "Destroys this Auster step in your AWS account."
+
+          CLI.standard_options(self)
+
+          run do |opts, args, cmd|
+            if args.length < 2
+              puts cmd.help
+              exit 1
+            else
+              CLI.repo_from_options(opts) do |repo|
+                config_set = repo.config_set(args[0])
+                step = repo.step_by_count_or_tag(args[1])
+
+                step.destroy(config_set)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/generate/repo.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require "cri"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.generate_repo
+        Cri::Command.define do
+          name "repo"
+          usage "repo OUTPUT_PATH"
+          description "Generates a new Auster plan repo."
+
+          CLI.base_options(self)
+
+          flag :h, :help, "show help for this command" do |_, cmd|
+            puts cmd.help
+            Kernel.exit 0
+          end
+
+          run do |_, _, cmd|
+            raise "TODO: implement"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/generate/step.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require "cri"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.generate_step
+        Cri::Command.define do
+          name "step"
+          usage "step ##"
+          description "Generates a step in the current Auster repo."
+
+          CLI.base_options(self)
+
+          flag :h, :help, "show help for this command" do |_, cmd|
+            puts cmd.help
+            Kernel.exit 0
+          end
+
+          run do |_, _, cmd|
+            raise "TODO: implement"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/generate.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require "cri"
+
+require "cfer/auster/cli/generate/repo"
+require "cfer/auster/cli/generate/step"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.generate
+        ret = Cri::Command.define do
+          name "generate"
+          description "Encapsulates generators for Auster."
+
+          CLI.base_options(self)
+
+          flag :h, :help, "show help for this command" do |_, cmd|
+            puts cmd.help
+            Kernel.exit 0
+          end
+
+          run do |_, _, cmd|
+            puts cmd.help
+            Kernel.exit 0
+          end
+        end
+
+        ret.add_command(CLI.generate_repo)
+        ret.add_command(CLI.generate_step)
+
+        ret
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/json.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require "cri"
+
+require "cfer/auster/cli/_shared"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.json
+        Cri::Command.define do
+          name "json"
+          usage "json aws-region/config-set count-or-tag"
+          description "Generates the CloudFormation JSON for this step."
+
+          CLI.standard_options(self)
+
+          option :o, :"output-file",
+                 "Saves the JSON output to a file (otherwise prints to stdout)",
+                 argument: :required
+
+          run do |opts, args, cmd|
+            if args.length < 2
+              puts cmd.help
+              exit 1
+            else
+              CLI.repo_from_options(opts) do |repo|
+                config_set = repo.config_set(args[0])
+                step = repo.step_by_count_or_tag(args[1])
+
+                ret = step.json(config_set)
+
+                if opts[:"output-file"]
+                  IO.write(opts[:"output-file"], ret)
+                else
+                  puts ret
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/nuke.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require "cri"
+
+require "cfer/auster/cli/_shared"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.nuke
+        Cri::Command.define do
+          extend Cfer::Auster::Logging::Mixin
+
+          name "nuke"
+          usage "nuke aws-region/config-set"
+          description "Destroys ALL AWS RESOURCES related to this config set."
+
+          CLI.standard_options(self)
+
+          flag nil, :force, "bypasses confirmation - use with care!"
+
+          run do |opts, args, cmd|
+            if args.length < 1
+              puts cmd.help
+              exit 1
+            else
+              CLI.repo_from_options(opts) do |repo|
+                config_set = repo.config_set(args[0])
+
+                accepted = !!opts[:force]
+
+                if !accepted && $stdin.tty?
+                  $stderr.write "\n\n"
+                  $stderr.write "!!! YOU ARE ABOUT TO DO SOMETHING VERY DRASTIC! !!!\n"
+                  $stderr.write "You are requesting to destroy ALL STEPS of the config set '#{config_set.full_name}'.\n"
+                  $stderr.write "If you are certain you wish to do this, please type CONFIRM: "
+
+                  input = $stdin.readline.chomp
+
+                  if input != "CONFIRM"
+                    $stderr.write "\n\nInvalid input. Aborting nuke.\n\n"
+                    Kernel.exit 1
+                  end
+
+                  accepted = true
+                end
+
+                unless accepted
+                  logger.error "You must pass interactive confirmation or use the --force parameter to nuke."
+                  Kernel.exit 1
+                end
+
+                repo.nuke(config_set)
+
+                logger.warn "I really, really hope you meant to do that."
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/run.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require "cri"
+
+require "cfer/auster/cli/_shared"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.run
+        Cri::Command.define do
+          name "run"
+          usage "run aws-region/config-set count-or-tag"
+          description "Runs this Auster step against your AWS infrastructure."
+
+          CLI.standard_options(self)
+
+          run do |opts, args, cmd|
+            if args.length < 2
+              puts cmd.help
+              exit 1
+            else
+              CLI.repo_from_options(opts) do |repo|
+                config_set = repo.config_set(args[0])
+                step = repo.step_by_count_or_tag(args[1])
+
+                step.run(config_set)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require "cri"
+require "semantic"
+require "json"
+
+require "cfer/auster"
+require "cfer/auster/cli/_shared"
+require "cfer/auster/cli/generate"
+require "cfer/auster/cli/json"
+require "cfer/auster/cli/run"
+require "cfer/auster/cli/destroy"
+require "cfer/auster/cli/nuke"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.root
+        ret = Cri::Command.define do
+          name "auster"
+          description "The best way to manage CloudFormation. Ever. (We think.)"
+
+          CLI.base_options(self)
+
+          flag :h, :help, "show help for this command" do |_, cmd|
+            puts cmd.help
+            Kernel.exit 0
+          end
+
+          flag nil, :version, "show version information for this command" do |_, _|
+            puts Cfer::Auster::VERSION
+            Kernel.exit 0
+          end
+          flag nil, :"version-json", "show version information for this command in JSON" do |_, _|
+            puts JSON.pretty_generate(
+              Semantic::Version.new(Cfer::Auster::VERSION).to_h.reject { |_, v| v.nil? }
+            )
+            Kernel.exit 0
+          end
+
+          run do |_, _, cmd|
+            puts cmd.help
+            Kernel.exit 0
+          end
+        end
+
+        ret.add_command(CLI.generate)
+        ret.add_command(CLI.json)
+        ret.add_command(CLI.run)
+        ret.add_command(CLI.destroy)
+        ret.add_command(CLI.nuke)
+
+        ret
+      end
+
+      def self.execute(args)
+        CLI.root.run(args)
+      end
+    end
+  end
+end

data/lib/cfer/auster/config.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require "kwalify"
+
+module Cfer
+  module Auster
+    class Config
+      include Cfer::Auster::Logging::Mixin
+
+      attr_reader :name
+      attr_reader :aws_region
+      attr_reader :data
+
+      def initialize(name:, aws_region:, data:)
+        raise "name must be a String" unless name.is_a?(String)
+        raise "aws_region must be a String" unless aws_region.is_a?(String)
+        raise "data must be a Hash" unless data.is_a?(Hash)
+
+        @name = name.dup.freeze
+        @aws_region = aws_region.dup.freeze
+        @data = data.deep_symbolize_keys
+
+        @data[:PlanID] = @name
+        @data[:AWSRegion] = @aws_region
+
+        IceNine.deep_freeze(@data)
+      end
+
+      def full_name
+        "#{aws_region}/#{name}"
+      end
+
+      def env_vars_for_shell
+        {
+          "PLAN_ID" => name,
+          "AWS_REGION" => aws_region,
+          "AWS_DEFAULT_REGION" => aws_region
+        }
+      end
+
+      class << self
+        include Cfer::Auster::Logging::Mixin
+
+        def from_file(name:, aws_region:, data_file:, schema_file:)
+          logger.debug "Loading config set from #{data_file}"
+          schema = schema_file.nil? ? nil : Kwalify::Yaml.load_file(schema_file)
+          validator = schema.nil? ? nil : Kwalify::Validator.new(schema)
+
+          parser = Kwalify::Yaml::Parser.new(validator)
+
+          data = parser.parse_file(data_file)
+          errors = parser.errors()
+
+          if errors && !errors.empty?
+            # TODO: make a better error to raise that can encapsulate these validation failures.
+            msg = "Schema validation failed for #{data_file}."
+
+            logger.error "Schema validation failed for #{data_file}."
+            errors.each do |e|
+              logger.error "#{e.linenum}:#{e.column} [#{e.path}] #{e.message}"
+            end
+
+            raise msg
+          end
+
+          Config.new(name: name, aws_region: aws_region, data: data)
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/logging.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Cfer
+  module Auster
+    module Logging
+      def self.logger
+        @logger
+      end
+
+      def self.logdev
+        @logdev
+      end
+
+      # rubocop:disable Style/AccessorMethodName
+      def self.set_logdev(logdev)
+        @logdev = logdev
+        @logger = Logger.new(@logdev)
+      end
+
+      set_logdev($stderr)
+      @logger.level = Logger::INFO
+
+      module Mixin
+        def logger
+          Cfer::Auster::Logging.logger
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/param_validator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Cfer
+  module Auster
+    class ParamValidator
+      def initialize(&validator)
+        raise "validator must be a Proc." unless validator.is_a?(Proc)
+        raise "validator must be arity 2." unless validator.arity == 2
+
+        @validator = validator
+      end
+
+      def validate(parameters)
+        raise "parameters must be a Hash." unless parameters.is_a?(Hash)
+
+        errors = []
+        @validator.call(parameters, errors)
+        errors
+      end
+    end
+  end
+end