MediaWiki-Vagrant/cs





MediaWiki-Vagrant je přenosné vývojové prostředí MediaWiki. Skládá se ze sady konfiguračních skriptů pro programy Vagrant a virtuální schránky, které automatizují vytvoření virtuálního počítače (v dalším textu VM (virtual machine)), na kterém běží MediaWiki. Konfigurace je zaměřena především na snadný vývoj než na bezpečnost. Z tohoto důvodu nedoporučujeme používat MediaWiki-Vagrant jako veřejně přístupnou wiki!

Virtuální nástroj (dále v textu jako "VM"), který MediaWiki-Vagrant vytváří, usnadňuje získávání informací, úpravy a vylepšování kódu MediaWiki. Ve výchozím nastavení se zobrazují užitečné informace o ladění a různé vývojářské nástroje speciálně nastavené pro kontrolu a spojení s kódem MediaWiki, včetně výkonného debuggeru a interaktivního tlumočníka. Je nejlepší ze všech, protože konfigurace je automatizovaná a obsažená ve virtuálním prostředí. Chyby lze snadno vrátit zpět.



Systémové požadavky

 * CPU
 * 64bitový procesor x86


 * OS
 * Linux, macOS nebo Windows


 * Paměť
 * Celkem 4 GB RAM ve vašem systému, nejlépe 8 GB případně i více, aby bylo možné spustit hostitelský operační systém i VM. Nepokoušejte se spustit systém s pouhými 2 GB RAM, protože to nakonec vždy selže.


 * Disk
 * U složitých instalací musíte mít na primární jednotce 10–12 GB volného místa (/home partition pro Linux, C: drive pro Windows). Zejména mějte na paměti, že obsahy disků VM budou ve výchozím nastavení uloženy ve vašem domovském adresáři.


 * Síť
 * Aktivní síťové připojení s dostatečnou šířkou pásma pro stahování aktualizací systému Debian Linux a zdrojového kódu MediaWiki.


 * Čas pro nastavení
 * 20 minut až 2 hodiny, v závislosti na podmínkách a případných potížích.



Rychlý start
(Pokud instalujete MediaWiki-Vagrant z distribuce USB, místo prvních pěti kroků postupujte podle kroků v README.)


 * 1) Stáhněte si Git
 * 2) (Pouze Linux) Nainstalujte NFS, pokud ještě není nainstalován. V Ubuntu použijte  . Fedora obvykle přichází s nainstalovaným NFS. Pokud není spuštěn.
 * 3) Stáhněte si VirtualBox
 * 4) Získejte nejnovější Vagrant
 * 5) Naklonujte kód do aktuálního adresáře (neklonujte do složky ve WSL)
 * 6) Zadejte adresář vagrant pro spouštění příkazů   v:
 * 7) Před spuštěním počítače spusťte instalační skript pro nastavení vagrant:
 * Linux/macOS:
 * Windows:
 * Až budete vyzváni, zadejte své uživatelské jméno Gerrit (doporučeno) nebo stačí stisknout Enter.
 * Pokud chcete místo nejnovější verze použít jinou větev vydání, můžete ji nyní zadat pomocí
 * 1) Spusťte virtuální počítač:
 * Věnujte pozornost výstupu konzoly, abyste se ujistili, že neexistují žádné chyby.
 * 1) Spusťte příkaz   (pouze Linux) nebo otevřete svou instanci MediaWiki. Můžete se přihlásit jako uživatel Admin s heslem vagrant.
 * 2) Povolte další funkce MediaWiki a rozšíření:
 * Chcete-li zobrazit seznam funkcí (rolí vagrant), které můžete povolit, spusťte:
 * Chcete-li povolit funkci, například, spusťte:
 * Chcete-li na svou wiki použít role, které jste povolili, spusťte:
 * 1) Spusťte příkaz   (pouze Linux) nebo otevřete svou instanci MediaWiki. Můžete se přihlásit jako uživatel Admin s heslem vagrant.
 * 2) Povolte další funkce MediaWiki a rozšíření:
 * Chcete-li zobrazit seznam funkcí (rolí vagrant), které můžete povolit, spusťte:
 * Chcete-li povolit funkci, například, spusťte:
 * Chcete-li na svou wiki použít role, které jste povolili, spusťte:
 * Chcete-li na svou wiki použít role, které jste povolili, spusťte:
 * Chcete-li na svou wiki použít role, které jste povolili, spusťte:



Windows Subsystém pro Linux (WSL)
Pokud používáte prostředí kompatibilní s WSL Linux na Windows 10: spusťte příkazy s  namísto. Spusťte  namísto , který v bash schránce Linuxu nefunguje.

Účet, ve kterém běží Vagrant, bude pravděpodobně potřebovat oprávnění "Vytvořit symbolické odkazy" (Create Symbolic Links) (snadný způsob, jak toho dosáhnout, je být spuštěn jako správce).



Odstraňování potíží při spouštění
Vaše problémy nejsou níže zodpovězeny? Využijte IRC, konkrétně kanál.


 * Nefunkční instalace např.: "Nebyla nalezena žádná wiki..."(No wiki found...) můžete opravit spuštěním, který obnoví virtuální počítač bez opakování časově nejnáročnějších části instalačního procesu.



