mail_runner 0.1.0

data/test/test_bot_helpers.rb

@@ -0,0 +1,158 @@
+require_relative 'helper'
+
+class TestBotHelpers < Minitest::Test
+
+####### BotHelpers::Tests ###########
+	describe "test BotHelpers:: Tests" do
+		before do
+			@opts ={
+				:mailbox => "/var/mail/root", #app 
+				:webhook => "http://127.0.0.1:4000/talkpost"
+			}
+			@test = BotHelpers::Tests
+		end
+
+		#all_args?
+		it "Error - .all_args_included? if arguments less than 2" do
+			@opts.shift
+			assert_raises(ArgumentError) {@test.all_args_included?(@opts)}
+		end
+
+		#Create test for other arguments like daemonize, log, etc
+
+		it "Passes - .all_args_included? if 2 or 3 arguments." do
+			assert_silent {@test.all_args_included?(@opts)}
+			@opts[:archive]=true
+			assert_silent {@test.all_args_included?(@opts)}
+		end
+
+		#test_mailbox
+		it "error - .test_mailbox if doesn't exist" do
+			assert_raises(ArgumentError) {@test.test_mailbox("no_mailbox")}
+		end
+
+		it "Passes - .test_mailbox if exists" do
+			assert_silent {@test.test_mailbox(@opts[:mailbox])}
+		end
+
+		#test_webhook
+		it "Passes - .test_webook if returns 200" do
+			assert_silent {@test.test_webhook(@opts[:webhook])}
+		end
+
+		it "fails - .test_webook if returns not 200" do
+			assert_raises(ArgumentError) {@test.test_webhook("http://127.0.0.1:4000/faulty_hook")}
+		end
+	end
+ ########################################
+
+
+ ####### BotHelpers::Runner ###########
+ 	describe "test BotHelpers:: Runner" do
+		context "method : get_contents_from_email" do
+			before do
+				@mailbox = "/var/mail/talkpost" #app 
+				@webhook = "http://127.0.0.1:4000/talkpost"
+				@runner = BotHelpers::Runner
+			end
+
+			#get_contents_from_email
+			context "when there is mail" do
+
+				it "returns an object of type mail & empties mailbox after reading" do
+			
+					#insert test content into mailbox for test.
+					`cp #{Dir[File.dirname(__FILE__)][0] + "/test_assets/test.email"} /var/mail/talkpost`
+		
+					object_returned = @runner.get_contents_from_mailbox(@mailbox)
+					assert_instance_of Array, object_returned
+					assert_equal 1, object_returned.length #confirms scrubs first empty item in array.
+					assert_equal true, File.zero?(@mailbox)
+				end
+			end
+
+			context "when there is no mail" do		
+				it "does nothing if mailbox empty" do
+					assert_silent {@runner.get_contents_from_mailbox(@mailbox)}
+				end
+			end
+
+		end
+		context "method : Post_to_hook" do
+			before do
+				@webhook = "http://127.0.0.1:4000/talkpost"
+				@runner = BotHelpers::Runner
+			end
+			it "successfully posts if packet has contents to webhook" do
+				parcel = File.read(("#{Dir[File.dirname(__FILE__)][0] + '/test_assets/test.json'}"))
+				assert_equal 200,  @runner.post_to_hook(@webhook, parcel).code
+			end
+
+			it "Returns an error if server down or response not 200" do
+				@faulty_webhook = "http://127.0.0.1:4000/faulty_hook"
+				parcel = File.read(("#{Dir[File.dirname(__FILE__)][0] + '/test_assets/empty.txt'}"))
+				assert_raises(ArgumentError) {@runner.post_to_hook(@faulty_webhook, parcel)}
+			end
+		end
+
+		context "method: add mail to queue" do
+			it "do we really need to test this one?" do
+			end
+		end
+
+
+	end
+
+ ########################################
+
+
+ ####### BotHelpers::Helpers ###########
+	describe "test BotHelpers:: Helpers" do
+		before do
+			@helper = BotHelpers::Helpers
+		end
+
+ 		context "method : convert_raw_mail_to_json" do
+ 			before do
+ 				@mail = Mail.read("#{Dir[File.dirname(__FILE__)][0] + "/test_assets/test.email"}")
+ 			end
+
+			it "returns valid json " do
+				def valid_json?(j)
+				  JSON.parse(j)  
+				  return true  
+				rescue JSON::ParserError  
+				  return false  
+				end 
+				
+				assert_equal true, valid_json?(@helper.convert_raw_mail_to_json(@mail))
+			end
+		end
+
+		context "method : parse_attachments" do
+			before do
+ 				@mail = Mail.read("#{Dir[File.dirname(__FILE__)][0] + "/test_assets/with_attachments.email"}")
+ 				@inline_mail = Mail.read("#{Dir[File.dirname(__FILE__)][0] + "/test_assets/inline_attachments.email"}")
+ 			end
+
+			it "returns a hash of 2 arrays" do
+				assert_instance_of Hash, @helper.parse_attachments(@mail.attachments)
+				assert_equal 2, @helper.parse_attachments(@mail.attachments).size
+			end
+
+			it "returns content in i_array if inline attachment" do
+				assert_equal 1, @helper.parse_attachments(@inline_mail.attachments)[:i_array].size
+				assert_equal 0, @helper.parse_attachments(@inline_mail.attachments)[:a_array].size
+			end
+
+			it "returns conent in a_array if not inline attachment" do
+				assert_equal 0, @helper.parse_attachments(@mail.attachments)[:i_array].size
+				assert_equal 1, @helper.parse_attachments(@mail.attachments)[:a_array].size
+			end
+		end
+
+
+	end
+########################################
+
+end

