# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import markdown
import mock
from allura.lib import markdown_extensions as mde
from tg import config as tg_config
class TestTracRef1:
@mock.patch('allura.lib.markdown_extensions.M.Shortlink.lookup')
def test_no_such_artifact(self, lookup):
lookup.return_value = None
assert mde.TracRef1().sub('#100') == '#100'
def test_skip_if_brackets(self):
assert mde.TracRef1().sub('[#100]') == '[#100]'
assert mde.TracRef1().sub('[r123]') == '[r123]'
def test_word_boundaries(self):
assert mde.TracRef1().sub('foo#100') == 'foo#100'
assert mde.TracRef1().sub('r123bar') == 'r123bar'
@mock.patch('allura.lib.markdown_extensions.M.Shortlink.lookup')
def test_legit_refs(self, lookup):
shortlink = mock.Mock(url='/p/project/tool/artifact')
shortlink.ref.artifact.deleted = False
lookup.return_value = shortlink
assert mde.TracRef1().sub('#100') == '[#100](/p/project/tool/artifact)'
assert mde.TracRef1().sub('r123') == '[r123](/p/project/tool/artifact)'
class TestTracRef2:
@mock.patch('allura.lib.markdown_extensions.M.Shortlink.lookup')
def test_no_such_artifact(self, lookup):
lookup.return_value = None
assert mde.TracRef2().sub('ticket:100') == 'ticket:100'
def test_word_boundaries(self):
assert mde.TracRef2().sub('myticket:100') == 'myticket:100'
assert mde.TracRef2().sub('ticket:100th') == 'ticket:100th'
@mock.patch('allura.lib.markdown_extensions.M.Shortlink.lookup')
def test_legit_refs(self, lookup):
shortlink = mock.Mock(url='/p/project/tool/artifact/')
shortlink.ref.artifact.deleted = False
lookup.return_value = shortlink
pattern = mde.TracRef2()
pattern.get_comment_slug = lambda *args: 'abc'
assert pattern.sub('ticket:100') == '[ticket:100](/p/project/tool/artifact/)'
assert pattern.sub('[ticket:100]') == '[[ticket:100](/p/project/tool/artifact/)]'
assert pattern.sub('comment:13:ticket:100') == '[comment:13:ticket:100](/p/project/tool/artifact/#abc)'
pattern.get_comment_slug = lambda *args: None
assert pattern.sub('comment:13:ticket:100') == '[comment:13:ticket:100](/p/project/tool/artifact/)'
class TestTracRef3:
def test_no_app_context(self):
assert mde.TracRef3(None).sub('source:file.py') == 'source:file.py'
def test_legit_refs(self):
app = mock.Mock(url='/p/project/tool/')
assert mde.TracRef3(app).sub('source:file.py') == '[source:file.py](/p/project/tool/HEAD/tree/file.py)'
assert mde.TracRef3(app).sub('source:file.py@123') == '[source:file.py@123](/p/project/tool/123/tree/file.py)'
assert mde.TracRef3(app).sub('source:file.py@123#L456') == '[source:file.py@123#L456](/p/project/tool/123/tree/file.py#l456)'
assert mde.TracRef3(app).sub('source:file.py#L456') == '[source:file.py#L456](/p/project/tool/HEAD/tree/file.py#l456)'
class TestRelativeLinkRewriter:
@mock.patch.dict(tg_config, {'nofollow_exempt_domains': '', 'domain': 'example.com'})
def test_rewrite(self):
rewriter = mde.RelativeLinkRewriter()
# curent directory link
res = rewriter.run('# README <a href="trunk/docs/EXTENSIONS.md">README</a>')
assert './trunk/docs/EXTENSIONS.md' in res
# parent link
res = rewriter.run('# README <a href="../trunk/docs/EXTENSIONS.md">README</a>')
assert '../trunk/docs/EXTENSIONS.md' in res
# child child to parent link
res = rewriter.run('# README <a href="../../docs/EXTENSIONS.md">README</a>')
assert '# README <a href="../../docs/EXTENSIONS.md">README</a>' == res
res = rewriter.run('# README <a href="https://foo.com">README</a>')
assert 'https://foo.com' in res
assert './' not in res
res = rewriter.run('# README <a href="mailto:foo@bar.com">README</a>')
assert 'mailto:' in res
class TestPatternReplacingProcessor:
@mock.patch('allura.lib.markdown_extensions.M.Shortlink.lookup')
def test_run(self, lookup):
shortlink = mock.Mock(url='/p/project/tool/artifact')
shortlink.ref.artifact.deleted = False
lookup.return_value = shortlink
p = mde.PatternReplacingProcessor(mde.TracRef1(), mde.TracRef2())
res = p.run(['#100', 'ticket:100'])
assert res == [
'[#100](/p/project/tool/artifact)',
'[ticket:100](/p/project/tool/artifact)']
class TestCommitMessageExtension:
@mock.patch('allura.lib.markdown_extensions.TracRef2.get_comment_slug')
@mock.patch('allura.lib.markdown_extensions.M.Shortlink.lookup')
def test_convert(self, lookup, get_comment_slug):
shortlink = mock.Mock(url='/p/project/tool/artifact/')
shortlink.ref.artifact.deleted = False
lookup.return_value = shortlink
get_comment_slug.return_value = 'abc'
app = mock.Mock(url='/p/project/tool/')
text = """\
# Not A Heading #
---
* #100, r2
* ticket:100
* comment:13:ticket:2
* source:test.py@2#L3
Not *strong* or _underlined_."""
expected_html = """\
<div class="markdown_content"><p># Not A Heading #<br>
---<br>
* <a href="/p/project/tool/artifact/">#100</a>, <a href="/p/project/tool/artifact/">r2</a><br>
* <a href="/p/project/tool/artifact/">ticket:100</a><br>
* <a href="/p/project/tool/artifact/#abc">comment:13:ticket:2</a><br>
* <a href="/p/project/tool/2/tree/test.py#l3">source:test.py@2#L3</a></p>
<p>Not *strong* or _underlined_.</div>"""
md = markdown.Markdown(
extensions=[mde.CommitMessageExtension(app), 'markdown.extensions.nl2br'],
output_format='html')
assert md.convert(text) == expected_html