Continuous Integration with Toad Edge

Compatibility matrix

Plugin version Toad EdgeTM version

2.2, 2.3, 2.4, 2.5, 2.6

2.0.x, 2.1.x, 2.2.x, 2.3.x, 2.4.x

Introduction

This plugin allows user to automate Database Lifecycle Management tasks from within Jenkins. Following tasks are available:

  1. Compare database schemas - Compare two different schemas (from database, model or snapshot). Based on it you can do in the next steps further actions (like generating report or alter script)

  2. Compare database with baseline - Compare your current schema with baseline. In case the schema is different the build step will fail.

  3. Create baseline - Set the current state of your schema as the baseline to detect any changes that has been made into the schema since now.

  4. Create snapshot - Save your database schema to a file to have the possibility to return to it later.

  5. Deploy SQL script - Execute any arbitrary SQL script on a selected database.

  6. Generate Jenkins HTML comparison report - Generate a HTML report based on a previous schema compare build step. This report is accessible via build detail within build history in Jenkins.

  7. Generate standalone HTML comparison report - Generate a HTML report based on a previous schema compare build step. 

  8. Generate change SQL script - Generate an alter SQL script based on a previous schema compare build step.

  9. Generate create SQL script - Generate a create SQL script from your VCS repository, saved snapshot or database.

Installing

First you need to install the plugin.

  1. Open your Jenkins.

  2. Go to Manage Jenkins > Manage Plugins > Available and search for Continuous Integration with Toad EdgeTM.

  3. Check the Continuous Integration with Toad EdgeTM, and finish installation

In order for plugin to work properly it needs Continuous Integration with Toad Edge CLI libraries. Those are distributed as .zip file. To make it work:

  1. Upload libraries to your jenkins master node

  2. Go to Manage Jenkins → Configure System and look for Continuous Integration with Toad Edge section

  3. Fill-in path to libraries to "Continuous Integration with Toad EdgeTM libraries .zip file" field

  4. Save

Troubleshooting

Jenkins HTML comparison report rendering issues

If you are having issues viewing Jenkins HTML comparison report, it could be due to your browser’s Content Security Policy. You can check your browser console to confirm the same. Also, the reports will not get rendered if Jenkins’s resource root url is configured.

To view Jenkins HTML reports, you would have to relax the CSP. This can be done by going to Jenkins > Manage Jenkins > Script Console

Execute this script to relax CSP:

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "default-src 'self'; script-src * 'self' 'unsafe-inline'; img-src 'self'; style-src 'self' 'unsafe-inline'; font-src * data:");

This will be reverted once Jenkins restarts

Please note that we would also suggest you to review https://www.jenkins.io/doc/book/security/configuring-content-security-policy/ and https://content-security-policy.com/ to understand the nature of CSP and the protection which it offers before changing CSP.

However, if you are reluctant to relax your CSP. We would recommend you to generate only standalone HTML comparison report. These reports can be found inside your chosen output folder.

Input folder/file path restrictions during job configuration

From plugin version 2.4, all folder and file paths should be inside the agent node where the job is running. Paths to master node and other remote nodes won’t work.