rlimit 0.1.0

data/spec/rlimit_get_spec.rb

@@ -0,0 +1,68 @@
+require_relative './spec_helper'
+require 'rlimit'
+
+describe RLimit do
+	context "#get" do
+		it "sends back two values for one-arg call" do
+			rv = RLimit.get(RLimit::NOFILE)
+			expect(rv).to be_an(Array)
+			expect(rv[0]).to be_an(Integer)
+			expect(rv[1]).to be_an(Integer)
+		end
+
+		it "sends back one arg for a soft-limit request" do
+			expect(RLimit.get(RLimit::NOFILE, :soft)).to be_an(Integer)
+		end
+		
+		it "sends back one arg for a hard-limit request" do
+			expect(RLimit.get(RLimit::NOFILE, :hard)).to be_an(Integer)
+		end
+		
+		it "raises ArgumentError on an unknown resource type" do
+			expect { RLimit.get("ohai!") }.to raise_error(ArgumentError)
+		end
+
+		it "raises ArgumentError on an unknown limit type" do
+			expect { RLimit.get(RLimit::NOFILE, :lolidunno) }.to raise_error(ArgumentError)
+		end
+		
+		it "handles an unprefixed string" do
+			expect(RLimit.get("NOFILE", :soft)).to eq(RLimit.get(RLimit::NOFILE, :soft))
+		end
+		
+		it "handles a prefixed string" do
+			expect(RLimit.get("RLIMIT_NOFILE", :soft)).to eq(RLimit.get(RLimit::NOFILE, :soft))
+		end
+		
+		it "handles an unprefixed symbol" do
+			expect(RLimit.get(:NOFILE, :soft)).to eq(RLimit.get(RLimit::NOFILE, :soft))
+		end
+		
+		it "handles a prefixed symbol" do
+			expect(RLimit.get(:RLIMIT_NOFILE, :soft)).to eq(RLimit.get(RLimit::NOFILE, :soft))
+		end
+		
+		it "sends back :unlimited when getrlimit returns RLIM_INFINITY" do
+			expect(RLimit::FFI).
+			  to receive(:getrlimit).
+			  # I'm using any_args() here, and then checking the types in the
+			  # block, because there's a buggy interaction with RSpec (3.1.3,
+			  # at least) and FFI::MemoryPointer (1.9.3, at least) which causes
+			  # any ArgumentMatcher to fail to match, because
+			  # FFI::MemoryPointer#== doesn't like getting compared with
+			  # something else.  I think the bug's in RSpec, but I'm not sure
+			  # enough to file a bug.  So we just work around it, because even
+			  # if I *did* submit a bug, we'd have to work around it anyway to
+			  # get the tests to pass.
+			  with(any_args()) do |resource, rlim_ptr|
+			    expect(resource).to eq(RLimit::NOFILE)
+			    expect(rlim_ptr).to be_an(FFI::MemoryPointer)
+			    rlim = RLimit::FFI::RLimitStruct.new(rlim_ptr)
+			    rlim[:rlim_cur] = 1024
+			    rlim[:rlim_max] = RLimit::RLIM_INFINITY
+			  end.and_return(0)
+			
+			expect(RLimit.get(RLimit::NOFILE, :hard)).to eq(:unlimited)
+		end
+	end
+end

data/spec/rlimit_resources_spec.rb

@@ -0,0 +1,26 @@
+require_relative './spec_helper'
+require 'rlimit'
+
+describe RLimit do
+	context "#resources" do
+		it "has a common RLIMIT constant" do
+			expect(RLimit.resources).to include("RLIMIT_NOFILE")
+		end
+
+		it "doesn't have a non-existent RLIMIT constant" do
+			expect(RLimit.resources).to_not include("RLIMIT_WTFISTHIS")
+		end
+		
+		it "doesn't have RLIM_INFINITY" do
+			expect(RLimit.resources).to_not include("RLIMIT_RLIM_INFINITY")
+			expect(RLimit.resources).to_not include("RLIM_INFINITY")
+		end
+		
+		it "doesn't have our exceptions" do
+			expect(RLimit.resources).to_not include("RLIMIT_PermissionDenied")
+			expect(RLimit.resources).to_not include("PermissionDenied")
+			expect(RLimit.resources).to_not include("RLIMIT_HardLimitExceeded")
+			expect(RLimit.resources).to_not include("HardLimitExceeded")
+		end
+	end
+end

