# frozen_string_literal: true require 'spec_helper' RSpec.describe MarkupHelper do let_it_be(:project) { create(:project, :repository) } let_it_be(:user) do user = create(:user, username: 'gfm') project.add_maintainer(user) user end let_it_be(:issue) { create(:issue, project: project) } let_it_be(:merge_request) { create(:merge_request, source_project: project, target_project: project) } let_it_be(:snippet) { create(:project_snippet, project: project) } let(:commit) { project.commit } before do # Helper expects a @project instance variable helper.instance_variable_set(:@project, project) # Stub the `current_user` helper allow(helper).to receive(:current_user).and_return(user) end describe "#markdown" do describe "referencing multiple objects" do let(:actual) { "#{merge_request.to_reference} -> #{commit.to_reference} -> #{issue.to_reference}" } it "links to the merge request" do expected = urls.project_merge_request_path(project, merge_request) expect(helper.markdown(actual)).to match(expected) end it "links to the commit" do expected = urls.project_commit_path(project, commit) expect(helper.markdown(actual)).to match(expected) end it "links to the issue" do expected = urls.project_issue_path(project, issue) expect(helper.markdown(actual)).to match(expected) end end describe "override default project" do let(:actual) { issue.to_reference } let_it_be(:second_project) { create(:project, :public) } let_it_be(:second_issue) { create(:issue, project: second_project) } it 'links to the issue' do expected = urls.project_issue_path(second_project, second_issue) expect(markdown(actual, project: second_project)).to match(expected) end end describe 'uploads' do let(:text) { "![ImageTest](/uploads/test.png)" } let_it_be(:group) { create(:group) } subject { helper.markdown(text) } describe 'inside a project' do it 'renders uploads relative to project' do expect(subject).to include("#{project.full_path}/uploads/test.png") end end describe 'inside a group' do before do helper.instance_variable_set(:@group, group) helper.instance_variable_set(:@project, nil) end it 'renders uploads relative to the group' do expect(subject).to include("#{group.full_path}/-/uploads/test.png") end end describe "with a group in the context" do let_it_be(:project_in_group) { create(:project, group: group) } before do helper.instance_variable_set(:@group, group) helper.instance_variable_set(:@project, project_in_group) end it 'renders uploads relative to project' do expect(subject).to include("#{project_in_group.path_with_namespace}/uploads/test.png") end end end context 'when text contains a relative link to an image in the repository' do let(:image_file) { "logo-white.png" } let(:text_with_relative_path) { "![](./#{image_file})\n" } let(:generated_html) { helper.markdown(text_with_relative_path, requested_path: requested_path, ref: ref) } subject { Nokogiri::HTML.parse(generated_html) } context 'when requested_path is provided, but ref isn\'t' do let(:requested_path) { 'files/images/README.md' } let(:ref) { nil } it 'returns the correct HTML for the image' do expanded_path = "/#{project.full_path}/-/raw/master/files/images/#{image_file}" expect(subject.css('a')[0].attr('href')).to eq(expanded_path) expect(subject.css('img')[0].attr('data-src')).to eq(expanded_path) end end context 'when requested_path and ref parameters are both provided' do let(:requested_path) { 'files/images/README.md' } let(:ref) { 'other_branch' } it 'returns the correct HTML for the image' do project.repository.create_branch('other_branch') expanded_path = "/#{project.full_path}/-/raw/#{ref}/files/images/#{image_file}" expect(subject.css('a')[0].attr('href')).to eq(expanded_path) expect(subject.css('img')[0].attr('data-src')).to eq(expanded_path) end end context 'when ref is provided, but requested_path isn\'t' do let(:ref) { 'other_branch' } let(:requested_path) { nil } it 'returns the correct HTML for the image' do project.repository.create_branch('other_branch') expanded_path = "/#{project.full_path}/-/blob/#{ref}/./#{image_file}" expect(subject.css('a')[0].attr('href')).to eq(expanded_path) expect(subject.css('img')[0].attr('data-src')).to eq(expanded_path) end end context 'when neither requested_path, nor ref parameter is provided' do let(:ref) { nil } let(:requested_path) { nil } it 'returns the correct HTML for the image' do expanded_path = "/#{project.full_path}/-/blob/master/./#{image_file}" expect(subject.css('a')[0].attr('href')).to eq(expanded_path) expect(subject.css('img')[0].attr('data-src')).to eq(expanded_path) end end end end describe '#markdown_field' do let(:attribute) { :title } describe 'with already redacted attribute' do it 'returns the redacted attribute' do commit.redacted_title_html = 'commit title' expect(Banzai).not_to receive(:render_field) expect(helper.markdown_field(commit, attribute)).to eq('commit title') end end describe 'without redacted attribute' do it 'renders the markdown value' do expect(Banzai).to receive(:render_field).with(commit, attribute, {}).and_call_original expect(Banzai).to receive(:post_process) helper.markdown_field(commit, attribute) end end context 'when post_process is false' do it 'does not run Markdown post processing' do expect(Banzai).to receive(:render_field).with(commit, attribute, {}).and_call_original expect(Banzai).not_to receive(:post_process) helper.markdown_field(commit, attribute, post_process: false) end end end describe '#link_to_markdown_field' do let(:link) { '/commits/0a1b2c3d' } let(:issues) { create_list(:issue, 2, project: project) } # Clean the cache to make sure the title is re-rendered from the stubbed one it 'handles references nested in links with all the text', :clean_gitlab_redis_cache do allow(commit).to receive(:title).and_return("This should finally fix #{issues[0].to_reference} and #{issues[1].to_reference} for real") actual = helper.link_to_markdown_field(commit, :title, link) doc = Nokogiri::HTML.parse(actual) # Make sure we didn't create invalid markup expect(doc.errors).to be_empty # Leading commit link expect(doc.css('a')[0].attr('href')).to eq link expect(doc.css('a')[0].text).to eq 'This should finally fix ' # First issue link expect(doc.css('a')[1].attr('href')) .to eq urls.project_issue_path(project, issues[0]) expect(doc.css('a')[1].text).to eq issues[0].to_reference # Internal commit link expect(doc.css('a')[2].attr('href')).to eq link expect(doc.css('a')[2].text).to eq ' and ' # Second issue link expect(doc.css('a')[3].attr('href')) .to eq urls.project_issue_path(project, issues[1]) expect(doc.css('a')[3].text).to eq issues[1].to_reference # Trailing commit link expect(doc.css('a')[4].attr('href')).to eq link expect(doc.css('a')[4].text).to eq ' for real' end end describe '#link_to_markdown' do let(:link) { '/commits/0a1b2c3d' } let(:issues) { create_list(:issue, 2, project: project) } it 'handles references nested in links with all the text' do actual = helper.link_to_markdown("This should finally fix #{issues[0].to_reference} and #{issues[1].to_reference} for real", link) doc = Nokogiri::HTML.parse(actual) # Make sure we didn't create invalid markup expect(doc.errors).to be_empty # Leading commit link expect(doc.css('a')[0].attr('href')).to eq link expect(doc.css('a')[0].text).to eq 'This should finally fix ' # First issue link expect(doc.css('a')[1].attr('href')) .to eq urls.project_issue_path(project, issues[0]) expect(doc.css('a')[1].text).to eq issues[0].to_reference # Internal commit link expect(doc.css('a')[2].attr('href')).to eq link expect(doc.css('a')[2].text).to eq ' and ' # Second issue link expect(doc.css('a')[3].attr('href')) .to eq urls.project_issue_path(project, issues[1]) expect(doc.css('a')[3].text).to eq issues[1].to_reference # Trailing commit link expect(doc.css('a')[4].attr('href')).to eq link expect(doc.css('a')[4].text).to eq ' for real' end it 'forwards HTML options' do actual = helper.link_to_markdown("Fixed in #{commit.id}", link, class: 'foo') doc = Nokogiri::HTML.parse(actual) expect(doc.css('a')).to satisfy do |v| # 'foo' gets added to all links v.all? { |a| a.attr('class').match(/foo$/) } end end it "escapes HTML passed in as the body" do actual = "This is a

