nginx_utils 0.0.3 → 0.0.4

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 require 'nginx_utils'
 ```
 
-Nginx log rotate:
+Logrotate:
 
 ```
 params = {
@@ -35,13 +35,33 @@ params = {
   target_logs: "*.log",
   prefix: Time.now.strftime("%Y%m%d%H%M%S"),
   retention: 90,
-  pid_file: "/usr/local/nginx/logs/nginx.pid"  
+  pid_file: "/usr/local/nginx/logs/nginx.pid"
 }
 
 rotate = NginxUtils::Logrotate.new(params)
 rotate.execute
 ```
 
+Status:
+
+```
+p NginxUtils::Status.get # => {active_connection: 1, accepts: 4, handled: 5, requests: 51, reading: 1, writing: 3, waiting: 2}
+```
+
+Logreader:
+
+```
+reader = NginxUtils::Logreader.new("/path/to/nginx/logs/access.log")
+reader.each do |line|
+  p line # => {time: "2013-05-19T08:13:14+00:00", host: "192.168.1.10", ...}
+end
+```
+
+Options that can be specified:
+
+* :format => :ltsv or :combined
+* :parser => Parse with scan method. Specified in Regexp.
+
 ## Contributing
 
 1. Fork it

data/lib/nginx_utils/logreader.rb

@@ -0,0 +1,63 @@
+# coding: utf-8
+
+module NginxUtils
+  class Logreader
+    include Enumerable
+
+    def initialize(log, options={})
+      @log = File.open(log, "r")
+
+      if options[:parser]
+        if options[:parser].is_a? Regexp
+          @format = :custom
+          @parser = options[:parser]
+        else
+          raise ArgumentError, "invalid argument"
+        end
+      else
+        @format = options[:format] || :ltsv
+      end
+    end
+
+    def each
+      @log.each do |line|
+        yield parse(line.chomp)
+      end
+    end
+
+    private
+    def parse(line)
+      case @format
+      when :ltsv then
+        row = line.split("\t").map do |f|
+          c = f.split(":")
+          if c == 2
+            [c[0].to_sym, c[1]]
+          else
+            [c[0].to_sym, c[1..-1].join(":")]
+          end
+        end
+        Hash[row]
+      when :combined then
+        if /([0-9.]+)\s-\s([^\s]+)\s\[(.*?)\]\s"(.*?)"\s([0-9]+)\s([0-9]+)\s"(.*?)"\s"(.*?)".*/ =~ line
+          {
+            remote_addr: $1,
+            remote_user: $2,
+            time_local: $3,
+            request: $4,
+            status: $5,
+            body_bytes_sent: $6,
+            http_referer: $7,
+            http_user_agent: $8
+          }
+        else
+          {unknown: line}
+        end
+      when :custom then
+        line.scan @parser
+      else
+        raise "format error"
+      end
+    end
+  end
+end

data/lib/nginx_utils/logrotate.rb

@@ -2,7 +2,9 @@
 
 module NginxUtils
   class Logrotate
-    attr_accessor :logger, :rename_logs, :delete_logs
+    attr_accessor :logger
+    attr_accessor :rename_logs
+    attr_accessor :delete_logs
 
     def initialize(options={})
       # Debug
@@ -134,22 +136,22 @@ module NginxUtils
         @logger.debug "Nginx restart command: #{cmd}" if @logger
         if @execute
           if system(cmd)
-            @logger.info "Nginx restart is successfully!" if @logger
+            @logger.info "Nginx restart is successfully" if @logger
           else
-            @logger.error "Nginx restart failed!" if @logger
-            raise "Nginx restart failed!" if @logger == false
+            @logger.error "Nginx restart failed" if @logger
+            raise "Nginx restart failed" if @logger == false
           end
         end
       else
-        @logger.warn "Pid file is not found. not restart nginx. (#{@pid_file})" if @logger
+        @logger.warn "Pid file is not found. Do not restart nginx. (#{@pid_file})" if @logger
       end
     end
 
     def execute
-      @logger.info "Nginx logrotate is started!" if @logger
+      @logger.info "Execute Nginx logrotate" if @logger
       rename
       delete
-      @logger.info "Nginx logrotate is successfully!" if @logger
+      @logger.info "Nginx logrotate is successfully" if @logger
       restart
     end
 

data/lib/nginx_utils/version.rb

@@ -1,3 +1,3 @@
 module NginxUtils
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/nginx_utils.rb

@@ -5,4 +5,5 @@ require "net/http"
 
 require "nginx_utils/version"
 require "nginx_utils/logrotate"
+require "nginx_utils/logreader"
 require "nginx_utils/status"

data/spec/nginx_utils/logreader_spec.rb

@@ -0,0 +1,126 @@
+# coding: utf-8
+
+require "spec_helper"
+
+describe NginxUtils do
+  include FakeFS::SpecHelpers
+
+  def create_log(format)
+    log_dir = "/tmp"
+    FileUtils.mkdir_p log_dir
+
+    case format
+    when :ltsv then
+      line = "time:2013-05-19T08:13:14+00:00\thost:192.168.1.10\txff:-\tmethod:GET\tpath:/\tstatus:200\tua:Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.65 Safari/537.31\treq_size:124\treq_time:0.007\tres_size:239\tbody_size:11\tapp_time:-\n"
+    when :combined then
+      line = "192.168.1.10 - - [19/May/2013:23:14:04 +0900] \"GET / HTTP/1.1\" 200 239 \"-\" \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.65 Safari/537.31\"\n"
+    else raise "format error"
+    end
+
+    File.open(File.join(log_dir, "access.log"), "w") do |f|
+      3.times {f.write line}
+    end
+  end
+
+  before(:each) do
+    @log_file = "/tmp/access.log"
+    @parser = /([0-9.]+)\s-\s([^\s]+)\s\[(.*?)\]\s"(.*?)"\s([0-9]+)\s([0-9]+)\s"(.*?)"\s"(.*?)"\s"(.*)".*/
+  end
+
+  describe "Logreader" do
+    describe "#initialize" do
+      context "with default parameters" do
+        before(:each) do
+          create_log(:ltsv)
+          @reader = NginxUtils::Logreader.new(@log_file)
+        end
+
+        it "specified file should be opened" do
+          expect(@reader.instance_eval{@log}.path).to eq(@log_file)
+        end
+
+        it "default format should be ltsv" do
+          expect(@reader.instance_eval{@format}).to eq(:ltsv)
+        end
+
+        it "default parser should be nil" do
+          expect(@reader.instance_eval{@parser}).to eq(nil)
+        end
+      end
+
+      context "with custom parameters" do
+        before(:each) do
+          create_log(:combined)
+        end
+
+        it "format should be specified parameter" do
+          reader = NginxUtils::Logreader.new(@log_file, format: :combined)
+          expect(reader.instance_eval{@format}).to eq(:combined)
+        end
+
+        it "parser should be specified parameter" do
+          reader = NginxUtils::Logreader.new(@log_file, parser: @parser)
+          expect(reader.instance_eval{@parser}).to eq(@parser)
+        end
+
+        it "format should be :custom if specified parser" do
+          reader = NginxUtils::Logreader.new(@log_file, parser: @parser)
+          expect(reader.instance_eval{@format}).to eq(:custom)
+        end
+
+        it "should create exception if parser is not Regexp instance" do
+          expect(proc{NginxUtils::Logreader.new(@log_file, parser: "invalid parser")}).to raise_error("invalid argument")
+        end
+      end
+    end
+
+    describe "#each" do
+      context "with ltsv log" do
+        it "return ltsv hash" do
+          create_log(:ltsv)
+          reader = NginxUtils::Logreader.new(@log_file)
+          ltsv_hash = {
+            time: "2013-05-19T08:13:14+00:00",
+            host: "192.168.1.10",
+            xff:"-",
+            method: "GET",
+            path: "/",
+            status: "200",
+            ua: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.65 Safari/537.31",
+            req_size: "124",
+            req_time: "0.007",
+            res_size: "239",
+            body_size: "11",
+            app_time: "-"
+          }
+          reader.each {|line| expect(line).to eq(ltsv_hash)}
+        end
+      end
+
+      context "with combined log" do
+        it "return combined hash" do
+          create_log(:combined)
+          reader = NginxUtils::Logreader.new(@log_file, format: :combined)
+          combined_hash = {
+            remote_addr: "192.168.1.10",
+            remote_user: "-",
+            time_local: "19/May/2013:23:14:04 +0900",
+            request: "GET / HTTP/1.1",
+            status: "200",
+            body_bytes_sent: "239",
+            http_referer: "-",
+            http_user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.65 Safari/537.31"
+          }
+          reader.each {|line| expect(line).to eq(combined_hash)}
+        end
+
+        it "return unknown log if parse error" do
+          create_log(:combined)
+          File.open(@log_file, "w") {|f| f.write "unknown log"}
+          reader = NginxUtils::Logreader.new(@log_file, format: :combined)
+          reader.each {|line| expect(line).to eq({unknown: "unknown log"})}
+        end
+      end
+    end
+  end
+end

data/spec/nginx_utils/logrotate_spec.rb

@@ -5,21 +5,21 @@ require "spec_helper"
 describe NginxUtils do
   include FakeFS::SpecHelpers
 
-  def create_files(options={retention: 90})
-    root_dir = options[:root_dir] || "/usr/local/nginx/logs"
+  def create_files
+    root_dir = "/usr/local/nginx/logs"
     FileUtils.mkdir_p root_dir
-    not_del = Time.now - ((options[:retention].to_i - 1) * 3600 * 24)
-    do_del = Time.now - ((options[:retention].to_i + 1) * 3600 * 24)
+    FileUtils.mkdir_p "/tmp"
+    not_del = Time.now - (89 * 3600 * 24)
+    do_del = Time.now - (91 * 3600 * 24)
     not_del_file = "access.log.#{not_del.strftime('%Y%m%d%H%M%S')}"
     do_del_file = "access.log.#{do_del.strftime('%Y%m%d%H%M%S')}"
-    files = [
+    [
       "access.log",
       "error.log",
       "nginx.pid",
       not_del_file,
       do_del_file
-    ]
-    files.each{|f| File.open(File.join(root_dir, f), "w").close}
+    ].each{|f| File.open(File.join(root_dir, f), "w").close}
     File.utime(not_del, not_del, File.join(root_dir, not_del_file))
     File.utime(do_del, do_del, File.join(root_dir, do_del_file))
     {
@@ -28,8 +28,12 @@ describe NginxUtils do
     }
   end
 
+  def log_lines
+    File.open("/tmp/nginx_rotate.log").read.split("\n")
+  end
+
   before(:each) do
-    FileUtils.mkdir_p "/tmp"
+    @created = create_files
     @script_log = File.open("/tmp/nginx_rotate.log", "a")
   end
 
@@ -37,15 +41,11 @@ describe NginxUtils do
     describe "#initialize" do
       before(:each) do
         @time_now = Time.now
-        Time.stub!(:now).and_return(@time_now)
+        Time.stub(:now).and_return(@time_now)
+        @rotate = NginxUtils::Logrotate.new(script_log: @script_log)
       end
 
       context "with default params" do
-        before(:each) do
-          create_files
-          @rotate = NginxUtils::Logrotate.new(script_log: @script_log)
-        end
-
         it "@execute should be true" do
           expect(@rotate.instance_eval{@execute}).to eq(true)
         end
@@ -154,7 +154,7 @@ describe NginxUtils do
     describe "#config" do
       before(:each) do
         @time_now = Time.now
-        Time.stub!(:now).and_return(@time_now)
+        Time.stub(:now).and_return(@time_now)
         @rotate = NginxUtils::Logrotate.new(script_log: @script_log)
       end
 
@@ -225,60 +225,49 @@ describe NginxUtils do
 
     describe "#rename" do
       before(:each) do
-        create_files
-        @rotate = NginxUtils::Logrotate.new(script_log: @script_log)
+        @prefix = Time.now.strftime('%Y%m%d%H%M%S')
+        @rotate = NginxUtils::Logrotate.new(script_log: @script_log, prefix: @prefix)
       end
 
       it "rename target logs" do
-        prefix = Time.now.strftime('%Y%m%d%H%M%S')
-        @rotate.config prefix: prefix
         @rotate.rename
         @rotate.rename_logs.each do |log|
           expect(File.exists? log).to eq(false)
-          expect(File.exists? "#{log}.#{prefix}").to eq(true)
+          expect(File.exists? "#{log}.#{@prefix}").to eq(true)
         end
       end
 
       it "output log file" do
         @rotate.rename
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
         expect(log_lines.size).to eq(@rotate.rename_logs.size)
+        expect(log_lines.select{|l| /Rename log file/ =~ l}.size).to eq(@rotate.rename_logs.size)
       end
 
       it "do not rename if a file with the same name exists" do
-        prefix = Time.now.strftime('%Y%m%d%H%M%S')
-        @rotate.config prefix: prefix
-        File.open("#{@rotate.rename_logs.first}.#{prefix}", "w").close
+        File.open("#{@rotate.rename_logs.first}.#{@prefix}", "w").close
         @rotate.rename
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
         expect(File.exists? @rotate.rename_logs.first).to eq(true)
         expect(log_lines.select{|line| /File already exists/ =~ line}.size).to eq(1)
       end
 
       it "do not rename if not executable" do
-        prefix = Time.now.strftime('%Y%m%d%H%M%S')
-        @rotate.config debug: true, script_log: false, prefix: prefix
+        @rotate.config debug: true, script_log: false
         @rotate.rename
         @rotate.rename_logs.each do |log|
           expect(File.exists? log).to eq(true)
-          expect(File.exists? "#{log}.#{prefix}").to eq(false)
+          expect(File.exists? "#{log}.#{@prefix}").to eq(false)
         end
       end
 
       it "do not output log if script_log is false" do
         @rotate.config script_log: false
         @rotate.rename
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
         expect(log_lines.size).to eq(0)
       end
     end
 
     describe "#delete" do
       before(:each) do
-        @time_now = Time.now
-        Time.stub!(:now).and_return(@time_now)
-        @retention = @time_now - (90 * 3600 * 24)
-        @created = create_files
         @rotate = NginxUtils::Logrotate.new(script_log: @script_log)
       end
 
@@ -290,89 +279,101 @@ describe NginxUtils do
 
       it "output log file" do
         @rotate.delete
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
         expect(log_lines.size).to eq(1)
       end
 
       it "do not delete if not executable" do
+        File.should_not_receive(:unlink)
         @rotate.config debug: true, script_log: false
         @rotate.delete
-        expect(File.exists? @created[:do_del_file]).to eq(true)
       end
 
       it "do not output log if script_log is false" do
         @rotate.config script_log: false
         @rotate.delete
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
         expect(log_lines.size).to eq(0)
       end
     end
 
     describe "#restart" do
       before(:each) do
-        @command = "kill -USR1 `cat /usr/local/nginx/logs/nginx.pid`"
-        create_files
+        Object.any_instance.stub(:system).and_return(true)
         @rotate = NginxUtils::Logrotate.new(script_log: @script_log)
       end
 
       it "should execute command" do
-        Object.any_instance.should_receive(:system).with(@command).and_return(true)
+        Object.any_instance.should_receive(:system).and_return(true)
+        @rotate.restart
+      end
+
+      it "output success log" do
         @rotate.restart
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
-        expect(log_lines.select{|line| /Nginx restart is successfully!/ =~ line}.size).to eq(1)
+        expect(log_lines.select{|l| /Nginx restart command/ =~ l}.size).to eq(1)
+        expect(log_lines.select{|l| /Nginx restart is successfully/ =~ l}.size).to eq(1)
       end
 
       it "do not execute command if not exists pid file" do
-        File.stub!(:exists?).and_return(false)
+        Object.any_instance.should_not_receive(:system)
+        File.stub(:exists?).and_return(false)
         @rotate.restart
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
-        expect(log_lines.select{|line| /Pid file is not found/ =~ line}.size).to eq(1)
+      end
+
+      it "should output log if not exists pid file" do
+        File.stub(:exists?).and_return(false)
+        @rotate.restart
+        expect(log_lines.select{|l| /Pid file is not found/ =~ l}.size).to eq(1)
       end
 
       it "do not execute commando if not executable" do
-        @rotate.config debug: true, script_log: @script_log
+        Object.any_instance.should_not_receive(:system)
+        @rotate.config debug: true, script_log: false
         @rotate.restart
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
-        expect(log_lines.size).to eq(1)
       end
 
       it "should outputs error log if it fails" do
-        Object.any_instance.should_receive(:system).with(@command).and_return(false)
+        Object.any_instance.should_receive(:system).and_return(false)
         @rotate.restart
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
-        expect(log_lines.select{|line| /Nginx restart failed!/ =~ line}.size).to eq(1)
+        expect(log_lines.select{|l| /Nginx restart failed/ =~ l}.size).to eq(1)
       end
 
       it "should generate an exception if it fails" do
+        Object.any_instance.should_receive(:system).and_return(false)
         @rotate.config script_log: false
-        Object.any_instance.should_receive(:system).with(@command).and_return(false)
-        expect(proc{@rotate.restart}).to raise_error
+        expect(proc{@rotate.restart}).to raise_error("Nginx restart failed")
+      end
+
+      it "do not output log if script_log is false" do
+        @rotate.config script_log: false
+        @rotate.restart
+        expect(log_lines.size).to eq(0)
       end
     end
 
     describe "#execute" do
       before(:each) do
-        NginxUtils::Logrotate.any_instance.should_receive(:rename).and_return(true)
-        NginxUtils::Logrotate.any_instance.should_receive(:delete).and_return(true)
-        NginxUtils::Logrotate.any_instance.should_receive(:restart).and_return(true)
-        create_files
+        NginxUtils::Logrotate.any_instance.stub(:rename).and_return(true)
+        NginxUtils::Logrotate.any_instance.stub(:delete).and_return(true)
+        NginxUtils::Logrotate.any_instance.stub(:restart).and_return(true)
         @rotate = NginxUtils::Logrotate.new(script_log: @script_log)
       end
 
-      it "should call methods" do
+      it "should call rename and delete and restart methods" do
+        NginxUtils::Logrotate.any_instance.should_receive(:rename).and_return(true)
+        NginxUtils::Logrotate.any_instance.should_receive(:delete).and_return(true)
+        NginxUtils::Logrotate.any_instance.should_receive(:restart).and_return(true)
         @rotate.execute
       end
 
       it "output log file" do
         @rotate.execute
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
+        expect(log_lines.select{|l| /Execute Nginx logrotate/ =~ l}.size).to eq(1)
+        expect(log_lines.select{|l| /Nginx logrotate is successfully/ =~ l}.size).to eq(1)
         expect(log_lines.size).to eq(2)
       end
 
       it "do not output log if script_log is false" do
         @rotate.config script_log: false
         @rotate.execute
-        log_lines = File.open("/tmp/nginx_rotate.log").read.split("\n")
         expect(log_lines.size).to eq(0)
       end
     end

data/spec/nginx_utils/status_spec.rb

@@ -8,14 +8,14 @@ describe NginxUtils do
       it "should get status" do
         body = "Active connections: 1 \nserver accepts handled requests\n 4 5 51 \nReading: 1 Writing: 3 Waiting: 2 \n"
         status = {active_connection: 1, accepts: 4, handled: 5, requests: 51, reading: 1, writing: 3, waiting: 2}
-        response = OpenStruct.new(body: body)
+        response = double("http response mock", body: body)
         Net::HTTP.should_receive(:start).and_return(response)
         expect(NginxUtils::Status.get).to eq(status)
       end
 
       it "should generate an exception if status get fails" do
-        res = OpenStruct.new(body: "invalid content")
-        Net::HTTP.should_receive(:start).and_return(res)
+        response = double("http response mock", body: "invalid content")
+        Net::HTTP.should_receive(:start).and_return(response)
         expect(proc{NginxUtils::Status.get}).to raise_error("Nginx status get failed")
       end
     end

data/spec/spec_helper.rb

@@ -1,3 +1,2 @@
 require "fakefs/spec_helpers"
-require "ostruct"
 require "nginx_utils"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nginx_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,10 +89,12 @@ files:
 - README.md
 - Rakefile
 - lib/nginx_utils.rb
+- lib/nginx_utils/logreader.rb
 - lib/nginx_utils/logrotate.rb
 - lib/nginx_utils/status.rb
 - lib/nginx_utils/version.rb
 - nginx_utils.gemspec
+- spec/nginx_utils/logreader_spec.rb
 - spec/nginx_utils/logrotate_spec.rb
 - spec/nginx_utils/status_spec.rb
 - spec/spec_helper.rb
@@ -111,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 17147575815869233
+      hash: -10429621290292328
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,14 +122,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 17147575815869233
+      hash: -10429621290292328
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Nginx utilities
 test_files:
+- spec/nginx_utils/logreader_spec.rb
 - spec/nginx_utils/logrotate_spec.rb
 - spec/nginx_utils/status_spec.rb
 - spec/spec_helper.rb