Adds CICS Resource builder build capability to zAppbuild #351

odttlnt · 2023-05-04T20:17:13Z

This request extends the functionality of the build by allowing users to build CICS resource definitions in yaml format. The changes will allow the CICS yaml formatted file to be build by the CICS Resource builder tool. It will generate an artefact which will be in the legacy CSD format. This artefact can then be used in a DFHCSDUP job to apply the changes to the CICS region. The PR is a part of the Infrastructure as code effort.
The PR consists of CRB. groovy file for doing the build and its corresponding properties files CRB.properties. Plus related changes to the README

Moved the Reporting feature into in its own utilities file, and simplifying the query to check for impacted logical files across collections using DBB 2.0 APIs.

Added preview build option to leverage DBBs reportOnly capability

* Add file count and progress indicators to language scripts. Signed-off-by: Marc Bauer <[email protected]>

M-DLB · 2023-05-05T07:12:03Z

@odttlnt - Can you please take the latest version of CRB.properties from our internal reference system?
Also you don't need to change the property files for the Mortgage Application.
Thank you!

@dennis-behm - Can you please have a look for the rest of the changes? Thanks!

dennis-behm

Thank you for the contribution.

@odttlnt I have a few comments on this PR, please see them attached to the PR.

@odttlnt, @M-DLB, I am wondering, if the crb_resourceModelFile and crb_applicationConstraintsFile should be defined the build-conf directory of zAppBuild, rather then pointing to an "external" configuration location.

languages/CRB.groovy

dennis-behm · 2023-05-08T12:50:45Z

languages/CRB.groovy

+
+List<String> buildList = argMap.buildList
+
+println("** Processing files mapped to ${this.class.getName()}.groovy script")


With the next release of zAppBuild, the language script have a progress indicator. You can find it already in the develop branch contributed with 04e6118. Can we please have the same logic here?

Changed to show progress indicator

dennis-behm · 2023-05-08T12:51:45Z

samples/MortgageApplication/application-conf/application.properties

@@ -3,7 +3,7 @@
 #
 # Comma separated list of additional application property files to load
 # Supports both relative path (to ${application}/application-conf/) and absolute path
-applicationPropFiles=file.properties,BMS.properties,Cobol.properties,LinkEdit.properties,languageConfigurationMapping.properties
+applicationPropFiles=file.properties,BMS.properties,Cobol.properties,LinkEdit.properties,languageConfigurationMapping.properties,CRB.properties


As mentioned by @M-DLB , the MortgageApplication sample should not be updated, unless we are providing the YAML for it. (Actually, a nice idea for a future enhancement).

dennis-behm · 2023-05-08T12:57:00Z

samples/application-conf/CRB.properties

+
+#
+# CRB model yaml file
+crb_resourceModelFile=/var/crb-1.0.3/resourcesModel.yml


Can we leave the references empty, so that users configure it, and put a sample into the description of the property?

# # CRB model yaml file # It defines the standards that must be used for resource definitions. # https://www.ibm.com/docs/en/cics-resource-builder/1.0?topic=creating-resource-model # sample: crb_resourceModelFile=/var/crb-1.0.3/resourcesModel.yml crb_resourceModelFile=

Added for both Model file and Application constraints

Signed-off-by: Sachin Naik <[email protected]>

M-DLB · 2023-05-09T10:02:45Z

@dennis-behm The challenge is that crb_resourceModelFile and crb_applicationConstraintsFile are application-related (different for each application) but are provided by CICS admins, so they are not supposed to be pat of the application's Git repo. We thought providing an override with an absolute path would be the best way.

Signed-off-by: Sachin Naik <[email protected]>

dennis-behm

Couple of additional comments.

dennis-behm · 2023-05-10T10:11:49Z

samples/MortgageApplication/application-conf/file.properties

@@ -7,6 +7,7 @@ dbb.scriptMapping = BMS.groovy :: **/*.bms
 dbb.scriptMapping = Cobol.groovy :: **/*.cbl
 dbb.scriptMapping = LinkEdit.groovy :: **/*.lnk
 dbb.scriptMapping = PLI.groovy :: **/*.pli
+dbb.scriptMapping = CRB.groovy :: **/*.yml, **/*.yaml


Please remove the scriptMapping from the MortgageApplication sample.

dennis-behm · 2023-05-10T10:30:27Z

languages/CRB.groovy