Jakýkoli počítač

 * Zkuste nainstalovat verze VirtualBox a Vagrant, které vaše distribuce Linuxu poskytuje. Pokud používáte nejnovější Debian nebo Ubuntu, zkuste sudo apt-get install virtualbox vagrant a nainstalujte balíčky pro VirtualBox a Vagrant.
 * Pokud se vám objeví chyby z vagrant up, nainstalujte nejnovější verze VirtualBox a Vagrant.
 * Při zobrazení chybové zprávy jako je "Couldn't open file $CLONED_REPOSITORY/trusty-cloud", zkuste následující příkaz: vagrant up --provider=virtualbox
 * Pokud narazíte na nějaké puppet chyby, možná budete muset iniciovat puppet submoduly. V adresáři s Vagrantem spusťte příkaz git submodule update --init.
 * Pomocí odkazu http://127.0.0.1:8080/info.php zkontrolujte, zda je Apache/PHP funkční.
 * Pomocí odkazu http://127.0.0.1:8080/info.php zkontrolujte, zda je Apache/PHP funkční.

Jestliže budete chtít porovnat výstup prvního spuštění aplikace vagrant up na vašem terminálu s tímto vzorkem. Počáteční nastavení může trvat dlouho! Jestli se zdá, že někde "visí", ale nedochází k žádným chybám, chvíli počkejte.


 * Když se zobrazí upozornění, že je verze programu VirtualBox Guest Additions nesprávná, můžete zkusit nainstalovat plugin vagrant-vbguest, který se automaticky aktualizuje.
 * Párování Vagrantu s vaším VM se zřídkakdy rozbije. Toto vlákno popisuje některé způsoby, jak toto obejít (např. připojit starý pevný disk VM k novému profilu)
 * Ujistěte se, že úložiště  je aktuální:
 * Ujistěte se, že jste povolili virtualizaci v systému BIOS. Někdy je to v nastavení zabezpečení.
 * Ujistěte se, že vaše nastavení kódování jazyka je UTF-8. Pokud se zobrazí "invalid byte sequence in US-ASCII" (neplatná sekvence bajtů v US-ASCII), zkuste (znovu) nastavit proměnné prostředí LANG a LC_ALL na něco vhodnějšího. Například:

Specifické pro Windows

 * Pokud používáte Windows a zobrazí se "hostující stroj vstoupil do neplatného stavu" (guest machine entered an invalid state) - "poweroff", zkuste stáhnout sestavení VirtualBox 4.3.15 (je známý problém s 4.3.14 na Windows). Pokud to nepomůže, ujistěte se, že v systému BIOS povolíte technologii hardwarové virtualizace (VT-x nebo AMD-V). Hardwarová virtualizace je nutná. Nejedná se o volitelné vylepšení výkonu. (Některé notebooky vyžadují, abyste na 30 sekund odpojili napájecí kabel a baterii )
 * VirtualBox není kompatibilní s Hyper-V společnosti Microsoft. Pokud máte povolenou technologii Hyper-V (což může být výchozí nastavení při nainstalované aplikaci Visual Studio) a zobrazí se při spouštění virtuálního počítače ve VirtualBoxu výše uvedené chyby. Máte tři možnosti:
 * V příkazovém řádku spusťte bcdedit/set hypervisorlaunchtype off. Tím vypnete Hyper-V a restartujete počítač. Chcete-li Hyper-V opět zapnout, přepněte jej zpět z off na auto.
 * Zakažte Hyper-V pomocí ovládacího panelu 'Přidat nebo odebrat funkce systému Window' (Add/Remove Windows Features) a restartujte počítač. Virtuální modul bude fungovat, ale znemožní vám používat jakékoli virtuální počítače Hyper-V, například emulátory Windows Phone.
 * Nebo pro Vagrant použijte systém Hyper-V namísto VirtualBoxu. Toto řešení může být nestabilní.

Specifické pro Mac

 * Chyby NFS Abyste se vyhnuli chybám NFS, během instalace, zajistěte aby firewall akceptoval připojení: Apple > System Preferences > Security & Privacy > Firewall > Firewall Options (Apple> předvolby systému> zabezpečení a soukromí > Firewall > Možnosti brány Firewall). Budete muset, pro akceptování následujících: netbiosd, nfsd, rpc.lockd, rpc.rquotad, rpcbind, VBoxHeadless, zrušit zaškrtnutí políčka "Block all incoming connections" (blokovat všechna příchozí připojení). A pravděpodobně také zrušit zaškrtnutí políčka "Enable stealth mode“ (povolit tajný režim). Během několika  budete možná muset restartovat počítač a změnit stav na "Allow incoming connections" (povolit příchozí připojení). Po instalaci, jakmile jsou pravidla brány firewall aktualizována, budete pravděpodobně muset znovu zkontrolovat "Block all incoming connections" (blokovaní všechna příchozí připojení) a "Enable stealth mode" (povolit tajný režim).
 * Alternativně můžete vypnout sdílení NFS pomocí.



