This plugin enables you run Oracle SQL*Plus scripts on your Jenkins jobs (user defined scripts or a script inside a workspace).

Oracle SQL*Plus installation required!

Java version: 11+

All you have to do is provide a valid ORACLE_HOME and you are in business:

You can run a script inside your workspace or a user defined for every job:

You can check later all SQL*Plus output inside your build output:

Download the last release and give it a try!

node {
   echo 'SQLPlusRunner running user define script for system@xe'
   step([$class: 'SQLPlusRunnerBuilder',credentialsId:'system', instance:'xe',scriptType:'userDefined', script: '',scriptContent: 'select * from v$version'])
}

node {
   echo 'SQLPlusRunner running file script for system@xe'
   step([$class: 'SQLPlusRunnerBuilder',credentialsId:'system', instance:'xe',scriptType:'file', script: 'start.sql',scriptContent: ''])
}

1. Fork repository
2. Code code code
3. Run it with:

• mvn clean
• mvn -DskipTests package
• mvn generate-sources (convert Message*.properties into Messages.java)
• mvn compiler:compile
• mvn -DskipTests package hpi:run

4. Try it at http://localhost:8080
5. Commit and submit pull request

1. Fork repository
2. Copy config.properties to config_.properties (example: config_pt_BR.properties)
3. Copy global.properties to global_.properties
4. Copy Messages.properties to Messages_.properties
5. Copy all HTML files too
6. Translate it
7. Run it with:

• mvn clean -DskipTests package hpi:run

8. Try it at http://localhost:8080
9. Commit and submit pull request

Please open a new issue and inform:

• Jenkins server Operation System;
• Jenkins version;
• Where SQLPlus Script Runner is running (local machine or agent machine);
• Agent machine Operation System (if applicable);
• Oracle Database version;
• Oracle SQL*Plus version;
• Build log with debug info enabled.

To migrate your workspace from version 2 is very simple, all you need todo is:

1. Create a credential for your user and password;
2. Edit you job configuration and select one credential;
3. Save your changes and you are good to go!

All you have to do is check the auto detect ORACLE_HOME option ( or a valid ORACLE_HOME ) and you are in business:

If you are having problems try to enable Debug info to see what is going on.

You can run a script inside your workspace or a user defined for every job:

Version 1.x:

Version 2.x :

Pay attention to what version you are using in order to work with variables:

You can use global variables for user and instance, first creating it in Jenkins→ configuration :

You user global variable can hold username and password as well like this (username/password):

And then using it:

You can check later all SQL*Plus output inside your build output:

Windows users sometimes get a running script stuck on build, even though they run everything on Oracle.

In that case you should use BuildTime Outplugin together to get everything working fine.

You should try running manually SQL*Plus before use Jenkins.

Sometimes on Linux Jenkins has his own Operation System user with his own variables.

Jenkins plugin can't find SQL*Plus executable file.

You should do in this order:

1. Stop Jenkins;

2. Find where are sqlplus executable file (usually at $ORACLE_HOME);

3. Check if they have proper permissions (chmod 755 *);

4. Create a global environment variable ORACLE_HOME like this: **export ORACLE_HOME=/oracle/app/oracle/product/12.1.0/dbhome_1/ ** or
   export ORACLE_HOME=<your-sqlplus-directory>

5. Test your environment with: *sqlplus -v * , should return SQL*Plus version like SQL*Plus: Release 12.1.0.1.0 Production

6. Start Jenkins;

7. Use the try to detect ORACLE_HOME option;

8. Retry your SQL*Plus operation.

SQL*Plus need its library and its message file to work properly.

You should do in this order:

1. Stop Jenkins;

2. Find where are libsqlplus.so files (usually at $ORACLE_HOME\lib );

3. Check if they have proper permissions (chmod 755 *);

4. Create a global environment variable LD_LIBRARY_PATH like this:
   **export LD_LIBRARY_PATH=$ORACLE_HOME/lib:$LD_LIBRARY_PATH **
   or export LD_LIBRARY_PATH=<your-libsqlplus-directory>:$LD_LIBRARY_PATH

5. Test your environment with: *sqlplus -v * , should return SQL*Plus version like SQL*Plus: Release 12.1.0.1.0 Production

6. Start Jenkins;

7. Use the try to detect ORACLE_HOME option;

8. Retry your SQL*Plus operation.

1. Install Mask Passwords Plugin;

2. Setup to hide everything you want.

Please open a newissue and inform:

• sqlplus-script-runner-plugin version;
• Jenkins server Operation System;
• Jenkins version ;
• Where SQLPlus Script Runner is running (local machine or slave machine);
• Slave machine Operation System (if applicable);
• Oracle Database version;
• Oracle SQL*Plus version;
• Build log with debug info enabled.