Welcome!

Java IoT Authors: Stackify Blog, Pat Romanski, Matt Lonstine, Glenda Sims, Paul Simmons

Related Topics: Java IoT

Java IoT: Article

Java Product Review: What to Do If Your Code Has No Tests

Tools that practically write tests by themselves

When MailReader - an example application bundled with the Struts Action framework - was created six years ago, most Java developers had yet to discover unit testing. Consequently neither the Struts framework nor the MailReader were created test-first. Since then, we've bolted a few unit tests onto the Action framework, but the MailReader for Struts 1.2 still has no developer tests at all.

Over the last 10 years, testing has become more popular with developers. Much of this popularity can be attributed to the JUnit framework: a simple effective tool for many teams. But JUnit isn't enough. It makes writing tests easier, but we still have to write the tests. Many of us despair at the notion of writing even more code to test the application code we're already writing. What we need are tools that can write most of the tests for us.

Software Agitation
Software Agitation exercises and analyzes Java binary code and generates observations about how the code behaves. Developers can quickly create tests based on these observations, often without writing any new code. This article walks through using Agitator to create unit tests for the Struts MailReader application.

The flagship software agitation tool is Agitator by Agitar Software. The tool rapidly creates observations of code behavior, and helps the developer determine if the code is working as expected or see if Agitation has revealed unexpected behavior.

From within the Eclipse IDE, we can promote a valid observation to a unit test, or we can trace through the code to change the behavior. If the application code is valid, but the range of acceptable values needs to be adjusted to demonstrate correct behavior, we can assign custom factories to a parameter. Along with factories, Agitar provides for automatic "Domain Experts" that we can use to test code peculiar to our own API or to test code peculiar to frameworks like Struts.

Getting Started
After launching Agitator's version of Eclipse, we can create a new project using the "Java Project with Agitation" template. For this project, we point Eclipse at the root of the Struts 1.2 source tree. We have a library of JARs for the Struts 1.2.8 distribution, which are easy to add to the Eclipse Build Path as "External JARs" along with a reference to the servlet JAR for Java 2.3.

The one other thing we have to do is unselect irrelevant packages as source folders. In Struts 1.2, the MailReader source is mixed in with packages for the rest of the framework distribution. In the end, we have two source folders: src/example and web/example.

We can open the "Agitator" view from the menu bar, and "Agitate" the package containing the five MailReader business classes [org.apache.struts.webapp.example.memory].

A New York minute later, Agitator has done its thing. Three classes are in good shape, with 100% code coverage. Two of the five classes were flagged with warning symbols. The MemoryDatabasePlugIn class weighed in at 70% coverage. The key class, MemoryUserDatabase, had 38% coverage. The code coverage for each is shown in Table 1.

Let's start with the low-hanging fruit and review the three classes with 100% coverage: MemorySubscription, MemoryUser and TestUserDatabase.

MemorySubscription and MemoryUser represent database entities. Being standard JavaBeans, these classes were easy for Agitator to test. Each of the JavaBean properties has a standard unit test to ensure that the field is set by the parameter.

The only two methods lacking tests are the constructor and toString. The constructor is simple, but, still, Agitator has generated some essential tests like:

this.getHost() == host
this.getUser() == user
Table 2 - MemorySubscription Constructor Method
    public MemorySubscription(MemoryUser user, String host) {
       super();
       this.user = user;
       this.host = host;
    }

We can mark these as unit tests to prevent simple silly mistakes like assigning a parameter back to itself.