data/test/test_cli.rb

@@ -0,0 +1,139 @@
+require_relative 'helper'
+
+class TestCLI< Minitest::Test
+	describe "test #parse_options" do
+		before do
+			@cli = MailRunner::CLI
+		end
+
+		it "returns a hash object when valid args entered" do
+			assert_instance_of Hash, @cli.parse_options(["-m", "talkpost", "-w", "http://127.0.0.1:4000/talkpost"])
+			assert_equal 2, @cli.parse_options(["-m", "talkpost", "-w", "http://127.0.0.1:4000/talkpost"]).size
+		end
+
+		it "Seems a worthless test to me..." do
+			@cli.stub :daemonize, true do
+				assert_equal true, @cli.daemonize
+			end
+		end
+	end
+	describe "demonization upon start" do
+
+		#create some set up where it makes sure server is down and test -d flag
+		it "does not daemonize if the mailbox or webhook is invalid" do
+			
+		end
+	end
+
+	describe 'with logfile' do
+    before do
+    	@cli = MailRunner::CLI
+      @tmp_log_path = '/tmp/mailrunner.log'
+      @options = @cli.parse_options(['mailrunner', '-L', @tmp_log_path])
+      @logger = Logger.new(@options[:logfile]) #Bypass logger in helper file so can create new one with tmp path
+    end
+    after do 
+    	File.unlink @tmp_log_path if File.exist?(@tmp_log_path)
+    end
+
+    it 'sets the logfile path' do
+      assert_equal @tmp_log_path, @options[:logfile]
+    end
+
+    it 'creates and writes to a logfile' do
+      @logger.info('test message')
+      assert_match(/test message/, File.read(@tmp_log_path), "didn't include the log message")
+    end
+
+    it 'appends messages to a logfile' do
+      File.open(@tmp_log_path, 'w') do |f|
+        f.puts 'Existing log message'
+      end
+     	@logger.info('test message')
+
+      log_file_content = File.read(@tmp_log_path)
+      assert_match(/Existing log message/, log_file_content, "didn't include the old message")
+      assert_match(/test message/, log_file_content, "didn't include the new message")
+    end
+  end
+
+  describe 'launch with config file' do
+    before do
+    	@cli = MailRunner::CLI
+      @options = @cli.parse_options(['mailrunner', '-c', './test/test_assets/test_config.yml'])
+    end
+
+    it 'takes a config path' do
+      assert_equal './test/test_assets/test_config.yml', @options[:config]
+    end
+
+    it 'sets mailbox' do
+      assert_equal 'test_mailbox', @options[:mailbox]
+    end
+
+    it 'sets webhook' do
+      assert_equal 'localhost:4000/test_hook', @options[:webhook]
+    end
+
+    it 'sets daemon false by default' do
+      assert_equal false, @options[:daemon]
+    end
+
+    it 'sets archive' do
+      refute_nil  @options[:archive]
+    end
+    #Add subsections once archive complete
+
+    it 'Does not set verbose' do
+      refute @options[:verbose]
+    end
+
+    it 'sets logfile' do
+      assert_equal '/home/user/mailrunner.log', @options[:logfile]
+    end
+  end
+
+  describe "individual flags override config file" do
+  	before do
+    	@cli = MailRunner::CLI
+			@options = @cli.parse_options(['mailrunner',
+						                '-m', 'flag_mailbox',
+						                '-w', 'localhost:4000/flag_hook',
+						                '-d', 
+						                '-a', true,
+						                '-L', '/home/user/flag.log',
+						                '-c', './test/test_assets/test_config.yml',
+						                '-v', true])
+	  end
+
+	  it ' takes the config path' do
+      assert_equal './test/test_assets/test_config.yml', @options[:config]
+    end
+
+    it 'uses flag mailbox' do
+      assert_equal 'flag_mailbox', @options[:mailbox]
+    end
+
+    it 'uses flag webhook' do
+      assert_equal 'localhost:4000/flag_hook', @options[:webhook]
+    end
+
+    it 'uses flag daemon setting' do
+      assert_equal true, @options[:daemon]
+    end
+
+    it 'uses flag archive' do
+      assert_equal true,  @options[:archive]
+    end
+    #Add subsections once archive complete
+
+    it 'uses flag verbose' do
+      assert_equal true, @options[:verbose]
+    end
+
+    it 'uses flag logfile' do
+      assert_equal '/home/user/flag.log', @options[:logfile]
+    end
+  end
+	
+end

