piculet 0.2.9.beta → 0.2.9.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c0b24c8f65fe70f30b1a75e0896fc7d511c9292
-  data.tar.gz: d835fe30ffb2c680f1291eacb10bf2b398dfc275
+  metadata.gz: ef643aaca63e3788b2a8564c9a1745a838ad7fb1
+  data.tar.gz: cde74196414708bf85fd941e333cfcb6130efa37
 SHA512:
-  metadata.gz: 3ec1d30fd1542d71e9481fb00aed745a522ceaf83a92151764f9356443887e39e815287707c9893059ded3c812054b93ea64b5ebc99fabeabdbfffc4b3e43736
-  data.tar.gz: d5d1b119e4ef72bfba4912573527df37a0b061ab7c03d0bdfcc2c175901b1176af69e2f571223d6b7e698a450ae86213363a3ccd9632a14e8427e9b21ab11b0c
+  metadata.gz: 0a0115ee9795c828186c31f2a90065a791e3655dbabe142ba8c578e5876b0f4968f6bbc572e9ca4894c9cc95a842bddf97a0a26da1e8d5f1f6cfb9cebcd52ef1
+  data.tar.gz: b145ff246f344b220beedfb4ad017592639e4331320ba1825d49e59acfcf06b212ce1f30be9dae89b53563aa3c11cfb709ef1acde68408d38c3c95a7022fa3d0

data/README.md

