Added DB2 Bind Package Sample

Author: drbruce-git

MortgageApplication/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>MortgageApplication</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

MortgageApplication/README.md

@@ -1,53 +1,55 @@
-# Mortgage Application Sample
-The Mortgage Application sample is comprised of a COBOL application and Groovy build scripts that use IBM Dependency Based Build (DBB) APIs to build the application for execution on z/OS. The sample demonstrates the following build functions:
-* How to use property files for build configuration
-* How to handle build script command line arguments
-* How to organize build scripts into main and called scripts for building specific source file types
-* How to create new datasets, copy zFS files to datasets, invoke z/OS compilers and linkers, copy SYSPRINT datasets to zFS as log files
-* How to scan source files to gather dependency data and store in the DBB repository for later dependency resolution
-* How to generate a build report that contains a summary of source files built
-* How to store build results in the DBB repository for later retrieval
-* How to perform incremental builds by identifying changed files since the last build and discover impacted programs that need rebuilding
-* How to run a post build process to create an UrbanCode Deploy shiplist from a saved DBB build report 
-
-## Configuring the Mortgage Application Sample for your system
-All of the build files are located in the `MortgageApplication/build` folder.  The folder contains two properties files that need to be edited before the Mortgage Application build scripts can run successfully.  The files contain instructions on what needs to be set.
-* datasets.properties - Contains build properties for Partition Data Sets (PDS) used by Mortgage Application sample scripts
-* build.properties - Contains default sandbox properties used by Mortgage Application build scripts.  Many of these properties can be overridden using command line arguments when running the Groovy build script (see the comment block in build.groovy)
- 
-## Build Script Organization
-The Mortgage Application build folder contains three main build scripts and six called build scripts. The Groovy scripts are extensively commented and can be used to jump start writing build scripts for new applications.
-
-### build.groovy 
-This is the main build script for building the Mortgage Application.  It performs build process initiation, scans the source files for dependency data, invokes called build scripts to build specific file types, generates a build report and saves build results to the DBB web application repository. The five called build scripts are 
-* BMSProcessing.groovy - Script that demonstrates how to build CICS BMS maps
-* Compile.groovy - Script that demonstrates how to just compile a COBOL program to produce a object deck
-* LinkEdit.groovy - Script that demonstrates how to link-edit object decks to produce a load module
-* CobolCompile.groovy - Script that demonstrates how to compile and link-edit COBOL programs in one script
-* MFSGENUtiltiy.groovy - Script that demonstrates how to build IMS Message Format Service (MFS) files
-* Tools.groovy - Script that provides common utility Groovy methods used by the build scripts.
-
-The easiest way to invoke the build.groovy file from the Unix System Services (USS) command line is to use the build.sh shell script provided in the MortgageApplication/build folder. **NOTE: The build.sh shell script may need to be edited if the DBB installation is not located at /usr/lpp/IBM/dbb .** Invoking `build.sh` with no arguments will result in all the files listed in `MortgageApplication/build/files.txt` being scanned and built.  Invoking `build.sh --help` will display the command line arguments that are supported by build.groovy.
-
-The build.groovy script can also be invoked from a Jenkins process server via a remote agent running on USS. It is important to note that when invoking Groovy scripts that use DBB APIs either by using Groovy directly or a tool like Jenkins that invokes Groovy, you will need to set both the Java classpath and the Java native library path to include the DBB toolkit lib directory.  Example:
-```
-Class path : /usr/lpp/IBM/dbb/lib/* 
-Java opts : -Djava.library.path=/usr/lpp/IBM/dbb
-```
-
-### impacts.groovy
-The impacts.groovy script is an optional pre-build script that runs before build.groovy runs.  When provided with the current build's Git hash, it will retrieve the last successful build's Git hash from the DBB web application repository and execute a `git diff` command to identify which files have changed since the last build. It then runs an impact analysis for each changed file to see what programs will need to be rebuilt. Finally it generates a buildList.txt file that can be passed to build.groovy to build just the programs that need to be built.
-
-In order to use impacts.groovy with build.groovy to changes need to be made to the build.groovy argument list:
-* add option `--buildHash <hash>` where <hash> is the Git commit hash for the current build
-* use `<workDir>/buildList.txt` as the build list file (last argument) where <workDir> is the directory where the buildList.txt was generated from running impacts.groovy.
-
-Since impacts.groovy requires the current Git build hash as an argument, no shell script has been provided to run the script as it is assumed that it will be run by a build processing server like Jenkins. The Jenkins Git client plugin sets the current build Git hash in environment variable $GIT_COMMIT.
-
-### deploy.groovy 
-The deploy.groovy script is an optional post-build script that runs after build.groovy runs.  The script parses the buildReport.json file generated by the build.groovy script at the end of the build.  From the build report it generates an UrbanCode Deploy (UCD) shiplist.  It then runs a UCD buztool command to create a UCD z/OS component version for deployment.
-
-
-
-
+# Mortgage Application Sample
+The Mortgage Application sample is comprised of a COBOL application and Groovy build scripts that use IBM Dependency Based Build (DBB) APIs to build the application for execution on z/OS. The sample demonstrates the following build functions:
+* How to use property files for build configuration
+* How to handle build script command line arguments
+* How to organize build scripts into main and called scripts for building specific source file types
+* How to create new datasets, copy zFS files to datasets, invoke z/OS compilers and linkers, copy SYSPRINT datasets to zFS as log files
+* How to scan source files to gather dependency data and store in the DBB repository for later dependency resolution
+* How to generate a build report that contains a summary of source files built
+* How to store build results in the DBB repository for later retrieval
+* How to perform incremental builds by identifying changed files since the last build and discover impacted programs that need rebuilding
+* How to run a post build process to create an UrbanCode Deploy shiplist from a saved DBB build report 
+* How to build a DB2 application package for SQL programs.
+
+## Configuring the Mortgage Application Sample for your system
+All of the build files are located in the `MortgageApplication/build` folder.  The folder contains two properties files that need to be edited before the Mortgage Application build scripts can run successfully.  The files contain instructions on what needs to be set.
+* datasets.properties - Contains build properties for Partition Data Sets (PDS) used by Mortgage Application sample scripts
+* build.properties - Contains default sandbox properties used by Mortgage Application build scripts.  Many of these properties can be overridden using command line arguments when running the Groovy build script (see the comment block in build.groovy)
+ 
+## Build Script Organization
+The Mortgage Application build folder contains three main build scripts and six called build scripts. The Groovy scripts are extensively commented and can be used to jump start writing build scripts for new applications.
+
+### build.groovy 
+This is the main build script for building the Mortgage Application.  It performs build process initiation, scans the source files for dependency data, invokes called build scripts to build specific file types, generates a build report and saves build results to the DBB web application repository. The five called build scripts are 
+* BMSProcessing.groovy - Script that demonstrates how to build CICS BMS maps
+* Compile.groovy - Script that demonstrates how to just compile a COBOL program to produce a object deck
+* LinkEdit.groovy - Script that demonstrates how to link-edit object decks to produce a load module
+* CobolCompile.groovy - Script that demonstrates how to compile and link-edit COBOL programs in one script
+     * BindPackage.groovy - Script that demonstrates how to build a DB2 application package for SQL programs. Called from CobolCompile.groovy.
+* MFSGENUtiltiy.groovy - Script that demonstrates how to build IMS Message Format Service (MFS) files
+* Tools.groovy - Script that provides common utility Groovy methods used by the build scripts.
+
+The easiest way to invoke the build.groovy file from the Unix System Services (USS) command line is to use the build.sh shell script provided in the MortgageApplication/build folder. **NOTE: The build.sh shell script may need to be edited if the DBB installation is not located at /usr/lpp/IBM/dbb .** Invoking `build.sh` with no arguments will result in all the files listed in `MortgageApplication/build/files.txt` being scanned and built.  Invoking `build.sh --help` will display the command line arguments that are supported by build.groovy.
+
+The build.groovy script can also be invoked from a Jenkins process server via a remote agent running on USS. It is important to note that when invoking Groovy scripts that use DBB APIs either by using Groovy directly or a tool like Jenkins that invokes Groovy, you will need to set both the Java classpath and the Java native library path to include the DBB toolkit lib directory.  Example:
+```
+Class path : /usr/lpp/IBM/dbb/lib/* 
+Java opts : -Djava.library.path=/usr/lpp/IBM/dbb
+```
+
+### impacts.groovy
+The impacts.groovy script is an optional pre-build script that runs before build.groovy runs.  When provided with the current build's Git hash, it will retrieve the last successful build's Git hash from the DBB web application repository and execute a `git diff` command to identify which files have changed since the last build. It then runs an impact analysis for each changed file to see what programs will need to be rebuilt. Finally it generates a buildList.txt file that can be passed to build.groovy to build just the programs that need to be built.
+
+In order to use impacts.groovy with build.groovy to changes need to be made to the build.groovy argument list:
+* add option `--buildHash <hash>` where <hash> is the Git commit hash for the current build
+* use `<workDir>/buildList.txt` as the build list file (last argument) where <workDir> is the directory where the buildList.txt was generated from running impacts.groovy.
+
+Since impacts.groovy requires the current Git build hash as an argument, no shell script has been provided to run the script as it is assumed that it will be run by a build processing server like Jenkins. The Jenkins Git client plugin sets the current build Git hash in environment variable $GIT_COMMIT.
+
+### deploy.groovy 
+The deploy.groovy script is an optional post-build script that runs after build.groovy runs.  The script parses the buildReport.json file generated by the build.groovy script at the end of the build.  From the build report it generates an UrbanCode Deploy (UCD) shiplist.  It then runs a UCD buztool command to create a UCD z/OS component version for deployment.
+
+
+
+
 