data/spec/rlimit_set_spec.rb

@@ -0,0 +1,139 @@
+require_relative './spec_helper'
+require 'rlimit'
+
+describe RLimit do
+	context "#set" do
+		context "via getrlimit" do
+			before :each do
+				expect(RLimit::FFI).
+				  to receive(:getrlimit).
+				  with(any_args()) do |res, rlim_ptr|
+				    expect(res).to eq(RLimit::NOFILE)
+				    expect(rlim_ptr).to be_an(::FFI::MemoryPointer)
+				    rlim = RLimit::FFI::RLimitStruct.new(rlim_ptr)
+				    rlim[:rlim_cur] = 1024
+				    rlim[:rlim_max] = 1048576
+				  end.and_return(0)
+			end
+				
+			it "handles both limits being set" do
+				expect(RLimit::FFI).
+				  to receive(:setrlimit).
+				  with(any_args()) do |res, rlim_ptr|
+				    expect(res).to eq(RLimit::NOFILE)
+				    expect(rlim_ptr).to be_an(::FFI::MemoryPointer)
+				    rlim = RLimit::FFI::RLimitStruct.new(rlim_ptr)
+				    expect(rlim[:rlim_cur]).to eq(4096)
+				    expect(rlim[:rlim_max]).to eq(65536)
+				  end.and_return(0)
+
+				expect(RLimit.set(RLimit::NOFILE, 4096, 65536)).to be(true)
+			end
+
+			it "handles just the soft limit changing" do
+				expect(RLimit::FFI).
+				  to receive(:setrlimit).
+				  with(any_args()) do |res, rlim_ptr|
+				    expect(res).to eq(RLimit::NOFILE)
+				    expect(rlim_ptr).to be_an(::FFI::MemoryPointer)
+				    rlim = RLimit::FFI::RLimitStruct.new(rlim_ptr)
+				    expect(rlim[:rlim_cur]).to eq(4096)
+				    expect(rlim[:rlim_max]).to eq(1048576)
+				  end.and_return(0)
+
+				expect(RLimit.set(RLimit::NOFILE, 4096)).to be(true)
+			end
+
+			["NOFILE", "RLIMIT_NOFILE", :NOFILE, :RLIMIT_NOFILE].each do |res|
+				it "handles the resource form #{res.inspect}" do
+					expect(RLimit::FFI).
+					  to receive(:setrlimit).
+					  with(any_args()) do |res, rlim_ptr|
+					    expect(res).to eq(RLimit::NOFILE)
+					    expect(rlim_ptr).to be_an(::FFI::MemoryPointer)
+					    rlim = RLimit::FFI::RLimitStruct.new(rlim_ptr)
+					    expect(rlim[:rlim_cur]).to eq(4096)
+					    expect(rlim[:rlim_max]).to eq(1048576)
+					  end.and_return(0)
+
+					expect(RLimit.set(res, 4096)).to be(true)
+				end
+			end
+
+			it "handles just the hard limit changing" do
+				expect(RLimit::FFI).
+				  to receive(:setrlimit).
+				  with(any_args()) do |res, rlim_ptr|
+				    expect(res).to eq(RLimit::NOFILE)
+				    expect(rlim_ptr).to be_an(::FFI::MemoryPointer)
+				    rlim = RLimit::FFI::RLimitStruct.new(rlim_ptr)
+				    expect(rlim[:rlim_cur]).to eq(1024)
+				    expect(rlim[:rlim_max]).to eq(65536)
+				  end.and_return(0)
+
+				expect(RLimit.set(RLimit::NOFILE, nil, 65536)).to be(true)
+			end
+			
+			it "handles the limit being :unlimited" do
+				expect(RLimit::FFI).
+				  to receive(:setrlimit).
+				  with(any_args()) do |res, rlim_ptr|
+				    expect(res).to eq(RLimit::NOFILE)
+				    expect(rlim_ptr).to be_an(::FFI::MemoryPointer)
+				    rlim = RLimit::FFI::RLimitStruct.new(rlim_ptr)
+				    expect(rlim[:rlim_cur]).to eq(RLimit::RLIM_INFINITY)
+				    expect(rlim[:rlim_max]).to eq(RLimit::RLIM_INFINITY)
+				  end.and_return(0)
+
+				expect(RLimit.set(RLimit::NOFILE, :unlimited, :unlimited)).to be(true)
+			end
+
+			it "freaks out if the soft limit is greater than the existing hard limit" do
+				expect { RLimit.set(RLimit::NOFILE, 1048577) }.
+				  to raise_error(
+				       RLimit::HardLimitExceeded,
+				       "You cannot set the soft limit above 1048576"
+				     )
+			end
+
+			it "freaks out if the soft limit is greater than the hard limit specified" do
+				expect { RLimit.set(RLimit::NOFILE, 65536, 4096) }.
+				  to raise_error(
+				       RLimit::HardLimitExceeded,
+				       "You cannot set the soft limit above 4096"
+				     )
+			end
+			
+			it "freaks out when setrlimit sends back EPERM" do
+				expect(RLimit::FFI).
+				  to receive(:setrlimit).
+				  with(any_args()) do |res, rlim_ptr|
+				    expect(res).to eq(RLimit::NOFILE)
+				    expect(rlim_ptr).to be_an(::FFI::MemoryPointer)
+				  end.and_return(-1)
+				
+				expect(::FFI).to receive(:errno).and_return(Errno::EPERM::Errno)
+				
+				expect { RLimit.set(RLimit::NOFILE, nil, 2000000) }.
+				  to raise_error(
+				       RLimit::PermissionDenied,
+				       "You do not have permission to raise hard limits"
+				     )
+			end
+		end
+
+		context "ArgumentError cases" do
+			it "raises ArgumentError on an unknown resource type" do
+				expect { RLimit.set("ohai!", 42) }.to raise_error(ArgumentError)
+			end
+
+			it "raises ArgumentError on a non-integer soft limit" do
+				expect { RLimit.set(RLimit::NOFILE, :lolidunno) }.to raise_error(ArgumentError)
+			end
+
+			it "raises ArgumentError on a non-integer hard limit" do
+				expect { RLimit.set(RLimit::NOFILE, 42, :lolidunno) }.to raise_error(ArgumentError)
+			end
+		end
+	end
+end

