r7insight 2.7.6 → 3.0.0

data/r7insight.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'English'
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'r7_insight'
+
+Gem::Specification.new do |gem|
+  gem.name = 'r7insight'
+  gem.version = '3.0.0'
+  gem.date = Time.now
+  gem.summary = 'Rapid7 Insight Platform logging plugin'
+  gem.licenses    = ['MIT']
+  gem.description = <<DESC
+    Rapid7 Insight Platform Ruby library for logging
+DESC
+
+  gem.authors = ['Rapid7']
+  gem.email = 'support@rapid7.com'
+  gem.homepage = 'https://github.com/rapid7/r7insight_ruby'
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'activesupport', '~> 6.0.0'
+  gem.add_development_dependency 'bundler', '~> 2.0.0'
+  gem.add_development_dependency 'minitest', '~> 5.12.2'
+  gem.add_development_dependency 'rake', '~> 13.0.0'
+end

data/test/host_spec.rb

@@ -1,23 +1,27 @@
-require 'spec_helper'
-
+# frozen_string_literal: true
 
-describe Le::Host do
+require 'spec_helper'
 
+describe R7Insight::Host do
   let(:token)   { '11111111-2222-3333-aaaa-bbbbbbbbbbbb' }
+  let(:region)  { 'eu' }
   let(:local)   { false }
   let(:debug)   { false }
   let(:ssl)     { true }
   let(:udp)     { nil }
 
-
-
-  let(:datahub_endpoint) { ["", 10000] }
-  let(:host_id) { ""}
-  let(:custom_host)	{ [false, ""]}
-  let(:data_endpoint) {true}
-
-  #let(:host)    { Le::Host.new(token, local, debug, ssl) }
-  let(:host)     { Le::Host::HTTP.new(token, local, debug, ssl, datahub_endpoint, host_id, custom_host, udp, data_endpoint) }
-  specify { host.must_be_instance_of Le::Host::HTTP }
-
+  let(:datahub_endpoint) { ['', 10_000] }
+  let(:host_id) { '' }
+  let(:custom_host) { [false, ''] }
+  let(:use_data_endpoint) { true }
+
+  let(:host) do
+    R7Insight::Host::CONNECTION.new(token, region, local, debug, ssl, datahub_endpoint,
+                                    host_id, custom_host, udp, use_data_endpoint)
+  end
+  describe 'host' do
+    it 'is an instance of CONNECTION' do
+      assert_instance_of(R7Insight::Host::CONNECTION, host)
+    end
+  end
 end

data/test/http_spec.rb

@@ -1,33 +1,52 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'pathname'
 
-describe Le::Host::HTTP do
-
+describe R7Insight::Host::CONNECTION do
   let(:token)              { '11111111-2222-3333-aaaa-bbbbbbbbbbbb' }
+  let(:region)             { 'eu' }
   let(:local)              { false }
   let(:debug)              { false }
   let(:ssl)                { false }
   let(:udp)                { nil }
 
-  let(:datahub_endpoint)  { ["", 10000]}
-  let(:host_id)           {""}
-  let(:custom_host)       {[false, ""]}
-  let(:endpoint)       {false}
-
-
-
-#  let(:host)               { Le::Host::HTTP.new(token, local, debug, ssl) }
-  let(:host)               { Le::Host::HTTP.new(token, local, debug, ssl, datahub_endpoint, host_id, custom_host, udp, endpoint) }
-
-  let(:logger_console)     { host.instance_variable_get(:@logger_console) }
-  let(:logger_console_dev) { logger_console.instance_variable_get(:@logdev).dev }
-
-  specify { host.must_be_instance_of Le::Host::HTTP }
-  specify { host.local.must_equal false }
-  specify { host.debug.must_equal false }
-  specify { host.ssl.must_equal false }
-  specify { host.udp_port.must_equal nil }
-  specify {host_id.must_equal ""}
-  specify {custom_host.must_equal [false, ""]}
-
+  let(:datahub_endpoint)  { ['', 10_000] }
+  let(:host_id)           { '' }
+  let(:custom_host)       { [false, ''] }
+  let(:endpoint) { false }
+
+  let(:host) do
+    R7Insight::Host::CONNECTION.new(token, region, local, debug, ssl, datahub_endpoint,
+                                    host_id, custom_host, udp, endpoint)
+  end
+
+  let(:logger_console) { host.instance_variable_get(:@logger_console) }
+
+  describe 'host' do
+    it 'is an instance of CONNECTION' do
+      assert_instance_of(R7Insight::Host::CONNECTION, host)
+    end
+    it 'region is expected value' do
+      assert_equal(host.region, 'eu')
+    end
+    it 'local is expected value' do
+      refute(host.local)
+    end
+    it 'debug is expected value' do
+      refute(host.debug)
+    end
+    it 'ssl is expected value' do
+      refute(host.ssl)
+    end
+    it 'udp port is expected value' do
+      assert_nil(host.udp_port)
+    end
+    it 'id is expected value' do
+      assert_equal(host_id, '')
+    end
+    it 'custom_host is expected value' do
+      assert_equal(custom_host, [false, ''])
+    end
+  end
 end

