Continuous integration/Jenkins

Jenkins is a Java tool used to handle recurring tasks such as running tests or building packages. Our primary install is at https://integration.wikimedia.org/ci/.

The tool is permanently connected to our review tool (Gerrit) and can be made to react on changes submitted to Gerrit. A typical example, is running MediaWiki unit tests whenever a change is submitted to the  repository.

The configuration of individual jobs is abstracted via Jenkins job builder. The jobs are triggered with Zuul (which processes Gerrit events), and configured in the  repository.

If you are on the allow list, you can force Zuul to run all tests on a patchset by adding a comment beginning with the word  in Gerrit.

Most of the infrastructure is detailed on wikitech:
 * Jenkins
 * Add new Jenkins agents.

Comment commands
You will need to be added to the allow list to trigger these commands.
 * — force Zuul to (re)run all tests on a patchset
 * — force Zuul to (re)run code coverage checks on a patchset
 * — force Zuul to (re)run codehealth checks on a patchset
 * — force Zuul to (re)run performance checks on a patchset

Automatic installation
To make the install go faster, it helps to have a mediawiki-core checkout in ~/src/mediawiki-core - if this repository exists, it will make a local clone. If it doesn't, it will download from gerrit instead (slow!).

Manual installation

 * is the default jenkins configuration directory
 * WM-specific configuration patch I -
 * because some jobs assume jenkins is installed in
 * Download jenkins and place it in ~/.jenkins
 * install the following plugins (download into ):
 * git
 * git-client
 * ansicolor
 * notification
 * scm-api
 * timestamper
 * build-timeout
 * xunit
 * Download and its  ‒ see Continuous_integration/Jenkins job builder for more information. You don't need a password when you install Jenkins locally.
 * WM-specific configuration patch II - Patch the JBB configuration that depends on Zuul (see the mkjenkins script for a diff)
 * If you already have a checkout of mediawiki-core: . Otherwise,
 * Start Jenkins:
 * When Jenkins is running, install the JBB jobs:.
 * When Jenkins is running, install the JBB jobs:.

Hung beta code/db update
This deadlock seems to happen more often than not following or during a database update that is taking a while to complete.


 * Take deployment-deploy03 offline in Jenkins https://integration.wikimedia.org/ci/computer/deployment-deploy03/markOffline
 * Kill any jenkins jobs running on deployment-deploy03 via Jenkins UI
 * Kill all pending jobs in the Jenkins queue that are "waiting on executors"
 * Disconnect deployment-deploy03 https://integration.wikimedia.org/ci/computer/deployment-deploy03/disconnect
 * Bring deployment-deploy03 back online (button labeled "Bring this node back online")
 * Launch slave agent (there's a button that says this)
 * Check agent log to see that it connected https://integration.wikimedia.org/ci/computer/deployment-deploy03/log

Sometimes you have to do this whole dance several times before Jenkins realizes that the there are a bunch of executors that it can use.

Alternate method:
 * Go to https://integration.wikimedia.org/ci/manage
 * Go to "Configure System"
 * Search page for "Enable Gearman"
 * Un-check the checkbox
 * Save
 * Wait 30s
 * Check the "Enable Gearman" checkbox
 * Save

This second method may interrupt communication between running Jenkins jobs and Zuul but it seems to work even when the offline/online method fails to clear the deadlock.

Alternate alternate method:


 * Login to https://integration.wikimedia.org/ci
 * Hit the red  to cancel one pending   job
 * That's it!

It seems that this is some conflict between the Jenkins native scheduler and the Gearman scheduler. Cancelling the build seems to fix the problem. Subsequent builds will deploy the same code to production.

Restart
Zuul should not be restarted. Zuul preserves the queue and continues after the restart.

Via web interface

Apply the self-serve Jenkins repair!

With a  any currently running jobs will block a restart until they are canceled. Any long running jobs should be killed. Check for jobs on the main jenkins dashboard, cancel any long-running jobs there. Bonus points: make a note of the patches for which you have canceled jobs on the zuul dashboard, comment "recheck" for any patches in the test queue that you have aborted.


 * 1) Head to https://integration.wikimedia.org/ci/safeRestart
 * 2) Login with your labs account being part of the 'wmf' LDAP group
 * 3) press "Yes"
 * 4) in : "!log restarting stuck Jenkins".

Shell

On contint2001.wikimedia.org:

sudo systemctl restart jenkins

And then wait a while. Monitor logs via

OOM Issues
Troubleshooting

Whenever Jenkins appears to be stuck or facing high CPU usage, you will want to look at the Java threads: https://integration.wikimedia.org/ci/threadDump

This is the way to do it from the CLI

jstack -l -F

Last time this happened (2017-05-20) a restart of Jenkins "fixed" the problem, but we were unable to troubleshoot without a stacktrace from

Build failures look unrelated
Sometimes, changes in other repositories may cause your builds to fail. You can check the Shared Build Failure board to see if any existing issues are similar to your build failure; if there aren’t any, and you’re reasonably certain that your build failures are unrelated to your own changes, you can create a new task.

Agent remote call failed
Errors like  are caused with problems in the java agent process running on each agent machine.

To fix these errors try restarting the agent on the target machine.


 * Take agent offline in Jenkins at https://integration.wikimedia.org/ci/computer/AGENTNAME/markOffline
 * Disconnect the agent: https://integration.wikimedia.org/ci/computer/AGENTNAME/disconnect
 * ssh into the agent and kill the java  process
 * Bring node back in Jenkins web ui: https://integration.wikimedia.org/ci/computer/AGENTNAME/toggleOffline
 * Relaunch the agent on the machine via Jenkins web ui: https://integration.wikimedia.org/ci/computer/AGENTNAME/launchSlaveAgent
 * Ensure the agent has launched on the agent itself, i.e., ensure that there is a new PID for the  process

Debugging
Start Jenkins with Java option:

-Dhudson.plugins.git.GitSCM.verbose="true"

Text thread dump: https://integration.wikimedia.org/ci/monitoring?part=threadsDump