ruby-paloalto-client 0.0.1 → 0.0.2

data/spec/lib/palo-alto/v6/log_api_spec.rb

@@ -0,0 +1,218 @@
+require "palo_alto/v6/log_api"
+require "palo_alto/helpers/rest"
+
+describe "PaloAlto::V6::LogApi" do
+  # dummy class to demonstrate functionality
+  class DummyClass
+    extend PaloAlto::V6::LogApi
+
+    def self.endpoint
+      "https://some.host:80/api/"
+    end
+
+    def self.auth_key
+      "OIGHOEIHT()*#Y"
+    end
+  end
+
+  describe ".generate_logs" do
+    let(:log_success_xml) { File.open(fixture_file("log_job.xml")).read }
+
+    describe "when specifying an invalid log_type parameter" do
+      it "raises an exception" do
+        expect{ DummyClass.generate_logs(log_type: "blah") }.to raise_exception
+      end
+    end
+
+    describe "for invalid number of logs specified" do
+      it "raises an exception when number of logs is less than minimum" do
+        expect{ DummyClass.generate_logs(log_type: "traffic", num_logs: -1000) }.to raise_exception
+      end
+
+      it "raises an exception when number of logs is greater than maximum" do
+        expect{ DummyClass.generate_logs(log_type: "traffic", num_logs: 99999) }.to raise_exception
+      end
+    end
+
+    describe "when the job is kicked off successfully" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(log_success_xml)
+      end
+
+      it "returns the job_id for the log job" do
+        expect(DummyClass.generate_logs(log_type: "traffic")).to eq("2014")
+      end
+    end
+
+    describe "when errors occur" do
+      it "raises an exception if an error occurred obtaining XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_raise(Exception)
+        expect{ DummyClass.generate_logs(log_type: "traffic") }.to raise_exception
+      end
+
+      it "raises an exception if an error occurred reported in the XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(File.open(fixture_file("failure.xml")).read)
+        expect{ DummyClass.generate_logs(log_type: "traffic") }.to raise_exception
+      end
+    end
+  end
+
+  describe ".log_job_complete?" do
+    let(:job_id)              { "2015" }
+    let(:log_in_progress_xml) { File.open(fixture_file("log_in_progress.xml")).read }
+    let(:log_complete_xml)    { File.open(fixture_file("log_complete.xml")).read }
+
+    describe "when a job is still in progress" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(log_in_progress_xml)
+      end
+
+      it "returns false" do
+        expect(DummyClass.log_job_complete?(job_id: job_id)).to eq(false)
+      end
+    end
+
+    describe "when a job has completed" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(log_complete_xml)
+      end
+
+      it "returns true" do
+        expect(DummyClass.log_job_complete?(job_id: job_id)).to eq(true)
+      end
+    end
+
+    describe "when errors occur" do
+      it "raises an exception if an error occurred obtaining XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_raise(Exception)
+        expect{ DummyClass.log_job_complete?(job_id: job_id) }.to raise_exception
+      end
+
+      it "raises an exception if an error occurred obtaining XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(File.open(fixture_file("failure.xml")).read)
+        expect{ DummyClass.log_job_complete?(job_id: job_id) }.to raise_exception
+      end
+    end
+  end
+
+  describe ".get_logs" do
+    let(:job_id)          { "2014" }
+    let(:log_xml)         { File.open(fixture_file("traffic_logs.xml")).read }
+    let(:blank_log_xml)   { File.open(fixture_file("blank_traffic_logs.xml")).read }
+    let(:pending_log_xml) { File.open(fixture_file("pending_traffic_logs.xml")).read }
+
+    describe "when logs exist" do
+      it "parses the XML response into the required format" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(log_xml)
+        logs = DummyClass.get_logs(job_id: job_id)
+
+        expect(logs).to be_instance_of(Array)
+        expect(logs).to_not be_empty
+      end
+    end
+
+    describe "when no logs exist" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(blank_log_xml)
+      end
+
+      it "returns an empty array" do
+        expect(DummyClass.get_logs(job_id: job_id)).to eq([])
+      end
+    end
+
+    describe "when the log job is not complete" do
+      before do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(pending_log_xml)
+      end
+
+      it "raises an Exception" do
+        expect{ DummyClass.get_logs(job_id: job_id) }.to raise_exception
+      end
+    end
+
+    describe "when errors occur" do
+      it "raises an exception if an error occurred obtaining XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_raise(Exception)
+        expect{ DummyClass.get_logs(job_id: job_id) }.to raise_exception
+      end
+
+      it "raises an exception if an error occurred reported in the XML" do
+        expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(File.open(fixture_file("failure.xml")).read)
+        expect{ DummyClass.get_logs(job_id: job_id) }.to raise_exception
+      end
+    end
+  end
+
+  describe "private functions" do
+    describe "get_log_xml" do
+      let(:job_id)          { "2014" }
+      let(:log_xml)         { File.open(fixture_file("traffic_logs.xml")).read }
+      let(:invalid_log_xml) { File.open(fixture_file("invalid_format.xml")).read }
+
+      describe "for valid XML data" do
+        it "parses the XML response into the required format" do
+          expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(log_xml)
+          logs = DummyClass.send(:get_log_xml, { job_id: job_id })
+
+          expect(logs).to be_instance_of(Nokogiri::XML::Document)
+        end
+      end
+
+      describe "for nil response from PaloAlto service" do
+        before do
+          expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(nil)
+        end
+
+        it "raises an Exception" do
+          expect{ DummyClass.send(:get_log_xml, { job_id: job_id }) }.to raise_exception
+        end
+      end
+
+      describe "for invalid XML data" do
+        before do
+          expect(PaloAlto::Helpers::Rest).to receive(:make_request).and_return(log_xml)
+          expect(Nokogiri::XML::Document).to receive(:parse).and_raise(Exception)
+        end
+
+        it "raises an Exception" do
+          expect{ DummyClass.send(:get_log_xml, { job_id: job_id }) }.to raise_exception
+        end
+      end
+    end
+
+    describe "get_log_xml_response_code" do
+      let(:log_xml)  { File.open(fixture_file("traffic_logs.xml")).read }
+      let(:xml_data) { Nokogiri::XML(log_xml) }
+
+      describe "for a valid Nokogiri::XML::Document" do
+        it "returns the response code" do
+          expect(DummyClass.send(:get_log_xml_response_code, { xml_data: xml_data })).to eq("success")
+        end
+      end
+
+      describe "for an input type that is not a Nokogiri::XML::Document" do
+        it "raises an Exception" do
+          expect{ DummyClass.send(:get_log_xml_response_code, { xml_data: "test" }) }.to raise_exception
+        end
+      end
+    end
+
+    describe "get_log_job_status" do
+      let(:log_xml)  { File.open(fixture_file("traffic_logs.xml")).read }
+      let(:xml_data) { Nokogiri::XML(log_xml) }
+
+      describe "for a valid Nokogiri::XML::Document" do
+        it "returns the response code" do
+          expect(DummyClass.send(:get_log_job_status, { xml_data: xml_data })).to eq("FIN")
+        end
+      end
+
+      describe "for an input type that is not a Nokogiri::XML::Document" do
+        it "raises an Exception" do
+          expect{ DummyClass.send(:get_log_job_status, { xml_data: "test" }) }.to raise_exception
+        end
+      end
+    end
+  end
+end