Debian a Ubuntu

 * MediaWiki-Vagrant používá systém síťových souborů NFS ke sdílení některých složek s hostitelským (vaším) počítačem. Počítač musíte nastavit jako "server NFS", viz např. příkazy Ubuntu. Na Debianu bude fungovat sudo apt-get install nfs-kernel-server . Možná budete muset také nastavit . Server NFS Debianu se nespustí bez nastavení v  . Pravděpodobně se to děje, pokud   nespustí služby "nfs". Pro odstranění tohoto problému bude stačit přidání domovského adresáře jako posledního řádku do   a poté /etc/init.d/nfs-kernel-server restart.
 * Sdílení NFS, které používá MediaWiki-Vagrant, nelze spouštět z šifrovaného adresáře. Což se může stát, pokud používáte Ubuntu a používáte šifrovaný domovský adresář. Chcete-li spustit MediaWiki-Vagrant, můžete buď:
 * Před spuštěním  přesuňtte adresář MediaWiki-Vagrant do nezašifrované složky (např.  ).
 * Alternativně můžete vypnout sdílení NFS pomocí.
 * Zdá se, že nastavení NFS se občas zasekne (počáteční  visí na "Připojení sdílených složek NFS"). Restartování démona NFS na hostiteli pomáhá. (Podívejte se na stránku #5802.)
 * Pokud dochází k chybám při přesměrování portů, kdy jsou porty používány, budete možná muset otevřít VirtualBox, úplně odebrat virtuální počítač a akci opakovat.
 * vám může hlásit, že "Spustitelný soubor 'bsdtar', který se Vagrant pokouší spustit, nebyl nalezen v proměnné PATH". Na Ubuntu to můžete opravit pomocí.
 * Na Ubuntu s povoleným Secure Boot budete mít s instalací VirtualBoxu problém. Když spustíte, váš stroj vám může hlásit nesmysly. Pokud ano, můžete situaci napravit signováním příslušného modulu jádra. Pokyny krok za krokem naleznete v tomto příspěvku askubuntu.

Fedora

 * Zobrazí-li se Vám po spuštění  hláška, že síť není k dispozici Network 10.11.12.13 is not available., deaktivujte SELinux pomocí   nebo opravte nastavení SELinux.
 * Jestliže poskytovatel tohoto nástroje řízeného Vagrantem po spuštění  hlásí, že ještě není připraven na SSH "The provider for this Vagrant-managed machine is reporting that it is not yet ready for SSH.", ujistěte se, že je správně nastaven poskytovatel, například prostřednictvím   a poté  u
 * Objeví-li se hláška mount.nfs: mount to NFS server '10.11.12.13:download-directory/vagrant' failed: RPC Error: Unable to receive (mount.nfs: připojení k serveru NFS '10.11.12.13:download-directory/vagrant' se nezdařilo: Chyba RPC: Nelze přijmout), spusťte.



Základní použití
Nástroj příkazového řádku vagrant na hostitelském počítači poskytuje několik základních příkazů pro ovládání virtuálního počítače. Již jste použili jeden: vagrant up zapínající virtuální počítač. Stejně jako většinu příkazů vagrant je spustíte z adresáře MediaWiki-Vagrant nebo některého z jeho podřízených adresářů. Při prvním spuštění načte Vagrant nastavení systému a nastaví potřebný software pro spuštění MediaWiki. Může to trvat 1 až 2 hodiny času procesoru a nástěnných hodin na širokopásmovém připojení. Ale pouze jednou. Při následujícím spuštění vagrant up, se jednoduše spustí již jenom počítač.

Vagrant ssh spustí interaktivní přihlašovací schránku na virtuálním počítači. Přihlašte se jako uživatel Vagrant. Root přístup je dostupný prostřednictvím sudo. Přístup je bez hesla. Virtuální počítač, zcela izolovaný v počítači, je nakonfigurován pro pohodlí, nikoli pro zabezpečení. Kdykoli narazíte na výzvu k zadání hesla, je to zpravidla heslo.

Po přihlášení byste měli vidět barevný banner MediaWiki a připomenutí několika užitečných příkazů.

Příkaz phpsh spustí interaktivní PHP interpreter s již načtenou kódovou základnou MediaWiki. Můžete zadat jakýkoli kód, stisknout 'enter' a kód bude okamžitě vyhodnocen. Pokud začnete řádek s '=', jeho vypočítaná hodnota bude zobrazena. Pro rychlou pomoc zadejte ? nebo help start (pomoc při spuštění). Zobrazí se Vám další pokyny.

Složka  odpovídá složce MediaWiki-Vagrant na hostitelském počítači a její obsah je sdílen. Kód MediaWiki je nainstalován v. To vám umožní k úpravě kódu MediaWiki použít normální prostředí editoru na hostitelském počítači, který běží na Vašem virtuálním počítači.

Aktualizace
Pomocí vagrant git-update můžete aktualizovat svůj git repozitář, externí knihovny a databázová schémata. Příkaz odpovídá spuštění:


 * 1) git pull v adresáři   a všech adresářích rozšíření a zobrazení.
 * 2) composer update, zajišťuje, že jsou k dispozici nejnovější knihovny spravované Composerem.
 * 3) Spuštění skriptu.

