Continuous integration/Entry points

From MediaWiki.org
Jump to: navigation, search

JavaScript[edit]

Testing JavaScript[edit]

We are using npm test as an entry point. If your project has JavaScript files, it should at least have a package.json file and define a "test" script.

You will need the .jshintignore, .jshintrc, and .jscsrc configuration files in your project (see Manual:Coding conventions/JavaScript#Linting). Look at one of the projects listed in the example section below for an example of these files.

On Linux, if npm commands fails with "node: No such file or directory", you may need to install the "nodejs-legacy" package.

Grunt task runner[edit]

If your project has complex build processes or is an extension or skin that will benefit from i18n checking and JSON file linting, the convention is to use Grunt as a task runner. Your project still has a package.json file, which has a dependency on grunt-cli and sets "test": "grunt test". In turn, a Gruntfile.js file implements grunt test, and this can run a wide variety of tools and tests:

  • eslint
  • banana-checker which checks messages in MediaWiki i18n files.
  • jsonlint which checks JSON files including composer.json and extension.json for conformance.

You can specify configuration settings for these tools in Gruntfile.js. However, it should contain little to no configuration for tools that can run outside grunt so that they operate the same when run standalone or from a text editor plugin. Always use native configuration files where possible, including .eslintrc.json mentioned above.

JavaScript documentation[edit]

Use npm run doc as the entry point. The convention is to use JSDuck. The "predoc" and "postdoc" script hooks in package.json can be used to run any additional scripts (e.g. build files for inclusion beforehand, or copy additional files for publication afterward).

Examples[edit]

Advanced setup using Grunt:

{
  "scripts": {
    "test": "grunt test",
    "doc": "jsduck"
  },
  "devDependencies": {
    "grunt": "1.0.1",
    "grunt-banana-checker": "0.5.0",
    "grunt-eslint": "19.0.0",
    "eslint-config-wikimedia": "0.3.0",
    "grunt-jsonlint": "1.1.0"
  }
}

Example projects:

Further reading:

PHP[edit]

Testing PHP[edit]

We are using composer test as an entry point. If your project has PHP files it should list the test framework packages it needs in composer.json under "require-dev" and list the commands to be run in the scripts.test property:

{
	"require-dev": {
		"jakub-onderka/php-parallel-lint": "0.9",
		"mediawiki/mediawiki-codesniffer": "0.7.2",
		"phpunit/phpunit": "4.8.*"
	},
	"scripts": {
		"test": [
			"parallel-lint . --exclude vendor",
			"phpunit",
			"phpcs -p -s"
		]
	}
}

See composer.json of the cdb project for a good example.

Note that MediaWiki extensions are not standalone projects and cannot run their own PHPUnit test suite from composer, those repositories have a separate mediawiki-extensions job. PHPCS and PHP lint are still run via composer.json and composer test.

When running the suite under Jenkins, we might want to capture the test results to publish them on the build page. Since your test entry point has multiple commands, the extra arguments are set by Jenkins and should be included in each script command. By convention, the environment variable holding these arguments is all upper case, with the command line name suffixed with _ARGS:

"scripts": {
	"test": [
		"phpunit $PHPUNIT_ARGS"
	]
}

The Jenkins job can then set these environment variables to inject additional arguments when invoking composer test for e.g. a JUnit report.

PHP Documentation[edit]

See: Doxygen.

Use the doxygen program to generate a Doxyfile file in the project root.

Testing Python[edit]

See Continuous integration/Tutorials/Test your python.

Ruby[edit]

Rake[edit]

Use Rake to define your commands, they will be executed via Bundler.

Example Rakefile:

require 'bundler/setup'

require 'rubocop/rake_task'
RuboCop::RakeTask.new(:rubocop) do |task|
  # if you use mediawiki-vagrant, rubocop will by default use it's .rubocop.yml
  # the next line makes it explicit that you want .rubocop.yml from the directory
  # where `bundle exec rake` is executed
  task.options = ['-c', '.rubocop.yml']
end

require 'mediawiki_selenium/rake_task'
MediawikiSelenium::RakeTask.new

task default: [:test]

desc 'Run all build/tests commands (CI entry point)'
task test: [:rubocop]

The above code will create following Rake targets.

$ bundle exec rake -T

rake rubocop               # Run RuboCop
rake rubocop:auto_correct  # Auto-correct RuboCop offenses
rake selenium              # Run Cucumber features
rake test                  # Run all build/tests commands (CI entry point)

The Jenkins job rake-jessie invokes test target by running bundle exec rake test.

Reference: phab:T104024

ruby debug tip[edit]

You can use the gem pry to break on error and get shown a console in the context of the failure. To your Gemfile add gem 'pry' then to break:

require 'pry'
binding.pry
your call that fail

You will then be in a console before the breakage that let you inspect the environment (ls). See https://github.com/pry/pry for details.

ci.yml[edit]

We have a set of Jenkins jobs that run daily and execute Ruby + Selenium tests. The jobs are named selenium*.

Each repositories has only a single job defined in Jenkins. It is a multi configuration job that spawns one or more child job based on a configuration in each repositories: tests/browser/ci.yml. The main job will then spawn child jobs based on its content.

Example of a simple ci.yml is in mediawiki/core.

BROWSER:
  - firefox

MEDIAWIKI_ENVIRONMENT:
  - beta

PLATFORM:
 - Linux

As you can see, there are three variables, BROWSER, MEDIAWIKI_ENVIRONMENT and PLATFORM.

BROWSER and PLATFORM can be any valid Sauce Labs browser/OS/version combination.

MEDIAWIKI_ENVIRONMENT can have values beta, mediawiki and test, or any other environment configured in environments.yml.

For example:

BROWSER:
  - chrome
  - firefox
  - internet_explorer 9.0
  - safari

MEDIAWIKI_ENVIRONMENT:
  - beta
  - mediawiki
  - test

PLATFORM:
  - Linux
  - OS X 10.9
  - Windows 8.1

Example of a complicated ci.yml is in mediawiki/extensions/MultimediaViewer. For more information see Jenkins Yaml Axis Plugin.

Reference: phab:T128190