This is a Vagrant Environment for a Continuous Integration server using the Jenkins daemon.

This configures Jenkins through CLI/JNLP and Groovy scripts to:

• Enable the simple Logged-in users can do anything Authorization security policy.
• Add a SSH public key to vagrant user account and use it to access the CLI.
  • Except on Windows; there it uses JNLP4/HTTPS to connect to the Jenkins Master from a Windows Service. Only a Windows Service has the needed permissions to run integration tests that use the WCF net.pipe transport and to build unity projects.
• Optionally use LDAP user authentication.
• Add and list users.
• Install and configure plugins.
• Setup GitLab integration (assumes rgl/gitlab-vagrant is already deployed)
• Setup nginx as a Jenkins HTTPS proxy and static file server.
• Create Freestyle project job.
• Create Pipeline job.
• Create Multibranch Pipeline job.
• Add a Ubuntu Linux slave node.
• Add a Windows slave node.
  • With docker-ce (default) or docker-ee (you need to uncomment it from the Vagrantfile).
  • With enabled long path support on the OS and chocolatey.
  • With MSYS2 to be able to use the Execute shell build step.
    • See the example-execute-shell-windows job.
  • With Unity Editor.
    • You still need to activate it by running Unity Hub.
• Add a macOS slave node.

NB If you are new to Groovy, be sure to check the Groovy Learn X in Y minutes page.

These are the machines and how they are connected with each other:

Usage

Build and install the Ubuntu 20.04 Base Box.

Build and install the Windows 2022 Base Box.

Build and install the macOS Base Box.

Add the following entry to your /etc/hosts file:

10.10.10.100 jenkins.example.com
10.10.10.102 windows.jenkins.example.com

If you want to use LDAP for user authentication, you have to:

1. have rgl/windows-domain-controller-vagrant up and running at ../windows-domain-controller-vagrant.
2. uncomment the config_authentication='ldap' line inside provision.sh.

Run vagrant up --no-destroy-on-error jenkins to launch the master. See its output to known how to login at the local Jenkins home page as admin (you can also login with one of the example accounts, e.g. alice.doe and password password).

NB nginx is setup with a self-signed certificate that you have to trust before being able to access the local Jenkins home page.

Run vagrant up --no-destroy-on-error ubuntu to launch the Ubuntu slave.

Run vagrant up --no-destroy-on-error windows to launch the Windows slave. Portainer is available at http://windows.jenkins.example.com:9000/.

Run vagrant up --no-destroy-on-error macos to launch the macOS slave. NB you first need to download Xcode_8.1.xip. After provisioning you can delete it, as Xcode_8.1.cpio.xz will take its place as a more efficient way to install Xcode.

Email notifications are sent to a local MailHog SMTP server running at localhost:1025 and you can browse them at http://jenkins.example.com:8025.

Groovy Snippets

Show Object Properties

def getObjectProperties(obj) {
    def filtered = ['class', 'active']

    properties = obj.metaClass.properties
        .findAll {it.name != 'class' && it.name != 'metaClass'}
        .inject([:]) {acc, e -> acc[e.name] = e.getProperty(obj); acc}

    properties
        .sort {it.key}
        .collect {it}
        .findAll {!filtered.contains(it.key)}
        .join('\n')
}

project = Jenkins.instance.getItem('MailBounceDetector-multibranch-pipeline')
getObjectProperties(project)

Create Api Token

// create an user api token.
// see http://javadoc.jenkins-ci.org/hudson/model/User.html
// see http://javadoc.jenkins-ci.org/jenkins/security/ApiTokenProperty.html
// see https://jenkins.io/doc/book/managing/cli/
import hudson.model.User
import jenkins.security.ApiTokenProperty

u = User.getById('alice.doe', false)
p = u.getProperty(ApiTokenProperty)
t = p.tokenStore.generateNewToken('token-name')
u.save()
println t.plainValue

Reference

• Jenkins Handbook