Měli byste také příležitostně (nebo když budete potřebovat novou funkci) aktualizovat samotnou aplikaci MediaWiki-Vagrant, což příkaz vagrant git-update nezahrnuje. Můžete to udělat spuštěním:

… V kořenovém adresáři MediaWiki-Vagrant. Aktualizace se projeví při spuštění příkazu:

Příkaz můžete spustit okamžitě po spuštění git pull nebo kdykoliv později.

Z virtuálního počítače se odhlásíte zadáním logout nebo stisknutím Ctrl. Nyní, když jste zpět ve standardním příkazovém řádku, můžete spustit vagrant halt pro vypnutí virtuálního nástroje a vagrant up pro jeho opětovné spuštění. vagrant destroy smaže soubory virtuálního nástroje. Tento příkaz je užitečný, pokud chcete svou instanci vrátit do původního stavu. (Abyste mohli zřídit novou instanci, budete muset zadat vagrant up .)



Používání rolí
MediaWiki-Vagrant standardně nastavuje základní instanci MediaWiki, ale dokáže také nakonfigurovat řadu doplňkového softwaru, včetně některých oblíbených rozšíření MediaWiki a jejich závislostí. Tyto volitelné softwarové balíčky jsou souhrnně známé jako 'role' a MediaWiki-Vagrant nabízí snadné a výkonné rozhraní příkazového řádku pro jejich správu.

Podívejte se na krátkou ukázku screencast demonstrující, jak používat role. Role obsahuje více informací o některých rolích.

Pokud přidáte mnoho rolí, budete asi muset zvětšit paměť dostupnou pro Vagrant VM. Zejména nastavení role "browsertests" zahrnuje kompilaci  ruby Gem, což je úkol vyčerpávající paměť. Pokud to bude nutné, uvolněte paměť ve virtuálním počítači nebo zvyšte přidělenou paměť.

Pokud máte zájem o přidání rolí do MediaWiki-Vagrant, přečtěte si níže uvedenou část Autorské role.



centralauth
Existují některé role, které vyžadují zvláštní pozornost. Role centralauth nespustí migrace db automaticky přes puppet a vyžaduje ruční spuštění. Pokud se při přidělování této role vyskytnou chyby, zkuste spustit tento skript za příponou a podívejte se na chyby, které z něj vyplynou:

mwscript extensions/CentralAuth/maintenance/migrateAccount.php --username 'Admin' --auto

Jakmile získáte konkrétnější chybu, budete pravděpodobně potřebovat vědět, kterou z těchto migrací musíte spustit:

extensions/CentralAuth/db_patches

wikidata
Jednoduché vagrantské role  (umožňující využívat wikidata jejichž poskytování Vagrantem by selhalo). Zde je kompletní sada příkazů, které zajistí, aby role Wikidata byla spuštěna a provozována.

Upozorňujeme, že první příkaz může hlásit chybu, takže vypadá jako selhání. Pokud však provedete druhý příkaz, bude vše v pořádku.

Pak můžete svůj prohlížeč odkázat na http://wikidata.wiki.local.wmftest.net:8080/. Chcete-li vytvořit novou položku wikidata, načíst http://wikidata.wiki.local.wmftest.net:8080/wiki/Special:NewItem a vytvořit novou vlastnost, přejděte na http://wikidata.wiki.local.wmftest.net:8080/wiki/Special:NewProperty.



Jak importovat výpis z Wikidata
Příkaz Vagrant, kterým importujete soubor XML do MediaWiki, zpracovává pouze výchozí wiki (viz T183274). Spusťte skript  v boxu Vagrant.

Zde je postup importu výpisů XML.


 * Stáhněte jakékoli  (stránky nebo články). Například:


 * Povolte import entit Wikibase (viz phab:T72898). Připojte následující řádek v :


 * Následující skript BASH vám pomůže monitorovat proces. Můžete jej vložit do souboru . Zvýrazněný řádek vyvolá skutečný skript pro import:


 * Přihlaste se do pole Vagrant a spusťte skript. Zde by se měly zobrazovat ladící zprávy:


 * Můžete sledovat průběh protokolu mimo box Vagrant:



Další návrhy


Zrychlení MediaWiki ve Windows
MediaWiki ihned po vybalení poběží pravděpodobně pomalu (načítání stránky trvá 5 a více sekund). Je to proto, že virtuální počítač používá sdílený systém souborů, který načítá soubory velmi pomalu. Enabling NFS on Windows by installing the Vagrant WinNFSd plugin with, enabling NFS shares with  , and restarting the machine with   should significantly speed up page load times. Měli byste se také ujistit, že je plugin nainstalován při každém spuštění počítače. Můžete to dále urychlit povolením, ale mějte na paměti, že vaše wiki může narazit na podivné chyby, protože některé soubory se při použití mezipaměti nemusí úplně aktualizovat.