MortgageApplication/build/BindPackage.groovy

@@ -0,0 +1,69 @@
+import com.ibm.dbb.build.*
+import com.ibm.dbb.repository.*
+import com.ibm.dbb.dependency.*
+
+/**
+* This script builds a DB2 application package for SQL programs in the MortgageApplication sample.  It is 
+* called by the CobolCompile.groovy script.  It requires that the properties in MortgageApplication/build/bind.properties 
+* be set to the correct values for your system.
+*
+* **NOTE - This script contains syntax that requires PTF UI54779 be applied to the DBB toolkit. 
+*/
+
+// receive passed arguments
+def file = args[0]
+println("* Binding $file using ${this.class.getName()}.groovy script")
+
+// define local properties
+def properties = BuildProperties.getInstance()
+def dbrmPDS = "${properties.hlq}.DBRM"
+def clistPDS = "${properties.hlq}.CLIST"
+def cmdscpDS = "${properties.hlq}.ISPFGWY.EXEC"
+def member = CopyToPDS.createMemberName(file)
+def logFile = new File("${properties.workDir}/${member}_bind.log")
+def srcOptions = "cyl space(1,1) lrecl(80) dsorg(PO) recfm(F,B) dsntype(library) msg(1)"
+
+// create BIND CLIST if necessary
+def clist = new File("${properties.workDir}/bind.clist")
+if (!clist.exists()) {
+   clist << """PROC 6 SUBSYS COLLID MEMBER LIB OWNER QUAL                       
+   DSN SYSTEM(&SUBSYS)                                       
+   BIND PACKAGE(&COLLID)    +                                
+        MEMBER(&MEMBER)     +
+        LIBRARY('&LIB')     +                                
+        OWNER(&OWNER)       +                                
+        QUALIFIER(&QUAL)    +                                
+        ACTION(REPLACE)     +                                
+        ISOLATION(CS)                                        
+   END                                                       
+EXIT CODE(&LASTCC)
+"""
+
+   // create CLIST PDS if necessary
+   new CreatePDS().dataset(clistPDS).options(srcOptions).create()
+   
+   // copy CLIST to PDS 
+   println("Copying ${properties.workDir}/bind.clist to $clistPDS(BIND)")
+   new CopyToPDS().file(clist).dataset(clistPDS).member("BIND").execute()
+}
+
+// bind the build file
+println("Executing CLIST to bind program $file")	
+
+// define TSOExec to run the bind clist
+def bind = new TSOExec().file(file)
+                        .command("exec '$clistPDS(BIND)'")
+                        .options("'${properties.SUBSYS} ${properties.COLLID} $member $dbrmPDS ${properties.OWNER} ${properties.QUAL}'")
+                        .logFile(logFile)
+                        .confDir(properties.CONFDIR)
+                        .keepCommandScript(true)
+bind.dd(new DDStatement().name("CMDSCP").dsn(cmdscpDS).options("shr"))
+
+// execute the bind clist
+def rc = bind.execute()
+
+// add the DB2 BIND status to the build result
+File scriptFile = new File("$properties.sourceDir/MortgageApplication/build/Tools.groovy")
+Class groovyClass = new GroovyClassLoader(getClass().getClassLoader()).parseClass(scriptFile)
+GroovyObject tools = (GroovyObject) groovyClass.newInstance()
+tools.updateBuildResult(file:"$file", rc:rc, maxRC:0, log:logFile)