test

- see #{issues[0].to_reference}" expect(helper.link_to_markdown(actual, link)) .to match('<h1>test</h1>') end it 'ignores reference links when they are the entire body' do text = issues[0].to_reference act = helper.link_to_markdown(text, '/foo') expect(act).to eq %Q(#{issues[0].to_reference}) end it 'replaces commit message with emoji to link' do actual = link_to_markdown(':book: Book', '/foo') expect(actual) .to eq '📖 Book' end end describe '#link_to_html' do it 'wraps the rendered content in a link' do link = '/commits/0a1b2c3d' issue = create(:issue, project: project) rendered = helper.markdown("This should finally fix #{issue.to_reference} for real", pipeline: :single_line) doc = Nokogiri::HTML.parse(rendered) expect(doc.css('a')[0].attr('href')) .to eq urls.project_issue_path(project, issue) expect(doc.css('a')[0].text).to eq issue.to_reference wrapped = helper.link_to_html(rendered, link) doc = Nokogiri::HTML.parse(wrapped) expect(doc.css('a')[0].attr('href')).to eq link expect(doc.css('a')[0].text).to eq 'This should finally fix ' end it "escapes HTML passed as an emoji" do rendered = '<div class="test">test</div>' expect(helper.link_to_html(rendered, '/foo')) .to eq '<div class="test">test</div>' end end describe '#render_wiki_content' do let(:wiki) { build(:wiki, container: project) } let(:content) { 'wiki content' } let(:slug) { 'nested/page' } let(:path) { "file.#{extension}" } let(:wiki_page) { double('WikiPage', path: path, content: content, slug: slug, wiki: wiki) } let(:context) do { pipeline: :wiki, project: project, wiki: wiki, page_slug: slug, issuable_reference_expansion_enabled: true, repository: wiki.repository, requested_path: path } end context 'when file is Markdown' do let(:extension) { 'md' } it 'renders using #markdown_unsafe helper method' do expect(helper).to receive(:markdown_unsafe).with('wiki content', context) helper.render_wiki_content(wiki_page) end context 'when context has labels' do let_it_be(:label) { create(:label, title: 'Bug', project: project) } let(:content) { '~Bug' } it 'renders label' do result = helper.render_wiki_content(wiki_page) doc = Nokogiri::HTML.parse(result) expect(doc.css('.gl-label-link')).not_to be_empty end end context 'when content has uploads' do let(:upload_link) { '/uploads/test.png' } let(:content) { "![ImageTest](#{upload_link})" } before do allow(wiki).to receive(:wiki_base_path).and_return(project.wiki.wiki_base_path) end it 'renders uploads relative to project' do result = helper.render_wiki_content(wiki_page) expect(result).to include("#{project.full_path}#{upload_link}") end end end context 'when file is Asciidoc' do let(:extension) { 'adoc' } it 'renders using Gitlab::Asciidoc' do expect(Gitlab::Asciidoc).to receive(:render) helper.render_wiki_content(wiki_page) end end context 'when file is Kramdown' do let(:extension) { 'rmd' } let(:content) do <<-EOF {::options parse_block_html="true" /}
FooBar
EOF end it 'renders using #markdown_unsafe helper method' do expect(helper).to receive(:markdown_unsafe).with(content, context) result = helper.render_wiki_content(wiki_page) expect(result).to be_empty end end context 'any other format' do let(:extension) { 'foo' } it 'renders all other formats using Gitlab::OtherMarkup' do expect(Gitlab::OtherMarkup).to receive(:render) helper.render_wiki_content(wiki_page) end end end describe '#markup' do let(:content) { 'Noël' } it 'sets the :text_source to :blob in the context' do context = {} helper.markup('foo.md', content, context) expect(context).to include(text_source: :blob) end it 'preserves encoding' do expect(content.encoding.name).to eq('UTF-8') expect(helper.markup('foo.rst', content).encoding.name).to eq('UTF-8') end it 'delegates to #markdown_unsafe when file name corresponds to Markdown' do expect(Gitlab::MarkupHelper).to receive(:gitlab_markdown?).with('foo.md').and_return(true) expect(helper).to receive(:markdown_unsafe).and_return('NOEL') expect(helper.markup('foo.md', content)).to eq('NOEL') end it 'delegates to #asciidoc_unsafe when file name corresponds to AsciiDoc' do expect(Gitlab::MarkupHelper).to receive(:asciidoc?).with('foo.adoc').and_return(true) expect(helper).to receive(:asciidoc_unsafe).and_return('NOEL') expect(helper.markup('foo.adoc', content)).to eq('NOEL') end it 'uses passed in rendered content' do expect(Gitlab::MarkupHelper).not_to receive(:gitlab_markdown?) expect(helper).not_to receive(:markdown_unsafe) expect(helper.markup('foo.md', content, rendered: '

NOEL

')).to eq('

NOEL

') end it 'defaults to CommonMark' do expect(helper.markup('foo.md', 'x^2')).to include('x^2') end end describe '#markup_unsafe' do subject { helper.markup_unsafe(file_name, text, context) } let_it_be(:project_base) { create(:project, :repository) } let_it_be(:context) { { project: project_base } } let(:file_name) { 'foo.bar' } let(:text) { 'Noël' } context 'when text is missing' do let(:text) { nil } it 'returns an empty string' do is_expected.to eq('') end end context 'when rendering takes too long' do before do stub_const("MarkupHelper::RENDER_TIMEOUT", 0.1) allow(Gitlab::OtherMarkup).to receive(:render) { sleep(0.2) } end it 'times out' do expect(Gitlab::RenderTimeout).to receive(:timeout).and_call_original expect(Gitlab::ErrorTracking).to receive(:track_exception).with( instance_of(Timeout::Error), project_id: project.id, file_name: file_name ) subject end context 'when markup_rendering_timeout is disabled' do it 'waits until the execution completes' do stub_feature_flags(markup_rendering_timeout: false) expect(Gitlab::RenderTimeout).not_to receive(:timeout) subject end end end context 'when file is a markdown file' do let(:file_name) { 'foo.md' } it 'returns html (rendered by Banzai)' do expected_html = '

Noël

' expect(Banzai).to receive(:render).with(text, context) { expected_html } is_expected.to eq(expected_html) end context 'when renderer returns an error' do before do allow(Banzai).to receive(:render).and_raise(StandardError, "An error") end it 'returns html (rendered by ActionView:TextHelper)' do is_expected.to eq('

Noël

') end it 'logs the error' do expect(Gitlab::ErrorTracking).to receive(:track_exception).with( instance_of(StandardError), project_id: project.id, file_name: 'foo.md' ) subject end end end context 'when file is asciidoc file' do let(:file_name) { 'foo.adoc' } it 'returns html (rendered by Gitlab::Asciidoc)' do expected_html = "
\n

Noël

\n
" expect(Gitlab::Asciidoc).to receive(:render).with(text, context) { expected_html } is_expected.to eq(expected_html) end end context 'when file is a regular text file' do let(:file_name) { 'foo.txt' } it 'returns html (rendered by ActionView::TagHelper)' do is_expected.to eq('
Noël
') end end context 'when file has an unknown type' do let(:file_name) { 'foo.tex' } it 'returns html (rendered by Gitlab::OtherMarkup)' do expected_html = 'Noël' expect(Gitlab::OtherMarkup).to receive(:render).with(file_name, text, context) { expected_html } is_expected.to eq(expected_html) end end end describe '#first_line_in_markdown' do shared_examples_for 'common markdown examples' do let(:project_base) { build(:project, :repository) } it 'displays the first line of a code block' do object = create_object("```\nCode block\nwith two lines\n```") expected = %r{Code block\.\.\.\n} expect(first_line_in_markdown(object, attribute, 100, project: project)).to match(expected) end it 'truncates a single long line of text' do text = 'The quick brown fox jumped over the lazy dog twice' # 50 chars object = create_object(text * 4) expected = (text * 2).sub(/.{3}/, '...') expect(first_line_in_markdown(object, attribute, 150, project: project)).to match(expected) end it 'preserves code color scheme' do object = create_object("```ruby\ndef test\n 'hello world'\nend\n```") expected = "\n
" \
          "def test...\n" \
          "
\n" expect(first_line_in_markdown(object, attribute, 150, project: project)).to eq(expected) end context 'when images are allowed' do it 'preserves data-src for lazy images' do object = create_object("![ImageTest](/uploads/test.png)") image_url = "data-src=\".*/uploads/test.png\"" text = first_line_in_markdown(object, attribute, 150, project: project, allow_images: true) expect(text).to match(image_url) expect(text).to match('