httpthumbnailer 0.3.1 → 1.0.0

data/features/step_definitions/httpthumbnailer_steps.rb

@@ -1,14 +1,7 @@
-Given /httpthumbnailer log is empty/ do
-		(support_dir + 'server.log').truncate(0)
-end
-
 Given /httpthumbnailer server is running at (.*)/ do |url|
-	start_server(
-		"bundle exec #{script('httpthumbnailer')}",
-		'/tmp/httpthumbnailer.pid',
-		support_dir + 'server.log',
-		url
-	)
+	log = support_dir + 'server.log'
+	cmd = "bundle exec #{script('httpthumbnailer')} -f -d -l #{log} -w 1"
+	start_server(cmd, '/tmp/httpthumbnailer.pid', log, url)
 end
 
 Given /(.*) file content as request body/ do |file|
@@ -16,61 +9,90 @@ Given /(.*) file content as request body/ do |file|
 end
 
 When /I do (.*) request (.*)/ do |method, url|
-	@response = HTTPClient.new.request(method, url, nil, @request_body)
+	@response = http_client.request(method, url, nil, @request_body)
 end
 
-Then /(.*) header will be (.*)/ do |header, value|
+When /I save response body/ do
+	@saved_response_body = @response.body
+end
+
+Then /(.*) header should be (.*)/ do |header, value|
 	@response.header[header].should_not be_empty
 	@response.header[header].first.should == value
 end
 
-Then /I will get multipart response/ do
+Then /I should get multipart response/ do
 	@response.header['Content-Type'].first.should match /^multipart/
-	@response_multipart = MultipartResponse.new(@response.header['Content-Type'].last, @response.body)
+	parser = MultipartParser::Reader.new(MultipartParser::Reader.extract_boundary_value(@response.header['Content-Type'].last))
+	@response_multipart = []
+
+	parser.on_part do |part|
+		part_struct = OpenStruct.new
+		part_struct.headers = part.headers
+
+		part_struct.body = ''
+		part.on_data do |data|
+			part_struct.body << data
+		end
+
+		part.on_end do
+			@response_multipart << part_struct
+		end
+	end
+
+	parser.write @response.body
+
+	parser.ended?.should be_true
+	@response_multipart.should_not be_empty
 end
 
-Then /response body will be CRLF endend lines like/ do |body|	
+Then /response body should be CRLF endend lines like/ do |body|	
 	@response.body.should match(body)
-	@response.body.each do |line|
+	@response.body.each_line do |line|
 		line[-2,2].should == "\r\n"
 	end
 end
 
-Then /response body will be CRLF endend lines$/ do |body|	
+Then /response body should be CRLF endend lines$/ do |body|	
 	@response.body.should == body.gsub("\n", "\r\n") + "\r\n"
 end
 
-Then /response status will be (.*)/ do |status|
+Then /response status should be (.*)/ do |status|
 	@response.status.should == status.to_i
 end
 
-Then /response content type will be (.*)/ do |content_type|
+Then /response content type should be (.*)/ do |content_type|
 	@response.header['Content-Type'].first.should == content_type
 end
 
-Then /(.*) part mime type will be (.*)/ do |part, mime|
-	@response_multipart.part[part_no(part)].header['Content-Type'].should == mime
+Then /response mime type should be (.*)/ do |mime_type|
+	step "response content type should be #{mime_type}"
+end
+
+Then /(.*) part mime type should be (.*)/ do |part, mime|
+	@response_multipart[part_no(part)].headers['content-type'].should == mime
+end
+
+Then /(.*) part content type should be (.*)/ do |part, content_type|
+	@response_multipart[part_no(part)].headers['content-type'].should == content_type
 end
 
-Then /(.*) part content type will be (.*)/ do |part, content_type|
-	@response_multipart.part[part_no(part)].header['Content-Type'].should == content_type
+Then /(.*) part status should be (.*)/ do |part, status|
+	@response_multipart[part_no(part)].headers['status'].should == status
 end
 
-Then /(.*) part body will be CRLF endend lines$/ do |part, body|	
-	@response_multipart.part[part_no(part)].body.should == body.gsub("\n", "\r\n") + "\r\n"
+Then /(.*) part body should be CRLF endend lines$/ do |part, body|	
+	@response_multipart[part_no(part)].body.should == body.gsub("\n", "\r\n")
 end
 
