29
Fri, Nov
0 New Articles

The Linux Letter: Expect Simplicity

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

Well, I'm finally back from my stay at Club Med! I want to thank Don Denoncourt for taking over the duties of "The Linux Letter" during my absence. I really enjoy Don's writing style. He has a way of cutting directly to the heart of a subject and can stitch together a fascinating article on virtually any topic. Thanks, Don!

One of the frequently asked questions in iSeries news groups (and the focus of many iSeries tech tips) is how to automate FTP transfers. This month, we'll look at a handy tool that will solve the problem for FTP as well as most other interactive programs. It's available not only for my favorite operating system but also for that other popular desktop operating system. Let's jump right in and get better acquainted with this month's subject, the expect program.

The Problem

If you haven't seen the solution to the FTP scripting problem before, you may be surprised by its simplicity. Just fire up your favorite text editor and enter into a text file the commands that you'd issue to FTP interactively. Once you have saved the file, start FTP and use redirection to send the contents of the file to FTP as a string of commands. The following example illustrates an FTP session where I logged onto Red Hat's site and retrieved the README file for Version 8.0 of the Linux distribution. The text appearing in boldface type is what I keyed interactively as input to FTP. The -n parameter disables automatic login in the FTP client.

ftp -n
ftp> open ftp.redhat.com
Trying 66.187.224.51...
Connected to ftp.redhat.com (66.187.224.51).
220 Red Hat FTP server ready. All transfers are logged. (FTP)
ftp> user anonymous This email address is being protected from spambots. You need JavaScript enabled to view it.
230 Login successful. Have fun.
Remote system type is UNIX.
Using binary mode to transfer files.
ftp> cd /pub/redhat/linux/8.0/en/doc
250 Directory successfully changed.
ftp> get README
local: README remote: README
227 Entering Passive Mode (66,187,224,51,209,4)
150 Opening BINARY mode data connection for README (442 bytes).
226 File send OK.
442 bytes received in 0.00581 secs (74 Kbytes/sec)
ftp> quit
221 Goodbye.

If we extracted all of the commands I entered and placed them into a text file, which I'll call ftp.txt, we would get a file containing the following lines:

open ftp.redhat.com 

user anonymous This email address is being protected from spambots. You need JavaScript enabled to view it. 

cd /pub/redhat/linux/8.0/en/doc 

get README 

quit

Now, we can get the README file any time we want by issuing this command:

ftp -n < ftp.txt

This method is simple and works well...as long as nothing goes wrong. But what if the file you want has been moved to another directory? What if the server is down? The problem with this simple method is that there's no mechanism for error handling or recovery. If you were typing these commands interactively, you'd know that there was trouble in paradise the moment you tried to get the file. But in a scripted environment, you may not notice. If you require a more robust and reliable solution, then you'll need to take a different tack.

The Solution

You have two options in solving this conundrum--hire someone to babysit the application or implement some software babysitter to do it for you. Obviously, the best solution is to use software. My choice is a program called expect.

Expect does its magic by spawning your desired program, redirecting stdin and stdout to itself. Thus, it can issue commands to the program and monitor the program's responses. The result is the equivalent of a virtual human running the program!

Let's revisit our README retrieval case study and, this time, rewrite it as an expect script, as shown below:

 

#!/usr/bin/expect --

# Initialize variables 
set ip "ftp.redhat.com"
set name anonymous
set password This email address is being protected from spambots. You need JavaScript enabled to view it.

# Start FTP and set an error for a timeout in 2 minutes
spawn ftp $ip

# Retrieve the file
set timeout 120
expect "Name*:"
send "$name "
expect "Password:"
send "$password "
expect "ftp>"
send "cd /pub/redhat/linux/8.0/en/doc "
expect "ftp>"
send "get README "
expect "ftp>"
send "quit "

# End the spawned job and wait for it to exit
close
wait

 

As you can see, there isn't much to this script. The first line is a *nix notation that indicates to the command processor which program will process the script. Normally, you invoke the script by typing expect ftp.txt, which passes "ftp.txt" to expect as a parameter. Using this notation, you simply can type ./ftp.txt and *nix will do the right thing. In either case, anything that follows a pound sign (#) on a line is considered a comment.

The second group of statements initializes variables (accessible from the script by preceding the variable with a dollar sign in the same fashion as the BASH shell). Since we're all good programmers here, I don't need to discuss the importance of never embedding constants throughout a program.

Next, the FTP program is spawned. Following a "send" command, expect will send the text to ftp's stdin and wait for the client program to send the "expected" text back. The "r" shown in each command is translated by expect into a return character, as if the user pressed the return key.

As you can see, the basics are simple. A basic script is comprised of send/expect statement pairs. Lather, rinse, and repeat for each pair of send/expect commands required to accomplish your desired task.

The only error handling I did in this simple script was to ensure that expect would timeout if the FTP client didn't receive the expected response (or any response) from the server within two minutes. Naturally, a more sophisticated script would take additional action.

Are You Expecting?

As so many of those infomercials say, you probably want to know how to get expect and how much it costs. Well, like almost everything I mention, the expect program is free. How you obtain expect depends upon which operating system or distribution you're using. Those who use the Red Hat Linux distribution can easily obtain expect and all of its package dependencies via the up2date utility by issuing the command: up2date -i expect. I believe that Debian users have a similar option through the use of apt-get, the Debian equivalent of up2date. Users of other Linux distributions, and Windows users, can obtain the software from the Expect home page.

Unfortunately, this program comes with scant documentation. However, plenty of sample scripts are provided, and for simple projects, that's all you'll need. For those who are really enthused about Expect's possibilities, you'll find that there is a book available titled Exploring Expect (O'Reilly, ISBN 1-56592-090-2). According to the Expect Web site, this is the definitive guide to using this program.
I haven't even begun to explore the power of expect. The rather simplistic example I use here pales in comparison to the incredible sophistication demonstrated in its sample scripts. I expect that, once you get started, you'll find lots of uses for this wonderful tool. Give it a try!

Barry L. Kline is a consultant and has been developing software on various DEC and IBM midrange platforms for over 20 years. Barry discovered Linux back in the days when it was necessary to download diskette images and source code from the Internet. Since then, he has installed Linux on hundreds of machines, where it functions as servers and workstations in iSeries and Windows networks. He recently co-authored the book Understanding Web Hosting on Linux with Don Denoncourt. Barry can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it..

 

Barry Kline 0

Barry L. Kline is a consultant and has been developing software on various DEC and IBM midrange platforms since the early 1980s. Barry discovered Linux back in the days when it was necessary to download diskette images and source code from the Internet. Since then, he has installed Linux on hundreds of machines, where it functions as servers and workstations in iSeries and Windows networks. He co-authored the book Understanding Web Hosting on Linux with Don Denoncourt. Barry can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it.

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: