1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
"""Test cases for MagicLink."""
from .. import util
import markdown
import warnings
class TestMagicLinkShortner(util.MdCase):
"""Test cases for repo link shortening."""
extension = [
'pymdownx.magiclink',
]
extension_configs = {
'pymdownx.magiclink': {
'repo_url_shortener': True
}
}
def test_user(self):
"""Test user shortening."""
# Test #! original syntax
self.check_markdown(
r'https://github.com/facelessuser',
r'<p><a class="magiclink magiclink-github magiclink-mention" href="https://github.com/facelessuser" title="GitHub User: facelessuser">@facelessuser</a></p>' # noqa: E501
)
def test_repo(self):
"""Test repository shortening."""
# Test #! original syntax
self.check_markdown(
r'https://github.com/facelessuser/pymdown-extensions',
r'<p><a class="magiclink magiclink-github magiclink-repository" href="https://github.com/facelessuser/pymdown-extensions" title="GitHub Repository: facelessuser/pymdown-extensions">facelessuser/pymdown-extensions</a></p>' # noqa: E501
)
def test_no_social(self):
"""Test that social shortening does not happen."""
self.check_markdown(
r'https://x.com/someuser',
r'<p><a href="https://x.com/someuser">https://x.com/someuser</a></p>'
)
def test_excluded_user(self):
"""Test excluded."""
self.check_markdown(
r'https://github.com/support',
r'<p><a href="https://github.com/support">https://github.com/support</a></p>'
)
def test_excluded_user_repo(self):
"""Test excluded."""
self.check_markdown(
r'https://github.com/support/repo',
r'<p><a href="https://github.com/support/repo">https://github.com/support/repo</a></p>'
)
def test_discuss(self):
"""Test discuss."""
self.check_markdown(
r'https://github.com/facelessuser/pymdown-extensions/discussions/1173',
r'<p><a class="magiclink magiclink-github magiclink-discussion" href="https://github.com/facelessuser/pymdown-extensions/discussions/1173" title="GitHub Discussion: facelessuser/pymdown-extensions #1173">facelessuser/pymdown-extensions?1173</a></p>' # noqa: E501
)
class TestMagicLinkShorthand(util.MdCase):
"""Test cases for repo link shortening."""
extension = [
'pymdownx.magiclink',
]
extension_configs = {
'pymdownx.magiclink': {
'repo_url_shorthand': True,
'user': 'facelessuser',
'repo': 'pymdown-extensions'
}
}
def test_discuss(self):
"""Test discuss."""
self.check_markdown(
r'?1173',
r'<p><a class="magiclink magiclink-github magiclink-discussion" href="https://github.com/facelessuser/pymdown-extensions/discussions/1173" title="GitHub Discussion: facelessuser/pymdown-extensions #1173">?1173</a></p>' # noqa: E501
)
def test_bad_discss(self):
"""Test repo that doesn't support discussions."""
self.check_markdown(
r'gitlab:user/repo?1173',
r'<p>gitlab:user/repo?1173</p>'
)
class TestMagicLinkExternalShorthand(util.MdCase):
"""Test cases for repo link shortening."""
extension = [
'pymdownx.magiclink',
]
extension_configs = {
'pymdownx.magiclink': {
'repo_url_shorthand': True,
'user': 'facelessuser',
'repo': 'pymdown-extensions',
'provider': 'gitlab'
}
}
def test_bad_discss(self):
"""Test repo that doesn't support discussions."""
self.check_markdown(
r'?1173',
r'<p>?1173</p>'
)
class TestMagicLinkShortnerSocial(util.MdCase):
"""Test cases for social link shortener."""
extension = [
'pymdownx.magiclink'
]
extension_configs = {
'pymdownx.magiclink': {
'social_url_shortener': True
}
}
def test_user(self):
"""Test user shortening."""
# Test #! original syntax
self.check_markdown(
r'https://x.com/someuser',
r'<p><a class="magiclink magiclink-x magiclink-mention" href="https://x.com/someuser" title="X User: someuser">@someuser</a></p>' # noqa: E501
)
def test_no_repo(self):
"""Test that repository shortening does not happen."""
self.check_markdown(
r'https://github.com/facelessuser',
r'<p><a href="https://github.com/facelessuser">https://github.com/facelessuser</a></p>'
)
def test_excluded(self):
"""Test excluded user."""
self.check_markdown(
r'https://x.com/home',
r'<p><a href="https://x.com/home">https://x.com/home</a></p>'
)
class TestMagicLinkCustom(util.MdCase):
"""Test cases for custom provider."""
extension = [
'pymdownx.magiclink',
'pymdownx.saneheaders'
]
extension_configs = {
'pymdownx.magiclink': {
'repo_url_shorthand': True,
'repo_url_shortener': True,
'user': 'facelessuser',
'repo': 'pymdown-extensions',
'provider': 'test',
'custom': {
'test': {
'host': 'http://test.com',
'label': 'Test',
'type': 'github'
}
}
}
}
def test_user(self):
"""Test user in custom repo."""
self.check_markdown(
'@facelessuser',
'<p><a class="magiclink magiclink-test magiclink-mention" href="http://test.com/facelessuser" title="Test User: facelessuser">@facelessuser</a></p>' # noqa: E501
)
def test_repo(self):
"""Test repo in custom repo."""
self.check_markdown(
'@facelessuser/pymdown-extensions',
'<p><a class="magiclink magiclink-test magiclink-repository" href="http://test.com/facelessuser/pymdown-extensions" title="Test Repository: facelessuser/pymdown-extensions">facelessuser/pymdown-extensions</a></p>' # noqa: E501
)
def test_default_issue(self):
"""Test default issue case."""
self.check_markdown(
'#2',
'<p><a class="magiclink magiclink-test magiclink-issue" href="http://test.com/facelessuser/pymdown-extensions/issues/2" title="Test Issue: facelessuser/pymdown-extensions #2">#2</a></p>' # noqa: E501
)
def test_default_pull(self):
"""Test default pull case."""
self.check_markdown(
'!2',
'<p><a class="magiclink magiclink-test magiclink-pull" href="http://test.com/facelessuser/pymdown-extensions/pull/2" title="Test Pull Request: facelessuser/pymdown-extensions #2">!2</a></p>' # noqa: E501
)
def test_default_discussion(self):
"""Test default discussion case."""
self.check_markdown(
'?2',
'<p><a class="magiclink magiclink-test magiclink-discussion" href="http://test.com/facelessuser/pymdown-extensions/discussions/2" title="Test Discussion: facelessuser/pymdown-extensions #2">?2</a></p>' # noqa: E501
)
def test_default_commit(self):
"""Test default commit case."""
self.check_markdown(
'3f6b07a8eeaa9d606115758d90f55fec565d4e2a',
'<p><a class="magiclink magiclink-test magiclink-commit" href="http://test.com/facelessuser/pymdown-extensions/commit/3f6b07a8eeaa9d606115758d90f55fec565d4e2a" title="Test Commit: facelessuser/pymdown-extensions@3f6b07a">3f6b07a</a></p>' # noqa: E501
)
def test_default_compare(self):
"""Test default compare case."""
self.check_markdown(
'e2ed7e0b3973f3f9eb7a26b8ef7ae514eebfe0d2...90b6fb8711e75732f987982cc024e9bb0111beac',
'<p><a class="magiclink magiclink-test magiclink-compare" href="http://test.com/facelessuser/pymdown-extensions/compare/e2ed7e0b3973f3f9eb7a26b8ef7ae514eebfe0d2...90b6fb8711e75732f987982cc024e9bb0111beac" title="Test Compare: facelessuser/pymdown-extensions@e2ed7e0...90b6fb8">e2ed7e0...90b6fb8</a></p>' # noqa: E501
)
def test_user_link(self):
"""Test user link."""
self.check_markdown(
'http://test.com/facelessuser',
'<p><a class="magiclink magiclink-test magiclink-mention" href="http://test.com/facelessuser" title="Test User: facelessuser">@facelessuser</a></p>' # noqa: E501
)
def test_repo_link(self):
"""Test repository link."""
self.check_markdown(
'http://test.com/facelessuser/pymdown-extensions',
'<p><a class="magiclink magiclink-test magiclink-repository" href="http://test.com/facelessuser/pymdown-extensions" title="Test Repository: facelessuser/pymdown-extensions">facelessuser/pymdown-extensions</a></p>' # noqa: E501
)
def test_issue_link(self):
"""Test issue link."""
self.check_markdown(
'http://test.com/facelessuser/pymdown-extensions/issues/2',
'<p><a class="magiclink magiclink-test magiclink-issue" href="http://test.com/facelessuser/pymdown-extensions/issues/2" title="Test Issue: facelessuser/pymdown-extensions #2">#2</a></p>' # noqa: E501
)
def test_pull_link(self):
"""Test issue link."""
self.check_markdown(
'http://test.com/facelessuser/pymdown-extensions/pull/2',
'<p><a class="magiclink magiclink-test magiclink-pull" href="http://test.com/facelessuser/pymdown-extensions/pull/2" title="Test Pull Request: facelessuser/pymdown-extensions #2">!2</a></p>' # noqa: E501
)
def test_discussion_link(self):
"""Test discussion link."""
self.check_markdown(
'http://test.com/facelessuser/pymdown-extensions/discussions/2',
'<p><a class="magiclink magiclink-test magiclink-discussion" href="http://test.com/facelessuser/pymdown-extensions/discussions/2" title="Test Discussion: facelessuser/pymdown-extensions #2">?2</a></p>' # noqa: E501
)
def test_commit_link(self):
"""Test commit link."""
self.check_markdown(
'http://test.com/facelessuser/pymdown-extensions/commit/3f6b07a8eeaa9d606115758d90f55fec565d4e2a',
'<p><a class="magiclink magiclink-test magiclink-commit" href="http://test.com/facelessuser/pymdown-extensions/commit/3f6b07a8eeaa9d606115758d90f55fec565d4e2a" title="Test Commit: facelessuser/pymdown-extensions@3f6b07a">3f6b07a</a></p>' # noqa: E501
)
def test_compare_link(self):
"""Test compare link."""
self.check_markdown(
'http://test.com/facelessuser/pymdown-extensions/compare/e2ed7e0b3973f3f9eb7a26b8ef7ae514eebfe0d2...90b6fb8711e75732f987982cc024e9bb0111beac',
'<p><a class="magiclink magiclink-test magiclink-compare" href="http://test.com/facelessuser/pymdown-extensions/compare/e2ed7e0b3973f3f9eb7a26b8ef7ae514eebfe0d2...90b6fb8711e75732f987982cc024e9bb0111beac" title="Test Compare: facelessuser/pymdown-extensions@e2ed7e0...90b6fb8">e2ed7e0...90b6fb8</a></p>' # noqa: E501
)
def test_external_user(self):
"""Test external user in custom repo."""
self.check_markdown(
'@github:facelessuser',
'<p><a class="magiclink magiclink-github magiclink-mention" href="https://github.com/facelessuser" title="GitHub User: facelessuser">@facelessuser</a></p>' # noqa: E501
)
self.check_markdown(
'@test:facelessuser',
'<p><a class="magiclink magiclink-test magiclink-mention" href="http://test.com/facelessuser" title="Test User: facelessuser">@facelessuser</a></p>' # noqa: E501
)
def test_bad_name(self):
"""Test bad name."""
extension = [
'pymdownx.magiclink',
'pymdownx.saneheaders'
]
extension_configs = {
'pymdownx.magiclink': {
'repo_url_shorthand': True,
'repo_url_shortener': True,
'user': 'facelessuser',
'repo': 'pymdown-extensions',
'provider': 'bad-name',
'custom': {
'bad-name': {
'host': 'http://bad.com',
'label': 'Bad',
'type': 'github'
}
}
}
}
with self.assertRaises(ValueError):
markdown.markdown('', extensions=extension, extension_configs=extension_configs)
class TestMagicLinkWarning(util.MdCase):
"""Test cases for social link shortener."""
extension = [
'pymdownx.magiclink'
]
extension_configs = {
'pymdownx.magiclink': {
'social_url_shortener': True,
'social_url_shorthand': True
}
}
def test_deprecated_twitter(self):
"""Test deprecation warning."""
with warnings.catch_warnings(record=True) as w:
# Cause all warnings to always be triggered.
# Trigger a warning.
warnings.simplefilter("always")
self.check_markdown(
'@twitter:user',
'<p><a class="magiclink magiclink-twitter magiclink-mention" href="https://twitter.com/user" title="Twitter User: user">@user</a></p>' # noqa: E501
)
target = "The 'twitter' social provider has been deprecated, please use 'x' instead"
for warn in w:
if target in str(warn.message):
found = True
break
# Verify some things
self.assertTrue(len(w) == 1)
self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
self.assertTrue(found)
def test_deprecated_twitter_shortener(self):
"""Test shortener deprecation warning."""
with warnings.catch_warnings(record=True) as w:
# Cause all warnings to always be triggered.
# Trigger a warning.
warnings.simplefilter("always")
self.check_markdown(
'https://twitter.com/user',
'<p><a class="magiclink magiclink-twitter magiclink-mention" href="https://twitter.com/user" title="Twitter User: user">@user</a></p>' # noqa: E501
)
target = "The 'twitter' social provider has been deprecated, please use 'x' instead"
for warn in w:
if target in str(warn.message):
found = True
break
# Verify some things
self.assertTrue(len(w) == 1)
self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
self.assertTrue(found)
|
