Open main menu

MediaWiki-Vagrant

This page is a translated version of the page MediaWiki-Vagrant and the translation is 51% complete.

Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎français • ‎italiano • ‎português • ‎português do Brasil • ‎Ελληνικά • ‎русский • ‎中文 • ‎日本語 • ‎한국어
Vagrantのビジュアルな概観
MediaWiki Vagrant のロゴ
ウィキマニアのインタビューで 使われたMediaWiki Vagrant の概念図(Bryan Davis)
TechTalkでMediaWiki-Vagrantを解説するBryan DavisとDan Duvall
TechTalkで使用したMediaWiki-Vagrantの解説スライドより(作成:Bryan Davis、Dan Duvall)

MediaWiki-Vagrant (訳注: 略称 MW-V) は、ポータブルな MediaWiki 開発環境です。MediaWiki が動作する仮想マシンの作成を自動化するVirtualBoxVagrant(ベイグラント)の一連の設定スクリプトで構成されています。 設定はセキュリティよりも開発しやすさに重点を置いており、MediaWiki-Vagrantは公開のウィキ群での使用が非推奨です。

MediaWiki-Vagrant が作成する仮想マシンは、MediaWiki のコードの学習や修正、改善を簡単にする:便利なデバッグ情報が標準で表示され、MediaWikiコードの検証やインタラクションに特化したさまざまな開発者向けツールが設定されていて、強力なデバッガーやインタラクティブなインタープリターが含まれている。なによりもまず、設定が仮想環境上に自動化され組み込まれているので、ミスを犯しても簡単に元の状態に戻すことが可能である。

Contents

システム要件

CPU
64-bit x86プロセッサ
OS
LinuxmacOSまたはWindows
メモリ
合計4 GiB RAM以上をシステムに搭載、ホストのOSとVMを同時に走らせるには理想的には8 GiB以上。2 GiB RAMしか積んでいない場合は障害を避けるため駆動しないこと
ディスク
プライマリドライブに数ギガバイトを開放(Linuxは/homeパーティション、WindowsはC: ドライブ)。VMディスクイメージが既定でホームディレクトリに保存されることに留意。
ネットワーク
Debian Linux 更新版とMediaWikiソースコードのダウンロードができる帯域の有効なネットワーク接続
セットアップ所要時間
20分から2時間。条件ならびにトラブル発生による。

クイックスタート

(USB ディストリビューションから MediaWiki-Vagrant をインストールしている場合は、最初の5つの手順ではなく README に従ってください。)

  1. Git を入手
  2. (Linux only) Install NFS if it is not already installed. In Ubuntu, use sudo apt-get install nfs-kernel-server. Fedora usually come with NFS installed, but try sudo dnf install vagrant-libvirt and see the specific documentation page to make sure a Fedora NFS setup is OK.
  3. 最新の VirtualBox を入手[1]
  4. 最新の Vagrant を入手[2]
  5. コードを取得して利用者のマシンを作成:
    $ git clone --recursive https://gerrit.wikimedia.org/r/mediawiki/vagrant
    
    (This will clone into your user home directory.)
    $ cd vagrant
    $ ./setup.sh
    
    When prompted, enter your Gerrit user name (recommended), or just press Enter.
    If you want to use a release branch instead of the latest version, you can specify it now with vagrant hiera mediawiki::branch REL1_27
    $ vagrant up
    
  1. 他のMediaWiki 機能を有効にする。例えば:
    $ vagrant roles list
    $ vagrant roles enable monobook --provision
    
  2. Vagrantによるマシン設定が完了したら、http:dev.wiki.local.wmftest.net:8080/を検索してMediaWikiインスタンスを確認。 ログインには利用者Adminとパスワードvagrantが必要です。
vagrant up fails if the default VirtualBox provider is used and the number of virtual CPUs on the computer exceeds 32. During setup the virtual cpu number was written to the .settings file in the same folder and can be manually overwritten to limit it to 32 or less.
最初の vagrant up が完了するのに1時間以上かかるかもしれません。

Windows利用者

Git for Windowsを取得し、Git Bashシェルでgitコマンドを起動します。setup.shの代わりにcmd.exeシェルからsetup.batを実行します。

WSL Linux互換性シェルをWindows 10で使用した場合:コマンドをvagrantではなくvagrant.exeで実行。Linuxバッシュシェルで無効な./setup.batvagrant.exe config --requiredで代替します。

トラブルシューティングのスタートアップ

問題の解決策がこのページで見つからない場合は、チャットルームの、特に#wikimedia-dev 接続するチャネルで相談するといいかもしれません。

