21
Thu, Nov
1 New Articles

A Fresh Approach to SCM

General
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Combine the merits of open-source software configuration management (SCM) tools and i5/OS native utilities.

 

For decades, in i5/OS (aka OS/400, iSeries, or IBM i), there has been a lack of free, powerful, and easy-to-use software configuration management (SCM) tools for i5/OS programmers working on green-screens. Now, it's the time to change this condition.

 

The approach I introduce here is a complete SCM solution that covers everything from source code editing to source change management to build automation. It is based on both existing i5/OS utilities, such as the Source Entry Utility (SEU) and the Portable Application Solutions Environment (PASE) make utility, and mature and powerful open-source SCM software, such as Subversion. This combination allows you to receive continual support from both IBM and the open-source community. It is based on the i5/OS Integrated File System (IFS), which is the prerequisite of applying SCM tools such as Subversion and PASE make.

 

These are the main steps in this solution:

 

  • 1. Storing source code in stream files in IFS

    2. Editing stream source files using open-source utility STMFSEU

    3. Accomplishing source change management by Subversion

    4. Automating build processes via the make utility that is available in the PASE

    5. Choosing a proper shell environment for your SCM processes

  •  

    Let's go through these steps one by one.

    Storing Source Code in IFS

    Storing source code in stream files in the IFS is the starting point of the whole SCM solution discussed here because it is the prerequisite to applying modern SCM tools. Can you imagine the efforts required to modify an existing Subversion client or implement a new one to manage source code stored in source physical file members in the library/database file system? By storing source code in stream files, you can directly apply a Subversion client with little or no need for migration or modification. But here comes the problem: how do you edit source code stored in stream files?

    Editing Source Files with STMFSEU

    For many green-screen programmers, the Source Entry Utility (SEU) is the preferred tool to edit source in i5/OS native languages such as RPG, CL, or DDS. But unfortunately, SEU does not support stream files and hence cannot be used to edit stream source files directly.

     

    To solve this problem, the open-source project i5/OS Programmer's Toolkit developed the CL command Start SEU on Stream Files (STMFSEU). STMFSEU is a glue layer that connects SEU with stream source files. Enter CL command STMFSEU, set the STMF parameter to the path name of your target stream source file, and specify the OPTION parameter. Then you can edit, view, or print source stream files in your familiar SEU screen. For example, the following CL command starts SEU and allows you to edit (with syntax checking) the CL stream source file /home/pgmr/hello.clp .

     

    STMFSEU STMF('/home/pgmr/hello.clp')

     

    Accomplishing Source Change Management by Subversion

    Apache Subversion (command name svn) is a revision control system. Developers on different computers use Subversion to maintain current and historical versions of files such as source code, Web pages, and documentation. As an open-source SCM utility, Subversion is so famous for its power, usability, and flexibility that there seems no need to introduce the detailed features of Subversion in this article. If you're new to Subversion, please refer to the official documentation of Subversion, Version Control with Subversion.

     

    To manage changes to source code stored in IFS stream files by Subversion, what we need is a Subversion client that can run on i5/OS. For this solution, I chose SVNKit, a pure-Java toolkit. It implements all Subversion features and provides APIs to work with Subversion working copies and to access and manipulate Subversion repositories. So it can be directly used on i5/OS with no change.

     

    Installing SVNKit on i5/OS is quite straightforward. Here's an example:

     

    Download the latest release package of SVNKit's standalone version without JNA. For example, org.tmatesoft.svn_1.3.3.standalone.nojna.zip.

     

    Upload the .zip file to your IFS directory /usr/local and unzip it using the jar utility in PASE. To start a PASE shell session to complete the following installation steps, call program QSYS/QP2TERM.

    > cd /usr/local         # Assume that you have uploaded the .zip file under /usr/local

      $

    > jar -xf org.tmatesoft.svn_1.3.3.standalone.nojna.zip  # unzip the .zip file using jar

      $

    > ls -d svnkit*         # Directory extracted from the .zip may be like the following

      svnkit-1.3.3.6648

      $

     

    The script file jsvn under the extracted directory has all you need to accomplish all Subversion client tasks. It works just like the standard Subversion client command svn. Make a symbolic link pointing to svnkit-1.3.3.6648/jsvn under directory /QOpenSys/usr/bin, which is by default in the PATH environment variable of each PASE shell session:

    > ln -fs /usr/local/svnkit-1.3.3.6648/jsvn /QOpenSys/usr/bin/jsvn

      $

     

    Add the system-level environment variable JAVA_HOME to your i5/OS machine using the Add Environment Variable (ADDENVVAR) Command. For example:

    ADDENVVAR ENVVAR(JAVA_HOME)                       

              VALUE('/QIBM/ProdData/OS400/Java400/jdk')

              LEVEL(*SYS)                             

              REPLACE(*YES)                           

     

    Note that a newly added system-level environment variable will take effect only after you've signed off your current interactive job and signed on again.

     

    Ready to try it? Start a PASE shell session by calling program QSYS/QP2TERM; then enter the following shell command to list the contents under the target repository URL:

     

    > jsvn list -v https://i5toolkit.svn.sourceforge.net/svnroot/i5toolkit

        172 junleili              Jul 22 06:02 ./

         17 junleili        35147 Jul 08  2009 COPYING

         31 junleili              Sep 22  2009 art/

        162 junleili         1102 Jul 01 19:10 build.sh

        162 junleili              Jul 01 19:10 cm/

         87 junleili              Nov 30  2009 emi-builtin/

        110 junleili              Feb 06 01:18 emi-inc/

        162 junleili              Jul 01 19:10 idx/

        151 junleili              Jun 12 23:22 mic/

        162 junleili              Jul 01 19:10 q/

        162 junleili              Jul 01 19:10 qsh/

         17 junleili              Jul 08  2009 ref/

        172 junleili              Jul 22 06:02 rpg/

         97 junleili              Dec 16  2009 rpg-mih/

        162 junleili         2508 Jul 01 19:10 rules.mk

      $

    Automating Build Processes via the make Utility

    make is a widely used dependency-tracking build utility that automatically builds binary components such as executable programs from source code by reading files called Makefiles. These are make's key features:

    • Tracking dependencies of a target recursively
    • Building out-of-date targets selectively
    • Stopping execution when one of the targets fails to be built 

    make has gone through many rewrites, including a number of from-scratch variants that used the same file format and basic algorithmic principles and also provided some of their own non-standard enhancements, e.g., BSD make and GNU make.

     

    The Portable Operating System Interface for UNIX (POSIX) includes standardization of the basic features and operation of the make utility and is implemented with varying degrees of completeness in UNIX-based versions of make. The PASE make utility is a migrated version of AIX make, so it uses the same syntax as AIX make and behaves just like AIX make. Documentation on AIX make also applies to PASE make.

    The design of make separates its dependency-driven mechanism from implementation details of this mechanism that can be defined by user: rules to build a specific target or a type of targets. For this reason, make is not limited to a single platform or to only the task of building binary components from source code. It can be used to describe and drive other processes, such as unit tests, integrated tests, and installation. It can also be used to build i5/OS objects from source code if you are willing to provide the necessary i5/OS-specific implementation: the make rules to create or update i5/OS objects.

     

    Here is an example single-suffix rule you can use to build RPG program objects automatically from ILE RPG stream source files with filename extension .rpgle.

     

    .SUFFIXES: .rpgle

    .rpgle:

          system "crtbndrpg $(BIN_LIB)/$@ srcstmf('$<') $(RPGLEFLAGS)"

          ln -fs "/qsys.lib/$(BIN_LIB).lib/$@.pgm" $@

     

    For more examples of make rules for building different types of i5/OS objects, please refer to Makefiles of open-source project i5/OS Programmer's Toolkit (e.g., rules.mk). Objects of most sub-projects of the project are built from PASE make.

    Choosing a Proper Shell Environment

    As you have seen in the above steps, to work with stream source files and directories, to access Subversion source repositories, or to initiate build processes, a proper shell environment is necessary. PASE includes three shells (Korn, Bourne, and C Shell) and over 200 utilities that you can use in your SCM processes, including the above-mentioned make utility. For example:

     

    • File management commands, such as cat, cd, cp, file, head, tail, ln, ls, mkdir, more, mv, pwd, rm, rmdir, and wc
    • Comparing and searching commands, such as diff, diff3, cmp, comm, dircmp, grep, and find
    • Text-processing commands, such as cut, join, paste, sort, split, uniq, awk, and sed
    • Storage commands, such as compress, uncompress, cpio, pack, and tar

    Additionally, PASE uses PC character-set encodings rather than EBCDIC encoding, which cannot be handled correctly by many common-platform utilities. Stream files created in the PASE shell environment are in PC character-set encodings—for example, UTF-8 (CCSID 1208) or ISO 8859-1 (CCSID 819).

     

    The above-mentioned reasons are why I chose PASE shells as the shell environment for SCM processes in this solution.

    A Great Combination

    Now green-screen programmers have an IFS-based SCM solution for i5/OS that's a combination of IBM and open-source utilities. What could be better?

     

    If you want to learn more about using Subversion or PASE make in i5/OS, please let me know!

     

    Junlei Li

    Junlei Li is a programmer from Tianjin, China, with 10 years of experience in software design and programming. Junlei Li began programming under i5/OS (formerly known as AS/400, iSeries) in late 2005. He is familiar with most programming languages available on i5/OS—from special-purpose languages such as OPM/ILE RPG to CL to general-purpose languages such as C, C++, Java; from strong-typed languages to script languages such as QShell and REXX. One of his favorite programming languages on i5/OS is machine interface (MI) instructions, through which one can discover some of the internal behaviors of i5/OS and some of the highlights of i5/OS in terms of operating system design.

     

    Junlei Li's Web site is http://i5toolkit.sourceforge.net/, where his open-source project i5/OS Programmer's Toolkit (https://sourceforge.net/projects/i5toolkit/) is documented.

    BLOG COMMENTS POWERED BY DISQUS

    LATEST COMMENTS

    Support MC Press Online

    $

    Book Reviews

    Resource Center

    • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

    • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

    • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

    • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

    • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

    • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

    • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

    • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

    • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

    • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

    • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

    • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

    • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

    • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

    • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

    • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

    • SB Profound WC 5536Join us for this hour-long webcast that will explore:

    • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: