Automated auditing of design principle adherence

Abstract

Software design patterns and refactoring browsers are useful tools in developing high-quality software. Object-Oriented Oracle (OOO) is a tool that combines patterns and refactoring and extends them with the ability to recognize when the source-base doesn't adhere to software design principles. OOO relies on sophisticated compiler analyses and a set of heuristics to recognize characteristics of the code where a design principle is applicable, but is not being used. We present an example where the OOO can recognize noncompliance of design rules and the analyses and heuristics that are used to do the recognition. We also discuss other patterns where this approach applies and results from a prototype.

JEqualityGen

“…A Point p1 = new Point(1,2,3,4); Point p2 = new Point(1,2,3,4); assert p1.equals(p2) && p2.equals(p1); HashSet<Point> pSet = new HashSet<Point>(); ArrayList<Point> pList = new ArrayList<Point>(); pList.add(p1); pSet.add(p1); assert pList.contains(p2); // true assert pSet.contains(p2); // false --error Listing 5. Consequence of equals not being in line with hashCode number of tools [8,12] can easily spot this trivial mistake and enforce implementation of both methods at once. A human inspector however can easily miss this mistake because "the mistake lies in what is missing" [8].…”