あらゆるホスト

  • VirtualBoxとVagrantはLinux配布の提供するバージョンをインストールしてみます。DebianあるいはUbuntuの最近の版を駆動する利用者は、sudo apt-get install virtualbox vagrantを試してVirtualBoxとVagrantのパッケージをインストールします。
  • エラーメッセージがvagrant upから送られる場合には、代わりにVirtualBoxとVagrantの最新バージョンをインストールします。
  • エラーメッセージのうち「$CLONED_REPOSITORY/trusty-cloudを開けません」などと表示される場合は、以下のコマンドを試してみます。 vagrant up --provider=virtualbox
  • puppet errors が発生した場合は、puppetモジュール初期化が求められている可能性があり、vagrantディレクトリでgit submodule update --initを実行します
    • Error: Puppet::Parser::AST::Resource failed with error ArgumentError: Could not find declared class
  • Apache/PHPが有効で機能しているかどうか確認するには、http://127.0.0.1:8080/info.phpを使います。

利用する端末におけるvagrant upの初期動作の出力を確認したい場合は、このsampleと比較します。初期セットアップには長時間かかることがあります。エラーはないのにハングアップしたと思われる場合は、しばらくそのままお待ちください。

  • VirtualBox Guest Additionsのバージョンが間違っているという警告が出た場合には、プラグインのvagrant-vbguestをインストールして自動更新を試します。
  • Vagrant がご利用のVMとのペアリングを失効することは滅多にありません。その回避方法はこのスレッドで協議しています(例えば新しいプロファイルに古いVMハードドライブを付けるなど)
  • vagrant/mediawikiリポジトリが最新版かどうか確認します。
$ cd vagrant/mediawiki
$ git pull
  • BIOSで仮想マシン利用を有効にしてあるかどうか確認します。セキュリティ設定内に置かれている場合があります。
  • 言語設定がUTF-8になっているかどうか確認します。「US-ASCIIのバイトシーケンスが無効」という警告が出たら、LANGおよびLC_ALLtryの環境変数の設定(再設定)を適切な値に変えてみます。

例:

