ntail 0.0.6 → 0.0.7

data/test/ntail/test_http_method.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+class TestHttpMethod < Test::Unit::TestCase
+
+  context "ntail" do
+    
+    context "(with Sickill::Rainbow enabled)" do
+      
+      setup do
+        Sickill::Rainbow.enabled = true
+      end
+    
+      should "color-code the HTTP method" do
+        
+        # read-only methods are never color-coded...
+        log_line = random_log_line(:http_method => 'GET')
+        assert_equal "GET", log_line.to_http_method_s
+        
+        # methods that change state are ALWAYS color-coded if Rainbow is enabled... 
+        log_line = random_log_line(:http_method => 'POST')
+        assert_not_equal "POST", log_line.to_http_method_s
+        assert_equal "POST".inverse, log_line.to_http_method_s
+        
+      end
+      
+    end
+    
+    context "(with Sickill::Rainbow disabled)" do
+
+      setup do
+        Sickill::Rainbow.enabled = false
+      end
+    
+      should "NOT color-code the HTTP method" do
+        
+        # read-only methods are never color-coded...
+        log_line = random_log_line(:http_method => 'GET')
+        assert_equal "GET", log_line.to_http_method_s
+        
+        # methods that change state are NOT color-coded if Rainbow is disabled...
+        log_line = random_log_line(:http_method => 'POST')
+        assert_equal "POST", log_line.to_http_method_s
+        
+      end
+      
+    end
+    
+  end
+
+end

data/test/ntail/test_http_referer.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+class TestHttpReferer < Test::Unit::TestCase
+
+  context "ntail" do
+    
+    setup do
+      @http_referer = "http://example.com/index.html"
+      @log_line = random_log_line(:http_referer => @http_referer)
+    end
+    
+    teardown do
+      # undo any changes the test may have made
+      NginxTail::LogLine.reset_internal_referers
+    end
+    
+    should "have empty list of internal referers without configuration" do
+      assert NginxTail::LogLine.internal_referers.empty?
+    end
+
+    should "correctly identify the default/unknown HTTP referer" do
+      unknown_referer = NginxTail::HttpReferer::UNKNOWN_REFERER
+      log_line = random_log_line(:http_referer => unknown_referer)
+
+      assert NginxTail::LogLine.unknown_referer?(unknown_referer)
+      assert !NginxTail::LogLine.internal_referer?(unknown_referer)
+      assert !NginxTail::LogLine.external_referer?(unknown_referer)
+
+      assert log_line.unknown_referer?
+    end
+
+    should "not allow the default/unknown HTTP referer to be added" do
+      assert_raise RuntimeError do
+        NginxTail::LogLine.add_internal_referer(NginxTail::HttpReferer::UNKNOWN_REFERER)
+      end
+    end
+
+    should "have non-empty list of internal referers after configuration" do
+      NginxTail::LogLine.add_internal_referer(first_referer = /http:\/\/my_website\.com/)
+      assert_equal 1, NginxTail::LogLine.internal_referers.size
+      assert NginxTail::LogLine.internal_referers.include?(first_referer)
+
+      NginxTail::LogLine.add_internal_referer(second_referer = /http:\/\/www.my_website\.com/)
+      assert_equal 2, NginxTail::LogLine.internal_referers.size
+      assert NginxTail::LogLine.internal_referers.include?(second_referer)
+    end
+
+    should "recognize an internal referer after configuration" do
+      assert !NginxTail::LogLine.internal_referer?(@http_referer)
+      assert NginxTail::LogLine.external_referer?(@http_referer)
+      assert !@log_line.internal_referer?
+      assert @log_line.external_referer?
+
+      NginxTail::LogLine.add_internal_referer(/http:\/\/example\.com/)
+      
+      assert NginxTail::LogLine.internal_referer?(@http_referer)
+      assert !NginxTail::LogLine.external_referer?(@http_referer)
+      assert @log_line.internal_referer?
+      assert !@log_line.external_referer?
+    end
+    
+    should "parse and format the unknownHTTP referer" do
+      http_referer = NginxTail::HttpReferer::UNKNOWN_REFERER
+      assert_equal http_referer, NginxTail::LogLine.to_referer_s(http_referer)
+    end
+
+    should "parse and format HTTP referer into a host string" do
+      # directly via the helper function
+      to_referer_s = NginxTail::LogLine.to_referer_s(@http_referer)
+      assert_equal "example.com", to_referer_s
+      # parsed from a raw log line
+      assert_equal "example.com", @log_line.to_referer_s    
+    end
+    
+  end
+
+end

