Jenkins is a powerful open-source automation server that enables continuous integration and continuous delivery (CI/CD) for software development workflows. It provides a robust platform for automating build, test, and deployment processes across multiple environments and platforms.
Bruno CLI integrates seamlessly with Jenkins pipelines to automate API testing workflows. This guide will walk you through setting up automated test execution using Jenkins CI.
Jenkinsfile.If you're using macOS, you can use the following setup to configure Jenkins in your system.
Run the following command on the terminal to install Jenkins.
brewinstall jenkins-lts
The jenkins-lts package installs the Long Term Support version of Jenkins, which is recommended for stability.
After installation, start the Jenkins service using Homebrew's services command:
brewservices start jenkins-lts
Jenkins typically runs on port 8080. Open your web browser and navigate to:
http://localhost:8080You will be greeted with the "Unlock Jenkins" screen.
Retrieve the initial admin password: The Jenkins console will display the path to the initial admin password. You can also find it by running:
cat/Users/Shared/Jenkins/Home/secrets/initialAdminPassword
Copy this password.
Paste the password: In the browser, paste the copied password into the "Administrator password" field and click Continue.
Install suggested plugins: On the next screen, choose Install suggested plugins. This will install a set of essential plugins required for most Jenkins functionalities.
Create First Admin User: After the plugins are installed, you'll be prompted to create your first admin user. Fill in the details and click Save and Finish.
Jenkins is Ready: Click Start using Jenkins to access your Jenkins Dashboard.
Now, let's start with automating the API testing workflow with Jenkins and Bruno CLI. This section will guide you for structuring your Bruno collection, the sample Jenkinsfile, and the initial setup you need to configure.
Ensure your Bruno collections and environment files are properly organized within your Git repository. A typical structure looks like this:
your-api-project/
├── Jenkinsfile
├── collections/
│ ├── authentication/
│ │ ├── login.bru
│ │ └── logout.bru
├── environments/
│ ├── development.bru
│ ├── ci.bru
│ └── production.bru
└── bruno.json
Before running Bruno CLI, you need to ensure Jenkins can access a Node.js runtime environment.
Manage Jenkins > Plugins.Available plugins tab, search for NodeJS, and install it.Manage Jenkins > Tools (under System Configuration).NodeJS installations section and Click Add NodeJS.Node.js 18). This exact name will be used in your Jenkinsfile.Install automaticallyand select your desired Node.js version (e.g., NodeJS 18.20.8).node and npm commands are available to your pipeline.Save.Create a file named Jenkinsfile in the root of your Git repository. This file defines the steps of your CI pipeline.
pipeline {
agent any // Run the pipeline on any available Jenkins agent
stages {
stage('Checkout Code') {
steps {
// Clones the repository to the Jenkins workspace
checkout scm
}
}
stage('Setup Node.js & Install Bruno CLI') {
steps {
// Makes the Node.js installation (configured in Jenkins Tools) available
tool 'Node.js 18' // Use the exact name configured in Jenkins Global Tool Configuration
echo 'Verifying Node.js and npm versions...'
sh 'node -v' // Verify Node.js is on PATH
sh 'npm -v' // Verify npm is on PATH
echo 'Installing Bruno CLI globally...'
sh 'npm install -g @usebruno/cli' // Install Bruno CLI
sh 'bru --version' // Verify Bruno CLI installation
}
}
stage('Run API Tests') {
steps {
// Ensure Node.js is available if this stage runs in a separate context
tool 'Node.js 18'
echo 'Executing Bruno API tests...'
// Run tests with 'ci' environment and generate an HTML report
sh 'bru run --env ci --reporter-html results.html'
}
}
stage('Archive Test Results') {
steps {
echo 'Archiving test report...'
// Save the generated HTML report as a build artifact
archiveArtifacts artifacts: 'results.html', fingerprint: true
}
}
}
post {
// Actions to run after the main pipeline stages complete
always {
echo 'Pipeline finished.'
}
success {
echo 'API Tests Passed Successfully!'
}
failure {
echo 'API Tests Failed! Check console output for details.'
}
}
}New Item.bruno-api-tests-pipeline).Pipeline as the item type and click OK.Pipeline section.Definition to Pipeline script from SCM and Choose your SCM (e.g., Git).Repository URL (e.g., https://github.com/your-org/your-repo.git).Credentials if your repository is private.Branches to build to */main (or the branch containing your Jenkinsfile).Script Path is Jenkinsfile (this is the default).Build Triggers, configure how you want your pipeline to start (e.g., GitHub hook trigger for GITScm polling for automatic builds on push, or Build periodically for scheduled runs using cron syntax).Save to finalize your job configuration.Build Now (in the left-hand menu) to manually start the pipeline.Build History section to see the status of your builds (green checkmark for success, red cross mark for failure).Console Output to view real-time logs and detailed execution steps.results.html completes, navigate to that specific build's page.results.html to download the report, then open it in your web browser for detailed test outcomes.We’ve published the full working collection on GitHub. You can either clone this or simply click the Fetch in Bruno button below!
Automating your API testing workflow can save a lot of time for software developers and QA engineers and cost for a organizations. Instead of repeating one task multiple times, you can automate with Bruno CLI and Jenkins to build robust, bug-free, and quality software applications.
Want to explore more about API automation, security, and AI? Join the Bruno Discord Server to connect, learn, and grow with a vibrant tech community!