https://github.com/jekyll/jekyll
Tip revision: 50dbf1ace788e1f99ec6ddf2b3ea1d5720e5d56f authored by olivia on 25 January 2018, 18:22:48 UTC
Release :gem: 3.7.1
Release :gem: 3.7.1
Tip revision: 50dbf1a
test_commands_serve.rb
# frozen_string_literal: true
require "webrick"
require "mercenary"
require "helper"
require "httpclient"
require "openssl"
require "thread"
require "tmpdir"
class TestCommandsServe < JekyllUnitTest
def custom_opts(what)
@cmd.send(
:webrick_opts, what
)
end
def start_server(opts)
@thread = Thread.new do
merc = nil
cmd = Jekyll::Commands::Serve
Mercenary.program(:jekyll) do |p|
merc = cmd.init_with_program(p)
end
merc.execute(:serve, opts)
end
@thread.abort_on_exception = true
Jekyll::Commands::Serve.mutex.synchronize do
unless Jekyll::Commands::Serve.running?
Jekyll::Commands::Serve.run_cond.wait(Jekyll::Commands::Serve.mutex)
end
end
end
def serve(opts)
allow(Jekyll).to receive(:configuration).and_return(opts)
allow(Jekyll::Commands::Build).to receive(:process)
start_server(opts)
opts
end
context "using LiveReload" do
setup do
@temp_dir = Dir.mktmpdir("jekyll_livereload_test")
@destination = File.join(@temp_dir, "_site")
Dir.mkdir(@destination) || flunk("Could not make directory #{@destination}")
@client = HTTPClient.new
@client.connect_timeout = 5
@standard_options = {
"port" => 4000,
"host" => "localhost",
"baseurl" => "",
"detach" => false,
"livereload" => true,
"source" => @temp_dir,
"destination" => @destination,
}
site = instance_double(Jekyll::Site)
simple_page = <<-HTML.gsub(%r!^\s*!, "")
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<title>Hello World</title>
</head>
<body>
<p>Hello! I am a simple web page.</p>
</body>
</html>
HTML
File.open(File.join(@destination, "hello.html"), "w") do |f|
f.write(simple_page)
end
allow(Jekyll::Site).to receive(:new).and_return(site)
end
teardown do
capture_io do
Jekyll::Commands::Serve.shutdown
end
Jekyll::Commands::Serve.mutex.synchronize do
if Jekyll::Commands::Serve.running?
Jekyll::Commands::Serve.run_cond.wait(Jekyll::Commands::Serve.mutex)
end
end
FileUtils.remove_entry_secure(@temp_dir, true)
end
should "serve livereload.js over HTTP on the default LiveReload port" do
skip_if_windows "EventMachine support on Windows is limited"
opts = serve(@standard_options)
content = @client.get_content(
"http://#{opts["host"]}:#{opts["livereload_port"]}/livereload.js"
)
assert_match(%r!LiveReload.on!, content)
end
should "serve nothing else over HTTP on the default LiveReload port" do
skip_if_windows "EventMachine support on Windows is limited"
opts = serve(@standard_options)
res = @client.get("http://#{opts["host"]}:#{opts["livereload_port"]}/")
assert_equal(400, res.status_code)
assert_match(%r!only serves livereload.js!, res.content)
end
should "insert the LiveReload script tags" do
skip_if_windows "EventMachine support on Windows is limited"
opts = serve(@standard_options)
content = @client.get_content(
"http://#{opts["host"]}:#{opts["port"]}/#{opts["baseurl"]}/hello.html"
)
assert_match(
%r!livereload.js\?snipver=1&port=#{opts["livereload_port"]}!,
content
)
assert_match(%r!I am a simple web page!, content)
end
should "apply the max and min delay options" do
skip_if_windows "EventMachine support on Windows is limited"
opts = serve(@standard_options.merge(
"livereload_max_delay" => "1066",
"livereload_min_delay" => "3"
))
content = @client.get_content(
"http://#{opts["host"]}:#{opts["port"]}/#{opts["baseurl"]}/hello.html"
)
assert_match(%r!&mindelay=3!, content)
assert_match(%r!&maxdelay=1066!, content)
end
end
context "with a program" do
setup do
@merc = nil
@cmd = Jekyll::Commands::Serve
Mercenary.program(:jekyll) do |p|
@merc = @cmd.init_with_program(
p
)
end
Jekyll.sites.clear
allow(SafeYAML).to receive(:load_file).and_return({})
allow(Jekyll::Commands::Build).to receive(:build).and_return("")
end
teardown do
Jekyll.sites.clear
end
should "label itself" do
assert_equal(
@merc.name, :serve
)
end
should "have aliases" do
assert_includes @merc.aliases, :s
assert_includes @merc.aliases, :server
end
should "have a description" do
refute_nil(
@merc.description
)
end
should "have an action" do
refute_empty(
@merc.actions
)
end
should "not have an empty options set" do
refute_empty(
@merc.options
)
end
context "with custom options" do
should "create a default set of mimetypes" do
refute_nil custom_opts({})[
:MimeTypes
]
end
should "use user destinations" do
assert_equal "foo", custom_opts({ "destination" => "foo" })[
:DocumentRoot
]
end
should "use user port" do
# WHAT?!?!1 Over 9000? That's impossible.
assert_equal 9001, custom_opts({ "port" => 9001 })[
:Port
]
end
should "use empty directory index list when show_dir_listing is true" do
opts = { "show_dir_listing" => true }
assert custom_opts(opts)[:DirectoryIndex].empty?
end
should "keep config between build and serve" do
options = {
"config" => %w(_config.yml _development.yml),
"serving" => true,
"watch" => false, # for not having guard output when running the tests
"url" => "http://localhost:4000",
}
config = Jekyll::Configuration.from(options)
allow(Jekyll::Command).to(
receive(:configuration_from_options).with(options).and_return(config)
)
allow(Jekyll::Command).to(
receive(:configuration_from_options).with(config).and_return(config)
)
expect(Jekyll::Commands::Build).to(
receive(:process).with(config).and_call_original
)
expect(Jekyll::Commands::Serve).to receive(:process).with(config)
@merc.execute(:serve, options)
end
context "in development environment" do
setup do
expect(Jekyll).to receive(:env).and_return("development")
expect(Jekyll::Commands::Serve).to receive(:start_up_webrick)
end
should "set the site url by default to `http://localhost:4000`" do
@merc.execute(:serve, { "watch" => false, "url" => "https://jekyllrb.com/" })
assert_equal 1, Jekyll.sites.count
assert_equal "http://localhost:4000", Jekyll.sites.first.config["url"]
end
should "take `host`, `port` and `ssl` into consideration if set" do
@merc.execute(:serve, {
"watch" => false,
"host" => "example.com",
"port" => "9999",
"url" => "https://jekyllrb.com/",
"ssl_cert" => "foo",
"ssl_key" => "bar",
})
assert_equal 1, Jekyll.sites.count
assert_equal "https://example.com:9999", Jekyll.sites.first.config["url"]
end
end
context "not in development environment" do
should "not update the site url" do
expect(Jekyll).to receive(:env).and_return("production")
expect(Jekyll::Commands::Serve).to receive(:start_up_webrick)
@merc.execute(:serve, { "watch" => false, "url" => "https://jekyllrb.com/" })
assert_equal 1, Jekyll.sites.count
assert_equal "https://jekyllrb.com/", Jekyll.sites.first.config["url"]
end
end
context "verbose" do
should "debug when verbose" do
assert_equal custom_opts({ "verbose" => true })[:Logger].level, 5
end
should "warn when not verbose" do
assert_equal custom_opts({})[:Logger].level, 3
end
end
context "enabling SSL" do
should "raise if enabling without key or cert" do
assert_raises RuntimeError do
custom_opts({
"ssl_key" => "foo",
})
end
assert_raises RuntimeError do
custom_opts({
"ssl_key" => "foo",
})
end
end
should "allow SSL with a key and cert" do
expect(OpenSSL::PKey::RSA).to receive(:new).and_return("c2")
expect(OpenSSL::X509::Certificate).to receive(:new).and_return("c1")
allow(File).to receive(:read).and_return("foo")
result = custom_opts({
"ssl_cert" => "foo",
"source" => "bar",
"enable_ssl" => true,
"ssl_key" => "bar",
})
assert result[:SSLEnable]
assert_equal result[:SSLPrivateKey ], "c2"
assert_equal result[:SSLCertificate], "c1"
end
end
end
should "read `configuration` only once" do
allow(Jekyll::Commands::Serve).to receive(:start_up_webrick)
expect(Jekyll).to receive(:configuration).once.and_call_original
@merc.execute(:serve, { "watch" => false })
end
end
end