data/test/ntail/test_http_user_agent.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+class TestHttpUserAgent < Test::Unit::TestCase
+
+  context "ntail" do
+    
+    should "correctly identify search bot user agent" do
+      search_bot_user_agent = "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
+      # directly via the helper function
+      assert NginxTail::LogLine.search_bot?(search_bot_user_agent)
+      # parsed from a raw log line
+      log_line = random_log_line(:http_user_agent => search_bot_user_agent)
+      assert log_line.search_bot?
+      assert log_line.to_agent.search_bot?
+    end
+
+    should "correctly identify non-bot user agent" do
+      non_bot_user_agent = "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)"
+      # directly via the helper function
+      assert !NginxTail::LogLine.search_bot?(non_bot_user_agent)
+      # parsed from a raw log line
+      log_line = random_log_line(:http_user_agent => non_bot_user_agent)
+      assert !log_line.search_bot?
+      assert !log_line.to_agent.search_bot?
+    end
+        
+  end
+
+end

data/test/ntail/test_known_ip_addresses.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestKnownIpAddresses < Test::Unit::TestCase
+
+  def teardown
+    # undo any changes the test may have made
+    NginxTail::LogLine.reset_known_ip_addresses
+  end
+
+  should "have empty list of known IP addresses without configuration" do
+    assert NginxTail::LogLine.known_ip_addresses.empty?
+  end
+
+  should "have non-empty list of known IP addresses after configuration" do
+    NginxTail::LogLine.add_known_ip_address(first_ip_address = random_ip_address)
+    assert_equal 1, NginxTail::LogLine.known_ip_addresses.size
+    assert NginxTail::LogLine.known_ip_addresses.include?(first_ip_address)
+    
+    NginxTail::LogLine.add_known_ip_address(second_ip_address = random_ip_address)
+    assert_equal 2, NginxTail::LogLine.known_ip_addresses.size
+    assert NginxTail::LogLine.known_ip_addresses.include?(second_ip_address)
+  end
+
+  should "avoid duplicates in list of known IP addresses" do
+    NginxTail::LogLine.add_known_ip_address(known_ip_address = random_ip_address)
+    assert_equal 1, NginxTail::LogLine.known_ip_addresses.size
+    
+    NginxTail::LogLine.add_known_ip_address(known_ip_address)
+    assert_equal 1, NginxTail::LogLine.known_ip_addresses.size
+  end
+  
+  should "recognize a known IP address after configuration" do
+    remote_address = random_ip_address
+    log_line = random_log_line(:remote_addr => remote_address)
+    
+    assert !NginxTail::LogLine.known_ip_address?(remote_address)
+    assert !log_line.known_ip_address?
+    
+    NginxTail::LogLine.add_known_ip_address(remote_address)
+    
+    assert NginxTail::LogLine.known_ip_address?(remote_address)
+    assert log_line.known_ip_address?
+  end
+
+end

data/test/ntail/test_local_ip_addresses.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestLocalIpAddresses < Test::Unit::TestCase
+
+  def teardown
+    # undo any changes the test may have made
+    NginxTail::LogLine.reset_local_ip_addresses
+  end
+
+  should "have empty list of known IP addresses without configuration" do
+    assert NginxTail::LogLine.local_ip_addresses.empty?
+  end
+
+  should "have non-empty list of known IP addresses after configuration" do
+    NginxTail::LogLine.add_local_ip_address(first_ip_address = local_ip_address)
+    assert_equal 1, NginxTail::LogLine.local_ip_addresses.size
+    assert NginxTail::LogLine.local_ip_addresses.include?(first_ip_address)
+    
+    NginxTail::LogLine.add_local_ip_address(second_ip_address = local_ip_address)
+    assert_equal 2, NginxTail::LogLine.local_ip_addresses.size
+    assert NginxTail::LogLine.local_ip_addresses.include?(second_ip_address)
+  end
+
+  should "avoid duplicates in list of known IP addresses" do
+    NginxTail::LogLine.add_local_ip_address(local_ip_address = local_ip_address)
+    assert_equal 1, NginxTail::LogLine.local_ip_addresses.size
+    
+    NginxTail::LogLine.add_local_ip_address(local_ip_address)
+    assert_equal 1, NginxTail::LogLine.local_ip_addresses.size
+  end
+  
+  should "recognize a known IP address after configuration" do
+    remote_address = local_ip_address
+    log_line = random_log_line(:remote_addr => remote_address)
+    
+    assert !NginxTail::LogLine.local_ip_address?(remote_address)
+    assert !log_line.local_ip_address?
+    
+    NginxTail::LogLine.add_local_ip_address(remote_address)
+    
+    assert NginxTail::LogLine.local_ip_address?(remote_address)
+    assert log_line.local_ip_address?
+  end
+
+end