-Then /(.*) part body will be CRLF endend lines like$/ do |part, body|	
-	pbody = @response_multipart.part[part_no(part)].body
+Then /(.*) part body should be CRLF endend lines like$/ do |part, body|	
+	pbody = @response_multipart[part_no(part)].body
 	pbody.should match(body)
-	pbody.each do |line|
-		line[-2,2].should == "\r\n"
-	end
 end
 
-Then /(.*) part will contain (.*) image of size (.*)x(.*)/ do |part, format, width, height|
-	mime = @response_multipart.part[part_no(part)].header['Content-Type']
-	data = @response_multipart.part[part_no(part)].body
+Then /response should contain (.*) image of size (.*)x(.*)/ do |format, width, height|
+	mime = @response.header['Content-Type'].first
+	data = @response.body
 	fail("expecte image got #{mime}: #{data}") unless mime =~ /^image\//
 
 	@image.destroy! if @image
@@ -81,27 +103,50 @@ Then /(.*) part will contain (.*) image of size (.*)x(.*)/ do |part, format, wid
 	@image.rows.should == height.to_i
 end
 
-Then /(.*) part will contain body of size within (.*) of (.*)/ do |part, margin, size|
-	data = @response_multipart.part[part_no(part)].body
-	data.length.should be_within(margin.to_i).of(size.to_i)
+
+Then /(.*) part should contain (.*) image of size (.*)x(.*)/ do |part, format, width, height|
+	mime = @response_multipart[part_no(part)].headers['content-type']
+	data = @response_multipart[part_no(part)].body
+
+	mime.should match /^image\//
+	data.should_not be_empty
+
+	@image.destroy! if @image
+	@image = Magick::Image.from_blob(data).first
+
+	@image.format.should == format
+	@image.columns.should == width.to_i
+	@image.rows.should == height.to_i
 end
 
-Then /(.*) part will contain body smaller than (.*) part/ do |part, big_part|
-	data = @response_multipart.part[part_no(part)].body
-	data_big = @response_multipart.part[part_no(big_part)].body
-	data.length.should < data_big.length
+Then /saved response body will be smaller than response body/ do
+	@saved_response_body.length.should < @response.body.length
+end
+
+And /response will be saved as (.*) for human inspection/ do |file|
+	data = @response.body
+	(support_dir + file).open('w'){|f| f.write(data)}
 end
 
 And /(.*) part body will be saved as (.*) for human inspection/ do |part, file|
-	data = @response_multipart.part[part_no(part)].body
+	data = @response_multipart[part_no(part)].body
 	(support_dir + file).open('w'){|f| f.write(data)}
 end
 
