BMC AMI DevX Code Pipeline-Git Integration
Summary
The purpose of this Test Drive is to highlight the integration between BMC AMI DevX Code Pipeline and Git, This integration for DevX Code Pipeline enables developers working in Topaz Workbench to clone mainframe source code stored in Git server (GitHub, BitBucket, etc.), make code changes, compile and test on the mainframe with the same tools and processes used on non-mainframe platforms.
Use Case
A developer,
- Creates a feature branch in BMC AMI DevX Workbench for Eclipse
- Makes a change to COBOL program
- Using tools in DevX Workbench for Eclipse, builds and tests the code
- Once successfully tested, commits the branch and the code changes to Git server (via EGit plugn)
- The commit triggers a webhook defined in Git server to run a rep-configured Jenkins multi-branch pipeline job
- The Jenkins job synchronizes between Git and DevX Code Pipeline, builds and tests the code again and runs the CI/CD pipeline
- In Git server, a Pull Request is created for the change against the MAIN branch
- Pull Request is merged with the MAIN, which triggers the Jenkins job again
- The Jenkins job synchronizes between Git and DevX Code Pipeline, builds and tests the code again and runs the CI/CD pipeline
- After a successful merge, the feature branch is deleted
- Finally, a promote of task in DevX Code Pipeline-Git perspective promotes the task to DevX Code Pipeline PROD level
The following diagram illustrates a possible DevOps toolchain which this script accomplishes.
DevOps Toolchain with DevX Code Pipeline-Git Integration
Instructions:
- This guide contains many screenshots to provide a visual reference
- Every action you must take is in "Do This..." info box
- Please note each place that you must enter your own specific ID or number
- You must complete each step before proceeding to the next to successfully follow the guide
Cleanup
- In Code Pipeline-Git perspective, navigate to "Git Repositories" view below
- Right-click on the root of the repository
- Click "Delete Repository..."
"Delete Repository" dialog pops up
- Check the checkboxes (as shown)
- Click "Delete"
This deletes the local git repositories as well as the local project from your local disk and you are ready to re-start the script from "Setup" or "Initialize" section.
Setup
Substitute your values in the screenshots
In this Test Drive the screen shots provided have used specific values that may differ from your assigned values. These were provided in your email notice.
Variable | Your Assigned Values |
Application | T<nnn> |
SubAppl | T<nnn> |
Assignment Prefix | T<nnn> |
* For the value of <nnn>, substitute the last three digits of your Test Drive username.
- Open the "Host Explorer" perspective,
- Click on the arrow next to Hosts,
- Right-click on "TestDrive" and select Login,
- Logon with the user credentials that were provided to you for Test Drive and click OK,
- Select "Code Pipeline-Git" from the "Window==>Open Perspective==>Other..." menu.
If at any time during the execution of this script the BMC AMI DevX Common Enterprise Services (CES) Login popup is shown, enter your test drive ID and password under User ID and Password, check the Save credentials box and then depress the ENTER key or click OK.
During this Test Drive you will encounter terms specific to DevX Code Pipeline. Here is a glossary for your convenience.
Term | Description |
Application | Business Area |
Stream | Development Life-Cycle used by one or more Applications |
Life-Cycle | Transitional Code States (DEV, QA, PROD) in the Development Life-Cycle |
Level | Instance of a Code State (DEV, QA, PROD) |
Component | SCM managed object such as a COBOL source member |
Component Version | An immutable version of a Component |
Task | An instance of a unit of work. For example, a change to a Component |
Part | A generated object such as a load module, or a Listing or a DBRM |
Warehouse | Storage location for inactive historical or overlaid Component Versions (source and parts) |
Assignment Container | A package of one or more, usually related, Tasks. A development container that is used to organize and manage development work |
Release Container | A package of Tasks from one or more Assignment Containers. An operational container that is used to organize and manage operational releases |
Set Container | A package of Tasks at an instance in time. A special DevX Code Pipeline container that is used internally to organize and manage work requests |
Add Task | Make a statement of intent, often because of some impact analysis |
Checkout Task | Copy source to development area |
Edit Task | Make a change to the source in the development area |
Generate Task | Execute Compile and Link processes |
Promote Task | Move Task forward to the next Level in the Life-Cycle |
Regress Task | Move Task backwards to the previous Level in the Life-Cycle |
Delete Task | Remove a Task from the development area |
Fallback Task | Restore previous version of Task |
Deploy Task | Implement Task in one or more Run Time environments |
Initialize
Clone Repository
In this step, you will be cloning a MAIN branch in Git server into your local repository in DevX Workbench.
- Click on “Clone a Git repository" link in "Git Repositories" view
- Enter the following information in the dialog (password is “ispwgit1”)
- Check the “Store in Secure Store” checkbox
Note: You can copy and paste the values from here
URI: https://tdgit.bmc.com/TD-ISPWGIT/TestDrive.git
Host: tdgit.bmc.com
Repository path: /TD-ISPWGIT/TestDrive.git
User: tduser
Password: ispwgit1
Your screen should look like below when done.
Click "Next"
Note (Optional): If you get the following dialog, click on “Always skip SSL verification for this server …” checkbox and click "OK".
- Click "Deselect All" to uncheck all branches
- Check your main branch (MAIN-T<nnn>) where, <nnn> is your Test Drive userid (Ex. MAIN-T080)
- Leave everything else as default
- Click “Next”
- Check “Import all existing Eclipse projects…” checkbox
- Leave everything else as default
- Click “Finish”
Create a Feature Branch
In this step, you will create a feature branch locally for your work within Topaz workbench
- In “Project Explorer”, right-click on the project root node, select “Team==>Switch to==>New Branch…” to create a new branch from your MAIN-T<nnn> branch
- Enter a name for the new branch FB-T<nnn> for your Test Drive userid <nnn> (Ex. FB-T100). Make sure the name is upper-case.
- Leave everything else as default
- Click “Finish”
You'll notice that the Project Explorer view got refreshed to the newly created feature branch.
Modify a program locally
In this step, you will be making a simple change to a COBOL program in your local feature branch.
- In “Project Explorer” view, expand COB folder on the root project node and double-click on “TPROG05.cbl” to open in editor
- Update just the date/time to reflect the current date/time
- Save the file (CTRL-S or clicking on “x” on the editor)
Generate (Compile) the program locally
In this step, you will make sure the changes made to the program do not break the code by issuing an DevX Code Pipeline Generate command locally.
- Switch to "Git Staging" view in the perspective (you'll notice that your program has been marked ready to stage)
- Right-click on TROG05.cbl in project explorer and select “Code Pipeline==>Generate”
DevX Code Pipeline will automatically generate the program and switches to "Console" view where you can see that a new Assignment container got created and the task loaded to DEV level in DevX Code Pipeline.
Commit to Git Server
In this step, you will commit the new feature branch as well as the modified program into Git server.
- In “Git Staging” view, select the program TPROG05 in "Unstaged Changes" section and click on "+" icon to move it to “Staged Changes” section (if there are other files, ignore them)
- Add a commit message and then click “Commit and Push” button
A push branch dialog pops up
- Leave everything as default
- Click "Preview"
- Click "Push" on the "Push Confirmation" dialog
Push Results confirmation dialog pops up to confirm that commit was successful. Click Close.
Create Pull Request and Merge
In this step, you will take on multiple roles (developer, code reviewer, approver, etc.) in order to go through the process of creating a pull request for your feature branch, approving the pull request, merging your feature branch changes with your Main branch. Finally, after a successful merge, delete your feature branch.
- In DevX Workbench, click on “Run==>External Tools==>Chrome” to bring up pre-configured Chrome browser
This will launch Chrome browser with multiple pre-configured tabs
- Click on the tab "Github"(last tab)
- (Optional) If you get "Privacy error", click on "Advanced" and click on "Proceed to .." link
- Enter username: TDUSER
- Enter password: ispwgit1 (lower-case)
- Click "Sign In"
- Click on the Repository "TD-ISPWGIT/TestDrive"
- Click on "Compare & pull request" (if available) or “Pull Requests” option at the top
This will bring up the "Open a Pull Request" screen
- Select “MAIN-T<nnn>” as the base and “FB-T<nnn>" as the compare from the drop-down, where <nnn> is your Test Drive userid
- Click on “Create Pull Request” button
- Give a name (or leave the default name) for Pull Request
- Click on “Merge pull request”
- Click on “Confirm Merge”
- You should get “Pull request successfully merged and closed” message
- At this point, you should delete the branch by clicking “Delete Branch”
Promote to PROD in DevX Code Pipeline
In this step, you can optionally promote the code from DevX Code Pipeline STG level to PROD level in case you want to use "fallback" feature of DevX Code Pipeline for emergency situations.
- Switch back to DevX Workbench (you can use the "Switch Windows" button on top)
- In "Code Pipeline-Git" perspective, click the "Containers" view
- Click on "Refresh" button to refresh the views
- Click on "View life cycle" button to display DevX Code Pipeline Life Cycle for the application
- Select the link to the top most (latest) Assignment container (which contains tasks at STG level)
This will bring the "Assignment" view with tasks in it
- Right-click on the task (at the STG level), select "Promote" to promote the task to PROD level
Notice the Git related columns in the view which store Git information in DevX Code Pipeline for easy traceability. To see the Git related columns, you may have to scroll to far right within the Assignment view.
A "Promotion Successful" dialog pops up. Click "OK".
- Click on "Refresh" icon to refresh the Life Cycle view.
Notice that the task is now sitting at PROD level in DevX Code Pipeline.
Congratulations! This completes the BMC AMI DevX Code Pipeline-Git integration Test Drive script.
Next Steps