palo_alto 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2b330f9634b5c7a7e2f7f9e0a0acc86bc393716529e1aeefac7f58c169161a9
-  data.tar.gz: 9e3f4fa3d3e54bed392a8ba3edd0f85b2dcb7b189afe4f5b739ada12beec6a26
+  metadata.gz: e727fd699e499c9c7cdf0f445f1f83dc6b39721595060eb40f8ca686742f76fe
+  data.tar.gz: 538f05942d1bebd82c67c79749cf4cca51c57d3f56d6acbe6c8765eccd0abaca
 SHA512:
-  metadata.gz: 407e0f6cbfd8d5b8ff7ec3c2fe53d7addf9162098c3bd1eb516a29d557eb7485500063b622d6153351ae697556f163c3312b5290d65130fde47a916bd084678e
-  data.tar.gz: fe95ffe17e2cb493ad949dcf8cc576b610b836e414b54bc557b86aa85d033983cb0a1fde7078630fd8ad53ce9ce6c21e0838d83881c8d3e1cbc1d2f331d65297
+  metadata.gz: 6e02483ec9f3e9860d2a248b043e30f8da48a89c7385feee667fffdea51abfaced43db81a487ba2bdf79b0c396310baf65f0b30c2132a7e1486e9e5ba4fc09f8
+  data.tar.gz: 1be23db7b31ed050c9fea102f2ba3007b916572a0f1b6d9b25e94bc1ebb09b923a6f938bc31c9b165c057cc8af984aa245266de71afb5cb20ac2890b167443d2

data/lib/palo_alto/config.rb

@@ -1,4 +1,4 @@
-# generated: 2021-09-23 10:29:11 +0200
+# generated: 2021-10-19 00:56:02 +0200
 require 'openssl'
 require 'nokogiri'
 
@@ -425,7 +425,7 @@ module PaloAlto
 				start_time=Time.now
 				result = self.parent_instance.dup.create!.clear!.external_set(data.xpath('//response/result').first)
 				if XML.debug.include?(:statistics)
-					puts "Elapsed for parsing #{result.length} results: #{Time.now-start_time} seconds"
+					warn "Elapsed for parsing #{result.length} results: #{Time.now-start_time} seconds"
 				end
 				result
 			end
@@ -473,7 +473,7 @@ module PaloAlto
 					self
 				end.tap do
 					if XML.debug.include?(:statistics)
-						puts "Elapsed for parsing: #{Time.now-start_time} seconds"
+						warn "Elapsed for parsing: #{Time.now-start_time} seconds"
 					end
 				end
 			end
@@ -531,9 +531,9 @@ module PaloAlto
 					when 'bool'
 						return true if ['yes', true].include?(value)
 						return false if ['no', false].include?(value)
-						raise ArgumentError, 'Not bool: ' + value.inspect
+						raise ArgumentError, "Not bool: #{value.inspect}"
 					when 'string', 'ipdiscontmask', 'iprangespec', 'ipspec', 'rangelistspec'
-						raise(ArgumentError, 'Not string') unless value.is_a?(String)
+						raise(ArgumentError, "Not string: #{value.inspect}") unless value.is_a?(String)
 						if prop_arr['regex']
 							raise ArgumentError, "Not matching regex: #{value.inspect} (#{prop_arr["regex"].inspect})" unless value.match(prop_arr["regex"])
 						end
@@ -667,28 +667,34 @@ module PaloAlto
 				elsif @external_values.has_key?(prop)
 					return @external_values[prop]
 				elsif my_prop.has_key?("default") && include_defaults
-					return enforce_type(my_prop, my_prop['default'])
+					return enforce_types(my_prop, my_prop['default'])
 				else
 					return nil
 				end
 			end
 
-			def prop_set(prop, value)
-				my_prop = self.class.props[prop] or raise(InternalErrorException, "Unknown attribute for #{self.class}: #{prop}")
+			def enforce_types(prop_arr, values)
+				return if values.nil?
 
-				if has_multiple_values? && value.is_a?(String)
-					value = value.split(/\s+/)
+				if has_multiple_values? && values.is_a?(String)
+					values = values.split(/\s+/)
 				end
 
-				if value.is_a?(Array)
-					@values[prop] = value.map{|v| enforce_type(my_prop, v)}
-				elsif value.nil?
-					@values[prop] = nil
+				if values.is_a?(Array) && has_multiple_values?
+					values.map{|v| enforce_type(prop_arr, v)}
+				elsif !has_multiple_values?
+					enforce_type(prop_arr, values)
 				else
-					@values[prop] = enforce_type(my_prop, value)
+					raise(ArgumentError, 'Needs to be Array but is not, or vice versa')
 				end
 			end
 
+			def prop_set(prop, value)
+				my_prop = self.class.props[prop] or raise(InternalErrorException, "Unknown attribute for #{self.class}: #{prop}")
+
+				@values[prop] = enforce_types(my_prop, value)
+			end
+
 			def to_xml(changed_only:, full_tree:, include_root: )
 				builder = Nokogiri::XML::Builder.new{|xml|
 					xml.send(self._section, (self.selector rescue nil)) {

data/lib/palo_alto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaloAlto
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/lib/palo_alto.rb

@@ -213,12 +213,15 @@ module PaloAlto
       end
     end
 
-    def commit!(all: false)
+    def commit!(all: false, device_groups: nil, wait_for_completion: true)
+      return nil if device_groups.is_a?(Array) && device_groups.empty?
+
       op = if all
              'commit'
            else
              { commit: { partial: [
                { 'admin': [XML.username] },
+               device_groups ? {'device-group': device_groups } : nil,
                'no-template',
                'no-template-stack',
                'no-log-collector',
@@ -227,9 +230,39 @@ module PaloAlto
                'no-wildfire-appliance-cluster',
                { 'device-and-network': 'excluded' },
                { 'shared-object': 'excluded' }
-             ] } }
+             ].compact } }
            end
-      Op.new.execute(op)
+      Op.new.execute(op).tap do |result|
+        if wait_for_completion
+          job_id = result.at_xpath('response/result/job')&.text
+          wait_for_job_completion(job_id) if job_id
+        end
+      end
+    end
+
+    def full_commit_required?
+      result = Op.new.execute({check: 'full-commit-required'})
+      return true unless result.at_xpath('response/result').text == 'no'
+
+      false
+    end
+
+    def check_for_changes(usernames: [XML.username])
+      result = Op.new.execute({show: {config: {list: {'change-summary': {partial: {admin: usernames}}}}}})
+      result.xpath('response/result/summary/device-group/member').map(&:inner_text)
+    end
+
+    def wait_for_job_completion(job_id, wait: 5, timeout: 300)
+      cmd = {show: {jobs: {id: job_id}}}
+      start = Time.now
+      begin
+        result = Op.new.execute(cmd)
+        unless result.at_xpath('response/result/job/status')&.text=='ACT'
+          return result
+        end
+        sleep wait
+      end while start+timeout > Time.now
+      return false
     end
 
     def revert!(all: false)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: palo_alto
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Sebastian Roesner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri