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
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
Canonical Releases Ubuntu 24.04
After a brief pause because of the XZ vulnerability, Ubuntu 24.04 is now available for install.
-
Linux Servers Targeted by Akira Ransomware
A group of bad actors who have already extorted $42 million have their sights set on the Linux platform.
-
TUXEDO Computers Unveils Linux Laptop Featuring AMD Ryzen CPU
This latest release is the first laptop to include the new CPU from Ryzen and Linux preinstalled.
-
XZ Gets the All-Clear
The back door xz vulnerability has been officially reverted for Fedora 40 and versions 38 and 39 were never affected.
-
Canonical Collaborates with Qualcomm on New Venture
This new joint effort is geared toward bringing Ubuntu and Ubuntu Core to Qualcomm-powered devices.
-
Kodi 21.0 Open-Source Entertainment Hub Released
After a year of development, the award-winning Kodi cross-platform, media center software is now available with many new additions and improvements.
-
Linux Usage Increases in Two Key Areas
If market share is your thing, you'll be happy to know that Linux is on the rise in two areas that, if they keep climbing, could have serious meaning for Linux's future.
-
Vulnerability Discovered in xz Libraries
An urgent alert for Fedora 40 has been posted and users should pay attention.
-
Canonical Bumps LTS Support to 12 years
If you're worried that your Ubuntu LTS release won't be supported long enough to last, Canonical has a surprise for you in the form of 12 years of security coverage.
-
Fedora 40 Beta Released Soon
With the official release of Fedora 40 coming in April, it's almost time to download the beta and see what's new.