Mediawiki můžete také urychlit použitím. Ujistěte se, že jej nepovolíte současně s. Povolte jej pomocí  a spusťte   v shellu spuštěném jako správce. Pokud ji nespustíte jako správce, budete upozorněni chybou, když se vagrant zvýší, a když přejdete na adresu wiki, uvidíte. Po zobrazení výzvy zadejte uživatelské jméno svého účtu (název vašeho domovského uživatelského adresáře) a heslo (heslo vašeho účtu Microsoft, pokud váš účet není místním účtem s normálním heslem).



Základní kopie Local MediaWiki
Někdy můžete chtít začít od nuly. Odstraňte celý adresář vagrant nebo vyčistěte adresář vagrant/mediawiki. Chcete-li urychlit proces zajišťování vagrantu, zvažte zachování lokálního aktualizovaného klonu jádra MediaWiki, který zkopírujete do vagrant/mediawiki.

Například v případě, že klonujete repozitáře MediaWiki do ~/projects/mediawiki/ :



Aktualizování klonovaného úložiště
Aktualizujte klonovaný repozitář tak často, jak jen je to možné, případně nutné.

Nebo aktualizujte všechny klonované repozitáře:



Opětovné načtení Vagrantu
Pokud změníte konfiguraci (např. $Ram) a váš web VM případně MediaWiki zamrzne či zatuhne nebo se vyskytne jiný problém, může to vyřešit vagrant reload. Tím vašehp hosta restartujete. Některé úlohy také vyžadují opětovné načtení, ke kterému by mělo dojít automaticky.



Kdy povolit role
Role povolte pouze po úspěšném spuštění prvního vagrant up.

Všimněte si, že vagrant destroy neresetuje povolené role. Po spuštění vagrant destroy vypněte všechny role a poté spusťte vagrant up. Nyní můžete znovu povolit jakékoli role a spustit vagrant provision.

<span id="Vagrant_behind_proxy">

Vagrant za proxy
Pokud jste za proxy, Vagrant by mohl hlásit některé chyby. Nainstalujte vagrant-proxyconf. Je to plugin, který umožňuje vašemu virtuálnímu počítači používat určené proxy. Zde je rychlý průvodce nastavením. Podrobnou dokumentaci najdete na této stránce.

Nainstalujte plugin:

Chcete-li nakonfigurovat nastavení proxy pro všechny části softwaru na všech virtuálních počítačích tuláků, přidejte následující řádky do svého  (výchozí  ).

Nahraďte adresy číslem IP a portem vašeho proxy serveru. Pomocí config.proxy.no_proxy vyjmenujte všechny weby případně domény, pro které byste mohli chtít obejít proxy. Například,

Nyní, když spustíte vagrant up, neměla by se objevit žádná varování.

Chcete-li plugin deaktivovat, nastavte config.proxy.enabled na false nebo prázdný řetězec (""). Můžete jej také zakázat pro konkrétní aplikace. Například,

MediaWiki-Vagrant prep
Možná budete chtít zvážit použití shellového skriptu, například mw-vagrant-prep, k přípravě adresáře pro instalaci MediaWiki-Vagrant.

Poskytování
Proces zřizování můžete ladit spuštěním

PHP
PHP můžete ladit pomocí Xdebugu. Ladění v PHP se liší od ostatních ladění na straně klienta. Vaše IDE sleduje příchozí připojení a když přistoupíte k serveru pomocí prohlížeče, speciální hlavička dá pokyn PHP, aby se připojil k vašemu IDE. Další informace viz MediaWiki-Vagrant/Advanced usage.

Chrome

 * Pro uživatele prohlížeče Chrome byste měli získat XDebug Helper a volitelně Clear Cache, HTTP header a Mod Headers. Konfigurujte vymazání mezipaměti tak, aby se po vymazání automaticky znovu načítala, a nastavení klávesových zkratek (např. Ctrl pro vymazání a opětovné načtení, Ctrl pro zapnutí případně vypnutí XDebuggeru).

