Perl script sets up Jenkins jobs to automate builds and tests
Automatic Testing

Instead of configuring the Jenkins continuous integration server in the browser with mouse clicks and text input for builds, programmers can store the necessary data in the source control system and let a Perl script do the work.
Continuous integration (CI) and the associated productivity gains are now firm favorites in the development universe. Input the code into the source control system, issue a pull request, have a co-worker check it – already the cogwheels of the CI pipeline grab the change, run it through the ever-growing test suite, and, presto, everything gets released all at once. CI servers like Jenkins [1] or TeamCity [2], which grab the latest source versions of a project and fire up a build with all tests and possible deployment steps, are enjoying growing popularity.
But spending two minutes creating a new build project in Jenkins' recalcitrant interface can wear down the enthusiasm of even the most motivated developers. As Figure 1 shows, the quest here is to find the required boxes, check them, and fill out some text fields.

If every Perl project requires the same command sequence to start the build process, you don't need to keep typing the same info for each new project. And, the question remains: What happens if a few dozen projects move to a new CI server, does this mean starting the insane task of typing and clicking all over again?
Minimalist Thinking
Your very own Perlmeister's vision is of a more minimalist and conventional approach, such as the one adopted by Travis-CI [3] a long time ago. In this case, a small file in the source code of the project specifies the Git repository from which Jenkins can retrieve the source code and the name under which to run the project on the Jenkins server.
The Perl script presented here then puts together the Jenkins configuration as an XML document and sends it to the server as a POST request via the Jenkins API. The result is that the project is set up without any typing.
No Docs Reading Required
How do you discover the correct format for the XML data without reading the documentation or even the Jenkins source code? Manually entering a test project in the Jenkins interface and then retrieving its XML representation reveals the secret, as shown in Figure 1. The developer here enabled Git as an option for the source code repository and then typed the URL for the GitHub project into the text box that appeared.
The project is called log4perl
on the Jenkins server, and the script in Listing 2 can easily read the associated XML data via the API. The CPAN Jenkins::API module provides the project_config()
method, which contacts the server on port 8080 of the localhost in the script and requests the configuration, supplying the project name.
Listing 2
jenkins-project-xml
First of all, however, a script like the one in Listing 1 [4] should check to see whether the Jenkins server responds to requests on the default port. If this works, Listing 2 can inquire as to what the configuration of a particular project looks like.
Listing 1
jenkins-ok
Configuration Jungle
If successful, the project_config()
method returns a tangled nest of XML, which – among other things – reveals the values for the URL pointing to the project's Git repository, as manually entered in the web UI (Figure 2).

Armed with this example, a script like that shown in Listing 3 can put together a template with an XML structure and use variables (e.g., [% git_url **%]
) interpreted by the CPAN Template Toolkit module to adapt them for existing projects (Figure 3).
Listing 3
jenkins-projects-sync

The script reads the minimum configuration of each project from the YAML data in Listing 4, consisting of the project name (e.g., log4perl
) and the URL for the source code on GitHub.
Listing 4
jenkins-projects.yml
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Direct Download
Read full article as PDF:
Price $2.95
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Find SysAdmin Jobs
News
-
Ubuntu Flatpak Remix Adds Flatpak Support Preinstalled
If you're looking for a version of Ubuntu that includes Flatpak support out of the box, there's one clear option.
-
Gnome 44 Release Candidate Now Available
The Gnome 44 release candidate has officially arrived and adds a few changes into the mix.
-
Flathub Vying to Become the Standard Linux App Store
If the Flathub team has any say in the matter, their product will become the default tool for installing Linux apps in 2023.
-
Debian 12 to Ship with KDE Plasma 5.27
The Debian development team has shifted to the latest version of KDE for their testing branch.
-
Planet Computers Launches ARM-based Linux Desktop PCs
The firm that originally released a line of mobile keyboards has taken a different direction and has developed a new line of out-of-the-box mini Linux desktop computers.
-
Ubuntu No Longer Shipping with Flatpak
In a move that probably won’t come as a shock to many, Ubuntu and all of its official spins will no longer ship with Flatpak installed.
-
openSUSE Leap 15.5 Beta Now Available
The final version of the Leap 15 series of openSUSE is available for beta testing and offers only new software versions.
-
Linux Kernel 6.2 Released with New Hardware Support
Find out what's new in the most recent release from Linus Torvalds and the Linux kernel team.
-
Kubuntu Focus Team Releases New Mini Desktop
The team behind Kubuntu Focus has released a new NX GEN 2 mini desktop PC powered by Linux.
-
KDE Plasma 5.27 Slated for a Valentine's Day Release
The next version of the KDE Plasma desktop is prepped and ready with numerous improvements and plenty of bug fixes.