-And /that image pixel at (.*)x(.*) will be of color (.*)/ do |x, y, color|
+And /that image pixel at (.*)x(.*) should be of color (.*)/ do |x, y, color|
 	@image.pixel_color(x.to_i, y.to_i).to_color.sub(/^#/, '0x').should == color
 end
 
-And /there will be no leaked images/ do
-	HTTPClient.new.get_content("http://localhost:3100/stats/images").to_i.should == 0
+And /that image should be (.*) bit image/ do |bits|
+	@image.depth.should == bits.to_i
+end
+
+
+And /there should be no leaked images/ do
+	Integer(http_client.get_content("http://localhost:3100/stats/images_loaded").strip).should == 0
+end
+
+And /there should be maximum (.*) images loaded during single request/ do |max|
+	Integer(http_client.get_content("http://localhost:3100/stats/max_images_loaded").strip).should <= max.to_i
 end
 

data/features/support/env.rb

@@ -7,13 +7,12 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 
 require 'rspec/expectations'
+require 'multipart_parser/reader'
 require 'daemon'
 require 'timeout'
 require 'httpclient'
-require 'httpthumbnailer/multipart_response'
 require "open3"
 require "thread"
 require 'RMagick'
@@ -43,28 +42,36 @@ def part_no(part)
 	end
 end
 
-
-def get(url)
-	HTTPClient.new.get_content(url)
+def http_client
+	client = HTTPClient.new
+	#client.debug_dev = STDOUT
+	client
 end
 
+@@running_cmd = {}
 def start_server(cmd, pid_file, log_file, test_url)
-	stop_server(pid_file)
+	if @@running_cmd[pid_file]
+		return if @@running_cmd[pid_file] == cmd
+		stop_server(pid_file) 
+	end
 
 	fork do
 		Daemon.daemonize(pid_file, log_file)
+		log_file = Pathname.new(log_file)
+		log_file.truncate(0) if log_file.exist?
 		exec(cmd)
 	end
-	Process.wait
+
+	@@running_cmd[pid_file] = cmd
 
 	ppid = Process.pid
 	at_exit do
 		stop_server(pid_file) if Process.pid == ppid
 	end
 
-	Timeout.timeout(20) do
+	Timeout.timeout(6) do
 		begin
-			get test_url
+			http_client.get_content test_url
 		rescue Errno::ECONNREFUSED
 			sleep 0.1
 			retry
@@ -76,6 +83,7 @@ def stop_server(pid_file)
 	pid_file = Pathname.new(pid_file)
 	return unless pid_file.exist?
 
+	STDERR.puts http_client.get_content("http://localhost:3100/stats")
 	pid = pid_file.read.strip.to_i
 
 	Timeout.timeout(20) do
@@ -90,3 +98,8 @@ def stop_server(pid_file)
 	end
 end
 
+After do |scenario|
+	step 'there should be no leaked images'
+	step 'there should be maximum 3 images loaded during single request'
+end
+

data/features/thumbnail.feature

@@ -0,0 +1,241 @@
+Feature: Generating single thumbnail with PUT request
+	In order to generate a single image thumbnail
+	A user must PUT an image to URL in format
+	/thumbnail[/<thumbnail type>,<width>,<height>,<format>
+
+	Background:
+		Given httpthumbnailer server is running at http://localhost:3100/
+
+	@test
+	Scenario: Single thumbnail
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,png
+		Then response status should be 200
+		Then response should contain PNG image of size 16x16
+		And that image should be 8 bit image
+		And response mime type should be image/png
+
+	@transparent
+	Scenario: Transparent image to JPEG handling - default background color white
+		Given test-transparent.png file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/fit,128,128,jpeg
+		Then response status should be 200
+		And response will be saved as test-transparent-default.png for human inspection
+		Then response should contain JPEG image of size 128x128
+		And that image pixel at 32x32 should be of color white
+
+	@input_format
+	Scenario: Thumbnails of format input should have same format as input image
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,4,8,input
+		Then response status should be 200
+		Then response should contain JPEG image of size 4x8
+		And response mime type should be image/jpeg
+		Given test.png file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,4,8,input
+		Then response status should be 200
+		Then response should contain PNG image of size 4x8
+		And that image should be 8 bit image
+		And response mime type should be image/png
+
+	@input_size
+	Scenario: Thumbnails of width or height input should have input image width or height
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,input,16,png
+		Then response status should be 200
+		Then response should contain PNG image of size 509x16
+		And response mime type should be image/png
+		When I do PUT request http://localhost:3100/thumbnail/crop,4,input,png
+		Then response status should be 200
+		Then response should contain PNG image of size 4x719
+		And response mime type should be image/png
+		When I do PUT request http://localhost:3100/thumbnail/crop,input,input,png
+		Then response status should be 200
+		Then response should contain PNG image of size 509x719
+		And response mime type should be image/png
+
+	@fit
+	Scenario: Fit thumbnailing method
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/fit,128,128,png
+		Then response status should be 200
+		Then response should contain PNG image of size 91x128
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/fit,1024,1024,png
+		Then response status should be 200
+		Then response should contain PNG image of size 725x1024
+
+	@limit
+	Scenario: Limit thumbnailing method should reduce image size when needed
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/limit,128,128,png
+		Then response status should be 200
+		Then response should contain PNG image of size 91x128
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/limit,1024,1024,png
+		Then response status should be 200
+		Then response should contain PNG image of size 509x719
+
+	@pad @transparent
+	Scenario: Pad thumbnailing method - default background color white
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/pad,128,128,png
+		Then response status should be 200
+		And response will be saved as test-pad.png for human inspection
+		Then response should contain PNG image of size 128x128
+		And that image pixel at 2x2 should be of color white
+
+	@pad @transparent
+	Scenario: Pad thumbnailing method with specified background color
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/pad,128,128,png,background-color:green
+		Then response status should be 200
+		And response will be saved as test-pad-background-color.png for human inspection
+		Then response should contain PNG image of size 128x128
+		And that image pixel at 2x2 should be of color green
+
+	@error_handling
+	Scenario: Reporitng of unsupported media type
+		Given test.txt file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,128,128,png
+		Then response status should be 415
+		And response content type should be text/plain
+		And response body should be CRLF endend lines like
+		"""
+		unsupported media type: no decode delegate for this image format
+		"""
+
+	@error_handling
+	Scenario: Reporitng of bad thumbanil spec format - bad dimension value
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,128,bogous,png
+		Then response status should be 400
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
+		"""
+		bad dimension value: bogous
+		"""
+
+	@error_handling
+	Scenario: Reporitng of bad thumbanil spec format - missing param
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,128,png
+		Then response status should be 400
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
+		"""
+		missing argument in: crop,128,png
+		"""
+
+	@error_handling
+	Scenario: Reporitng of bad thumbanil spec format - bad options format
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,128,128,png,fas-xyz
+		Then response status should be 400
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
+		"""
+		missing option key or value in: fas-xyz
+		"""
+
+	@error_handling
+	Scenario: Reporitng of bad operation value
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/blah,128,128,png
+		Then response status should be 400
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
+		"""
+		thumbnail method 'blah' is not supported
+		"""
+
+	@error_handling
+	Scenario: Reporitng of image thumbnailing errors
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,0,0,jpeg
+		Then response status should be 400
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
+		"""
+		at least one image dimension is zero: 0x0
+		"""
+
+	@optimization
+	Scenario: Handing of large image data - possible thanks to loading size optimization
+		Given test-large.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,png
+		Then response status should be 200
+		Then response should contain PNG image of size 16x16
+
+	@resources
+	Scenario: Memory limits exhausted while loading - no loading optimization possible
+		Given test-large.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,7000,7000,png
+		Then response status should be 413
+		And response content type should be text/plain
+		And response body should be CRLF endend lines like
+		"""
+		image too large: cache resources exhausted
+		"""
+
+	@resources
+	Scenario: Memory limits exhausted while thumbnailing
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,16000,16000,jpeg
+		Then response status should be 413
+		And response content type should be text/plain
+		And response body should be CRLF endend lines like
+		"""
+		image too large: cache resources exhausted
+		"""
+
+	@quality
+	Scenario: Quality option - JPEG
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,32,32,jpeg,quality:10
+		When I save response body
+		When I do PUT request http://localhost:3100/thumbnail/crop,32,32,jpeg,quality:80
+		Then saved response body will be smaller than response body
+		When I save response body
+		When I do PUT request http://localhost:3100/thumbnail/crop,32,32,jpeg,quality:90
+		Then saved response body will be smaller than response body
+
+	@quality
+	Scenario: Quality option - JPEG - default 85
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,32,32,jpeg,quality:84
+		When I save response body
+		Then response mime type should be image/jpeg
+		When I do PUT request http://localhost:3100/thumbnail/crop,32,32,jpeg
+		Then saved response body will be smaller than response body
+		Then response mime type should be image/jpeg
+		When I save response body
+		When I do PUT request http://localhost:3100/thumbnail/crop,32,32,jpeg,quality:86
+		Then saved response body will be smaller than response body
+		Then response mime type should be image/jpeg
+
+	@quality
+	Scenario: Quality option - PNG (XY where X - zlib compresion level, Y - filter)
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnail/crop,128,128,png,quality:90
+		When I save response body
+		Then response mime type should be image/png
+		When I do PUT request http://localhost:3100/thumbnail/crop,128,128,png,quality:50
+		Then saved response body will be smaller than response body
+		Then response mime type should be image/png
+		When I save response body
+		When I do PUT request http://localhost:3100/thumbnail/crop,128,128,png,quality:10
+		Then saved response body will be smaller than response body
+		Then response mime type should be image/png
+
+	@hint
+	Scenario: Hint on input image mime type
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,16,16,png
+		Then response status should be 200
+		And X-Input-Image-Content-Type header should be image/jpeg
+		Given test.png file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,16,16,png
+		Then response status should be 200
+		And X-Input-Image-Content-Type header should be image/png
+

data/features/thumbnails.feature

@@ -0,0 +1,142 @@
+Feature: Generating set of thumbnails with single PUT request
+	In order to generate a set of image thumbnails
+	A user must PUT an image to URL in format
+	/thumbnails[/<thumbnail type>,<width>,<height>,<format>[,<option key>:<option value>]+]+
+
+	Background:
+		Given httpthumbnailer server is running at http://localhost:3100/
+
+	@multipart
+	Scenario: Single thumbnail
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,16,16,png
+		Then response status should be 200
+		And I should get multipart response
+		Then first part should contain PNG image of size 16x16
+		And that image should be 8 bit image
+		And first part mime type should be image/png
+
+	@multipart
+	Scenario: Multiple thumbnails
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,16,16,png/crop,4,8,jpeg/crop,16,32,jpeg
+		Then response status should be 200
+		And I should get multipart response
+		Then first part should contain PNG image of size 16x16
+		And first part mime type should be image/png
+		Then second part should contain JPEG image of size 4x8
+		And second part mime type should be image/jpeg
+		Then third part should contain JPEG image of size 16x32
+		And third part mime type should be image/jpeg
+
+	@input_size
+	Scenario: Thumbnails of width or height input should have input image width or height
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,input,16,jpeg/crop,4,input,png/crop,input,input,png
+		Then response status should be 200
+		And I should get multipart response
+		Then first part should contain JPEG image of size 509x16
+		Then second part should contain PNG image of size 4x719
+		Then third part should contain PNG image of size 509x719
+
+	@leaking
+	Scenario: Image leaking on error
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,0,0,png/fit,0,0,jpeg/pad,0,0,jpeg
+		Then response status should be 200
+		And I should get multipart response
+		And first part content type should be text/plain
+		And second part content type should be text/plain
+		And third part content type should be text/plain
+
+	@error_handling
+	Scenario: Reporitng of bad thumbanil spec format - bad dimension value
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,4,4,png/crop,128,bogous,png
+		Then response status should be 400
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
+		"""
+		bad dimension value: bogous
+		"""
+
+	@error_handling
+	Scenario: Reporitng of bad thumbanil spec format - missing param
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,4,4,png/crop,128,png
+		Then response status should be 400
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
+		"""
+		missing argument in: crop,128,png
+		"""
+
+	@error_handling
+	Scenario: Reporitng of bad thumbanil spec format - bad options format
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,4,4,png/crop,128,128,png,fas-fda
+		Then response status should be 400
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
+		"""
+		missing option key or value in: fas-fda
+		"""
+
+	@error_handling
+	Scenario: Reporitng of bad operation value
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,4,4,png/blah,128,128,png
+		Then response status should be 200
+		And I should get multipart response
+		And second part content type should be text/plain
+		And second part body should be CRLF endend lines
+		"""
+		thumbnail method 'blah' is not supported
+		"""
+		And second part status should be 400
+
+	@error_handling
+	Scenario: Reporitng of image thumbnailing errors
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,16,16,png/crop,0,0,jpeg/crop,16,32,jpeg
+		Then response status should be 200
+		And I should get multipart response
+		Then first part should contain PNG image of size 16x16
+		And first part mime type should be image/png
+		And second part content type should be text/plain
+		And second part body should be CRLF endend lines
+		"""
+		at least one image dimension is zero: 0x0
+		"""
+		And second part status should be 400
+		Then third part should contain JPEG image of size 16x32
+		And third part mime type should be image/jpeg
+
+	@resources
+	Scenario: Memory limits exhausted while thumbnailing
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,16,16,png/crop,16000,16000,jpeg/crop,16,32,jpeg
+		Then response status should be 200
+		And I should get multipart response
+		Then first part should contain PNG image of size 16x16
+		And first part mime type should be image/png
+		And second part content type should be text/plain
+		And second part body should be CRLF endend lines like
+		"""
+		image too large: cache resources exhausted
+		"""
+		And second part status should be 413
+		Then third part should contain JPEG image of size 16x32
+		And third part mime type should be image/jpeg
+
+	@hint
+	Scenario: Hint on input image mime type
+		Given test.jpg file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,16,16,png
+		Then response status should be 200
+		And X-Input-Image-Content-Type header should be image/jpeg
+		Given test.png file content as request body
+		When I do PUT request http://localhost:3100/thumbnails/crop,16,16,png
+		Then response status should be 200
+		And X-Input-Image-Content-Type header should be image/png
+