Module:Annotated link/testcases

-- Unit tests for [[Module:AnnotatedLink]]. Run all tests on the talk page.
-- Due to the changable nature of short descriptions; some of these tests may need to be updated before running them.

local p = require('Module:UnitTests')

--[[ empty params ]]

function p:test__no_name_param()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main}}', '<strong class="error">ERROR with invocation of [[Module:AnnotatedLink]]: a page name (including namespace) MUST be provided</strong>', { nowiki = 1 })
end

function p:test__no_name_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=}}', '<strong class="error">ERROR with invocation of [[Module:AnnotatedLink]]: a page name (including namespace) MUST be provided</strong>', { nowiki = 1 })
end

function p:test__no_display_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|display=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_quote_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|quote=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_abbr_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|abbr=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_abbr_value__abbr_title()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|abbr=|abbr_title=Abbreviation}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_abbr__no_abbr_title_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|abbr=|abbr_title=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_aka_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|aka=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_wedge_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|wedge=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_dash_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|dash=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_desc_first_letter_case_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|desc_first_letter_case=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_link_lang_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|link_lang=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

-- tests for empty |link_lang_italic= |link_lang_nocat= |link_lang_size= |link_lang_cat= |link_lang_rtl= ?

function p:test__no_aka_lang_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|aka_lang=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

-- tests for empty |aka_lang_italic= |aka_lang_nocat= |aka_lang_size= |aka_lang_cat= |aka_lang_rtl= ?

function p:test__no_wedge_lang_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|wedge_lang=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

-- tests for empty |wedge_lang_italic= |wedge_lang_nocat= |wedge_lang_size= |wedge_lang_cat= |wedge_lang_rtl= ?

function p:test__no_only_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|only=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_prefer_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|prefer=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__no_fallback_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|fallback=}}', "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]]")
end

--[[ unknown param ]]

function p:test__no_unknown_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|unknown=}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__unknown_value()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|unknown=unknown}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

--[[ none but name ]]

function p:test__short_description_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__short_description_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description}}', "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]]")
end

--[[ name and display ]]

function p:test__display__short_description_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|display=Test page}}', "[[:User:Fred Gandt/sandbox/explicit short description|Test page]] – explicit short description")
end

function p:test__display__short_description_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|display=Test page}}', "[[:User:Fred Gandt/sandbox/no explicit short description|Test page]]")
end

--[[ name and quote ]]

function p:test__quote__short_description_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|quote=yes}}', '"[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]]" – explicit short description')
end

function p:test__quote__short_description_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|quote=yes}}', '"[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]]"')
end

--[[ name and abbr ]]

function p:test__abbr__short_description_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|abbr=ESD}}', '[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] (<abbr>ESD</abbr>) – explicit short description', { nowiki = 1 })
end

function p:test__abbr__short_description_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|abbr=NESD}}', '[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]] (<abbr>NESD</abbr>)', { nowiki = 1 })
end

--[[ name, abbr and abbr_title ]]

function p:test__abbr__abbr_title__short_description_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|abbr=ESD|abbr_title=Explicit Short Description}}', '[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] (<abbr title="Explicit Short Description">ESD</abbr>) – explicit short description', { nowiki = 1 })
end

function p:test__abbr__abbr_title__short_description_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|abbr=NESD|abbr_title=No Explicit Short Description}}', '[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]] (<abbr title="No Explicit Short Description">NESD</abbr>)', { nowiki = 1 })
end

--[[ name and aka ]]

function p:test__aka__short_description_exists()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|aka=Fred's test page}}", "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]], also known as Fred's test page – explicit short description")
end

function p:test__aka__short_description_does_not_exist()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|aka=Fred's test page}}", "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]], also known as Fred's test page")
end

--[[ name and wedge ]]

function p:test__wedge__short_description_exists()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|wedge=[[Tight Fit]]}}", "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]], [[Tight Fit]] – explicit short description")
end

function p:test__wedge__short_description_does_not_exist()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|wedge=[[Tight Fit]]}}", "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]], [[Tight Fit]]")
end

--[[ name, abbr and aka ]]

function p:test__abbr__aka__short_description_exists()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|abbr=ESD|aka=Fred's test page}}", "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] (<abbr>ESD</abbr>), also known as Fred's test page – explicit short description", { nowiki = 1 })
end

function p:test__abbr__aka__short_description_does_not_exist()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|abbr=NESD|aka=Fred's test page}}", "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]] (<abbr>NESD</abbr>), also known as Fred's test page", { nowiki = 1 })
end

--[[ name, abbr and wedge ]]

function p:test__abbr__wedge__short_description_exists()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|abbr=ESD|wedge=[[Tight Fit]]}}", "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] (<abbr>ESD</abbr>), [[Tight Fit]] – explicit short description", { nowiki = 1 })
end

function p:test__abbr__wedge__short_description_does_not_exist()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|abbr=NESD|wedge=[[Tight Fit]]}}", "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]] (<abbr>NESD</abbr>), [[Tight Fit]]", { nowiki = 1 })
end

--[[ name, abbr, aka and wedge ]]

function p:test__abbr__aka__wedge__short_description_exists()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|abbr=ESD|aka=Fred's test page|wedge=[[Tight Fit]]}}", "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] (<abbr>ESD</abbr>), also known as Fred's test page, [[Tight Fit]] – explicit short description", { nowiki = 1 })
end