data/test/r7insight_spec.rb

@@ -0,0 +1,312 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe R7Insight do
+  let(:token)              { '11111111-2222-3333-aaaa-bbbbbbbbbbbb' }
+  let(:local)              { false }
+  let(:region)             { 'eu' }
+  let(:logger)             { R7Insight.new(token, region, local: local) }
+  let(:logdev)             { logger.instance_variable_get(:@logdev).dev }
+  let(:logger_console)     { logdev.instance_variable_get(:@logger_console) }
+  let(:logger_console_dev) { logger_console.instance_variable_get(:@logdev).dev }
+
+  describe 'when non-Rails environment' do
+    describe 'is initialised with just a token' do
+      let(:logger) { R7Insight.new(token, region) }
+
+      describe 'logger' do
+        it 'should be a Logger instance' do
+          assert_instance_of(Logger, logger)
+        end
+      end
+
+      describe 'logger device' do
+        it 'is an instance of R7Insight::Host::CONNECTION' do
+          assert_instance_of(R7Insight::Host::CONNECTION, logdev)
+        end
+        it 'local is false' do
+          refute(logdev.local)
+        end
+        it 'ssl is true' do
+          assert(logdev.ssl)
+        end
+      end
+
+      describe 'logger console' do
+        it 'is nil' do
+          assert_nil(logger_console)
+        end
+      end
+    end
+
+    describe 'is initialized with :ssl => true' do
+      let(:logger) { R7Insight.new(token, region, ssl: true) }
+
+      describe 'logger device' do
+        it 'ssl is true' do
+          assert(logdev.ssl)
+        end
+      end
+    end
+
+    describe 'is initialized with :ssl => false' do
+      let(:logger) { R7Insight.new(token, region, ssl: false) }
+
+      describe 'logger device' do
+        it 'ssl is false' do
+          refute(logdev.ssl)
+        end
+      end
+    end
+
+    it 'logger device local is false' do
+      refute(logdev.local)
+    end
+
+    it 'logger console is nil' do
+      assert_nil(logger_console)
+    end
+
+    describe 'local is set to true' do
+      let(:local) { true }
+
+      it 'logger device local is true' do
+        assert(logdev.local)
+      end
+
+      it 'logger console is instance of Logger' do
+        assert_instance_of(Logger, logger_console)
+      end
+
+      it 'logger console device instance of IO' do
+        assert_instance_of(IO, logger_console_dev)
+      end
+    end
+
+    describe 'and :local => ' do
+      let(:local_test_log) do
+        Pathname.new(File.dirname(__FILE__))
+                .join('fixtures', 'log', 'local_log.log')
+      end
+      let(:local) { log_file }
+
+      describe 'Pathname' do
+        let(:log_file) { local_test_log }
+
+        describe 'logger device' do
+          it 'is an instance of our CONNECTION' do
+            assert_instance_of(R7Insight::Host::CONNECTION, logdev)
+          end
+          it 'local is true' do
+            assert(logdev.local)
+          end
+        end
+
+        describe 'logger console' do
+          it 'is an instance of Logger' do
+            assert_instance_of(Logger, logger_console)
+          end
+        end
+
+        describe 'logger console device' do
+          it 'is an instance of File' do
+            assert_instance_of(File, logger_console_dev)
+          end
+          it 'path matches specified log file' do
+            assert_match('local_log.log', logger_console_dev.path)
+          end
+        end
+      end
+
+      describe 'path string' do
+        let(:log_file) { local_test_log.to_s }
+
+        describe 'logger device' do
+          it 'is an instance of CONNECTION' do
+            assert_instance_of(R7Insight::Host::CONNECTION, logdev)
+          end
+          it 'local is true' do
+            assert(logdev.local)
+          end
+        end
+
+        describe 'logger console' do
+          it 'is an instance of Logger' do
+            assert_instance_of(Logger, logger_console)
+          end
+        end
+
+        describe 'logger console device' do
+          it 'is an instance of File' do
+            assert_instance_of(File, logger_console_dev)
+          end
+          it 'path matches expected log filename' do
+            assert_match('local_log.log', logger_console_dev.path)
+          end
+        end
+      end
+
+      describe 'File' do
+        let(:log_file) { File.new(local_test_log, 'w') }
+
+        describe 'logger device' do
+          it 'is an instance of CONNECTION' do
+            assert_instance_of(R7Insight::Host::CONNECTION, logdev)
+          end
+          it 'local is true' do
+            assert(logdev.local)
+          end
+        end
+        describe 'logger console' do
+          it 'is an instance of Logger' do
+            assert_instance_of(Logger, logger_console)
+          end
+        end
+        describe 'logger console device' do
+          it 'is an instance of File' do
+            assert_instance_of(File, logger_console_dev)
+          end
+          it 'path matches expected log location' do
+            assert_match('local_log.log', logger_console_dev.path)
+          end
+        end
+      end
+    end
+  end
+
+  describe 'when Rails environment' do
+    before do
+      class Rails
+        def self.root
+          Pathname.new(File.dirname(__FILE__)).join('fixtures')
+        end
+
+        def self.env
+          'test'
+        end
+      end
+    end
+    after do
+      Object.send(:remove_const, :Rails)
+    end
+
+    it 'ssl is true' do
+      assert(logdev.ssl)
+    end
+
+    it 'local is false' do
+      refute(logdev.local)
+      assert_nil(logger_console)
+    end
+
+    describe 'and :local is true' do
+      let(:local) { true }
+
+      describe 'logger device' do
+        it 'local is true' do
+          assert(logdev.local)
+        end
+      end
+      describe 'logger console' do
+        it 'is an instance of Logger' do
+          assert_instance_of(Logger, logger_console)
+        end
+      end
+      describe 'logger console device' do
+        it 'is an instance of File' do
+          assert_instance_of(File, logger_console_dev)
+        end
+        it 'path matches expected log filename' do
+          assert_match('test.log', logger_console_dev.path)
+        end
+      end
+    end
+
+    describe 'and :local => ' do
+      let(:local_test_log) do
+        Pathname.new(File.dirname(__FILE__))
+                .join('fixtures', 'log', 'local_log.log')
+      end
+      let(:local) { log_file }
+
+      describe 'Pathname' do
+        let(:log_file) { local_test_log }
+
+        describe 'logger device' do
+          it 'is an instance of CONNECTION' do
+            assert_instance_of(R7Insight::Host::CONNECTION, logdev)
+          end
+          it 'local is true' do
+            assert(logdev.local)
+          end
+        end
+        describe 'logger console' do
+          it 'is an instance of Logger' do
+            assert_instance_of(Logger, logger_console)
+          end
+        end
+        describe 'logger console device' do
+          it 'is an instance of File' do
+            assert_instance_of(File, logger_console_dev)
+          end
+          it 'path matches expected log filename' do
+            assert_match('local_log.log', logger_console_dev.path)
+          end
+        end
+      end
+
+      describe 'path string' do
+        let(:log_file) { local_test_log.to_s }
+
+        describe 'logger device' do
+          it 'is an instance of CONNECTION' do
+            assert_instance_of(R7Insight::Host::CONNECTION, logdev)
+          end
+          it 'local is true' do
+            assert(logdev.local)
+          end
+        end
+        describe 'logger console' do
+          it 'is an instance of Logger' do
+            assert_instance_of(Logger, logger_console)
+          end
+        end
+        describe 'logger console device' do
+          it 'is an instance of File' do
+            assert_instance_of(File, logger_console_dev)
+          end
+          it 'path matches expected log filename' do
+            assert_match('local_log.log', logger_console_dev.path)
+          end
+        end
+      end
+
+      describe 'File' do
+        let(:log_file) { File.new(local_test_log, 'w') }
+
+        describe 'logger device' do
+          it 'is an instance of CONNECTION' do
+            assert_instance_of(R7Insight::Host::CONNECTION, logdev)
+          end
+          it 'local is true' do
+            assert(logdev.local)
+          end
+        end
+        describe 'logger console' do
+          it 'is an instance of Logger' do
+            assert_instance_of(Logger, logger_console)
+          end
+        end
+        describe 'logger console device' do
+          it 'is an instance of File' do
+            assert_instance_of(File, logger_console_dev)
+          end
+          it 'path matches expected log filename' do
+            assert_match('local_log.log', logger_console_dev.path)
+          end
+        end
+      end
+    end
+  end
+end