data/test/ntail/test_log_line.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+class TestLogLine < Test::Unit::TestCase
+
+  context "NginxTail::LogLine" do
+    
+    should "initialize itself correctly from a parsable log line" do
+      raw_line = random_raw_line
+      log_line = NginxTail::LogLine.new(raw_line)
+      assert_equal raw_line, log_line.raw_line
+      assert log_line.parsable
+    end
+    
+    should "initialize itself correctly from a non-parsable log line" do
+      raw_line = "foo bar blegga"
+      log_line = NginxTail::LogLine.new(raw_line)
+      assert_equal raw_line, log_line.raw_line
+      assert !log_line.parsable
+    end
+    
+    should "implement non-abbreviated alias for $remote_addr" do
+      remote_addr = random_ip_address
+      log_line = random_log_line(:remote_addr => remote_addr)
+      assert_equal remote_addr, log_line.remote_addr
+      assert_equal remote_addr, log_line.remote_address
+    end
+    
+    should "implement a getter method for each (sub-)component" do
+      (NginxTail::LogLine::COMPONENTS + NginxTail::LogLine::SUBCOMPONENTS).each do |component|
+        getter_method = component.to_s
+        assert NginxTail::LogLine.instance_methods.include?(getter_method), "getter '#{getter_method}' should exist"
+      end
+    end
+
+    should "NOT implement a setter method for any (sub-)component" do
+      (NginxTail::LogLine::COMPONENTS + NginxTail::LogLine::SUBCOMPONENTS).each do |component|
+        setter_method = component.to_s + "="
+        assert !NginxTail::LogLine.instance_methods.include?(setter_method), "setter '#{setter_method}' should NOT exist"
+      end
+    end
+    
+    should "include an extension module for each (sub-)component" do
+      (NginxTail::LogLine::COMPONENTS + NginxTail::LogLine::SUBCOMPONENTS).each do |component|
+        ntail_module = NginxTail::LogLine.component_to_ntail_module(component)
+        assert NginxTail::LogLine.included_modules.include?(ntail_module), "module '#{ntail_module.name}' should be included"
+      end
+    end
+      
+  end
+
+end

data/test/ntail/test_remote_addr.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+class TestRemoteAddr < Test::Unit::TestCase
+
+  context "ntail" do
+    
+    setup do
+      @remote_addr = "192.0.32.10"
+      @log_line = random_log_line(:remote_addr => @remote_addr)
+    end
+
+    should "convert the request's remote address into a host string" do
+      # directly via the helper function
+      to_host_s = NginxTail::LogLine.to_host_s(@remote_addr)
+      assert_equal "www.example.com", to_host_s
+      # parsed from a raw log line
+      assert_equal "www.example.com", @log_line.to_host_s    
+    end
+    
+    should "convert the request's remote address into a country string" do
+      # directly via the helper function
+      to_country_s = NginxTail::LogLine.to_country_s(@remote_addr)
+      assert_equal "United States", to_country_s
+      # parsed from a raw log line
+      assert_equal "United States", @log_line.to_country_s
+    end
+    
+    should "convert the request's remote address into a city string" do
+      # directly via the helper function
+      to_city_s = NginxTail::LogLine.to_city_s(@remote_addr)
+      assert_equal "Marina Del Rey", to_city_s
+      # parsed from a raw log line
+      assert_equal "Marina Del Rey", @log_line.to_city_s
+    end
+    
+  end
+
+end