data/test/test_inbound_manager_bot.rb

@@ -0,0 +1,70 @@
+require_relative 'helper'
+
+class TestInboundManager < Minitest::Test
+	
+	#describe "Test Process Inbound Method" do
+
+	#ADD AND FIND EXCEPTION!  e.g. what happens if can convert to json? is mail lost?
+	#end
+
+	describe "Inbound Manager::get_mail" do
+		before do
+			@inboundManager = MailRunner::InboundManagerBot
+			@mailbox = "/var/mail/talkpost" #app 
+			@webhook = "http://127.0.0.1:4000/talkpost"
+		end
+		context "when there is mail" do
+
+			it "returns an object of type mail & empties mailbox after reading" do
+		
+				#insert test content into mailbox for test.
+				`cp #{Dir[File.dirname(__FILE__)][0] + "/test_assets/test.email"} /var/mail/talkpost`
+	
+				object_returned = @inboundManager.get_mail(@mailbox)
+				assert_instance_of Array, object_returned
+				assert_equal 1, object_returned.length #confirms scrubs first empty item in array.
+				assert_equal true, File.zero?(@mailbox)
+			end
+		end
+	
+		context "when there is no mail" do		
+			it "does nothing if mailbox empty" do
+				assert_silent {@inboundManager.get_mail(@mailbox)}
+			end
+		end
+	end
+
+	describe "Inbound Manager::read_mail" do
+		before do
+			@inboundManager = MailRunner::InboundManagerBot
+			@raw_msg = File.read("#{Dir[File.dirname(__FILE__)][0] + "/test_assets/test.email"}")
+		end
+		it "takes raw message & returns an object of type mail" do
+			assert_instance_of Mail::Message, @inboundManager.read_mail(@raw_msg)
+		end
+	end
+
+	describe "Inbound Manager::deliver_mail" do
+		before do 
+			@inboundManager = MailRunner::InboundManagerBot
+			@webhook = "http://127.0.0.1:4000/talkpost"
+		end
+		context "When webhook is valid" do
+			it "successfully delivers mail " do
+				parcel = File.read(("#{Dir[File.dirname(__FILE__)][0] + '/test_assets/test.json'}"))
+				assert_equal 200,  @inboundManager.deliver_mail(@webhook, parcel).code
+			end
+		end
+
+		context "when webhook is invalid" do
+			it "Returns true = added to queue" do
+				@faulty_webhook = "http://127.0.0.1:4000/faulty_hook"
+				@dead_webhook = "http://127.0.0.1:4000/faulty_hook"
+				parcel = File.read(("#{Dir[File.dirname(__FILE__)][0] + '/test_assets/empty.txt'}"))
+				#Below 
+				assert_equal true, @inboundManager.deliver_mail(@faulty_webhook, parcel)
+				assert_equal true, @inboundManager.deliver_mail(@dead_webhook, parcel)
+			end
+		end
+	end
+end

data/test/test_mail_runner.rb

