itamae-plugin-resource-firewalld 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecfc329d9c4b178963b42cd2158ece91a45a09c7
-  data.tar.gz: 0b1aecf2a70e5ebd83b74c57ac2731239e54ffe6
+  metadata.gz: 4807810bd464e363989c8de9382f9789a54b929a
+  data.tar.gz: 9fd487b59fa8e659f59d15e1e5dd0d01b9e149f5
 SHA512:
-  metadata.gz: 13882c1f745cc3ed1c003e5d7f258beb15247d4f64495252d7a43f1b64ab8562c6b5c77cfa6f53f9d5374c56e309429bae658ea4de7c0d5028af398108f5ec24
-  data.tar.gz: 1e0c4ee9bcbac634088d227dd6061303faf57ac47123c22bb1302e4bd57e44db5d890f26c7f3eb150243e9ba26292275c27bb2bcc492726a6abf6d34684950bc
+  metadata.gz: bb05092f5c6aab47f91bfe5a1b0664d9d2014c63c4a1fbb353d517d9f506dbd30b56f910dd81f60f7b9a8cca7129a8f74e2ec99a727bedc2566a1390f2b86135
+  data.tar.gz: 6035f2c23cdea29bb99359b92fb37a082ec67f3da48a883927694c991054e8eb6c2bde24ad4f6ffd8d0d78703e1fe3e2611765e2bee98787be84662e3eb4c5d1

data/.travis.yml

@@ -1,4 +1,13 @@
 language: ruby
+
+sudo: false
+cache: bundler
+
+branches:
+  only:
+    - master
+
 rvm:
-  - 2.1.4
+  - 2.1
+  - 2.2
 script: bundle exec rake test

data/README.md

@@ -113,7 +113,7 @@ firewalld_service 'my-service' do
 
   short       # [String]
   description # [String]
-  port        # [String]
+  ports       # [Array of String]
   protocol    # [String]
   module_name # [String]
   to_ipv4     # [String]

data/examples/README.md

@@ -17,30 +17,16 @@ $ cd ./examples/
 $ vagrant up
 $ bundle exec itamae ssh -h default --vagrant recipe.rb
  INFO : Starting Itamae...
