stax 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fb67f05d66f75c3ee95f2f244189b9f0a24cf84c510280a02f17325b0f6c29b
-  data.tar.gz: e8a9c6ab1f3b869f36c688ffc7c9caf69799ed9fd9730f23beabd29a750ddfa2
+  metadata.gz: f67200ba2fe96d677017c4c8b7fd8cdaeb96c64c2b460a772e792b002002e99c
+  data.tar.gz: 73ca26f1f17f37249fd3a472445234c157ab91634187f6d9037e0a20ff131af6
 SHA512:
-  metadata.gz: e31cf509ed73dbfc5045f5d2971d47894be9194f0a78d33812544ee5e854f15095c32ff3d4be868a168cf4d29475e9bf2bd03338f8f9043a6b43774bbecf3fa0
-  data.tar.gz: fad98ced6ce0cced2e8fa45405e6e3f5dd47d168ab5134a41c66e42cea280f2b36d9169b11d367aeb19e88cfbac3b093aa72541b619ca3de2a3b52c933dff9f2
+  metadata.gz: 4ab6c6a8e26b26d4886c2b1ee296c01d966ca67a1562853c88ecb65888b5de91fecd86edd036f7867e3f91a50f7e85595eb359f393de73be6345285f62c93e78
+  data.tar.gz: 1035345699f80580901023c0a1462f3407bb46778714c0e649e08136ad6518ed749add006ac18426e8835d8f0238d6424129cbb58a05b83a78f4538833c8a8d8

data/README.md

@@ -6,10 +6,9 @@ stacks along with all the crappy glue code you need around them.
 Stax is built as a set of ruby classes, with configuration based
 around sub-classing and monkey-patching.
 
