vagrant

Vagrant

Minimal setup

This extension uses Mediawiki-Vagrant, and a complete setup can be made quite easily.

1. Make sure you have Vagrant, etc, prepare a development directory, and move to that directory.

2. Clone Mediawiki

   git clone --recursive https://gerrit.wikimedia.org/r/mediawiki/vagrant .
   

3. Run setup.

    ./setup.sh
   

4. Enable the role for Expect. This pulls inn the role for Scribunto, which pulls in additional roles.

    vagrant roles enable expect
   

5. Start the instance.

    vagrant up
   

6. Done.

This should create a working environment with phpmd, phpcs, and phpunit. An actual call would be composer unit. See scripts in composer.json for all calls.

Extended setup

Luarocks and ldoc

It is necessary to install luarocks and a few libs to recreate the generated docs.

1. Install luarocks. This will pull in several additional packages, the most important is lua5.1.

    sudo apt install luarocks
   

2. Install ldoc. This will pull in several additional packages, like penlight, markdown, and luafilesystem.

    sudo luarocks install ldoc
   

3. Done.

This should make a working ldoc. An actual call would be composer ldoc.

Import of pages

A few pages for testing can be imported in the new instance.

1. Open a terminal at the new Vagrant instance

    vagrant ssh
   

2. Go to the Expect folder and import the pages.

    cd /vagrant/mediawiki/extensions/Expect
    composer import
   

3. Go to the mediawiki root, rebuild recent changes, and rebuild site stats.

    cd /vagrant/mediawiki
    php maintenance/rebuildrecentchanges.php
    php maintenance/initSiteStats.php --update
   

4. Done

Resource allocations

Vagrant resources

It could be interesting to adjust the amount of memory and number of CPU cores used during testing. Such resource allocations are described on mw:MediaWiki-Vagrant#Adjust the resources allocated to the VM? Especially note the code snippet for ~/picklespace/Vagrantfile-extra.rb.

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', '1536']
    vb.customize ['modifyvm', :id, '--cpus', '2']
  end
end

To restart the instance do vagrant reload.

If the memory is too low, then the test run in guest will end in a fork failed. When that happen, increase the memory until the test runs ok. With fastest it should be sufficient to set this around “1024”, and “1536” is enough. If it is set to high, then it seems like the test runs take more time. This could be due to garbage collection.

If the number of CPUs are increased beyond the actual number of cores, an increase in run time might be observed. When that happen, decrease the number of CPUs available to the vagrant instance.

Composer resources

There can be timeouts in the Vagrant guest instance during composer runs. To adjust for the increased time do something like

vagrant ssh
composer config --global process-timeout 900

Manual verification

A few manual checks to verify proper operation.

Run composer import to load the examples.

Open the page “Module:Export-expect” for editing, and scroll down to the console. Typing the example code you should get the result described in the comment.

= type( p )            -- 'table'
= mw.dumpObject( p )   -- this is the actual table

Open the page “Module:Hello-world” for editing, and scroll down to the console. Typing the example code you should get the result described in the comment.

= p._hello('Foo')      -- 'Hi there Foo!'
= p._hello('User:Foo') -- throws an error

An alternative is to inspect the page “hello-world”, given that the test pages are imported.