@@ -0,0 +1,59 @@
+#####################
+# Several tests require a live server behind the test webhook.  
+# will cause sveral fails if not. Must be Post method.
+
+
+
+######################
+require_relative 'helper'
+
+class TestMailRunnerManager < Minitest::Test
+	
+	####### Top Level Call Tests ##########
+	describe 'MailRunner Manager initialize' do
+		before do
+			@bot = MailRunner.initialize_manager_bot
+		end
+
+		it "MailRunner Manager & atributes exist" do
+			assert_instance_of MailRunner::ManagerBot, @bot 
+			assert_equal nil, @bot.mailbox
+			assert_equal nil, @bot.webhook 
+			assert_equal false, @bot.archive
+		end
+
+		it "includes BotHelpers" do
+		end
+	end
+
+	describe "Parse Options method" do
+		before do
+			@bot = MailRunner.initialize_manager_bot
+			@opts = {:mailbox => "box_name", :webhook => "webhook/path"}
+		end
+
+		it "assigns passed arguments as getter bot attributes" do
+			@bot.parse_options(@opts)
+			assert_equal "/var/mail/box_name", @bot.mailbox
+			assert_equal "webhook/path", @bot.webhook
+			assert_equal false, @bot.archive
+		end
+
+		it "archive = true if passed archive argument" do
+			@opts[:archive] = "true"
+			@bot.parse_options(@opts)
+			assert_equal true, @bot.archive
+		end
+	end
+
+	describe "Run Method" do
+		before do
+			@bot = MailRunner.initialize_manager_bot
+			@bot.mailbox = "/var/mail/root" #app 
+			@bot.webhook = "http://127.0.0.1:4000/talkpost"
+		end
+
+	end
+ ########################################
+
+end

data/test/test_queue_manager_bot.rb

@@ -0,0 +1,76 @@
+require_relative 'helper'
+
+
+class TestQueueManager < Minitest::Test
+
+	describe "Queue Manager::add_mail_to_queue" do
+		before do
+			$redis.del("mail_room") # make sure starting with empty list
+			@queueManager = MailRunner::QueueManagerBot
+			@parcel = File.read(("#{Dir[File.dirname(__FILE__)][0] + '/test_assets/empty.txt'}"))
+			@webhook = "http://127.0.0.1:4000/talkpost"
+
+		end
+		it 'successfully adds web hook & parcel to redis queue' do
+			assert_equal true, @queueManager.add_to_mail_queue(@webhook, @parcel)
+			assert_equal 1, $redis.llen("mail_room")
+		end
+
+		#it "preserves the content ty"
+	end
+
+	describe "Queue Manager::pop_packet_from_queue" do
+		before do
+			$redis.del("mail_room") # make sure starting with empty list
+			@queueManager = MailRunner::QueueManagerBot
+
+			webhook = "http://127.0.0.1:4000/talkpost"
+			mail = Mail.read("#{Dir[File.dirname(__FILE__)][0] + "/test_assets/test.email"}")
+			@helper = BotHelpers::Helpers
+			que_packet = [webhook, @helper.convert_raw_mail_to_json(mail)]
+			
+			$redis.lpush("mail_room", que_packet.to_json)
+		end
+
+
+		it "returns an array with the hook & json email packet" do
+			def valid_json? json_  
+			  JSON.parse(json_)  
+			  return true  
+			rescue JSON::ParserError  
+			  return false  
+			end 
+			
+			returned_data = @queueManager.pop_packet_from_queue
+			assert_equal 2, returned_data.size
+			assert_equal "http://127.0.0.1:4000/talkpost", returned_data[0]
+			assert_equal true, valid_json?(returned_data[1])
+		end
+
+	end
+
+	describe "Queue Manager::deliver_mail" do
+		before do 
+			@queueManager = MailRunner::QueueManagerBot
+			@webhook = "http://127.0.0.1:4000/talkpost"
+		end
+		context "When webhook is valid" do
+			it "successfully delivers mail " do
+				parcel = File.read(("#{Dir[File.dirname(__FILE__)][0] + '/test_assets/test.json'}"))
+				assert_equal 200,  @queueManager.deliver_mail(@webhook, parcel).code
+			end
+		end
+
+		context "when webhook is invalid" do
+			it "Returns true = added to queue" do
+				@faulty_webhook = "http://127.0.0.1:4000/faulty_hook"
+				@dead_webhook = "http://127.0.0.1:4000/faulty_hook"
+				parcel = File.read(("#{Dir[File.dirname(__FILE__)][0] + '/test_assets/empty.txt'}"))
+				#Below 
+				assert_raises(ArgumentError) {@queueManager.deliver_mail(@faulty_webhook, parcel)}
+				assert_raises(ArgumentError) {@queueManager.deliver_mail(@dead_webhook, parcel)}
+			end
+		end
+	end
+
+end