data/spec/lib/palo-alto/v6/virtual_system_api_spec.rb

@@ -1,5 +1,5 @@
-require "palo-alto/v6/virtual-system-api"
-require "palo-alto/helpers/rest"
+require "palo_alto/v6/virtual_system_api"
+require "palo_alto/helpers/rest"
 require "nokogiri"
 
 describe "PaloAlto::V6::VirtualSystemApi" do

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require "fakeweb"
 require "simplecov"
+require "nokogiri"
 
 SimpleCov.start do
   add_filter "/spec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-paloalto-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin Karimi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-01 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -123,34 +123,48 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/palo-alto/client.rb
-- lib/palo-alto/client/version.rb
-- lib/palo-alto/common/base-api.rb
-- lib/palo-alto/helpers/rest.rb
-- lib/palo-alto/models/address-group.rb
-- lib/palo-alto/models/address.rb
-- lib/palo-alto/models/device.rb
-- lib/palo-alto/models/rulebase.rb
-- lib/palo-alto/models/virtual-system.rb
-- lib/palo-alto/v6/address-api.rb
-- lib/palo-alto/v6/address-group-api.rb
-- lib/palo-alto/v6/api.rb
-- lib/palo-alto/v6/device-api.rb
-- lib/palo-alto/v6/virtual-system-api.rb
+- lib/palo_alto/client.rb
+- lib/palo_alto/client/version.rb
+- lib/palo_alto/common/base_api.rb
+- lib/palo_alto/helpers/rest.rb
+- lib/palo_alto/models/address.rb
+- lib/palo_alto/models/address_group.rb
+- lib/palo_alto/models/device.rb
+- lib/palo_alto/models/log_entry.rb
+- lib/palo_alto/models/rulebase.rb
+- lib/palo_alto/models/system_log_entry.rb
+- lib/palo_alto/models/traffic_log_entry.rb
+- lib/palo_alto/models/virtual_system.rb
+- lib/palo_alto/v6/address_api.rb
+- lib/palo_alto/v6/address_group_api.rb
+- lib/palo_alto/v6/api.rb
+- lib/palo_alto/v6/device_api.rb
+- lib/palo_alto/v6/log_api.rb
+- lib/palo_alto/v6/virtual_system_api.rb
 - ruby-paloalto-client.gemspec
 - spec/fixtures/address_groups.xml
 - spec/fixtures/addresses.xml
 - spec/fixtures/blank_address_groups.xml
 - spec/fixtures/blank_addresses.xml
 - spec/fixtures/blank_devices.xml
