'
)
end
end
end
context 'when the book contains beta[]' do
include_context 'care admonition'
convert_single_before_context do |src|
src.write 'index.asciidoc', <<~ASCIIDOC
#{HEADER}
beta[]
Words
ASCIIDOC
end
page_context 'chapter.html' do
it 'includes the beta text' do
expect(body).to include(
'The design and code is less mature than official GA features'
)
end
end
end
context 'when the book contains experimental[]' do
include_context 'care admonition'
convert_single_before_context do |src|
src.write 'index.asciidoc', <<~ASCIIDOC
#{HEADER}
experimental[]
Words
ASCIIDOC
end
page_context 'chapter.html' do
it 'includes the experimental text' do
expect(body).to include(
'This functionality is in technical preview and may be changed or '\
'removed in a future release. Elastic will work to fix '\
'any issues, but features in technical preview are not subject to '\
'the support SLA of official GA features.'
)
end
end
end
context 'when there is a link to elastic.co' do
convert_single_before_context do |src|
src.write 'index.asciidoc', <<~ASCIIDOC
= Title
[[chapter]]
== Chapter
https://www.elastic.co/cloud/[link]
ASCIIDOC
end
page_context 'chapter.html' do
it 'contains an absolute link to www.elatic.co' do
expect(body).to include(<<~HTML.strip)
link
HTML
end
end
end
context 'for README.asciidoc' do
convert_single_before_context do |src|
root = File.expand_path('../../', __dir__)
images = ['cat.jpg', 'chunking-toc.png', 'example.svg', 'screenshot.png']
images.each do |img|
src.cp "#{root}/resources/readme/#{img}", "resources/readme/#{img}"
end
src.copy_shared_conf
txt = File.open("#{root}/README.asciidoc", 'r:UTF-8', &:read)
src.write 'index.asciidoc', txt
end
page_context 'index.html' do
it 'has the right title' do
expect(title).to eq('Docs HOWTO')
end
end
page_context '_conditions_of_use.html' do
it 'has the right title' do
expect(title).to eq('Conditions of use')
end
end
page_context 'setup.html' do
it 'has the right title' do
expect(title).to eq('Getting started')
end
end
page_context 'build.html' do
it 'has the right title' do
expect(title).to eq('Building documentation')
end
end
page_context 'asciidoc-guide.html' do
it 'has the right title' do
expect(title).to eq('Asciidoc Guide')
end
end
page_context 'images.html' do
it 'has the right title' do
expect(title).to eq('Images')
end
it 'has the cat image with a title' do
expect(body).to include <<~HTML
HTML
end
it 'has the cat image with specified width and without a title' do
expect(body).to include <<~HTML
HTML
end
it 'has the screenshot' do
expect(body).to include <<~HTML
HTML
end
end
page_context 'chunking.html' do
it 'has the right title' do
expect(title).to eq('Controlling chunking')
end
it 'has the chunking image' do
expect(body).to include <<~HTML
HTML
end
end
# NOTE: There are lots more pages but it probably isn't worth asserting
# on them too.
file_context 'snippets/1.console' do
let(:expected) do
<<~CONSOLE
GET /_search
{
"query": "foo bar"
}
CONSOLE
end
it 'has the right content' do
expect(contents).to eq(expected)
end
end
file_context 'resources/readme/cat.jpg'
file_context 'resources/readme/chunking-toc.png'
file_context 'resources/readme/screenshot.png'
end
context 'for a book with console alternatives' do
def self.index
<<~ASCIIDOC
= Title
[[chapter]]
== Chapter
#{ConsoleExamples::README_LIKE}
ASCIIDOC
end
convert_before do |src, dest|
repo = src.repo 'src'
from = repo.write 'index.asciidoc', index
repo.commit 'commit outstanding'
# Points java to a directory without any examples so we can report that.
convert = dest.prepare_convert_single(from, '.')
.alternatives(
'console', 'js', "#{__dir__}/../readme_examples/js"
)
.alternatives(
'console', 'csharp',
"#{__dir__}/../readme_examples/csharp"
)
.alternatives('console', 'java', "#{__dir__}/helper")
convert.convert
end
include_examples 'README-like console alternatives', 'raw', '.'
end
context 'for a book with an -extra-title-page.html file' do
INDEX_BODY = <<~ASCIIDOC
= Title
[[section]]
== Section
ASCIIDOC
context 'single page' do
def self.setup(index_name)
convert_before do |src, dest|
repo = src.repo 'src'
from = repo.write index_name, INDEX_BODY
repo.write 'index-extra-title-page.html', '
Figure 1. A scaredy cat
extra!
' repo.commit 'commit outstanding' dest.prepare_convert_single(from, '.').single.convert end end shared_examples 'has the extra' do file_context 'raw/index.html' do it 'contains the extra title page' do expect(contents).to include("\n
")
end
end
end
context 'when the index is .adoc' do
setup 'index.adoc'
include_examples 'has the extra'
end
context 'when the index is .asciidoc' do
setup 'index.asciidoc'
include_examples 'has the extra'
end
context 'when the index is .x.asciidoc' do
setup 'index.x.asciidoc'
include_examples 'has the extra'
end
end
context 'multipage' do
convert_before do |src, dest|
repo = src.repo 'src'
from = repo.write 'index.adoc', INDEX_BODY
repo.write 'index-extra-title-page.html', 'extra!
\nextra!
' repo.commit 'commit outstanding' dest.prepare_convert_single(from, '.').convert end file_context 'raw/index.html' do it 'contains the extra title page' do expect(contents).to include("\n
")
end
it 'still contains the TOC' do
expect(contents).to include('START_TOC')
expect(contents).to include('extra!
\n')
end
end
file_context 'raw/section.html' do
it "doesn't contain the extra title page" do
expect(contents).not_to include("
\n
")
end
end
end
end
context 'for a book with a -custom-title-page.html file' do
INDEX_BODY = <<~ASCIIDOC
= Title
[[section]]
== Section
ASCIIDOC
context 'built as a single page' do
convert_before do |src, dest|
repo = src.repo 'src'
from = repo.write 'index.asciidoc', INDEX_BODY
repo.write 'index-custom-title-page.html', 'extra!
\nMy Custom Header
' repo.commit 'commit outstanding' dest.prepare_convert_single(from, '.') .single.convert(expect_failure: true) end it 'prints an error message about being incompatible' do expect(outputs[0]).to include(<<~LOG.strip) Using a custom title page is incompatible with --single LOG end end context 'multipage' do convert_before do |src, dest| repo = src.repo 'src' from = repo.write 'index.adoc', INDEX_BODY repo.write 'index-custom-title-page.html', 'My Custom Header
' repo.commit 'commit outstanding' dest.prepare_convert_single(from, '.').convert end file_context 'raw/index.html' do it 'contains the custom header' do expect(contents).to include('My Custom Header
') end it 'does not contain the table of contents' do expect(contents).not_to include('START_TOC') expect(contents).not_to include('')
end
end
file_context 'raw/section.html' do
it 'does not contain the custom header' do
expect(contents).not_to include('My Custom Header')
end
end
end
context 'and a -extra-title-page.html file' do
convert_before do |src, dest|
repo = src.repo 'src'
from = repo.write 'index.adoc', INDEX_BODY
repo.write 'index-custom-title-page.html', '
My Custom Header
' repo.write 'index-extra-title-page.html', 'My Extra Header
' repo.commit 'commit outstanding' dest.prepare_convert_single(from, '.').convert(expect_failure: true) end it 'prints an error about both files existing' do expect(outputs[0]).to include(<<~LOG.strip) Cannot have both custom and extra title pages for the same source file LOG end end end context 'for a book with page-header.html' do context 'single page' do convert_before do |src, dest| repo = src.repo 'src' from = repo.write 'index.adoc', <<~ASCIIDOC = Title [[section]] == Section Words. ASCIIDOC repo.write 'page_header.html', 'header
' repo.commit 'commit outstanding' dest.prepare_convert_single(from, '.').single.convert end file_context 'raw/index.html' do it 'should contain the header' do expect(contents).to include 'header
' end end end context 'multipage' do convert_before do |src, dest| repo = src.repo 'src' from = repo.write 'index.adoc', <<~ASCIIDOC = Title [[section]] == Section Words. ASCIIDOC repo.write 'page_header.html', 'header
' repo.commit 'commit outstanding' dest.prepare_convert_single(from, '.').convert end file_context 'raw/index.html' do it 'should contain the header' do expect(contents).to include 'header
' end end file_context 'raw/section.html' do it 'should contain the header' do expect(contents).to include 'header
' end end end context 'with chinese text' do # We've failed in the past on Chinese text with encoding issues. convert_before do |src, dest| repo = src.repo 'src' from = repo.write 'index.adoc', <<~ASCIIDOC = Title [[section]] == Section Words. ASCIIDOC repo.write 'page_header.html', '请注意
' repo.commit 'commit outstanding' dest.prepare_convert_single(from, '.').convert end file_context 'raw/index.html' do it 'should contain the header' do expect(contents).to include '请注意
' end end file_context 'raw/section.html' do it 'should contain the header' do expect(contents).to include '请注意
' end end end end context 'for a book that uses {source_branch}' do INDEX = <<~ASCIIDOC = Title [[chapter]] == Chapter The branch is {source_branch}. ASCIIDOC def self.convert_with_source_branch_before_context(branch) convert_single_before_context do |src| unless branch == 'master' src.write 'dummy', 'needed so git is ok with switching branches' src.commit 'dummy' src.switch_to_new_branch branch end src.write 'index.asciidoc', INDEX end end shared_examples 'contains branch' do |branch| page_context 'chapter.html' do it 'contains the branch name' do expect(body).to include("The branch is #{branch}.") end end end context 'when the branch is master' do convert_with_source_branch_before_context 'master' include_examples 'contains branch', 'master' end context 'when the branch is 7.x' do convert_with_source_branch_before_context '7.x' include_examples 'contains branch', '7.x' end context 'when the branch is 1.5' do convert_with_source_branch_before_context '1.5' include_examples 'contains branch', '1.5' end context 'when the branch is 18.5' do convert_with_source_branch_before_context '18.5' include_examples 'contains branch', '18.5' end context 'when the branch is some_crazy_thing' do convert_with_source_branch_before_context 'some_crazy_thing' include_examples 'contains branch', 'master' end context 'when the branch is some_crazy_thing_7.x' do convert_with_source_branch_before_context 'some_crazy_thing_7.x' include_examples 'contains branch', '7.x' end context 'when the branch is some_crazy_thing_7_x' do convert_with_source_branch_before_context 'some_crazy_thing_7_x' include_examples 'contains branch', '7_x' end end context 'when run with --open' do include_context 'source and dest' before(:context) do repo = @src.repo_with_index 'repo', 'Words' @opened_docs = @dest.prepare_convert_single("#{repo.root}/index.asciidoc", '.').open end after(:context) do @opened_docs.exit end let(:root) { 'http://localhost:8000/guide' } let(:static) { "#{root}/static" } let(:index) { Net::HTTP.get_response(URI("#{root}/index.html")) } let(:air_gapped_index) do uri = URI("#{root}/index.html") req = Net::HTTP::Get.new(uri) req['Host'] = 'gapped.localhost' Net::HTTP.start(uri.hostname, uri.port, read_timeout: 20) do |http| http.request(req) end end let(:toc) { Net::HTTP.get_response(URI("#{root}/toc.html")) } let(:js) do Net::HTTP.get_response(URI("#{static}/docs-v1.js")) end let(:jquery) do Net::HTTP.get_response(URI("#{static}/jquery.js")) end let(:css) do Net::HTTP.get_response(URI("#{static}/styles-v1.css")) end include_examples 'the root' include_examples 'the favicon' context 'the index' do context 'when not air gapped' do it 'contains the gtag js' do expect(index).to serve(include(<<~HTML.strip)) https://www.googletagmanager.com/gtag/js HTML end it 'serves the chapter header' do expect(index).to serve(doc_body(include(<<~HTML.strip))) Chapter HTML end end context 'when air gapped' do it "doesn't contain the gtag js" do expect(air_gapped_index).not_to serve(include(<<~HTML.strip)) https://www.googletagmanager.com/gtag/js HTML end it 'serves the chapter header' do expect(air_gapped_index).to serve(doc_body(include(<<~HTML.strip))) Chapter HTML end end end context 'the table of contents' do it "isn't templated" do expect(toc).to serve(start_with(''))
end
end
context 'the js' do
it 'is unminified' do
expect(js).to serve(include(<<~JS))
// Test comment used to detect unminifed JS in tests
JS
end
it 'include hot module replacement for the css' do
expect(js).to serve(include(<<~JS))
// Setup hot module replacement for css if we're in dev mode.
JS
end
it 'includes a source map' do
expect(js).to serve(include('sourceMappingURL='))
end
end
context 'jquery' do
it 'is unminified' do
# This comment is a little brittle to detect but I don't expect us to
# rely on jquery forever.
expect(jquery).to serve(include(<<~JS))
Includes Sizzle.js
JS
end
it "doesn't include a source map" do
expect(jquery).not_to serve(include('sourceMappingURL='))
end
end
context 'the css' do
it 'is unminified' do
expect(css).to serve(include(<<~CSS))
/* test comment used to detect unminified source */
CSS
end
it 'includes a source map' do
expect(css).to serve(include('sourceMappingURL='))
end
end
end
##
# When you point `build_docs` to a worktree it doesn't properly share the
# worktree's parent into the docker container. This test simulates *that*.
context 'when building a book in a worktree without its parent' do
convert_before do |src, dest|
repo = src.repo_with_index 'src', <<~ASCIIDOC
I am in a worktree.
ASCIIDOC
worktree = src.path 'worktree'
repo.create_worktree worktree, 'HEAD'
FileUtils.rm_rf repo.root
dest.prepare_convert_single("#{worktree}/index.asciidoc", '.')
.convert
end
page_context 'chapter.html' do
it 'complains about not being able to find the repo toplevel' do
expect(outputs[0]).to include("Couldn't find repo toplevel for /tmp/")
end
it 'has the worktree text' do
expect(body).to include('I am in a worktree.')
end
end
end
context 'when a book contains migration warnings' do
shared_context 'convert with migration warnings' do |suppress|
convert_before do |src, dest|
repo = src.repo_with_index 'src', <<~ASCIIDOC
--------
CODE HERE
----
ASCIIDOC
c = dest.prepare_convert_single("#{repo.root}/index.asciidoc", '.')
c.suppress_migration_warnings if suppress
c.convert(expect_failure: !suppress)
end
end
context 'and they are not suppressed' do
include_context 'convert with migration warnings', false
it 'fails with an appropriate error status' do
expect(statuses[0]).to eq(255)
end
it 'complains about the MIGRATION warning' do
expect(outputs[0]).to include(<<~LOG)
asciidoctor: WARNING: index.asciidoc: line 7: MIGRATION: code block end doesn't match start
LOG
end
end
context 'and they are suppressed' do
include_context 'convert with migration warnings', true
it "doesn't complain about the MIGRATION warning" do
expect(outputs[0]).not_to include(<<~LOG)
asciidoctor: WARNING: index.asciidoc: line 7: MIGRATION: code block end doesn't match start
LOG
end
page_context 'chapter.html' do
it 'contains the snippet' do
expect(body).to include('CODE HERE')
end
end
end
end
context 'when an included file is missing' do
convert_before do |src, dest|
repo = src.repo_with_index 'src', <<~ASCIIDOC
include::missing.asciidoc[]
ASCIIDOC
dest.prepare_convert_single("#{repo.root}/index.asciidoc", '.')
.convert(expect_failure: true)
end
it 'fails with an appropriate error status' do
expect(statuses[0]).to eq(255)
end
it 'logs the missing file' do
expect(outputs[0]).to include(<<~LOG.strip)
ERROR: index.asciidoc: line 5: include file not found: #{@src.repo('src').root}/missing.asciidoc
LOG
end
end
context 'when a referenced id is missing' do
convert_before do |src, dest|
repo = src.repo_with_index 'src', <<~ASCIIDOC
<>
ASCIIDOC
dest.prepare_convert_single("#{repo.root}/index.asciidoc", '.')
.convert(expect_failure: true)
end
it 'fails with an appropriate error status' do
expect(statuses[0]).to eq(255)
end
it 'logs the file that contains the missing include' do
expect(outputs[0]).to include(<<~LOG.strip)
asciidoctor: WARNING: invalid reference: missing-ref
LOG
end
end
end