The toString method creates a textual representation of the class. The method looks hard to test with a known set of input data. For now, we can change the method's property to "Exclude from testing."

    public String toString() {

      StringBuffer sb = new StringBuffer("<subscription host=\"");
      sb.append(host);
// ...
      if (username != null) {
        sb.append(" username=\"");
        sb.append(username);
        sb.append("\"");
    }
    sb.append(">");
    return (sb.toString());

Reviewing observations for the other classes and methods, we find several other assertion candidates. Each of these candidates corresponds to assertions that we might have made in a conventional JUnit test. For example, setting the pathname property also sets the pathnameNew and pathnameOld fields. We didn't have to express that fact to Agitator. On its own, the software observed that

@EQUALS( this.pathnameOld, "database.xml.old" )

All we have to do is confirm that the observation is an assertion that we should test. If we were writing a JUnit test, we'd have typed-out code like:

assertEquals( this.pathnameOld, "database.xml.old" );

With Agitator in play, we just point and click.

Not bad. After only a few minutes of clicking around, we have almost 80 test points. Perhaps most important, these test points will automatically evolve with the code - something that hand-coded tests can never do.

Now, what's the problem with the other two classes that had less than 100% coverage?

Agitator displays a legend next to the lines in a class to show how often each line of code is being reached by Agitation, or if the line was even reached in the first place. In the case of MemoryUserDatabase, we can see that there are a lot of red lines after an input-output call, indicating that the code isn't being reached. Clicking through, it's easy to see why many of the Exceptions were being thrown: "File Not Found."

The "Memory" implementation of the MailReader data access object loads a list of Users and their e-mail Subscriptions from an XML document into an object graph stored in main memory. (Hence, the package name.) The file wasn't found because Agitator had no way of guessing the right file name. For now, I mark the problematic classes or methods "Exclude from testing" - at least until we can learn a bit more about Agitator.

Excluding the eight input-output members lowered the overall test coverage. But, even so, in only a few minutes, we were able crank up Agitator for the first time, create over 80 test points, and yield a test coverage of around 40%.

Agitating Struts
The Agitar website hosts a 47-minute "webinar" on its Struts Expert. I watch this and skim the documentation.

Now that we've had a taste of Domain Experts, let's put the Struts Expert through its paces.

LogonAction
The webinar mentioned the standard Struts Expert, which can be found and enabled on Agitator/Plugin Experts menu. Eclipse is not displaying any red marks, so the code seems to be compiling. Let the Struts Agitation begin!

After Agitating the MailReader code base with the Struts Expert enabled, a number of red marks popped up in the Package Explorer. Drilling down, we find error icons next to the Action execute methods. The pop-up hint explains that the Struts configuration can't be found. Meanwhile, the Console view contains several warnings that a ServletContext can't be found either.

Returning to the Agitator menu, we find the likely item "Create J2EE Environment." A wizard leads us through creating a default environment, and even includes a "Test" button so we can check our work.

Now that we have a J2EE environment, for good measure, we pop back to the PlugIn Experts menu and enable the J2EE expert too. After another Agitation, there are still red marks, but the messages are functional rather than systemic, with remarks like "Coverage failed" and "Outcome failed".

Opening up LogonAction, we find the Struts We already have 67% coverage, and the execute method has partitions for the various Struts outcomes: registration, logoff, logon, success, and welcome. Several class invariants were generated, but only "this.getServlet() != null" looks like a worthwhile assertion.


More Stories By Ted Husted

Ted Husted (http://husted.com/ted/) is a software engineer and an active member of several open source projects hosted by the Apache Software Foundation, including Struts and iBATIS. His books include JUnit in Action, Struts in Action, and Professional JSP Site Design. Ted is also a consultant for Agitar Software, Inc.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Conference Guru has been named “Media Sponsor” of the 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. A valuable conference experience generates new contacts, sales leads, potential strategic partners and potential investors; helps gather competitive intelligence and even provides inspiration for new products and services. Conference Guru works with conference organizers to pass great deals to gre...
The Internet of Things will challenge the status quo of how IT and development organizations operate. Or will it? Certainly the fog layer of IoT requires special insights about data ontology, security and transactional integrity. But the developmental challenges are the same: People, Process and Platform. In his session at @ThingsExpo, Craig Sproule, CEO of Metavine, demonstrated how to move beyond today's coding paradigm and shared the must-have mindsets for removing complexity from the develop...
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
"Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.
It is of utmost importance for the future success of WebRTC to ensure that interoperability is operational between web browsers and any WebRTC-compliant client. To be guaranteed as operational and effective, interoperability must be tested extensively by establishing WebRTC data and media connections between different web browsers running on different devices and operating systems. In his session at WebRTC Summit at @ThingsExpo, Dr. Alex Gouaillard, CEO and Founder of CoSMo Software, presented ...