export LANG=en_US.UTF-8
export LC_ALL=en_US.UTF-8
  • Sometimes you can fix broken installations (e.g. one saying "No wiki found..." by running vagrant destroy; vagrant up which will rebuild the virtual machine without repeating the most time-consuming parts of the installation process.
過去にVMの旧版を削除しているとエラーメッセージを表示してvagrant upは完了しません(例:「…非ディレクトリもしくは存在しないコンポーネントがパスに含まれています…」) NFS利用者(Windows以外のホストのOS上で)は/etc/exportsの削除で解決します:sudo rm -i /etc/exportsを入力 Vagrantの次回の実行時に/etc/exportsファイルが新たに生成されます。 vagrant up.
MediaWiki-Vagrantは64ビットのゲスト(仮想マシン)を特定するVT-Xをサポートしないホストでは稼働しません。 MediaWiki-Vagrant の稼働には64-bit仮想マシンが必要であり、amd64アーキテクチャ限定でビルドされたWMF製use deb パッケージ他を使用するからです。

Windows特有

  • Windows利用者で「ゲストマシンが無効になりました」 - 「電源オフ」の状態になった場合、VirtualBoxの4.3.15ビルドのダウンロードを試してください(Windowsでは4.3.14のビルドに既知の問題あり)。それでも解決しない場合はBIOSでハードウェア仮想化技術(VT-xもしくはAMD-V)が有効かどうか確認。ハードウェア仮想化は必須であり、オプションのパフォーマンス強化ではありません。(一部のノートパソコンでは電源ケーブルとバッテリーを30秒間、取り外す必要あり [1]
  • VirtualBox は、マイクロソフトの Hyper-V と互換性がありません。 Hyper-Vを有効にした場合 – Visual Studio をインストールした環境ではおそらく既定 – VirtualBox の VM をブートしようとすると上記のエラーが発生します。 可能な対処法は3つ:
    • Hyper-Vを終了させるためコマンドプロンプトで「bcdedit /set hypervisorlaunchtype off」を実行後、リブート。 Hyper-Vをオンにするには、「オフ」から「自動」に切り替え
    • コントロール パネルの「Windows の機能を追加・削除」を介して Hyper-V を無効化、再起動する。 この操作で VirtualBox を有効にできるものの、Windows Phone のエミュレータなど Hyper-V VMs はすべて無効になります。
    • または、VirtualBox の代わりに Vagrant Hyper-V provider を使う。 これは不安定の可能性があります。

Mac特有

  • NFS errors NFSエラーの回避には、インストール作業中にファイアウォールで接続を認めるように設定します:Apple > システム設定 > セキュリティとプライバシー > ファイアウォール > ファイアウォールのオプション。「外部からの接続をブロック」のレ点を外し、さらに「ステルスモードを有効にする」も外すことで以下を可能にします:netbiosd、nfsd、rpc.lockd、rpc.rquotad、rpcbind、VBoxHeadless。注記=コンピュータの再起動を求められ、さらに複数のvagrant upでステータスを「外部からの接続を許可」に変更を求められる場合があります。インストール完了後、ファイアウォールのルールが更新できていれば「全ての外部からの接続をブロック」「ステルスモードを有効にする」にレ点を入れることができるはずです。
    • 代替策としてvagrant config nfs_shares off経由でNFSシェアをオフにできます

Debian および Ubuntu

  • MediaWiki-Vagrant は特定のフォルダーをホストマシン (利用者のコンピューター) と共有するため NFS を使います。 それには利用者のコンピュータをUbuntuの手順の指示などを参照して「NFSサーバ」に設定する必要があります。 Debian上ではsudo apt-get install nfs-kernel-serverが使えます。こちらもmodprobe nfsv3の処理をします。 注記=DebianのNFSサーバを始動するには/etc/exportsにエントリをします。 sudo rpcinfo -pで有効な「nfs」サービスを検知しない場合、現状はそのとおりだと考えられます。 通常は、/etc/exportsの最終行に利用しているホームディレクトリを記入してから/etc/init.d/nfs-kernel-server 再起動 すると、堂々めぐりの問題から脱出できるはずです。
  • MediaWiki-Vagrantの採用するNFS共有は、暗号化されたディレクトリからは駆動しません。その点、Ubuntuでは暗号化されたホームディレクトリを使用します。そこに問題の原因があるのかもしれません。MediaWiki-Vagrantを走らせるには以下から処理を選んで実行します。
    • vagrant upの駆動の前に、MediaWiki-Vagrantディレクトリを暗号化していないボリュームに移動(例:/opt
    • 別の処理として、vagrant config nfs_shares off経由でNFS共有を無効にする
  • NFS設定そのものが完了していない場合(初期のvagrant upが「NFS共有フォルダを積む」段階でハングアップした状態)。ホストでNFS daemonを再スタートすると解決することがあります(#5802を参照してください。)

基本的な使用法

 
Screenshot

ホストマシン上のvagrantコマンドラインツールは仮想マシンの制御に使うサブコマンドを複数、提供します。実は既に利用しています。仮想マシンをオンにするvagrant upです。大部分のvagrantサブコマンドと同様、実行はMediaWiki-Vagrantディレクトリもしくは その子クラスから起動する必要があります。初回の起動ではVagrantがシステムイメージを取得、MediaWikiの駆動に不可欠なソフトウェアを準備します。処理にはブロードバンド接続でCPU時間と実測時間で1–2時間かかるものの、実行は1回限りです。その後vagrant upを起動すると仮想マシンをすぐに起動します。

vagrant sshは仮想マシン上にインタラクティブなログインシェルを起動し、ユーザ名vagrantとしてログインします。ルートへはsudo経由でアクセス可能で、パスワードは不要です。仮想マシンはユーザのコンピュータ上で完全にサンドボックス化されており、環境設定はセキュリティではなく使いやすさ主体です。原則としてパスワードを求められたらvagrantと入力します。

ログインすると色鮮やかなMediaWikiのバナーの他、便利なコマンドのヒントが表示されます。

コマンドの phpsh は既に読み込まれた MediaWiki のコードベースとともに対話的な PHP インタプリターを開始します。コードを入力して「Enter」キーを押すとコードは直後に評価されます。行頭に等号「=」を入力すると処理結果はプリティプリントで出力されます。? と入力すると簡潔なヘルプを、help start で補足的な指示を表示します。

/vagrantフォルダはユーザのホストマシン上のMediaWiki-Vagrantフォルダに対応し、内容を共有します。MediaWikiのコードのインストール先は/vagrant/mediawikiです。そのため仮想マシンのMediaWikiコードの編集は、ホストマシン上の通常のエディタ環境を利用できます。

Updating

gitリポジトリや外部ライブラリ、データベースのスキーマを最新に保つには、vagrant git-updateを使います。このコマンドは次の処理に相当します。

  1. coreとすべての拡張機能や外装のディレクトリでgit pullを走らせる。
  2. composer updateを走らせ、最新の Composer で管理するライブラリを使用できるようにする
  3. さらにupdate.phpスクリプトを走らせる。

また機会を見て(もしくは近い将来の必要に応じて)vagrant git-updateに含まれないMediaWiki-Vagrant自体を更新する必要があります。実行する内容は以下のとおり。

git pull

… ご利用のMediaWiki-Vagrantルートディレクトリで実行。これを有効にするため次の処理をします。

vagrant provision

… (直後または後ほど)。

  警告: git を利用して手動で更新する場合、同時にcomposer updateを実行し、MediaWikiで必須とされる外部ライブラリをダウンロードする必要があります。 composer updateが必要かどうか判断するには、 checkComposerLockUpToDate.phpスクリプトを実行します。
Some projects have NPM dependencies, often for development usage only, that are not installed by Composer. These may be approximately identified with find -not \( -name node_modules -prune \) -name package.json and manually installed as needed after an update by executing npm install in each directory wanted.

仮想マシンからログアウトするにはlogoutと入力するかCTRL + Dのキーを押します。すると標準のコマンドプロンプトに戻り、vagrant haltを起動仮想マシンをシャットダウンしたり、vagrant upで再起動できます。仮想マシンのファイルを削除するにはvagrant destroyというコマンドを使い、インスタンスを手付かずの状態に戻すのに便利です。(新たなインスタンスとして整えるには続いてvagrant upを実行します。)

ロールの利用

MediaWiki-Vagrantは既定でMediaWikiの基本的なインスタンスを設定するものの、人気のあるMediaWikiの拡張機能やその依存関係など、相補的なソフトウェアの環境設定の方法も承知しています。これらの選択できるソフトウェアスタックを総合して〈ロール〉(役割)と呼び、MediaWiki-Vagrantによってコマンドラインの強力なインタフェースでそれらを簡単に制御します。

$ vagrant roles list
# 利用できるロールの一覧

$ vagrant roles enable role
# このマシン上でroleをオンにする。

$ vagrant roles disable role
# このマシン上でロール をオフにする。

$ vagrant provision
# ロールの有効・無効の切り替えもしくは設定が完了したら、変更の効果が発揮されるように起動。

短編のscreencastでロールの使い方を実演しています。ロールのページでその他の詳細情報を紹介します。

加えるロールが多くなるとVagrant仮想マシン(VM)に当てるメモリを増やす必要があるかもしれません。 特に「ブラウザーテスト」ロールの設定にはffiruby Gemのコンパイルというメモリを食うタスクが関わります。もし失敗したらVM内のメモリの解放もしくはメモリ割り当ての増加をしてみてください (bug 53864)。

MediaWiki-Vagrantにロールを増やす方法に興味があれば、下記の「ロールのオーサリング」の節を参照してください。

特定のロールのトラブル解決

centralauth

There are some roles that require special attention, centralauth role does not run db migrations automatically via puppet and requires running those by hand. If you get errors on provisioning this role try to run this script on the extension and see the errors it outputs:

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

Once you get a more concrete error you probably need to know what migration you need to run from the ones here:

extensions/CentralAuth/db_patches

wikidata

A simple vagrant roles enable wikidata && vagrant provision would fail. Here is a complete set of commands to make the Wikidata role up and running.

 $ vagrant up
 $ vagrant git-update
 $ vagrant ssh
 $ sudo apt-get update && sudo apt-get upgrade
 $ composer selfupdate --update-keys
 $ composer config --global process-timeout 9600

Log out from Vagrant, then you can happily run:

 $ vagrant roles enable wikidata
 $ vagrant provision

Note that the first provision may complain, thus looking like a failure. However, if you run a second provision, you will see that everything goes fine.

You may then point your browser to http://wikidata.wiki.local.wmftest.net:8080/. To create a new wikidata item load http://wikidata.wiki.local.wmftest.net:8080/wiki/Special:NewItem and to create a new property navigate to http://wikidata.wiki.local.wmftest.net:8080/wiki/Special:NewProperty

How to import a Wikidata dump

The Vagrant command import-dump, which imports an XML file into MediaWiki, does not handle wikis other than the default one (see phab:T183274#3893785). You need to run the importDump.php script inside the Vagrant box.

Here is the procedure to import XML dumps.

 $ mkdir wikidata_dumps
 $ cd wikidata_dumps
  • download the pages-articles chunks. For instance:
 $ wget https://dumps.wikimedia.org/wikidatawiki/latest/wikidatawiki-latest-pages-articles10.xml-p5264684p6341661.bz2
  • enable the import of Wikibase entities (see phab:T72898#1588002). Append the following line to your LocalSettings.php:
 $wgWBRepoSettings['allowEntityImport'] = true;
  • the following BASH script can help you monitor the process. You can paste it in a import_wikidata.sh file. Note that the highlighted line calls the actual import script:
#!/usr/bin/env bash

chunks=$(find wikidata_dumps -type f)
for chunk in $chunks
do
    now=$(date)
    echo "$now: started import of $chunk" >> wd_import.log
    echo "-------------------------------------------" >> wd_import.log
    bzcat $chunk | mwscript importDump.php --wiki=wikidatawiki --uploads --debug --report 10000 2>>wd_import.log
    now=$(date)
    echo "-------------------------------------------" >> wd_import.log
    echo "$now: completed import of $chunk" >> wd_import.log
    echo "===========================================" >> wd_import.log
done
  • log into the Vagrant box and run the script. Debug messages should show up there:
 $ vagrant ssh
 $ sudo chmod +x import_wikidata.sh
 $ ./import_wikidata.sh 
  • you can follow the progress log from outside the Vagrant box:
 $ tail -f wd_import.log

追加的な提案

ローカルにMediaWikiコアを複写

Sometimes you may want to start over from scratch by removing the entire vagrant directory or cleaning out the vagrant/mediawiki directory. In order to speed up the vagrant provisioning process, you may want to consider keeping a local, updated clone of the MediaWiki core that you copy into vagrant/mediawiki.

for example, assuming you are cloning MediaWiki repos into ~/projects/mediawiki/:

# clone and store a clean copy of MediaWiki core in ~/projects/mediawiki/core
cd ~/projects/mediawiki/
git clone ssh://<your-gerrit-username>@gerrit.wikimedia.org:29418/mediawiki/core

# clone a clean copy of vagrant in ~/projects/mediawiki/vagrant
cd ~/projects/mediawiki
git clone ssh://<your-gerrit-username>@gerrit.wikimedia.org:29418/mediawiki/vagrant

# create the mediawiki sub-directory if it doesn't exist
cd ~/projects/mediawiki/vagrant
mkdir ~/projects/mediawiki/vagrant/mediawiki

# copy the clean MediaWiki core to the clean vagrant/mediawiki directory
cp -r ~/projects/mediawiki/core/ ~/projects/mediawiki/vagrant/mediawiki

クローンしたリポジトリの更新

Update the cloned repos as often as possible/necessary.

cd ~/projects/mediawiki/core
git pull

cd ~/projects/mediawiki/vagrant
git pull
git submodule update --init --recursive

Or to update all cloned repos:

vagrant git-update

Vagrantの再読み込み

If you change configuration (e.g. vagrant_ram, your VM/MediaWiki web site freezes, or you experience a problem, vagrant reload may resolve it. This will restart your guest. Some roles also require a reload, which should happen automatically.

ロールを有効にするタイミング

Enable roles only once you've successfully run your first vagrant up.

Note that vagrant destroy will not reset the enabled roles. Be sure to disable all roles after running vagrant destroy, then run vagrant up. Then you can re-enable any roles and run vagrant provision.

proxyの背後のVagrant

If you are behind a proxy, Vagrant might throw some errors. vagrant-proxyconf をインストールすることもできます。 仮想マシンが特定のプロキシを使用できるようにするプラグインです。 This is a quick set up guide. For a detailed documentation you may check here.

プラグインをインストールします:

vagrant plugin install vagrant-proxyconf

すべての vagrant 仮想マシン上のすべてのソフトウェアのプロキシ設定を変更するには、$VAGRANT_HOME/Vagrantfile (既定では ~/.vagrant.d/Vagrantfile) に以下の行を追加します。

Vagrant.configure("2") do |config|
  if Vagrant.has_plugin?("vagrant-proxyconf")
    config.proxy.http     = "http://192.168.0.2:3128/"
    config.proxy.https    = "http://192.168.0.2:3128/"
    config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
  end
  # ... other stuff
end

Replace the addresses with the ip and port number of your proxy server. Use the config.proxy.no_proxy option to list out all the sites/domains for which you might want to bypass proxy. For example,

config.proxy.no_proxy = "localhost,127.0.0.1,.example.com,.someinternaldomain.com"

Now when you run a vagrant up, there shouldn’t be any warnings.

To disable the plugin set config.proxy.enabled to false or empty string (""). You can also disable it for specific applications. For example,

config.proxy.enabled         # => すべてのアプリケーションが有効 (既定)
config.proxy.enabled = true  # => すべてのアプリケーションが有効
config.proxy.enabled = { svn: false, docker: false }
                             # => 特定のアプリケーションが無効
config.proxy.enabled = ""    # => すべてのアプリケーションが無効
config.proxy.enabled = false # => すべてのアプリケーションが無効

MediaWiki-Vagrant prep

You may want to consider using a shell script such as mw-vagrant-prep to prepare a directory for a MediaWiki-Vagrant install.

デバッグ

プロビジョニング

あなたは実行中にプロビジョニングプロセスをデバッグできます。

PUPPET_DEBUG=1 vagrant provision

PHP

See Manual:How to debug#HHVM. But first work around タスク T94868.

You can debug PHP with Xdebug if you vagrant enable-role zend. Debugging in PHP is different from other client-side debugging. Your IDE listens for incoming connections, and when you access the server with a browser, a special header instructs PHP to connect to your IDE. See MediaWiki-Vagrant/Advanced usage#MediaWiki debugging using Xdebug and an IDE in your host for further information.

Chrome

  • For Chrome users, you should get XDebug Helper, and optionally Clear Cache, HTTP headers, and Mod Headers. Configure clear cache to automatically reload after clearing, and set up keyboard shortcuts (e.g. Ctrl+R for clear&reload, Ctrl+Shift+D to switch XDebugger on/off)

Firefox

  • Firefox users should check out easy Xdebug.
  • Install and configure an xdebug-compatible IDE on your machine (Eclipse, PhpStorm, Emacs, etc)
  • In IDE, start listening for the incoming debug connection
  • In IDE, set break point at the spot that interests you
  • Enable XDebug in the browser and navigate to your vagrant installation ( http://127.0.0.1:8080/... )

ログ ファイル

The mediawiki logs can be found in /vagrant/logs. There are log files for Apache in /var/log/apache2/, but it seems they are not written to. There is a log file for HHVM in /var/log/hhvm/. The PHP notices, warnings, errors, uncaught exceptions are logged by HHVM to the syslog which you can see in /var/log/syslog. The MySQL query log can be obtained by issuing SET GLOBAL general_log = 'ON'; in a client and then looking at /var/lib/mysql/*.log.

Running and debugging unit tests

To run the PHPUnit tests for ALL extensions:

$ vagrant ssh
$ cd /vagrant/mediawiki
$ sudo -u www-data php tests/phpunit/phpunit.php --wiki wiki

To run unit tests for a single extension:

$ sudo -u www-data env "PHP_IDE_CONFIG=serverName=mwvagrant" "CIRRUS_REBUILD_FIXTURES=yes" "XDEBUG_CONFIG=idekey=netbeans-xdebug" php tests/phpunit/phpunit.php --wiki=wiki --stop-on-failure --stop-on-error extensions/ExtensionName/tests/phpunit/

You can append path/to/tests/to/run.

Some tests may require running as the proper user to create lock files and such, hence this command runs as the "user" www-data that handles web requests.

For building coverage reports, see Manual:PHP unit testing/Code coverage#MediaWiki-Vagrant.

Debugging phpunit tests is a little more complex. This method is a bit hacky, but can be used until debugging remote interpreter improves (e.g. in phpStorm 8 EAP). This workaround lets you run MediaWiki unit tests from the browser.

  • Download phpunit.phar file to the root of your vagrant directory.
  • Create a php file unittest.php in the root of the mediawiki directory. Do not commit this file to the repository. Paste the following code into it:
  • In the above file, change argv parameter to the name of your test file
  • Apache maps the root of the mediawiki directory to /w. So navigate to http://127.0.0.1:8080/w/unittest.php to run this file
  • Follow #Debugging instructions to attach your debugger

Running browser tests

See Manual:JavaScript unit testing .

This link is pointing to deprecated documentation, someone who knows more about testing MediaWiki should update: Quality_Assurance/Browser_testing/Running_tests#Running_VisualEditor_browser_tests_via_Vagrant

コミットのプッシュ

If you're using MediaWiki-Vagrant for development you'll probably want to push some commits to MediaWiki core or an extension's repository using git review. By default, all remotes point to the https:// URLs. To avoid overriding this on a case by case basis, run:

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

You also need to have your ssh keys in ~/.ssh.

How do I...?

Check PHP version and settings
http://127.0.0.1:8080/info.php
Edit LocalSettings.php?
First, check that there is no role (vagrant list-roles) that already does what you need. If not, create a file in settings.d/ directory. See README and 00-debug.php-example file.
Update MediaWiki code?
The easiest is to use vagrant git-update from the host. Or, to just update the code without dependencies, you can use regular git fetch, pull, etc. commands in vagrant/mediawiki and vagrant/mediawiki/extensions/SomeExtension directories. You can run these commands on the virtual machine, but the file access will be faster on the host machine. MediaWiki-Vagrant pulls code from git master when you initially set up and/or add a role, but doesn't automatically update code after that.
Run MediaWiki PHP interpreter
ssh to vagrant and run mwscript eval.php. You might need to run it with sudo
Run MediaWiki SQL interpreter
ssh to vagrant and run mwscript sql.php. You might need to run it with sudo
Update virtual machine software packages?
vagrant provision does not update system packages in the VM. When you connect with vagrant ssh the login message will inform that you:
NN packages can be updated.
NN updates are security updates.

In vagrant ssh:
  • to update all packages, enter sudo apt-get update && sudo apt-get upgrade
  • for "automatic installation of security (and other) upgrades", similar to Cloud VPS instances, enter sudo unattended-upgrade
  • to update to the same packages that are on production WMF servers... TODO
Customize Vagrant
You should never need to change Vagrantfile directly. There are several aspects of vagrant you can customize:
  • Core settings (git user, ports, ram, ip, port forwarding) can be customized via .settings.yaml file. See vagrant config --help and vagrant forward-port --help for instructions. So for example you may run vagrant forward-port 1234 80 to enable port forwarding from host:1234 to guest:80.
  • Perform additional steps after Vagrantfile load by creating a file called Vagrantfile-extra.rb and placing it in the same folder as Vagrantfile - it will be automatically loaded. In case of conflict, values in the 'extra' file will supersede values in this file. See example in support/ directory.
Add custom Puppet code?
This is ideal if you want to work on your own MediaWiki site locally and let the MediaWiki-Vagrant install your dependencies for you. It's ideal if you have your own fork. There is a distinction between a role and this use case. Roles are meant to be installed in any order and without breaking. If your fork needs different calls and get in trouble with roles, create your own class and call what you need, including roles.
To do so, place your custom puppet code in puppet/modules/local/manifests/myown.pp with your own class, like so:
class local::myown {
    include ::role::svg
}

To apply your class, add it to the "classes" key in puppet/hieradata/local.yaml. You can create the file if it doesn't exist.

classes:
  - local::myown

Then run vagrant provision to apply the change via Puppet.

Update MediaWiki-Vagrant itself?
(For example, to use new roles.) In a terminal, change to the vagrant directory on the host computer and enter a regular git command such as git pull --ff-only. You will typically want to run vagrant provision after updating to apply any new puppet changes to your virtual machine.
Run GUI applications on the virtual machine?
If you have an X server installed, SSH into the virtual machine using ssh -- -X to enable X forwarding. (Mac users should update to the latest version of XQuartz.)
As an alternative, you can run the virtual machine in GUI mode, which allows you to interact with the VM as though it had a physical display. To enable GUI mode, create a file called Vagrantfile-extra.rb in the root repository folder, with this as its content:
Vagrant.configure('2') do |config|
    config.vm.provider :virtualbox do |vb|
        vb.gui = true
    end
end
Save the file and run vagrant halt followed by vagrant up. The virtual machine's display will appear in a window on your desktop.
Adjust the resources allocated to the VM?
If you'd like to allocate more or less CPU / RAM to the VM, see vagrant config --help for instructions.

Alternatively, you can do it by creating Vagrantfile-extra.rb (see support/ dir for an example):

Vagrant.configure('2') do |config|
    config.vm.provider :virtualbox do |vb|
        # See http://www.virtualbox.org/manual/ch08.html for additional options.
        vb.customize ['modifyvm', :id, '--memory', '768']
        vb.customize ['modifyvm', :id, '--cpus', '2']
    end
end
Change the editor used for git commit messages?
git config --global core.editor "vim"
Setup a custom hostname?

Go to Horizon, choose Web Proxies, and enter a DNS hostname, say <hostname> View your new wiki at "http://<hostname>/wiki/"

Make the custom hostname point to homepage of my vagrant role instead of wiki homepage?

Create a local.yaml file in the /vagrant/puppet/hieradata directory. In it, add:

<rolename>::vhost_name:<hostname>
role::mediawiki::hostname: localhost

Run vagrant provision.

Run a branch of MediaWiki other than master?
Set the "mediawiki::branch" key in puppet/hieradata/local.yaml. You can create the file if it doesn't exist.
mediawiki::branch: "wmf/1.24/wmf18"
This change has to be made BEFORE running vagrant up for the first time. If you decide you want to do it later, make the change, destroy your current VM with vagrant destroy -f, delete your existing mediawiki checkout and finally build a new VM with vagrant up.
Vagrant is designed to run with the master branch, and may not work perfectly, or at all with older versions of core and/or extensions[3].
Run MediaWiki under HHVM rather than Zend PHP?
  • To convert all wikis in your MediaWiki-Vagrant instance to HHVM: vagrant roles enable hhvm && vagrant provision

高度な使用法

MediaWiki の設定

As an alternative to managing all MediaWiki settings in a single, large LocalSettings.php file, consider grouping your configurations by component or theme, and creating a separate PHP file in settings.d/ for each group. This makes it quite easy to keep your settings organized, to temporarily disable specific configurations, and to share settings with others.

MediaWiki will automatically load any PHP files in settings.d/ in lexical order. You can control the order in which your configurations are set by adopting the habit of adding a two-digit prefix to each file name.

例:

    settings.d/
    ├── 10-RunFirst.php
    ├── 20-SomeExtension.php
    └── 99-RunLast.php

Note that the settings files in settings.d/puppet-managed are automatically created and destroyed in response to your Puppet configuration. Don't put your custom settings there, because Puppet will erase or override them. Keep your custom settings files in settings.d/ instead.

Vagrant flags

vagrant config --list display a list of all current Vagrant flags.

After the initial ./setup.sh, in your vagrant directory, you can then set one of the vagrant flags that appears in the config list, e.g. vagrant config nfs_shares no

Job queue

If you're testing something that needs to churn the job queue, you may need to increase the number of job runners. Currently this is not available through LocalSettings.php, but must be set in the config file for the job runner.

  1. Open puppet/modules/mediawiki/templates/jobrunner.json.erb
  2. Change the value for the 'runners' key from 1 to the desired value (say, 4)
  3. Re-provision with vagrant --provision
  4. Beware this will be a difference from the git master in your code

See instructions above for adjusting CPU core count appropriately (highly recommended for CPU-bound task such as video transcoding).

Additional storage space

By default, there is relatively little free space on the root partition within the VM. If you plan to test uploading and processing of large image and video files, this may be insufficient.

Manual steps:

  • Shut down the VM (vagrant halt)
  • Open VirtualBox Manager
  • Select the VM and go into Settings
    • Under Storage, select "Controller: SATA" and click the "Add hard disk" icon.
    • Select the default disk image type.
    • Name the disk 'VagrantImageSpace' or similar, and give it enough space (say, 80GB) -- by default the file will start small and expand to actual usage, so give as much space as you might need
    • Close out the dialogs and restart the VM (vagrant up)
  • Run vagrant ssh to get a shell inside the terminal
    • Run sudo fdisk /dev/sdb to set up new partitions...
    • Type n, p, 1, and hit (enter) twice for default size
    • Type w to save the partition table
  • Run sudo mke2fs /dev/sdb1 to create the filesystem
  • Run sudo vi /etc/fstab to edit the mounts list
    • Add line at end: /dev/sdb1 /srv/images ext4 errors=remount-ro 0 2
    • save out
  • Run sudo mount /srv/images to mount the filesystem
  • Run sudo chown www-data:www-data /srv/images to set the file permissions
  • Exit the shell exit
  • Reboot the VM (vagrant halt; vagrant up)

ロールのオーサリング

MediaWiki-Vagrantが作成した仮想マシンは、ウィキメディアの主要なプロジェクトの制作環境に似ていて、ウィキメディアの技術オペレーションチームがプロダクションサーバ管理ならびにWikimedia Cloud VPSインスタンスに使うのと同じツール—Puppet—を用います。設定管理ツールとしてのPuppetは、宣言型のソフトウェア設定を表現するドメイン固有の言語を提供します。Puppetコードを含むファイルが〈マニフェスト〉です。Puppetを実行すると利用者が送ったマニフェストを解釈し、それに従ってマシンを設定します。Vagrantのロールとは、つまりPuppetのマニフェストの組み合わせなのです。

MediaWiki-Vagrant's Puppet codebase contains abstractions that make it easy to automate the configuration of MediaWiki extensions and related software. If you are a developer working on a software project that relates to MediaWiki, you are encouraged to submit a patch with a Puppet role for your project. Adding a Vagrant role for your project makes it easy for other developers to check out your work. Using a managed virtual machine as a development sandbox for your project reduces the chance of "works-on-my-machine" errors that often result from geographically remote developers working in incompatible environments.

The easiest way to get started with custom roles is to look at how existing roles are implemented in puppet/modules/role/manifests/*.pp. These roles depend on Puppet modules in puppet/modules (usually, foo::bar { ... } translates to a call to puppet/modules/foo/manifests/bar.pp) and use files and templates from the other puppet/modules/role/*/rolename/ directories. The Puppet code is generally well-documented and contains examples that demonstrate its proper usage.

Some of the more useful puppet modules are:

Setting up an instance on Cloud VPS

You can use MediaWiki-Vagrant in Cloud VPS to install MediaWiki on a Wikimedia Cloud VPS instance and enable MediaWiki-Vagrant roles in it.

バグ

If you spot a bug in MediaWiki-Vagrant, please report it. First, make sure the bug is not a known Vagrant or VirtualBox bug by searching the Vagrant issue tracker on GitHub and the VirtualBox bugtracker. If it is not, go ahead and submit the bug to Wikimedia Phabricator. Clearly describe the issue and include steps to reproduce, whenever possible.

リンク


注記

  1. Fedora利用者はOracleの指示に従わないでください。代わりにRPMfusionリポジトリを有効化(例えばApper設定経由)した後、VirtualBoxおよびkmod-VirtualBoxを選択してインストールします(注記=大文字小文字識別で、場合によりバージョン識別あり! パッケージが見つからない時はApperで検索。) こちらのガイドに従うと代替手段が使えます。 エラーが表示され、カーネルが新しすぎると警告を受けることがあります。その場合には akmods-VirtualBoxをインストール後、sudo akmodsを起動してモジュール作成を確認します。
  2. If you are on Ubuntu 16.04, do not install Vagrant using apt-get. Instead, download it on the Vagrant web site. Using the version from APT will cause setup.sh to fail.
  3. Vagrant dependent on MediaWiki 1.21+