+import groovy.transform.*
+
+/*
+The language script is for running the CICS tool (zrb) on CICS definitions in YML (yaml)


A minor comment.

The CICS tool is a confusing term for me. Instead of

The language script is for running the CICS tool (zrb) on CICS definitions in YML (yaml) format ...

can we please rephrase it to:

This language script is invoking the 'CICS TS resource builder utility' for the CICS resource definitions defined in the YAML format. The script processes CICS definition files stored in the git repository with suffix .yml or .yaml to produce a CSD formatted file. The model file and the application constraints file, required by the CICS TS resource builder, are referenced via the crb.properties files. The script expects that the CICS TS resource builder is installed on the build machine in z/OS UNIX. The location of it is also referenced in the properties files. The output of the process is a CSD formatted file, which is reported in the DBB Build report for further post-build processing such as packaging and deployment into a target environment. Further information on the CICS TS resource builder utility and can be found at https://www.ibm.com/docs/en/cics-resource-builder/1.0?topic=overview

Updated as requested

Changed as requested

dennis-behm · 2023-05-10T10:34:09Z

samples/application-conf/CRB.properties

@@ -0,0 +1,27 @@
+# Language properties used by language/CRB.groovy


@odttlnt @M-DLB ,
I see that these definitions are part of application-conf and build-conf. What would be the best location to manage these property definitions? Can we propose just one?

If necessary, we would need to split it up into central build config, like crb_zrbLocation in build-conf and application specifics into the application configuration dir.

I think the way we have it provides more flexibility to the user. The can provide some options which are applicable for the application only in application conf and vice versa.

I think it should be as is. Primarily because it provides more flexibility to the developer. They can mix and match the parameters and values

Signed-off-by: Sachin Naik <[email protected]>

dennis-behm · 2023-05-12T06:15:38Z

Thank you for the updates @odttlnt . This PR is depending on #308 , because YAML files should not be scanned with the default DBB dependency scanner.

FYI - We had some un-signed commits on develop why I had to rebase the last 3 commits. The PR looks corrupted, but we will take care during the merge process and squash them into a new one.

dennis-behm · 2023-08-16T13:31:28Z

Superseded by #391 - because this PR is based on an outdated version of zAppBuild

dennis-behm and others added 3 commits April 17, 2023 15:48

Refactor zAppBuild reporting capabilities (IBM#341)

3a62b76

Moved the Reporting feature into in its own utilities file, and simplifying the query to check for impacted logical files across collections using DBB 2.0 APIs.

Preview build option (IBM#347)

66489c6

Added preview build option to leverage DBBs reportOnly capability

Add file count and progress indicators to language scripts. (IBM#336)

04e6118

* Add file count and progress indicators to language scripts. Signed-off-by: Marc Bauer <[email protected]>

dennis-behm requested changes May 8, 2023

View reviewed changes

odttlnt added 3 commits May 8, 2023 11:18

Add Cics Resource builder processing to zAppBuild

c1a32f0

Signed-off-by: Sachin Naik <[email protected]>

Updated as per PR comments

59ba103

Signed-off-by: Sachin Naik <[email protected]>

Add Progress Indicator to CRB build

3689661

Signed-off-by: Sachin Naik <[email protected]>

odttlnt force-pushed the IACMayDevelop branch from 064777a to 3689661 Compare May 8, 2023 15:21

odttlnt added 2 commits May 8, 2023 11:30

Updated for comments

3f5e28b

Signed-off-by: Sachin Naik <[email protected]>

Fixed CRB.Groovy for errors

854f248

Signed-off-by: Sachin Naik <[email protected]>

odttlnt requested a review from dennis-behm May 8, 2023 16:12

Removed non-required options from CRB.properties

b80266c

Signed-off-by: Sachin Naik <[email protected]>

dennis-behm requested changes May 10, 2023

View reviewed changes

Updated as per PR Comments

17c068d

Signed-off-by: Sachin Naik <[email protected]>

odttlnt requested a review from dennis-behm May 10, 2023 17:59

dennis-behm force-pushed the develop branch from 04e6118 to 3d80eb9 Compare May 11, 2023 10:25

dennis-behm approved these changes May 12, 2023

View reviewed changes

dennis-behm closed this Aug 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds CICS Resource builder build capability to zAppbuild #351

Adds CICS Resource builder build capability to zAppbuild #351

odttlnt commented May 4, 2023

M-DLB commented May 5, 2023

dennis-behm left a comment

dennis-behm May 8, 2023

odttlnt May 8, 2023

dennis-behm May 8, 2023

odttlnt May 8, 2023

dennis-behm May 8, 2023

odttlnt May 8, 2023

M-DLB commented May 9, 2023

dennis-behm left a comment

dennis-behm May 10, 2023

odttlnt May 10, 2023

odttlnt May 10, 2023

dennis-behm May 10, 2023

odttlnt May 10, 2023

odttlnt May 10, 2023

dennis-behm May 10, 2023

odttlnt May 10, 2023

odttlnt May 10, 2023

dennis-behm commented May 12, 2023

dennis-behm commented Aug 16, 2023


		List<String> buildList = argMap.buildList

		println("** Processing files mapped to ${this.class.getName()}.groovy script")

		@@ -0,0 +1,27 @@
		# Language properties used by language/CRB.groovy

Adds CICS Resource builder build capability to zAppbuild #351

Adds CICS Resource builder build capability to zAppbuild #351

Conversation

odttlnt commented May 4, 2023

M-DLB commented May 5, 2023

dennis-behm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

M-DLB commented May 9, 2023

dennis-behm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dennis-behm commented May 12, 2023

dennis-behm commented Aug 16, 2023