Annotation refactoring: inferring upgrade transformations for legacy applications

ABSTRACT

Since annotations were added to the Java language, many frameworks have moved to using annotated Plain Old Java Objects (POJOs) in their newest releases. Legacy applications are thus forced to undergo extensive restructuring in order to migrate from old framework versions to new versions based on annotations (Version Lock-in). Additionally, because annotations are embedded in the application code, changing between framework vendors may also entail largescale manual changes (Vendor Lock-in).

This paper presents a novel refactoring approach that effectively solves these two problems. Our approach infers a concise set of semantics-preserving transformation rules from two versions of a single class. Unlike prior approaches that detect only simple structural refactorings, our algorithm can infer general composite refactorings and is more than 97% accurate on average. We demonstrate the effectiveness of our approach by automatically upgrading more than 80K lines of the unit testing code of four open-source Java applications to use the latest version of the popular JUnit testing framework.

REFERENCES

• 1: Taweesup Apiwattanapong , Alessandro Orso , Mary Jean Harrold, A Differencing Algorithm for Object-Oriented Programs, Proceedings of the 19th IEEE international conference on Automated software engineering, p.2-13, September 20-24, 2004 [doi>10.1109/ASE.2004.5]
• 2: Ira D. Baxter , Christopher Pidgeon , Michael Mehlich, DMS®: Program Transformations for Practical Scalable Software Evolution, Proceedings of the 26th International Conference on Software Engineering, p.625-634, May 23-28, 2004
• 3: K. Beck and E. Gamma. Test Infected: Programmers love writing tests. Java Report, 3(7):37--50, 1998.
• 4: Cédric Beust , Hani Suleiman, Next Generation Java Testing: TestNG and Advanced Concepts, Addison-Wesley Professional, 2007
• 5: Marat Boshernitsan , Susan L. Graham , Marti A. Hearst, Aligning development tools with the way programmers think about code changes, Proceedings of the SIGCHI conference on Human factors in computing systems, April 28-May 03, 2007, San Jose, California, USA [doi>10.1145/1240624.1240715]
• 6: William J. Brown , Raphael C. Malveau , Hays W. McCormick, III , Thomas J. Mowbray, AntiPatterns: refactoring software, architectures, and projects in crisis, John Wiley & Sons, Inc., New York, NY, 1998
• 7: F. Castor and P. Borba. A language for specifying Java transformations. In V Brazilian Symposium on Programming Languages, pages 236--251, 2001.
• 8: Sudarshan S. Chawathe , Anand Rajaraman , Hector Garcia-Molina , Jennifer Widom, Change detection in hierarchically structured information, Proceedings of the 1996 ACM SIGMOD international conference on Management of data, p.493-504, June 04-06, 1996, Montreal, Quebec, Canada
• 9: Kingsum Chow , David Notkin, Semi-automatic update of applications in response to library changes, Proceedings of the 1996 International Conference on Software Maintenance, p.359, November 04-08, 1996
• 10: James R. Cordy, The TXL source transformation language, Science of Computer Programming, v.61 n.3, p.190-210, August 2006 [doi>10.1016/j.scico.2006.04.002]
• 11: Mariela Cortes , Marcus Fontoura , Carlos Lucena, Using refactoring and unification rules to assist framework evolution, ACM SIGSOFT Software Engineering Notes, v.28 n.6, November 2003 [doi>10.1145/966221.966234]
• 12: M. Cortés, M. Fontoura, and C. Lucena. A Rule-based Approach to Framework Evolution. Journal of Object Technology (JOT), 5(1), jan-feb 2006.
• 13: Rylan Cottrell , Joseph J. C. Chang , Robert J. Walker , Jörg Denzinger, Determining detailed structural correspondence for generalization tasks, Proceedings of the the 6th joint meeting of the European software engineering conference and the ACM SIGSOFT symposium on The foundations of software engineering, September 03-07, 2007, Dubrovnik, Croatia [doi>10.1145/1287624.1287649]
• 14: Ilie Şavga , Michael Rudolf, Refactoring-based support for binary compatibility in evolving frameworks, Proceedings of the 6th international conference on Generative programming and component engineering, October 01-03, 2007, Salzburg, Austria [doi>10.1145/1289971.1290000]
• 15: L. DeMichiel and M. Keith. JSR 220: Enterprise JavaBeans 3.0, 2008. http://jcp.org/aboutJava/communityprocess/final/jsr220/index.html.
• 16: D. Dig, C. Comertoglu, D. Marinov, and R. Johnson. Automated detection of refactorings in evolving components. In ECOOP, pages 404--428, 2006.
• 17: Danny Dig , Kashif Manzoor , Ralph Johnson , Tien N. Nguyen, Refactoring-Aware Configuration Management for Object-Oriented Programs, Proceedings of the 29th international conference on Software Engineering, p.427-436, May 20-26, 2007 [doi>10.1109/ICSE.2007.71]
• 18: Danny Dig , Stas Negara , Vibhu Mohindra , Ralph Johnson, ReBA: refactoring-aware binary adaptation of evolving libraries, Proceedings of the 30th international conference on Software engineering, May 10-18, 2008, Leipzig, Germany [doi>10.1145/1368088.1368148]
• 19: Mikhail Dmitriev, Language-specific make technology for the Java programming language, ACM SIGPLAN Notices, v.37 n.11, November 2002
• 20: Eclipse Foundation. Eclipse Java development tools, March 2008. http://www.eclipse.org/jdt.
• 21: Beat Fluri , Michael Wuersch , Martin PInzger , Harald Gall, Change Distilling: Tree Differencing for Fine-Grained Source Code Change Extraction, IEEE Transactions on Software Engineering, v.33 n.11, p.725-743, November 2007 [doi>10.1109/TSE.2007.70731]
• 22: T. Genssler and V. Kuttruff. Source-to-source transformation in the large. In Modular Programming Languages, pages 254--265. Springer-Verlag, 2003.
• 23: Johannes Henkel , Amer Diwan, CatchUp!: capturing and replaying refactorings to support API evolution, Proceedings of the 27th international conference on Software engineering, May 15-21, 2005, St. Louis, MO, USA [doi>10.1145/1062455.1062512]
• 24: Miryung Kim , David Notkin , Dan Grossman, Automatic Inference of Structural Changes for Matching across Program Versions, Proceedings of the 29th international conference on Software Engineering, p.333-343, May 20-26, 2007 [doi>10.1109/ICSE.2007.20]
• 25: H. Lieberman. Your Wish is My Command: Programming By Example. Morgan Kaufmann, 2001.
• 26: Y. Lin, J. Gray, and F. Jouault. DSMDiff: A differentiation tool for domain-specific models. European Journal of Information Systems, 16:349--361, 2007.
• 27: D. Panda, D. Clarke, and M. Schincariol. EJB 3.0 migration. Technical report, Oracle, October 2005.
• 28: R. Pawlak, C. Noguera, and N. Petitprez. Spoon: Program analysis and transformation in Java. Technical report, INRIA Research Report, 2006.
• 29: Jeff H. Perkins, Automatically generating refactorings to support API evolution, Proceedings of the 6th ACM SIGPLAN-SIGSOFT workshop on Program analysis for software tools and engineering, September 05-06, 2005, Lisbon, Portugal
• 30: M. Proctor, M. Neale, P. Lin, and M. Frandsen. Drools Documentation. Technical report, JBoss Inc., 2006.
• 31: Chris Richardson, Untangling enterprise Java, Queue, v.4 n.5, June 2006 [doi>10.1145/1142031.1142045]
• 32: D. Roberts and J. Brant. Tools for making impossible changes - experiences with a tool for transforming large Smalltalk programs. Software, IEE Proceedings-, 151(2):49--56, 2004. 1462--5970.
• 33: S. Roock and A. Havenstein. Refactoring tags for automatic refactoring of framework dependent applications. In Proc. Int'l Conf. eXtreme Programming and Flexible Processes in Software Engineering (XP), 2002.
• 34: C. Russell. Java Data Objects 2.1, June 2007. http://db.apache.org/jdo/specifications.html.
• 35: Macneil Shonle , William G. Griswold , Sorin Lerner, Beyond refactoring: a framework for modular maintenance of crosscutting design idioms, Proceedings of the the 6th joint meeting of the European software engineering conference and the ACM SIGSOFT symposium on The foundations of software engineering, September 03-07, 2007, Dubrovnik, Croatia [doi>10.1145/1287624.1287650]
• 36: R. Stuckert. JUnit reloaded, December 2006. http://today.java.net/pub/a/today/2006/12/07/junit-reloaded.html.
• 37: Kunal Taneja , Danny Dig , Tao Xie, Automated detection of api refactorings in libraries, Proceedings of the twenty-second IEEE/ACM international conference on Automated software engineering, November 05-09, 2007, Atlanta, Georgia, USA [doi>10.1145/1321631.1321688]
• 38: W. Tansey and E. Tilevich. Refactoring object-oriented applications for metadata-based frameworks. Technical report, Virginia Tech, January 2008.
• 39: Tom Tourwé , Tom Mens, Automated Support for Framework-Based Software Evolution, Proceedings of the International Conference on Software Maintenance, p.148, September 22-26, 2003
• 40: D. Vines and K. Sutter. Migrating legacy Hibernate applications to OpenJPA and EJB 3.0, August 2007. http://www.ibm.com/developerworks/websphere/techjournal/0708_vines/0708_vines.html.
• 41: E. Visser. A survey of strategies in program transformation systems. Electronic Notes in Theoretical Computer Science, 57, 2001.
• 42: E. Visser. Program transformation with Stratego/XT: Rules, strategies, tools, and systems in StrategoXT-0.9. In Domain-Specific Program Generation, volume 3016 of Lecture Notes in Computer Science, pages 216--238. Spinger-Verlag, June 2004.
• 43: Zhenchang Xing , Eleni Stroulia, UMLDiff: an algorithm for object-oriented design differencing, Proceedings of the 20th IEEE/ACM international Conference on Automated software engineering, November 07-11, 2005, Long Beach, CA, USA [doi>10.1145/1101908.1101919]
• 44: Zhenchang Xing , Eleni Stroulia, API-Evolution Support with Diff-CatchUp, IEEE Transactions on Software Engineering, v.33 n.12, p.818-836, December 2007 [doi>10.1109/TSE.2007.70747]
• 45: Zhenchang Xing , Eleni Stroulia, Differencing logical UML models, Automated Software Engineering, v.14 n.2, p.215-259, June 2007 [doi>10.1007/s10515-007-0007-3]

INDEX TERMS

Primary Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
      D.2.3 Coding Tools and Techniques
          Subjects: Object-oriented programming

Additional Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
      D.2.6 Programming Environments
          Subjects: Integrated environments
      D.2.7 Distribution, Maintenance, and Enhancement
          Subjects: Portability; Enhancement**

General Terms:
Experimentation, Languages

Keywords:
JUnit, annotations, eclipse, frameworks, java, metadata, refactoring, upgrading