+- spec/fixtures/blank_traffic_logs.xml
 - spec/fixtures/blank_virtual_systems.xml
 - spec/fixtures/devices.xml
 - spec/fixtures/failure.xml
+- spec/fixtures/log_complete.xml
+- spec/fixtures/log_in_progress.xml
+- spec/fixtures/log_job.xml
+- spec/fixtures/missing_type_logs.xml
 - spec/fixtures/no_address_group_virtual_systems.xml
 - spec/fixtures/no_address_virtual_systems.xml
 - spec/fixtures/no_members_address_groups.xml
 - spec/fixtures/no_rulebase_virtual_systems.xml
 - spec/fixtures/no_vsys_devices.xml
+- spec/fixtures/pending_traffic_logs.xml
+- spec/fixtures/system_logs.xml
+- spec/fixtures/traffic_logs.xml
+- spec/fixtures/unsupported_log_attribute.xml
+- spec/fixtures/unsupported_logs.xml
 - spec/fixtures/virtual_systems.xml
 - spec/lib/palo-alto/client_spec.rb
 - spec/lib/palo-alto/common/base_api_spec.rb
@@ -158,12 +172,16 @@ files:
 - spec/lib/palo-alto/models/address_group_spec.rb
 - spec/lib/palo-alto/models/address_spec.rb
 - spec/lib/palo-alto/models/device_spec.rb
+- spec/lib/palo-alto/models/log_entry_spec.rb
 - spec/lib/palo-alto/models/rulebase_spec.rb
+- spec/lib/palo-alto/models/system_log_entry_spec.rb
+- spec/lib/palo-alto/models/traffic_log_entry_spec.rb
 - spec/lib/palo-alto/models/virtual_system_spec.rb
 - spec/lib/palo-alto/v6/address_api_spec.rb
 - spec/lib/palo-alto/v6/address_group_api_spec.rb
 - spec/lib/palo-alto/v6/api_spec.rb
 - spec/lib/palo-alto/v6/device_api_spec.rb
+- spec/lib/palo-alto/v6/log_api_spec.rb
 - spec/lib/palo-alto/v6/virtual_system_api_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -196,14 +214,24 @@ test_files:
 - spec/fixtures/blank_address_groups.xml
 - spec/fixtures/blank_addresses.xml
 - spec/fixtures/blank_devices.xml
+- spec/fixtures/blank_traffic_logs.xml
 - spec/fixtures/blank_virtual_systems.xml
 - spec/fixtures/devices.xml
 - spec/fixtures/failure.xml
+- spec/fixtures/log_complete.xml
+- spec/fixtures/log_in_progress.xml
+- spec/fixtures/log_job.xml
+- spec/fixtures/missing_type_logs.xml
 - spec/fixtures/no_address_group_virtual_systems.xml
 - spec/fixtures/no_address_virtual_systems.xml
 - spec/fixtures/no_members_address_groups.xml
 - spec/fixtures/no_rulebase_virtual_systems.xml
 - spec/fixtures/no_vsys_devices.xml
+- spec/fixtures/pending_traffic_logs.xml
+- spec/fixtures/system_logs.xml
+- spec/fixtures/traffic_logs.xml
+- spec/fixtures/unsupported_log_attribute.xml
+- spec/fixtures/unsupported_logs.xml
 - spec/fixtures/virtual_systems.xml
 - spec/lib/palo-alto/client_spec.rb
 - spec/lib/palo-alto/common/base_api_spec.rb
@@ -211,11 +239,15 @@ test_files:
 - spec/lib/palo-alto/models/address_group_spec.rb
 - spec/lib/palo-alto/models/address_spec.rb
 - spec/lib/palo-alto/models/device_spec.rb
+- spec/lib/palo-alto/models/log_entry_spec.rb
 - spec/lib/palo-alto/models/rulebase_spec.rb
+- spec/lib/palo-alto/models/system_log_entry_spec.rb
+- spec/lib/palo-alto/models/traffic_log_entry_spec.rb
 - spec/lib/palo-alto/models/virtual_system_spec.rb
 - spec/lib/palo-alto/v6/address_api_spec.rb
 - spec/lib/palo-alto/v6/address_group_api_spec.rb
 - spec/lib/palo-alto/v6/api_spec.rb
 - spec/lib/palo-alto/v6/device_api_spec.rb
+- spec/lib/palo-alto/v6/log_api_spec.rb
 - spec/lib/palo-alto/v6/virtual_system_api_spec.rb
 - spec/spec_helper.rb