Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix daemonization broken in #219 #224

Merged
merged 4 commits into from
Jun 8, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 21 additions & 15 deletions lib/shoryuken/cli.rb
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ def run(args)

options = parse_cli_args(args)

daemonize
write_pid

load_celluloid
daemonize(options)
write_pid(options)

EnvironmentLoader.load(options)

load_celluloid
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have to load celluloid later so we could attach logger properly.


require 'shoryuken/launcher'
@launcher = Shoryuken::Launcher.new

Expand All @@ -64,21 +64,27 @@ def run(args)
private

def load_celluloid
raise "Celluloid cannot be required until here, or it will break Shoryuken's daemonization" if defined?(::Celluloid) && Shoryuken.options[:daemon]

# Celluloid can't be loaded until after we've daemonized
# because it spins up threads and creates locks which get
# into a very bad state if forked.
require 'celluloid/autostart'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@phstc it's just moved from here :)

Celluloid.logger = (Shoryuken.options[:verbose] ? Shoryuken.logger : nil)

require 'shoryuken/manager'
end

def daemonize
return unless Shoryuken.options[:daemon]
def celluloid_loaded?
defined?(::Celluloid)
end

def daemonize(options)
return unless options[:daemon]

fail ArgumentError, "You really should set a logfile if you're going to daemonize" unless Shoryuken.options[:logfile]
fail ArgumentError, "You really should set a logfile if you're going to daemonize" unless options[:logfile]

if celluloid_loaded?
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Daemonizing should fail if there is celluloid loaded, not loading celluloid, as we had before.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mariokostelac this is only to prevent users that manually require celluloid before requiring shoryuken?

Copy link
Contributor Author

@mariokostelac mariokostelac Jun 8, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, or us accidentally breaking it. Like we did few days ago.

# Celluloid can't be loaded until after we've daemonized
# because it spins up threads and creates locks which get
# into a very bad state if forked.
raise "Celluloid cannot be required until here, or it will break Shoryuken's daemonization"
end

files_to_reopen = []
ObjectSpace.each_object(File) do |file|
Expand All @@ -96,16 +102,16 @@ def daemonize
end

[$stdout, $stderr].each do |io|
File.open(Shoryuken.options[:logfile], 'ab') do |f|
File.open(options[:logfile], 'ab') do |f|
io.reopen(f)
end
io.sync = true
end
$stdin.reopen('/dev/null')
end

def write_pid
if (path = Shoryuken.options[:pidfile])
def write_pid(options)
if (path = options[:pidfile])
File.open(path, 'w') do |f|
f.puts Process.pid
end
Expand Down
69 changes: 69 additions & 0 deletions spec/shoryuken/cli_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
require 'spec_helper'
require 'shoryuken/cli'
require 'shoryuken/launcher'

RSpec.describe Shoryuken::CLI do
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

let(:cli) { Shoryuken::CLI.instance }

before(:each) do
# make sure we do not bail
allow(cli).to receive(:exit)

# make sure we do not mess with standard streams
allow_any_instance_of(IO).to receive(:reopen)
end

describe '#run' do
let(:launcher) { instance_double('Shoryuken::Launcher') }

before(:each) do
allow(Shoryuken::Launcher).to receive(:new).and_return(launcher)
allow(launcher).to receive(:run).and_raise(Interrupt)
allow(launcher).to receive(:stop)
end

it 'does not raise' do
expect { cli.run([]) }.to_not raise_error
end

it 'daemonizes with --daemon --logfile' do
expect(cli).to receive(:celluloid_loaded?).and_return(false)
expect(Process).to receive(:daemon)
cli.run(['--daemon', '--logfile', '/dev/null'])
end

it 'does NOT daemonize with --daemon --logfile' do
expect(Process).to_not receive(:daemon)
cli.run(['--logfile', '/dev/null'])
end

it 'writes PID file with --pidfile' do
pidfile = instance_double('File')
expect(File).to receive(:open).with('/dev/null', 'w').and_yield(pidfile)
expect(pidfile).to receive(:puts).with(Process.pid)
cli.run(['--pidfile', '/dev/null'])
end
end

describe '#daemonize' do
before(:each) do
allow(cli).to receive(:celluloid_loaded?).and_return(false)
end

it 'raises if logfile is not set' do
expect { cli.send(:daemonize, daemon: true) }.to raise_error(ArgumentError)
end

it 'raises if Celluloid is already loaded' do
expect(cli).to receive(:celluloid_loaded?).and_return(true)
args = { daemon: true, logfile: '/dev/null' }
expect { cli.send(:daemonize, args) }.to raise_error(RuntimeError)
end

it 'calls Process.daemon' do
args = { daemon: true, logfile: '/dev/null' }
expect(Process).to receive(:daemon).with(true, true)
cli.send(:daemonize, args)
end
end
end