- INFO : Recipe: /path/to/itamae-plugin-resource-firewalld/examples/recipe.rb
- INFO :    service[firewalld]
- INFO :       action: start
- INFO :          running will change from 'false' to 'true'
- INFO :       action: enable
- INFO :          enabled will change from 'false' to 'true'
- INFO :    firewalld_service[my-ssh]
- INFO :       action: create
- INFO :       Notifying restart to service resource 'firewalld-add-service' (delayed)
- INFO :    service[firewalld-add-service]
- INFO :       action: restart
- INFO :    firewalld_zone[home]
- INFO :       action: update
- INFO :          services will change from '["dhcpv6-client", "ipp-client", "mdns", "samba-client", "ssh"]' to '["samba", "ssh", "vnc-server"]'
- INFO :          ports will change from '[]' to '["1900/udp", "32469/tcp", "5353/udp"]'
- INFO :       Notifying restart to service resource 'firewalld' (delayed)
- INFO :    firewalld_zone[public]
- INFO :       action: update
- INFO :          services will change from '["dhcpv6-client", "ssh"]' to '["https", "my-ssh", "mysql", "ssh"]'
- INFO :       Notifying restart to service resource 'firewalld' (delayed)
- INFO :    service[firewalld-add-service]
- INFO :       action: restart
- INFO :    service[firewalld]
- INFO :       action: restart
+ INFO : Recipe: /Users/gongo/.ghq/github.com/gongo/itamae-plugin-resource-firewalld/examples/recipe.rb
+ INFO :   service[firewalld] running will change from 'false' to 'true'
+ INFO :   service[firewalld] enabled will change from 'false' to 'true'
+ INFO :   firewalld_service[my-ssh] ports will change from '[]' to '["2222/tcp"]'
+ INFO :   Notifying restart to service resource 'firewalld-add-service' (delayed)
+ INFO :   firewalld_zone[home] services will change from '["dhcpv6-client", "ipp-client", "mdns", "samba-client", "ssh"]' to '["samba", "ssh", "vnc-server"]'
+ INFO :   firewalld_zone[home] ports will change from '[]' to '["1900/udp", "32469/tcp", "5353/udp"]'
+ INFO :   Notifying restart to service resource 'firewalld' (delayed)
+ INFO :   firewalld_zone[public] services will change from '["dhcpv6-client", "ssh"]' to '["https", "my-ssh", "mysql", "ssh"]'
+ INFO :   Notifying restart to service resource 'firewalld' (delayed)
 ```
 
 ### Confirmation

data/examples/recipe.rb

@@ -7,8 +7,7 @@ end
 firewalld_service 'my-ssh' do
   short       'my-ssh'
   description 'My perfect ssh!!'
-  port        '2222'
-  protocol    'tcp'
+  ports       %w(2222/tcp)
 
   #
   # Necessary to restart before use added service.

data/itamae-plugin-resource-firewalld.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'test-unit', '~> 3.0.1'
   spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'coveralls'
-  spec.add_dependency 'itamae', '~> 1.2.0'
+  spec.add_dependency 'itamae', '~> 1.2.14'
 end

data/lib/itamae/plugin/resource/firewalld/version.rb

@@ -2,7 +2,7 @@ module Itamae
   module Plugin
     module Resource
       module Firewalld
-        VERSION = "0.0.5"
+        VERSION = "0.0.6"
       end
     end
   end

data/lib/itamae/plugin/resource/firewalld_service.rb

@@ -11,8 +11,7 @@ module Itamae
 
         define_attribute :short,       type: String, default: ''
         define_attribute :description, type: String, default: ''
-        define_attribute :protocol,    type: String, default: ''
-        define_attribute :port,        type: String, default: ''
+        define_attribute :ports,       type: Array,  default: []
         define_attribute :module_name, type: String, default: ''
         define_attribute :to_ipv4,     type: String, default: ''
         define_attribute :to_ipv6,     type: String, default: ''
@@ -35,9 +34,12 @@ module Itamae
             current.description = service['description'].text
           end
 
-          if service['port']
-            current.protocol = service['port'].attributes['protocol']
-            current.port = service['port'].attributes['port']
+          current.ports = service.collect('port') do |port|
+            if port.attributes['port'].nil? || port.attributes['port'].empty?
+              port.attributes['protocol']
+            else
+              "#{port.attributes['port']}/#{port.attributes['protocol']}"
+            end
           end
 
           if service['module']
@@ -50,6 +52,12 @@ module Itamae
           end
         end
 
+        def show_differences
+          current.ports = normalize_ports(current.ports)
+          attributes.ports = normalize_ports(attributes.ports)
+          super
+        end
+
         def action_create(options)
           run_specinfra(:move_file, build_xmlfile_on_remote, service_xmlfile_path)
           attributes.status = :defined
@@ -64,6 +72,16 @@ module Itamae
 
         private
 
+        def normalize_ports(ports)
+          return [] if ports.nil?
+          ports.map(&:to_s).sort
+        end
+
+        # '80/tcp' => ['tcp', 80]; 'igmp' => ['igmp']
+        def parse_port(port)
+          port.to_s.split('/', 2).reverse
+        end
+
         def build_xmlfile_on_remote
           local_path  = build_xmlfile_on_local
           remote_path = ::File.join(runner.tmpdir, Time.now.to_f.to_s)
@@ -79,7 +97,7 @@ module Itamae
 
           add_short_tag
           add_description_tag
-          add_port_tag
+          add_port_tags
           add_module_tag
           add_destination_tag
 
@@ -103,12 +121,16 @@ module Itamae
           description.text = attributes.description unless attributes.description.empty?
         end
 
-        def add_port_tag
-          return if (attributes.protocol.empty? && attributes.port.empty?)
+        def add_port_tags
+          return unless attributes.ports
 
-          node = @service_document.add_element('port')
-          node.add_attribute('protocol', attributes.protocol) unless attributes.protocol.empty?
-          node.add_attribute('port', attributes.port) unless attributes.port.empty?
+          normalize_ports(attributes.ports).each do |port|
+            protocol, portnum = parse_port(port)
+
+            node = @service_document.add_element('port')
+            node.add_attribute('protocol', protocol)
+            node.add_attribute('port', portnum || '')
+          end
         end
 
         def add_module_tag
@@ -131,7 +153,7 @@ module Itamae
         end
 
         def current_status
-          command  = ['firewall-cmd', '--permanent', '--list-services']
+          command  = ['firewall-cmd', '--permanent', '--get-services']
           services = run_command(command).stdout.strip.split
           services.include?(attributes.name) ? :defined : :undefined
         end

data/test/helper.rb

@@ -6,3 +6,17 @@ require 'mocha/test_unit'
 require 'itamae'
 
 Itamae::Logger.log_device = StringIO.new
+
+class BackendMock < ::Itamae::Backend::Local
+  class UnexpectedCallError < StandardError ; end
+
+  attr_reader :sent_file
+
+  def run_command(*args)
+    raise UnexpectedCallError.new('Should have been stubbing')
+  end
+
+  def send_file(src, dst)
+    @sent_file = src
+  end
+end

data/test/itamae/plugin/resource/test_firewalld_service.rb

@@ -4,20 +4,12 @@ require 'itamae/plugin/resource/firewalld_service'
 module Itamae
   module Plugin
     module Resource
-      # Stub
-      class FirewalldService
-        def send_file(from, to)
-          @local_path = from
-        end
-
-        def local_path
-          @local_path
-        end
-      end
-
       class TestFirewalldService < Test::Unit::TestCase
         setup do
-          @resource = FirewalldService.new(stub, 'test-service')
+          @backend  = BackendMock.new({})
+          runner    = stub(tmpdir: ::Dir.tmpdir, backend: @backend)
+          recipe    = stub(runner: runner)
+          @resource = FirewalldService.new(recipe, 'test-service')
         end
 
         sub_test_case '#action_delete' do
@@ -28,7 +20,7 @@ module Itamae
           sub_test_case 'predefined service' do
             setup do
               @resource.expects(:run_command)
-                .with(['firewall-cmd', '--permanent', '--list-services'])
+                .with(['firewall-cmd', '--permanent', '--get-services'])
                 .returns(stub(stdout: 'service1 service2 test-service'))
             end
 
@@ -42,7 +34,7 @@ module Itamae
           sub_test_case 'undefined service' do
             setup do
               @resource.expects(:run_command)
-                .with(['firewall-cmd', '--permanent', '--list-services'])
+                .with(['firewall-cmd', '--permanent', '--get-services'])
                 .returns(stub(stdout: 'service1 service2'))
             end
 
@@ -56,25 +48,10 @@ module Itamae
         sub_test_case '#action_create' do
           setup do
             @resource.attributes.action = :create
-            @resource.stubs(:runner).returns(stub(tmpdir: ::Dir.tmpdir))
-            @resource.stubs(:move_file)
             @resource.stubs(:run_specinfra).with(:move_file, is_a(String), is_a(String))
-
             @resource.expects(:notify)
           end
 
-          sub_test_case 'undefined service' do
-            setup do
-              @resource.stubs(:current_status).returns(:undefined)
-            end
-
-            test 'create service' do
-              @resource.run
-
-              assert ::File.exists?(@resource.local_path )
-            end
-          end
-
           sub_test_case 'predefined service' do
             setup do
               @resource.stubs(:current_status).returns(:defined)
@@ -86,6 +63,8 @@ module Itamae
   <short>test-service</short>
   <description>test-service description</description>
   <port protocol="tcp" port="2222"/>
+  <port protocol="udp" />
+  <port protocol="tcp" port="80-82"/>
   <module name="test-module"/>
   <destination ipv4="224.0.0.251" ipv6="ff02::fb"/>
 </service>
@@ -95,20 +74,30 @@ module Itamae
             test 'update service' do
               @resource.attributes.short       = 'test-service!!'
               @resource.attributes.description = 'test-service update description'
-              @resource.attributes.protocol    = 'udp'
-              @resource.attributes.port        = '2222-2224'
+              @resource.attributes.ports       = ['2222-2224/udp', '80/tcp', 'igmp']
               @resource.attributes.module_name = 'new-test-module'
               @resource.attributes.to_ipv4     = '172.17.0.1'
               @resource.attributes.to_ipv6     = 'ffff::fc'
               @resource.run
 
-              root = REXML::Document.new(File.read(@resource.local_path))
+              assert_equal 'test-service',                   @resource.current.short
+              assert_equal 'test-service description',       @resource.current.description
+              assert_equal ['2222/tcp', '80-82/tcp', 'udp'], @resource.current.ports
+              assert_equal 'test-module',                    @resource.current.module_name
+              assert_equal '224.0.0.251',                    @resource.current.to_ipv4
+              assert_equal 'ff02::fb',                       @resource.current.to_ipv6
+
+              root = REXML::Document.new(File.read(@backend.sent_file))
               service = root.elements['/service'].elements
 
               assert_equal @resource.attributes.short,       service['short'].text
               assert_equal @resource.attributes.description, service['description'].text
-              assert_equal @resource.attributes.protocol,    service['port'].attributes['protocol']
-              assert_equal @resource.attributes.port,        service['port'].attributes['port']
+              assert_equal 'udp',                            service[1, 'port'].attributes['protocol']
+              assert_equal '2222-2224',                      service[1, 'port'].attributes['port']
+              assert_equal 'tcp',                            service[2, 'port'].attributes['protocol']
+              assert_equal '80',                             service[2, 'port'].attributes['port']
+              assert_equal 'igmp',                           service[3, 'port'].attributes['protocol']
+              assert_equal '',                               service[3, 'port'].attributes['port']
               assert_equal @resource.attributes.module_name, service['module'].attributes['name']
               assert_equal @resource.attributes.to_ipv4,     service['destination'].attributes['ipv4']
               assert_equal @resource.attributes.to_ipv6,     service['destination'].attributes['ipv6']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itamae-plugin-resource-firewalld
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Wataru MIYAGUNI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2015-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.14
 description: Itamae resource plugin to manage firewalld.
 email:
 - gonngo@gmail.com