data/test/ntail/test_remote_user.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+class TestRemoteUser < Test::Unit::TestCase
+
+  def teardown
+    # undo any changes the test may have made
+    NginxTail::LogLine.reset_authenticated_users
+  end
+
+  should "have empty list of authenticated users without configuration" do
+    assert NginxTail::LogLine.authenticated_users.empty?
+  end
+  
+  should "correctly identify the default/unknown remote user" do
+    unknown_remote_user = NginxTail::RemoteUser::UNKNOWN_REMOTE_USER
+    log_line = random_log_line(:remote_user => unknown_remote_user)
+    
+    assert NginxTail::LogLine.unknown_remote_user?(unknown_remote_user)
+    assert !NginxTail::LogLine.remote_user?(unknown_remote_user)
+    assert !NginxTail::LogLine.authenticated_user?(unknown_remote_user)
+    
+    assert log_line.unknown_remote_user?
+  end
+  
+  should "not allow the default/unknown remote user to be added" do
+    assert_raise RuntimeError do
+      NginxTail::LogLine.add_authenticated_user(NginxTail::RemoteUser::UNKNOWN_REMOTE_USER)
+    end
+  end
+
+  should "have non-empty list of authenticated users after configuration" do
+    NginxTail::LogLine.add_authenticated_user(first_remote_user = "john_doe")
+    assert_equal 1, NginxTail::LogLine.authenticated_users.size
+    assert NginxTail::LogLine.authenticated_users.include?(first_remote_user)
+    
+    NginxTail::LogLine.add_authenticated_user(second_referer = "jane_doe")
+    assert_equal 2, NginxTail::LogLine.authenticated_users.size
+    assert NginxTail::LogLine.authenticated_users.include?(second_referer)
+  end
+
+  should "avoid duplicates in list of authenticated users" do
+    NginxTail::LogLine.add_authenticated_user(authenticated_user = "john_doe")
+    assert_equal 1, NginxTail::LogLine.authenticated_users.size
+    
+    NginxTail::LogLine.add_authenticated_user(authenticated_user)
+    assert_equal 1, NginxTail::LogLine.authenticated_users.size
+  end
+
+  should "recognize a remote user after configuration" do
+    remote_user = "john_doe"
+    log_line = random_log_line(:remote_user => remote_user)
+
+    assert NginxTail::LogLine.remote_user?(remote_user)
+    assert !NginxTail::LogLine.authenticated_user?(remote_user)
+    assert log_line.remote_user?
+    assert !log_line.authenticated_user?
+    
+    NginxTail::LogLine.add_authenticated_user(remote_user)
+    assert NginxTail::LogLine.remote_user?(remote_user)
+    assert NginxTail::LogLine.authenticated_user?(remote_user)
+    assert log_line.remote_user?
+    assert log_line.authenticated_user?
+  end
+
+end

data/test/ntail/test_request.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+class TestRequest < Test::Unit::TestCase
+
+  context "ntail" do
+    
+    should "do something reasonable for bad requests" do
+      
+      log_line = bad_request_log_line
+      assert_equal "-", log_line.request
+      
+      assert_nil log_line.http_method
+      assert_nil log_line.uri
+      assert_nil log_line.http_version
+      
+      assert_equal "", log_line.to_http_method_s
+      assert_equal "-", log_line.to_uri_s
+      assert_equal "", log_line.to_http_version_s
+      
+      assert_equal "-", log_line.to_request_s
+      
+    end
+     
+  end
+
+end

data/test/ntail/test_status.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+class TestStatus < Test::Unit::TestCase
+
+  context "ntail" do
+    
+    should "correctly identify the nginx 499 status code" do
+      status = NginxTail::Status::NGINX_MAGIC_STATUS # 499
+      # directly via the helper function
+      assert !NginxTail::LogLine.information_status?(status)
+      assert !NginxTail::LogLine.success_status?(status)
+      assert !NginxTail::LogLine.redirect_status?(status)
+      assert !NginxTail::LogLine.client_error_status?(status)
+      assert !NginxTail::LogLine.server_error_status?(status)
+      # parsed from a raw log line
+      log_line = random_log_line(:status => NginxTail::Status::NGINX_MAGIC_STATUS)
+      assert !log_line.information_status?
+      assert !log_line.success_status?
+      assert !log_line.redirect_status?
+      assert !log_line.client_error_status?
+      assert !log_line.server_error_status?
+    end
+        
+  end
+
+end