-For now, Stax reads template files written using the
-[cfer](https://github.com/seanedwards/cfer) ruby wrapper. It should be
-straightforward to change to raw json/yaml, or a different wrapper by
-re-implementing the methods in `lib/stax/stack/crud.rb`.
+Stax can read template files written in `yaml`, `json` or the
+[cfer](https://github.com/seanedwards/cfer) ruby wrapper. It will
+choose which to use based on file extensions found.
 
 ## Concepts
 

data/lib/stax.rb

@@ -20,6 +20,9 @@ require 'stax/stack/outputs'
 require 'stax/stack/imports'
 require 'stax/stack/resources'
 
+require 'stax/generators'
+require 'stax/generators/stack_generator'
+require 'stax/generate'
 require 'stax/mixin/ec2'
 require 'stax/mixin/alb'
 require 'stax/mixin/elb'

data/lib/stax/cfer.rb

@@ -47,27 +47,13 @@ module Stax
         nil
       end
 
-      ## override with SNS ARNs as needed
-      def cfer_notification_arns
-        []
-      end
-
-      def cfer_termination_protection
-        false
-      end
-
-      ## location of template file
-      def cfn_template_path
-        File.join('cf', "#{class_name}.rb")
-      end
-
       def cfer_client
         @_cfer_client ||= Cfer::Cfn::Client.new({})
       end
 
       ## generate JSON for stack without sending to cloudformation
-      def cfer_generate
-        Cfer::stack_from_file(cfn_template_path, client: cfer_client, parameters: stringify_keys(cfn_parameters)).to_json
+      def cfer_generate(filename)
+        Cfer::stack_from_file(filename, client: cfer_client, parameters: stringify_keys(cfn_parameters)).to_json
       rescue Cfer::Util::FileDoesNotExistError => e
         fail_task(e.message)
       end

data/lib/stax/generate.rb

@@ -0,0 +1,12 @@
+module Stax
+  class Cli < Base
+
+    desc 'generate NAME [ARGS]', 'run code generators'
+    def generate(generator, *args)
+      Stax::const_get(generator.capitalize + 'Generator').start(args)
+    rescue NameError => e
+      fail_task(e.message)
+    end
+
+  end
+end

data/lib/stax/generators.rb

@@ -0,0 +1,20 @@
+module Stax
+  module Generators
+    class Base < Thor::Group
+      include Thor::Actions
+
+      protected
+
+      ## name for invoking this generator
+      def self.command_name
+        self.to_s.split('::').last.delete_suffix('Generator').downcase
+      end
+
+      ## override help banner to make sense for generators
+      def self.banner(*args)
+        "#{basename} generate #{command_name} ARGS"
+      end
+
+    end
+  end
+end

data/lib/stax/generators/stack_generator.rb

@@ -0,0 +1,106 @@
+## generator to create the basic files for one or more new stacks:
+##   - add stack to Staxfile
+##   - subclass in lib/stack/
+##   - cfer/json/yaml template outline in cf/
+
+module Stax
+  class StackGenerator < Stax::Generators::Base
+    desc 'Create new stacks with given names.'
+
+    class_option :json, type: :boolean, default: false, desc: 'create json templates'
+    class_option :yaml, type: :boolean, default: false, desc: 'create yaml templates'
+
+    def check_args
+      abort('List one or more stacks to create') if args.empty?
+    end
+
+    def create_staxfile
+      create_file 'Staxfile' unless File.exist?('Staxfile')
+      append_to_file 'Staxfile' do
+        args.map { |s| "stack :#{s}" }.join("\n").concat("\n")
+      end
+    end
+
+    def create_lib_files
+      args.each do |s|
+        create_file "lib/stack/#{s}.rb" do
+          <<~FILE
+            module Stax
+              class #{s.capitalize} < Stack
+                # include Logs
+
+                # no_commands do
+                #   def cfn_parameters
+                #     super.merge(
+                #       # add parameters as a hash here
+                #     )
+                #   end
+                # end
+              end
+            end
+          FILE
+        end
+      end
+    end
+
+    def create_templates
+      if options[:json]
+        create_json_templates
+      elsif options[:yaml]
+        create_yaml_templates
+      else
+        create_cfer_templates
+      end
+    end
+
+    private
+
+    def create_cfer_templates
+      args.each do |s|
+        create_file "cf/#{s}.rb" do
+          <<~FILE
+            description '#{s} stack'
+
+            # parameter :foo, type: :String, default: ''
+            # mappings()
+            # include_template()
+          FILE
+        end
+      end
+    end
+
+    def create_json_templates
+      args.each do |s|
+        create_file "cf/#{s}.json" do
+          <<~FILE
+            {
+              "AWSTemplateFormatVersion": "2010-09-09",
+              "Description": "#{s} stack",
+              "Parameters": {},
+              "Mappings": {},
+              "Conditions": {},
+              "Resources": {},
+              "Outputs": {}
+            }
+          FILE
+        end
+      end
+    end
+
+    def create_yaml_templates
+      args.each do |s|
+        create_file "cf/#{s}.yaml" do
+          <<~FILE
+            AWSTemplateFormatVersion: '2010-09-09'
+            Description: Stax test stack
+            Parameters: {}
+            Mappings: {}
+            Conditions: {}
+            Resources:
+            Outputs: {}
+          FILE
+        end
+      end
+    end
+  end
+end

data/lib/stax/stack/cfn.rb

@@ -18,9 +18,15 @@ module Stax
     desc 'template', 'get template of existing stack from cloudformation'
     method_option :pretty, type: :boolean, default: true, desc: 'format json output'
     def template
-      Aws::Cfn.template(stack_name).tap { |t|
-        puts options[:pretty] ? JSON.pretty_generate(JSON.parse(t)) : t
-      }
+      body = Aws::Cfn.template(stack_name)
+      if options[:pretty]
+        begin
+          body = JSON.pretty_generate(JSON.parse(body))
+        rescue JSON::ParserError
+          ## not valid json, may be yaml
+        end
+      end
+      puts body
     end
 
     desc 'events', 'show all events for stack'

data/lib/stax/stack/changeset.rb

@@ -21,7 +21,7 @@ module Stax
           template_url: cfn_template_url,
           parameters: cfn_parameters_update,
           capabilities: cfn_capabilities,
-          notification_arns: cfer_notification_arns,
+          notification_arns: cfn_notification_arns,
           change_set_name: change_set_name,
           change_set_type: :UPDATE,
         ).id

data/lib/stax/stack/crud.rb

@@ -61,9 +61,24 @@ module Stax
         end
       end
 
-      ## memoized template
+      ## location of templates relative to Staxfile
+      def cfn_template_dir
+        'cf'
+      end
+
+      ## get cfn template from file depending on the format
       def cfn_template
-        @_cfn_template ||= cfer_generate
+        @_cfn_template ||= \
+        begin
+          stub = File.join(cfn_template_dir, "#{class_name}")
+          if File.exists?(f = "#{stub}.rb")
+            cfer_generate(f)
+          elsif File.exists?(f = "#{stub}.yaml")
+            File.read(f)
+          elsif File.exists?(f = "#{stub}.json")
+            File.read(f)
+          end
+        end
       end
 
       ## set this to always do an S3 upload of template
@@ -90,6 +105,26 @@ module Stax
         obj.public_url + ((v = obj.version_id) ? "?versionId=#{v}" : '')
       end
 
+      ## override with SNS ARNs as needed
+      def cfn_notification_arns
+        if self.class.method_defined?(:cfer_notification_arns)
+          warn('Method cfer_notification_arns deprecated, please use cfn_notification_arns')
+          cfer_notification_arns
+        else
+          []
+        end
+      end
+
+      ## set true to protect stack
+      def cfn_termination_protection
+        if self.class.method_defined?(:cfer_termination_protection)
+          warn('Method cfer_termination_protection deprecated, please use cfn_termination_protection')
+          cfer_termination_protection
+        else
+          false
+        end
+      end
+
       ## template body, or nil if uploading to S3
       def cfn_template_body
         @_cfn_template_body ||= cfn_use_s3? ? nil : cfn_template
@@ -132,8 +167,8 @@ module Stax
         parameters: cfn_parameters_create,
         capabilities: cfn_capabilities,
         stack_policy_body: stack_policy,
-        notification_arns: cfer_notification_arns,
-        enable_termination_protection: cfer_termination_protection,
+        notification_arns: cfn_notification_arns,
+        enable_termination_protection: cfn_termination_protection,
       )
 
       ## show stack events
@@ -155,7 +190,7 @@ module Stax
         parameters: cfn_parameters_update,
         capabilities: cfn_capabilities,
         stack_policy_during_update_body: stack_policy_during_update,
-        notification_arns: cfer_notification_arns,
+        notification_arns: cfn_notification_arns,
       )
       tail
       update_warn_imports
@@ -185,7 +220,7 @@ module Stax
 
     desc 'generate', 'generate cloudformation template'
     def generate
-      puts cfer_generate
+      puts cfn_template
     end
 
     desc 'protection', 'show/set termination protection for stack'

data/lib/stax/version.rb

@@ -1,3 +1,3 @@
 module Stax
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stax
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Richard Lister
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-03 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,9 @@ files:
 - lib/stax/cli.rb
 - lib/stax/docker.rb
 - lib/stax/dsl.rb
+- lib/stax/generate.rb
+- lib/stax/generators.rb
+- lib/stax/generators/stack_generator.rb
 - lib/stax/git.rb
 - lib/stax/github.rb
 - lib/stax/iam.rb