@@ -7,6 +7,14 @@ It defines the state of EC2 Security Group using DSL, and updates EC2 Security G
 [![Gem Version](https://badge.fury.io/rb/piculet.svg)](http://badge.fury.io/rb/piculet)
 [![Build Status](https://travis-ci.org/winebarrel/piculet.svg?branch=master)](https://travis-ci.org/winebarrel/piculet)
 
+## Notice
+
+* `>= 0.2.9`
+  * Add ip/group duplicate check [PR#16](https://github.com/winebarrel/piculet/pull/16)
+  * Add `--exclude-tags` option [PR#17](https://github.com/winebarrel/piculet/pull/18)
+  * Support Template
+  * Add `--split-more` option
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -48,11 +56,13 @@ Usage: piculet [options]
     -f, --file FILE
     -n, --names SG_LIST
     -x, --exclude SG_LIST
+    -t, --exclude-tags TAG_LIST
         --ec2s VPC_IDS
         --dry-run
     -e, --export
     -o, --output FILE
         --split
+        --split-more
         --format=FORMAT
         --no-color
         --debug
@@ -169,6 +179,40 @@ ec2 "vpc-XXXXXXXX" do
 end
 ```
 
+## Use Template
+
+```ruby
+template "basic" do
+  permission :tcp, 22..22 do
+    ip_ranges(
+      "0.0.0.0/0",
+    )
+  end
+end
+
+template "egress" do
+  egress do
+    permission :any do
+      ip_ranges(
+        context.ip_addr || "0.0.0.0/0"
+      )
+    end
+  end
+end
+
+ec2 "vpc-XXXXXXXX" do
+  security_group "default" do
+    description "default VPC security group"
+
+    ingress do
+      include_template "basic"
+    end
+
+    include_template "egress", :ip_addr => "192.168.0.0/24"
+  end
+end
+```
+
 ## JSON Groupfile
 
 ```json

data/bin/piculet

@@ -40,11 +40,13 @@ ARGV.options do |opt|
     opt.on('-f', '--file FILE')                     {|v| file                         = v           }
     opt.on('-n', '--names SG_LIST', Array)          {|v| options[:sg_names]           = v           }
     opt.on('-x', '--exclude SG_LIST', Array)        {|v| options[:exclude_sgs]        = v           }
+    opt.on('-t', '--exclude-tags TAGS_LIST', Array) {|v| options[:exclude_tags]       = v           }
     opt.on('',   '--ec2s VPC_IDS', Array)           {|v| options[:ec2s]               = v           }
     opt.on('',   '--dry-run')                       {|v| options[:dry_run]            = true        }
     opt.on('-e', '--export')                        {|v| mode                         = :export     }
     opt.on('-o', '--output FILE')                   {|v| output_file                  = v           }
     opt.on('',   '--split')                         {|v| split                        = true        }
+    opt.on('',   '--split-more')                    {|v| split                        = :more       }
     opt.on('',   '--format=FORMAT', [:ruby, :json]) {|v| format_passed = true; options[:format] = v }
     opt.on(''  , '--no-color')                      {    options[:color]              = false       }
     opt.on(''  , '--debug')                         {    options[:debug]              = true        }
@@ -107,11 +109,10 @@ begin
 
       output_file = 'Groupfile' if output_file == '-'
       requires = []
+      base_dir = File.dirname(output_file)
 
       client.export(options.merge(:without_convert => options[:format] != :ruby)) do |exported, converter|
-        exported.each do |vpc, security_groups|
-          group_file = File.join(File.dirname(output_file), "#{vpc || :classic}.group")
-
+        write_group_file = proc do |group_file, vpc, security_groups|
           if options[:format] == :json
             group_file << '.json'
           end
@@ -119,6 +120,7 @@ begin
           requires << group_file
 
           logger.info("  write `#{group_file}`")
+          FileUtils.mkdir_p(File.dirname(group_file))
 
           open(group_file, 'wb') do |f|
             if options[:format] == :json
@@ -129,6 +131,19 @@ begin
             end
           end
         end
+
+        exported.each do |vpc, security_groups|
+          if split == :more
+            security_groups.each do |sg_id, sg_attrs|
+              sg_name = sg_attrs.fetch(:name)
+              group_file = File.join(base_dir, vpc || 'classic', "#{sg_name}.group")
+              write_group_file.call(group_file, vpc, sg_id => sg_attrs)
+            end
+          else
+            group_file = File.join(base_dir, "#{vpc || :classic}.group")
+            write_group_file.call(group_file, vpc, security_groups)
+          end
+        end
       end
 
       if options[:format] == :ruby
@@ -138,7 +153,8 @@ begin
           f.puts MAGIC_COMMENT
 
           requires.each do |group_file|
-            f.puts "require '#{File.basename group_file}'"
+            group_file.sub!(%r|\A#{Regexp.escape base_dir}/?|, '')
+            f.puts "require '#{group_file}'"
           end
         end
       end

data/lib/piculet/client.rb

@@ -13,6 +13,30 @@ module Piculet
       AWS.memoize { walk(file) }
     end
 
+    def should_skip(sg_name, sg)
+      # Name
+      if @options.sg_names
+        if not @options.sg_names.include?(sg_name)
+          return true
+        end
+      end
+
+      if @options.exclude_sgs
+        if @options.exclude_sgs.any? {|regex| sg_name =~ regex}
+          return true
+        end
+      end
+
+      # Tag
+      if @options.exclude_tags
+        if sg and @options.exclude_tags.any? {|tagname| not sg.tags.has_key?(tagname) }
+          return true
+        end
+      end
+
+      false
+    end
+
     def export(options = {})
       exported = AWS.memoize do
         Exporter.export(@options.ec2, @options_hash.merge(options))
@@ -97,17 +121,10 @@ module Piculet
 
       sg_list_dsl.each do |key, sg_dsl|
         name = key[0]
-
-        if @options.sg_names
-          next unless @options.sg_names.include?(name)
-        end
-
-        if @options.exclude_sgs
-          next if @options.exclude_sgs.any? {|regex| name =~ regex}
-        end
-
         sg_aws = sg_list_aws[key]
 
+        next if should_skip(name, sg_aws)
+
         unless sg_aws
           sg_aws = collection_api.create(name, :vpc => vpc, :description => sg_dsl.description)
 
@@ -121,29 +138,17 @@ module Piculet
 
       sg_list_dsl.each do |key, sg_dsl|
         name = key[0]
+        sg_aws = sg_list_aws.delete(key)
 
-        if @options.sg_names
-          next unless @options.sg_names.include?(name)
-        end
-
-        if @options.exclude_sgs
-          next if @options.exclude_sgs.any? {|regex| name =~ regex}
-        end
+        next if should_skip(name, sg_aws)
 
-        sg_aws = sg_list_aws.delete(key)
         walk_security_group(sg_dsl, sg_aws)
       end
 
       sg_list_aws.each do |key, sg_aws|
         name = key[0]
 
-        if @options.sg_names
-          next unless @options.sg_names.include?(name)
-        end
-
-        if @options.exclude_sgs
-          next if @options.exclude_sgs.any? {|regex| name =~ regex}
-        end
+        next if should_skip(name, sg_aws)
 
         sg_aws.ingress_ip_permissions.each {|i| i.delete }
         sg_aws.egress_ip_permissions.each {|i| i.delete } if vpc
@@ -152,13 +157,7 @@ module Piculet
       sg_list_aws.each do |key, sg_aws|
         name = key[0]
 
-        if @options.sg_names
-          next unless @options.sg_names.include?(name)
-        end
-
-        if @options.exclude_sgs
-          next if @options.exclude_sgs.any? {|regex| name =~ regex}
-        end
+        next if should_skip(name, sg_aws)
 
         sg_aws.delete
       end

data/lib/piculet/dsl/ec2.rb

@@ -1,10 +1,14 @@
 module Piculet
   class DSL
     class EC2
+      include Piculet::TemplateHelper
+
       attr_reader :result
 
-      def initialize(vpc, security_groups = [], &block)
+      def initialize(context, vpc, security_groups = [], &block)
         @names = Set.new
+        @context = context.merge(:vpc => vpc)
+
         @result = OpenStruct.new({
           :vpc             => vpc,
           :security_groups => security_groups,
@@ -19,7 +23,7 @@ module Piculet
           raise "EC2 `#{@result.vpc || :classic}`: `#{name}` is already defined"
         end
 
-        @result.security_groups << SecurityGroup.new(name, @result.vpc, &block).result
+        @result.security_groups << SecurityGroup.new(@context, name, @result.vpc, &block).result
         @names << name
       end
     end # EC2

data/lib/piculet/dsl/permission.rb

@@ -4,10 +4,18 @@ module Piculet
       class SecurityGroup
         class Permissions
           class Permission
-            def initialize(security_group, direction, protocol_prot_range, &block)
+            include Piculet::TemplateHelper
+
+            def initialize(context, security_group, direction, protocol_prot_range, &block)
               @security_group = security_group
               @direction = direction
               @protocol_prot_range = protocol_prot_range
+
+              @context = context.merge(
+                :protocol => protocol_prot_range[0],
+                :port_range => protocol_prot_range[1]
+              )
+
               @result = OpenStruct.new
               instance_eval(&block)
             end

data/lib/piculet/dsl/permissions.rb

@@ -4,10 +4,12 @@ module Piculet
       class SecurityGroup
         class Permissions
           include Logger::ClientHelper
+          include Piculet::TemplateHelper
 
-          def initialize(security_group, direction, &block)
+          def initialize(context, security_group, direction, &block)
             @security_group = security_group
             @direction = direction
+            @context = context.merge(:direction => direction)
             @result = {}
             instance_eval(&block)
           end
@@ -32,7 +34,7 @@ module Piculet
             end
 
             key = [protocol, port_range]
-            res = Permission.new(@security_group, @direction, key, &block).result
+            res = Permission.new(@context, @security_group, @direction, key, &block).result
 
             if @result.has_key?(key)
               @result[key] = OpenStruct.new(@result[key].marshal_dump.merge(res.marshal_dump) {|hash_key, old_val, new_val|

data/lib/piculet/dsl/security-group.rb

@@ -2,9 +2,12 @@ module Piculet
   class DSL
     class EC2
       class SecurityGroup
-        def initialize(name, vpc, &block)
+        include Piculet::TemplateHelper
+
+        def initialize(context, name, vpc, &block)
           @name = name
           @vpc = vpc
+          @context = context.merge(:security_group_name => name)
 
           @result = OpenStruct.new({
             :name    => name,
@@ -47,7 +50,7 @@ module Piculet
             raise "SecurityGroup `#{@name}`: `ingress` is already defined"
           end
 
-          @result.ingress = Permissions.new(@name, :ingress, &block).result
+          @result.ingress = Permissions.new(@context, @name, :ingress, &block).result
           @ingress_is_defined = true
         end
 
@@ -60,7 +63,7 @@ module Piculet
             raise "SecurityGroup `#{@name}`: Cannot define `egress` in classic"
           end
 
-          @result.egress = Permissions.new(@name, :egress, &block).result
+          @result.egress = Permissions.new(@context, @name, :egress, &block).result
 
           @egress_is_defined = true
         end

data/lib/piculet/dsl.rb

@@ -1,5 +1,7 @@
 module Piculet
   class DSL
+    include Piculet::TemplateHelper
+
     class << self
       def define(source, path)
         self.new(path) do
@@ -17,17 +19,28 @@ module Piculet
     def initialize(path, &block)
       @path = path
       @result = OpenStruct.new(:ec2s => {})
+
+      @context = Hashie::Mash.new(
+        :path => path,
+        :templates => {}
+      )
+
       instance_eval(&block)
     end
 
     private
+
+    def template(name, &block)
+      @context.templates[name.to_s] = block
+    end
+
     def require(file)
-      groupfile = File.expand_path(File.join(File.dirname(@path), file))
+      groupfile = (file =~ %r|\A/|) ? file : File.expand_path(File.join(File.dirname(@path), file))
 
       if File.exist?(groupfile)
-        instance_eval(File.read(groupfile))
+        instance_eval(File.read(groupfile), groupfile)
       elsif File.exist?(groupfile + '.rb')
-        instance_eval(File.read(groupfile + '.rb'))
+        instance_eval(File.read(groupfile + '.rb'), groupfile + '.rb')
       else
         Kernel.require(file)
       end
@@ -35,9 +48,9 @@ module Piculet
 
     def ec2(vpc = nil, &block)
       if (ec2_result = @result.ec2s[vpc])
-        @result.ec2s[vpc] = EC2.new(vpc, ec2_result.security_groups, &block).result
+        @result.ec2s[vpc] = EC2.new(@context, vpc, ec2_result.security_groups, &block).result
       else
-        @result.ec2s[vpc] = EC2.new(vpc, [], &block).result
+        @result.ec2s[vpc] = EC2.new(@context, vpc, [], &block).result
       end
     end
   end # DSL

data/lib/piculet/logger.rb

@@ -22,7 +22,8 @@ module Piculet
         message << ": #{log_id}" if log_id
         message << ' (dry-run)' if @options && @options.dry_run
         logger = (@options && @options.logger) || Piculet::Logger.instance
-        logger.send(level, message.send(color))
+        message = message.send(color) if color
+        logger.send(level, message)
       end
     end # ClientHelper
   end # Logger

data/lib/piculet/template-helper.rb

@@ -0,0 +1,20 @@
+module Piculet
+  module TemplateHelper
+    def include_template(template_name, context = {})
+      tmplt = @context.templates[template_name.to_s]
+
+      unless tmplt
+        raise "Template `#{template_name}` is not defined"
+      end
+
+      context_orig = @context
+      @context = @context.merge(context)
+      instance_eval(&tmplt)
+      @context = context_orig
+    end
+
+    def context
+      @context
+    end
+  end
+end

data/lib/piculet/utils.rb

@@ -0,0 +1,17 @@
+module Piculet
+  class Utils
+    class << self
+      def diff(obj1, obj2, options = {})
+        diffy = Diffy::Diff.new(
+          obj1.pretty_inspect,
+          obj2.pretty_inspect,
+          :diff => '-u'
+        )
+
+        out = diffy.to_s(options[:color] ? :color : :text).gsub(/\s+\z/m, '')
+        out.gsub!(/^/, options[:indent]) if options[:indent]
+        out
+      end
+    end # of class methods
+  end
+end

data/lib/piculet/version.rb

@@ -1,3 +1,3 @@
 module Piculet
-  VERSION = "0.2.9.beta"
+  VERSION = "0.2.9.beta2"
 end

data/lib/piculet/wrapper/security-group.rb

@@ -71,7 +71,7 @@ module Piculet
           self_tags = normalize_tags(self.tags)
           dsl_tags = normalize_tags(dsl.tags)
 
-          log(:info, "  set tags=#{dsl_tags.inspect}" , :green)
+          log(:info, "  tags:\n".green + Piculet::Utils.diff(self_tags, dsl_tags, :color => @options.color, :indent => '    '), false)
 
           unless @options.dry_run
             if dsl_tags.empty?

data/lib/piculet.rb

@@ -4,6 +4,9 @@ require 'ostruct'
 require 'set'
 require 'singleton'
 require 'term/ansicolor'
+require 'diffy'
+require 'pp'
+require 'hashie'
 
 require 'aws-sdk-v1'
 
@@ -13,6 +16,8 @@ require 'piculet/ext/ip-permission-collection-ext'
 require 'piculet/ext/string-ext'
 
 require 'piculet/logger'
+require 'piculet/template-helper'
+require 'piculet/utils'
 require 'piculet/client'
 require 'piculet/dsl'
 require 'piculet/dsl/converter'

metadata

@@ -1,97 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: piculet
 version: !ruby/object:Gem::Version
-  version: 0.2.9.beta
+  version: 0.2.9.beta2
 platform: ruby
 authors:
 - winebarrel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-26 00:00:00.000000000 Z
+date: 2015-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.48.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.48.0
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: rspec-instafail
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Piculet is a tool to manage EC2 Security Group. It defines the state
@@ -105,26 +133,28 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/piculet
+- lib/piculet.rb
 - lib/piculet/client.rb
+- lib/piculet/dsl.rb
 - lib/piculet/dsl/converter.rb
 - lib/piculet/dsl/ec2.rb
 - lib/piculet/dsl/permission.rb
 - lib/piculet/dsl/permissions.rb
 - lib/piculet/dsl/security-group.rb
-- lib/piculet/dsl.rb
 - lib/piculet/exporter.rb
 - lib/piculet/ext/ec2-owner-id-ext.rb
 - lib/piculet/ext/ip-permission-collection-ext.rb
 - lib/piculet/ext/security-group.rb
 - lib/piculet/ext/string-ext.rb
 - lib/piculet/logger.rb
+- lib/piculet/template-helper.rb
+- lib/piculet/utils.rb
 - lib/piculet/version.rb
 - lib/piculet/wrapper/ec2-wrapper.rb
 - lib/piculet/wrapper/permission-collection.rb
 - lib/piculet/wrapper/permission.rb
 - lib/piculet/wrapper/security-group-collection.rb
 - lib/piculet/wrapper/security-group.rb
-- lib/piculet.rb
 homepage: http://piculet.codenize.tools/
 licenses:
 - MIT
@@ -135,17 +165,17 @@ 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: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Piculet is a tool to manage EC2 Security Group.