data/spec/rlimit_supports_spec.rb

@@ -0,0 +1,24 @@
+require_relative './spec_helper'
+require 'rlimit'
+
+describe RLimit do
+	context "#supports?" do
+		[RLimit::NOFILE, "NOFILE", :NOFILE, "RLIMIT_NOFILE", :RLIMIT_NOFILE].each do |res|
+			it "OKs #{res.inspect}" do
+				expect(RLimit.supports?(res)).to be(true)
+			end
+		end
+		
+		it "rejects a random symbol" do
+			expect(RLimit.supports?(:OHAI)).to be(false)
+		end
+		
+		it "rejects a random string" do
+			expect(RLimit.supports?("OHAI")).to be(false)
+		end
+		
+		it "rejects something really weird" do
+			expect(RLimit.supports?(RLimit)).to be(false)
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'spork'
+
+Spork.prefork do
+	require 'bundler'
+	Bundler.setup(:default, :test)
+	require 'rspec/core'
+	require 'rspec/mocks'
+
+	require 'pry'
+
+	RSpec.configure do |config|
+		config.fail_fast = true
+#		config.full_backtrace = true
+
+		config.expect_with :rspec do |c|
+			c.syntax = :expect
+		end
+	end
+end
+
+Spork.each_run do
+	# Nothing to do here, specs will load the files they need
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: rlimit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Palmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git-version-bump
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-release
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENCE
+- README.md
+- Rakefile
+- lib/rlimit.rb
+- rlimit.gemspec
+- spec/rlimit_get_spec.rb
+- spec/rlimit_resources_spec.rb
+- spec/rlimit_set_spec.rb
+- spec/rlimit_supports_spec.rb
+- spec/spec_helper.rb
+homepage: http://theshed.hezmatt.org/rlimit
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4592700154150996709
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4592700154150996709
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Retrieve and adjust rlimits
+test_files: []