Installer syntax

From MediaWiki extension testing

Jump to: navigation, search

Contents

A quick walkthrough

If you are used to the wikiation installer, it should still work roughly the same way it used to, with few caveats. Operation of the installer is still fairly simple, but the scope of the tasks you can perform with it has been expanded.

Here's a walkthrough I performed on 6.wikiation.

kim@6:~$ sudo bash
root@6:~# wikiation_installer 
=== Wikiation installer (v.  50) ===

Interactive mode.
please type a command and hit enter
help<enter> for help
^D, or quit<enter> to quit



installer > ls
Did you mean to specify any of wikiation_toolkit:, extension:, mediawiki:

The installer now supports more than just mediawiki, so you need to pick what you would like to work with.

installer > ls mediawiki:
REL1_13_2
wikiationext_family.py
test_targe
REL1_13_3
ssltest
versiontest
extension_test
pywikipedia.tar.gz
betawiki
exttest_target

(note that this walk-through was carried out on the development machine 6.wikiation.nl, and thus already has all kinds of things installed. Your system is likely still empty, or almost so.)

This is fairly straightforward. Note that ls mediawiki: is actually short for ls installed.mediawiki:. Try to type that now. There shouldn't be a difference in the output. Anytime you leave out part of a name (or "path"), the installer will try to intelligently fill in the blanks. For instance, if you leave out the first part, it will assume you mean to look at what is already installed.


If you want to see what is available, you can ask:

installer > ls available.mediawiki:
REL1_13_2
wikiationext_family.py
test_targe

...

REL1_13_1/
REL1_13_2/
REL1_13_3/

...

merged_to_wikidata_2/
start/
tug_0_1/
installer > 

In revision 50, the installer makes a wrong assumption when you look at extension: . You always need to ask for available.extension:

installer > ls extension:
no revision specified ... did you try doing   ...  in <Revision> ?
installer > ls available.extension:
ImageMap
ParserFunctions
Cite
installer >

(This document was written very early on. Your list of available extensions will be considerably longer than this!)

you can quit the installer at any time using either quit , or by pressing the key-combination CTRL+D (Unix users write this key-combination as ^D )

 
installer > quit
root@6:~# 

You've now had a quick look around in the installer. We'll actually get around to installing things shortly. But first, let's look at how things are named.

Paths

The wikiation_installer needs to refer to all kinds of different things in different locations, and it also needs to keep track of what is already installed, and what is available to be installed, and it must do so for several quite different kinds of systems. That's a lot of ground to cover. The wikiation_installer tries to keep things as simple as possible.

Explore around a bit, and get used to them.

Full Path.

A command needs to operate on something, that something is called a path

ls <path>
info <path>
install <path>
uninstall <path>

A full path to an item consists of 4 parts.

available/installed.installation_system:name in destination as alternate name

Sometimes you can leave out parts of the path, and the installer will try to infer what you mean.

available/installed.

Should we look under things that are available, or should we look under things that are already installed?

If not specified, the installer will look under things that are already installed

installation_system:

The installer manages several very different kinds of system which it can install things under.

A system determines the names of things, online sources to download things from, where to put files once they are installed, how to configure components, etc etc.

The installer currently understands 3 installation systems:

  • wikiation_toolkit: installs and uninstalls the tools you use to run extension tests, check for isolation issues, etc.
  • mediawiki: Installs mediawiki
  • extension: Installs extensions into an existing mediawiki (such as the mediawiki you just installed using mediawiki:)

name

The name of the thing you want to (un)install, get information on, etc.

you can find out what names are available using

ls available.wikiation_toolkit:
ls available.mediawiki:
ls available.extension:

in destination

The wikiation installer can manage several revisions and mediawiki versions all at once. When working with the extension: installation system, you need to install extensions in some mediawiki revision, and here's where you get to specify which one.

For a list of mediawiki revisions you can install to, you can look it up with

ls installed.mediawiki:

Of course, in a new, clean environment, this list will be empty. Install a mediawiki revision first!

as alternate name

When working with the mediawiki: installation system, you can provide a name for your wiki while you are installing it.

example
install mediawiki:REL1_13_1 as my_test_environment

This installs a new mediawiki instance, corresponding to release 1.13.1, which will henceforth be referred to as my_test_environment. (This also applies to installing extensions, uninstalling the instance in future, etc)

If you do not provide a name with as, the wiki will be installed as the name of the release. The following two lines are equivalent:

install mediawiki:REL1_13_1
install mediawiki:REL1_13_1 as REL1_13_1

Examples

full paths
ls available.mediawiki:
install available.mediawiki:REL1_13_2
install available.extension:ImageMap in REL1_13_1
uninstall installed.extension:ImageMap in REL1_13_1
info available.wikiation_toolkit:wikiation_exttest
abbreviations
example                           Full
=====================================================
ls mediawiki:                     ls installed.mediawiki:
install mediawiki:REL1_12_0       install available.mediawiki:REL1_12_0
info extension:wikiation_exttest  info installed.extension:wikiation_toolkit
uninstall mediawiki:REL1:13_1     uninstall installed.mediawiki:REL1_13_1
Personal tools