Firefox

 * Uživatelé Firefoxu by se měli podívat na jednoduchý Xdebug.
 * Nainstalujte a nakonfigurujte kompatibilní xdebug IDE na vašem počítači (Eclipse, PhpStorm, Emacs atd.).
 * V IDE začněte sledovat příchozí ladicí spojení.
 * V IDE stanovte bod zlomu na místě, které vás zajímá.
 * V prohlížeči povolte XDebug a přejděte k vagrantské instalaci ( http://127.0.0.1:8080/... ).

<span id="Log_files">

Soubory protokolu
Protokoly MediaWiki lze nalézt v /vagrant/logs. V /var/log/apache2/ jsou soubory protokolu pro Apache, ale zdá se, že na něm nejsou zapsány. Protokol dotazů MySQL lze získat vydáním SET GLOBAL general_log = 'ON'; v klientovi a poté prohlížením /var/lib/mysql/*.log.

<span id="Running_and_debugging_unit_tests">

Spouštění a ladění testů jednotek
Pro spuštění testů pro VŠECHNA rozšíření:

Spuštění testů jednotky pro jedno rozšíření:

Můžete připojit path/to/tests/to/run (cestu/k/testy/spuštění).

Některé testy mohou vyžadovat spuštění oprávněným uživatelem pro vytvoření souborů uzamčení. Proto se tento příkaz spustí jako "user" (uživatel), který zpracovává webové požadavky.

Informace o vytváření reportů o pokrytí vysvětluje Příručka:Testování jednotek PHP/pokrytí kódu#MediaWiki-Vagrant.

Ladění phpunit testů je trochu složitější. Tato metoda je trochu hackerská, ale lze ji použít, pokud se nezlepší možnosti vzdáleného interpretu (např. v phpStorm 8 EAP). Toto řešení umožňuje spustit unit testy MediaWiki přímo z prohlížeče.


 * Stáhněte soubor phpunit.phar do kořenového adresáře vagrant.
 * Vytvořte soubor php  v kořenovém adresáři  . Neukládejte tento soubor do repozitáře. Vložte do něj následující kód:


 * Ve výše uvedeném souboru změňte parametr argv na název souboru s testy.
 * Apache mapuje kořenový adresář MediaWiki na . Chcete-li tento soubor spustit, přejděte na http://127.0.0.1:8080/w/unittest.php.
 * Pro připojení debuggeru postupujte podle pokynů #Debugging.

<span id="Running_browser_tests">

Pouštění browser testů
Pro testy jednotek JavaScript (JUnit), se podívejte na stránku.

End-to-end testy prohlížeče (Selenium) viz

<span id="Pushing_commits">

Potlačení odevzdání
Pokud pro vývoj používáte MediaWiki-Vagrant, pravděpodobně budete chtít poslat nějaká hlášení do jádra MediaWiki nebo úložiště rozšíření pomocí git review. Ve výchozím nastavení všechny dálkové ovladače odkazují na URL. Chcete-li se vyhnout tomu, aby toto bylo případ od případu potlačeno, spusťte:

$ git config --global url."ssh:// @gerrit.wikimedia.org:29418/".insteadOf "https://gerrit.wikimedia.org/r/"

Musíte také mít nastaveny své ssh klíče v.

Gerrit
Chcete-li odeslat změny, přejděte do složky rozšíření pomocí. Poté postupujte podle pokynů pro odeslání opravy přes gerrit.

Odstraňování problémů

 * Zkontrolujte verzi a nastavení PHP
 * http://127.0.0.1:8080/info.php


 * Upravujete LocalSettings.php?
 * Nejprve se ujistěte, že neexistuje žádná úloha ( vagrant list-roles ), která již dělá to, co potřebujete. Pokud ne, vytvořte soubor v adresáři . Viz README a příklad souboru 00-debug.php.


 * Aktualizujete kód MediaWiki?
 * Nejjednodušší je použít  od hostitele. Nebo, chcete-li aktualizovat kód bez závislostí, můžete použít běžné příkazy git ,   atd. V   a   adresáře. Tyto příkazy můžete spouštět na virtuálním počítači, ale přístup k souborům bude na hostitelském počítači rychlejší. MediaWiki-Vagrant stahuje kód z hlavního serveru git, když jste původně nastavili nebo přidali úlohu, ale poté automaticky neaktualizuje kód.


 * Spouštíte překladač MediaWiki PHP
 * ssh pro vagrant a spusťte . Možná jej budete muset spustit pomocí


 * Spouštíte interpretátor SQL MediaWiki
 * ssh pro vagrant a spuštění . Možná jej budete muset spustit pomocí

''Balíčky NN lze aktualizovat. Aktualizací NN jsou aktualizace zabezpečení.'' Ve vagrant ssh:
 * Aktualizujete softwarové balíčky virtuálních strojů?
 * neaktualizuje systémové balíčky ve virtuálním počítači. Když se spojíte s vagrantem ssh, přihlašovací zpráva vás informuje, že:
 * * Chcete-li aktualizovat všechny balíčky, zadejte
 * * pro automatickou instalaci bezpečnostních (a dalších) upgradů, podobně jako v případě cloudových VPS, zadejte
 * * pro aktualizaci na stejné balíčky, které jsou na produkčních serverech WMF ... TODO


 * Přizpůsobujete Vagrant
 * Nikdy byste neměli měnit Vagrantfile přímo. Existuje několik aspektů, které můžete přizpůsobit:
 * Základní nastavení (uživatel git, porty, RAM, IP, přeposílání portů) lze upravit pomocí souboru .settings.yaml. Pokyny viz  a  . Můžete tedy například spustit   a povolit předávání portů z hostitele: 1234 na hosta:80.
 * Po načtení souboru Vagrantfile proveďte další kroky vytvořením souboru s názvem Vagrantfile-extra.rb a jeho umístěním do stejné složky jako Vagrantfile - bude automaticky načten. V případě konfliktu nahradí hodnoty v souboru 'extra' hodnoty v tomto souboru. Viz příklad v adresáři support/directory.


 * Přidáváte vlastní puppet kód?
 * To je ideální, pokud chcete pracovat na svém vlastním webu MediaWiki místně a nechat MediaWiki-Vagrant nainstalovat vaše závislosti za vás. Je ideální, pokud máte vlastní rozdělení. Existuje rozdíl mezi rolí a tímto případem použití. Role jsou určeny k instalaci v libovolném pořadí a bez přerušení. Pokud vaše rozdělení potřebuje různé hovory a dostane se do potíží s rolemi, vytvořte si vlastní třídu a zvolte, co potřebujete, včetně rolí.
 * Chcete-li, vložte svůj vlastní puppet kód do  s vaší vlastní třídou, například:

Chcete-li použít svou třídu, přidejte ji do klíče "třídy" (classes) v souboru. Soubor, pokud neexistuje, můžete vytvořit.

Poté spusťte  a udělejte změnu prostřednictvím systému Puppet.


 * Aktualizujete MediaWiki-Vagrant sám?
 * (Například pro použití nových rolí.) V terminálu přejděte do hostitelského počítače do adresáře vagrant a zadejte příkaz git, například . Obvykle budete chtít po aktualizaci spustit , abyste na svém virtuálním nástroji použili všechny nové puppet změny.


 * Spouštíte GUI aplikace na virtuálním nástroji?
 * Pokud máte nainstalovaný X server, SSH do virtuálního počítače pomocí  pro povolení X forwardingu. (Uživatelé Mac by měli aktualizovat na nejnovější verzi XQuartz.)


 * Alternativně můžete spustit virtuální nástroj v režimu GUI, což vám umožní komunikovat s VM, jako by měl fyzický displej. Chcete-li povolit režim GUI, vytvořte ve složce kořenového úložiště soubor s názvem, jehož obsah je:


 * Uložte soubor a spusťte  následovaný  . Displej virtuálního nástroje se objeví v okně na ploše.


 * <span id="Adjust_CPU"> Upravujete zdroje přidělené VM?
 * Pokud chcete VM přidělit více či méně CPU / RAM, pokyny najdete v.

Alternativně to můžete udělat vytvořením souboru Vagrantfile-extra.rb (příklad viz podpora / pro příklad):


 * Měníte editor používaný pro zprávy git commit?


 * Nastavujete vlastní název hostitele?
 * Přejděte na Horizon, vyberte Web Proxies a zadejte název hostitele DNS, zadejte &lt;hostname>

Prohlédněte si svou novou wiki na " http://&lt;hostname>/wiki/ "


 * Nastavujete vlastní název hostitele, aby místo na domovskou stránku wiki ukazoval na domovskou stránku mého vanrant?
 * Vytvořte soubor local.yaml v adresáři /vagrant/puppet/hieradata. V něm přidejte:

Spusťte.


 * Provozujete pobočku MediaWiki jinou než master?
 * V klíči  nastavte klíč "". Soubor, pokud neexistuje, můžete vytvořit.

<span id="Advanced_usage">

Pokročilá využití
<span id="MediaWiki_settings">

Nastavení MediaWiki
Jako alternativu ke správě všech nastavení MediaWiki v jediném velkém souboru zvažte seskupení konfigurací podle komponenty nebo tématu a vytvoření samostatného souboru PHP v   pro každou skupinu. Díky tomu je docela snadné udržovat vaše nastavení uspořádané, dočasně deaktivovat konkrétní konfigurace a sdílet nastavení s ostatními.

MediaWiki automaticky načte jakékoli soubory PHP v  v lexikálním pořadí. Pořadí, ve kterém jsou vaše konfigurace nastaveny, můžete lépe ovládat osvojením si zvyku přidávat ke každému názvu souboru dvoumístnou předponu.

Například:

<pre style="background-color: #efefef; border: 0; display: inline-block; font-family: Consolas, monaco, monospace; margin: 0.4em 0 1em; padding: 0.2em 0.6em;"> settings.d/   ├── 10-RunFirst.php ├── 20-SomeExtension.php └── 99-RunLast.php Mějte na paměti, že soubory nastavení v  jsou automaticky vytvořeny a zrušeny podle vaší konfigurace Puppet. Nenastavujte zde svá vlastní nastavení, protože Puppet je smaže nebo přepíše. Místo toho si ponechejte soubory vlastních nastavení v.

<span id="Vagrant_flags">

Vagrantské příznaky
Příkaz  zobrazí seznam všech aktuálních vagrantských označení.

Po počátečním  můžete v adresáři vagrant nastavit vagrant flags, které se zobrazí v seznamu konfigurací, např.

<span id="Job_queue">

Fronta úloh
V případě, že testujete něco, co potřebuje rozbít frontu úloh, budete možná muset zvýšit počet běžících úloh. V současné době to není dostupné prostřednictvím LocalSettings.php, ale musí to být nastaveno v konfiguračním souboru pro spouštěče úloh.


 * 1) Otevřete.
 * 2) Změňte hodnotu klíče ' ' z   na požadovanou hodnotu (řekněme  ).
 * 3) Opětovné spusťte s.
 * 4) Pozor! Bude se to lišit od git masteru ve vašem kódu.

Více najdete na stránce instrukce pro úpravu počtu jader CPU (velmi doporučeno pro úlohy vázané na CPU, jako je například video transkódování).

<span id="Additional_storage_space">

Další úložný prostor
Ve výchozím nastavení je v kořenovém oddílu v rámci VM relativně málo volného místa. Pokud plánujete otestovat nahrávání a zpracování velkých obrazových a video souborů, může to být nedostatečné.

Postup změny:


 * Vypněte VM.
 * Otevřete VirtualBox Manager.
 * Vyberte VM a přejděte do Settings (nastavení).
 * V části Storage (úložiště) vyberte "Controller: SATA" (řadič:SATA) a klikněte na ikonu "Add hard disk" (přidat pevný disk).
 * Vyberte výchozí typ obrazu disku.
 * Pojmenujte disk "VagrantImageSpace" nebo podobně a dejte mu dostatek místa (řekněme 80 GB) – ve výchozím nastavení se soubor začne zmenšovat a rozšíří se podle skutečného využití, takže mu dejte tolik místa, kolik budete potřebovat.
 * Zavřete dialogová okna a restartujte VM.
 * Spusťte  a získejte shell uvnitř terminálu.
 * Spusťte  a nastavte nové oddíly....
 * Zadejte,  ,   a dvakrát stiskněte (enter) pro výchozí velikost.
 * Chcete-li uložit tabulku oddílů, zadejte.
 * Spusťte  a vytvořte souborový systém.
 * Spusťte  a upravte seznam připojení.
 * Na konec přidejte řádek:.
 * Uložte.
 * Spusťte  a připojte souborový systém.
 * Spusťte  a nastavte oprávnění souboru.
 * Ukončete shell.
 * Restartujte VM.

<span id="Authoring_roles">

Autorské role
Virtuální počítač vytvořený programem MediaWiki-Vagrant se v klíčových ohledech podobá produkčnímu prostředí Wikimedie a používá stejný nástroj—Puppet—tým technických operací Wikimedia používá ke správě produkčních serverů a Wikimedia Cloud VPS instance. Puppet je nástroj pro správu konfigurace, který poskytuje jazyk specifický pro doménu pro deklarativní vyjádření softwarových konfigurací. Soubory obsahující Puppet kód se nazývají 'manifesty' (manifests). Když puppet běží, interpretuje projevy, které zadáváte a podle toho nakonfiguruje VM. Vagrant role je soubor puppet manifestů.

Puppet codebase MediaWiki-Vagrant obsahuje abstrakce, které usnadňují automatizaci konfigurace rozšíření MediaWiki a souvisejícího softwaru. Pokud jste vývojář pracující na softwarovém projektu, který se vztahuje k MediaWiki, doporučujeme vám stáhnout záplatu s rolí puppet pro váš projekt. Přidáním role Vagrant do projektu usnadníte ostatním vývojářům kontrolu vaší práce. Použití spravovaného virtuálního počítače jako vývojové karantény pro váš projekt snižuje pravděpodobnost chyb "works-on-my-machine" (funguje na mém nástroji), které často vycházejí od geograficky vzdálených vývojářů pracujících v nekompatibilních prostředích.

Nejjednodušší způsob, jak začít s vlastními rolemi je, podívat se, jak jsou stávající role implementovány v. Tyto role závisí na puppet modulech v  (obvykle se   převádí na volání do  ) a používají soubory a šablony z ostatních adresářů. Puppet kód je obecně dobře zdokumentován a obsahuje příklady, které prokazují jeho správné použití.

Některé z užitečných puppet modulů jsou:


 * mediawiki::extension - instalace a konfigurace rozšíření (příklad)
 * mediawiki::import::text - vytváření dokumentace nebo testovací stránky na wiki (příklad: prohlášení, stránka)
 * mediawiki::import::dump - import wiki dump (příklad)
 * require_package - nainstalujte systémový balíček (příklad)
 * exec - provedení shellového příkazu (příklad)

<span id="Setting_up_an_instance_on_Cloud_VPS">

Nastavení instance v cloudu VPS
Můžete použít MediaWiki-Vagrant v Cloud VPS k instalaci MediaWiki na Wikimedia Cloud VPS instance a povolit v něm role MediaWiki-Vagrant.

Chyby
Pokud narazíte na chybu v MediaWiki-Vagrant, nahlaste ji. Nejprve se ujistěte, že chyba není známá chyba Vagrant nebo VirtualBox, a to tak, že prohledáte Vagrant issue tracker na GitHubu a VirtualBox bugtracker. Pokud ne, pokračujte a odešlete hlášení o chybě do Wikimedia Phabricator. Jasně popište problém a zahrňte kroky k reprodukci, kdykoli je to možné.

Odkazy

 * Stránka projektu na Ohlohu
 * MediaWiki-Vagrant na GitHubu
 * Sledování problémů na Phabricatoru
 * Bash příkazy potřebné pro rychlý start na Ubuntu
 * Bash příkazy potřebné pro rychlý start na Ubuntu