function p:test__abbr__aka__wedge__short_description_does_not_exist()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|abbr=NESD|aka=Fred's test page|wedge=[[Tight Fit]]}}", "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]] (<abbr>NESD</abbr>), also known as Fred's test page, [[Tight Fit]]", { nowiki = 1 })
end

--[[ name, aka and wedge ]]

function p:test__aka__wedge__short_description_exists()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|aka=Fred's test page|wedge=[[Tight Fit]]}}", "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]], also known as Fred's test page, [[Tight Fit]] – explicit short description")
end

function p:test__aka__wedge__short_description_does_not_exist()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|aka=Fred's test page|wedge=[[Tight Fit]]}}", "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]], also known as Fred's test page, [[Tight Fit]]")
end

--[[ name and link_lang en ]]

function p:test__link_lang_en()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|link_lang=en}}', "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]]")
end

--[[ name, display and link_lang fr ]]

function p:test__display__link_lang_fr()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|display=La page de test de Fred|link_lang=fr}}', '<span title="French-language text"><i lang="fr">[[:User:Fred Gandt/sandbox/no explicit short description|La page de test de Fred]]</i></span>', { nowiki = 1 })
end

--[[ name, display, quote and link_lang fr ]]

function p:test__display__quote__link_lang_fr()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|display=La page de test de Fred|quote=yes|link_lang=fr}}', '"<span title="French-language text"><i lang="fr">[[:User:Fred Gandt/sandbox/no explicit short description|La page de test de Fred]]</i></span>"', { nowiki = 1 })
end

--[[ name, aka and aka_lang ja ]]

function p:test__aka__aka_lang_ja()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|aka=フレッドのテストページ|aka_lang=ja}}", '[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]], also known as <span title="Japanese-language text"><span lang="ja">フレッドのテストページ</span></span>', { nowiki = 1 })
end

--[[ name, wedge and wedge_lang ga ]]

function p:test__wedge__wedge_lang_ga()
	self:preprocess_equals("{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|wedge=Leathanach tástála Fred|wedge_lang=ga}}", '[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]], <span title="Irish-language text"><i lang="ga">Leathanach tástála Fred</i></span>', { nowiki = 1 })
end

--[[ name and mixed language ]]

function p:test__mixed_language()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|display=La page de test de Fred|link_lang=fr|aka=フレッドのテストページ|aka_lang=ja|wedge=Leathanach tástála Fred|wedge_lang=ga}}', '<span title="French-language text"><i lang="fr">[[:User:Fred Gandt/sandbox/no explicit short description|La page de test de Fred]]</i></span>, also known as <span title="Japanese-language text"><span lang="ja">フレッドのテストページ</span></span>, <span title="Irish-language text"><i lang="ga">Leathanach tástála Fred</i></span>', { nowiki = 1 })
end

function p:test__dash_value_comma()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|dash=,}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]], explicit short description")
end

function p:test__desc_first_letter_case_upper()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|desc_first_letter_case=upper}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – Explicit short description")
end

--[[ basic passthrough to Module:GetShortDescription ]]

--[[ only explicit ]]

function p:test__only_explicit__explicit_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|only=explicit}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

function p:test__only_explicit__explicit_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|only=explicit}}', "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]]")
end

--[[ only wikidata ]]

function p:test__only_wikidata__wikidata_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=Wikipedia|only=wikidata}}', "[[:Wikipedia|Wikipedia]] – free multilingual online encyclopedia")
end

function p:test__only_wikidata__wikidata_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|only=wikidata}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]]")
end

--[[ prefer explicit ]]

function p:test__only_explicit__explicit_exists__wikidata_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=Wikipedia|prefer=explicit}}', "[[:Wikipedia|Wikipedia]] – free multilingual, online, crowdsourced encyclopedia")
end

function p:test__only_explicit__explicit_does_not_exist__wikidata_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=Example|prefer=explicit}}', "[[:Example|Example]] – wikimedia disambiguation page")
end

--[[ prefer wikidata ]]

function p:test__only_wikidata__wikidata_exists__explicit_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=Wikipedia|prefer=wikidata}}', "[[:Wikipedia|Wikipedia]] – free multilingual online encyclopedia")
end

function p:test__only_wikidata__wikidata_does_not_exist__explicit_exists()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|prefer=wikidata}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – explicit short description")
end

-- [[ fallback ]]

function p:test__only_explicit__fallback__explicit_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/no explicit short description|only=explicit|fallback=fallback}}', "[[:User:Fred Gandt/sandbox/no explicit short description|User:Fred Gandt/sandbox/no explicit short description]] – fallback")
end

function p:test__only_wikidata__fallback__wikidata_does_not_exist()
	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=User:Fred Gandt/sandbox/explicit short description|only=wikidata|fallback=fallback}}', "[[:User:Fred Gandt/sandbox/explicit short description|User:Fred Gandt/sandbox/explicit short description]] – fallback")
end

--[[ test the test; sanity check; should fail ]]

--function p:test_the_test()
--	self:preprocess_equals('{{#invoke:AnnotatedLink|main|name=Example}}', "test the test")
--end

--[[ foreign language wikidata ]]

-- Testing |desc_lang_italic= |desc_lang_nocat= |desc_lang_size= |desc_lang_cat= |desc_lang_rtl= |desc_lang_no= will require a wikidata description in a language other than English to be returned

return p