Method and system to monitor software interface updates and assess backward compatibility

• US 7,600,219 B2
• Filed: 12/10/2003
• Issued: 10/06/2009
• Est. Priority Date: 12/10/2003
• Status: Active Grant

• Current Assignee: SAP SE
• Original Assignee: SAP AG (SAP SE)
• Inventors: Tsantilis, Efstratios
• Primary Examiner(s): Bullock, Jr.; Lewis A
• Assistant Examiner(s): Wang; Jue S
• Application Number:
  US10/730,975
• Publication Number:
  US 20050132346A1
• Time in Patent Office: 2,127 Days
• Field of Search: 707/203, 717/122, 717/168, 717/170
• US Class Current: 717/122
• CPC Class Codes: G06F 8/71 Version control security arrangements therefor G06F21/57; Configuration management

Abstract

A system and method for monitoring updates to the interface portion of a software library or repository. An embodiment of the invention determines whether detected changes made to the software interface are likely to cause backward compatibility problems. Initially, an embodiment assembles and stores a snapshot of a baseline version of the software interface. Then, an embodiment assembles a snapshot of an updated version of the interface and compares the updated snapshot to the baseline snapshot to detect whether any changes have been made. Any differences between the updated snapshot and the baseline snapshot are rated by an embodiment according to a backward compatibility metric and reported in an alert message to an appropriate user.

Claims

1. A method for monitoring updates in a software repository in a multi-author software design environment, comprising:

constructing a first snapshot of a set of software module source code stored by the software repository at a first point in time, the source code represented by a plurality of objects;

constructing a second snapshot of the set of software module source code stored by the software repository at a second point in time;

comparing the first snapshot with the second snapshot, to detect differences in the source code;

rating each detected difference according to a backward compatibility metric, the backward compatibility metric representing a probability that the detected difference renders a source code attribute of the second snapshot incompatible with a similar source code attribute of the first snapshot;

determining an overall backward compatibility score for the second snapshot, based on the rated differences; and

issuing an alert message to registered authors of the set of software module source code when the overall backward compatibility exceeds a backward compatibility threshold, wherein the alert message is issued only to users associated with objects for which differences are detected.

2. The method of claim 1, wherein the backward compatibility threshold is set by a registered author.

3. The method of claim 1, wherein the constructing is performed a plurality of times, to construct a plurality of successive snapshots representing the software repository as respective points in time, each successive snapshot having a version and being stored in a snapshot history database.

4. The method of claim 3, wherein each successive snapshot is constructed on a periodic basis.

5. The method of claim 4, wherein the periodic basis is a set timetable.

6. The method of claim 3, wherein each successive snapshot is constructed in response to a predefined event.

7. The method of claim 1, wherein the alert message is issued only to authors of objects for which differences are detected.

8. The method of claim 1, wherein the alert message is issued only when the overall backward compatibility score indicates the second snapshot is not backward compatible.

9. The method of claim 1, wherein the backward compatibility metric comprises a table of software modifications identifying backward-compatible software modifications and backward-incompatible software modifications.

10. The method of claim 1, wherein the backward-incompatible detected differences include:

a deleted parameter from a subroutine; and

a deleted field from a public data structure.

11. The method of claim 1, wherein the backward-incompatible detected differences include:

an added mandatory parameter in a subroutine; and

an added mandatory field in a public data structure.

12. The method of claim 1, wherein the backward-incompatible detected differences include:

an optional parameter redefined as a mandatory parameter;

a changed parameter data type; and

a changed public field data type.

13. A system for monitoring updates in a software repository in a multi-author software design environment, comprising:

a processor configured to construct a first snapshot of a set of software module source code stored by the software repository at a first point in time, the source code represented by a plurality of objects;

the processor configured to construct a second snapshot of the set of software module source code stored by the software repository at a second point in time;

the processor configured to compare the first snapshot with the second snapshot, to detect differences in the source code;

the processor configured to rate each detected difference according to a backward compatibility metric, the backward compatibility metric representing a probability that the detected difference renders a source code attribute of the second snapshot incompatible with a similar source code attribute of the first snapshot;

the processor configured to determine an overall backward compatibility score for the second snapshot, based on the rated differences;

the processor, in connection with an output device, configured to issue an alert message to registered authors of the set of software module source code when the overall backward compatibility exceeds a backward compatibility threshold, wherein the alert message is issued only to users associated with objects for which differences are detected.

14. The system of claim 13, wherein the first and second snapshots are constructed from a subset of the software module source code, the subset specified by a registered author.

15. The system of claim 13, wherein the constructing is performed a plurality of times, to construct a plurality of successive snapshots representing the software repository as respective points in time, each successive snapshot having a version and being stored in a snapshot history database.

16. The system of claim 15, wherein each successive snapshot is constructed on a periodic basis.

17. The system of claim 16, wherein the periodic basis is a set timetable.

18. The system of claim 15, wherein each successive snapshot is constructed in response to a predefined event.

19. The system of claim 13, wherein the alert message is issued only to authors of objects for which differences are detected.

20. The system of claim 13, wherein the alert message is issued only when the overall backward compatibility score indicates the second snapshot is not backward compatible.

21. The system of claim 13, wherein the backward compatibility metric comprises a table of software modifications identifying backward-compatible software modifications and backward-incompatible software modifications.

22. The system of claim 13, wherein the backward-incompatible detected differences include:

a deleted parameter from a subroutine;

a deleted field from a public data structure, an added mandatory parameter to a subroutine, an added mandatory field to a public data structure, an optional parameter redefined as a mandatory parameter, a changed parameter data type, and a changed public field data type.

23. A computer-readable storage medium encoded with instructions configured to be executed by a processor, the instructions which, when executed by the processor, cause the performance of a method, comprising:

constructing a first snapshot of a set of software module source code stored by the software repository at a first point in time, the source code represented by a plurality of objects;

constructing a second snapshot of the set of software module source code stored by the software repository at a second point in time;

comparing the first snapshot with the second snapshot, to detect differences in the source code;

rating each detected difference according to a backward compatibility metric, the backward compatibility metric representing a probability that the detected difference renders a source code attribute of the second snapshot incompatible with a similar source code attribute of the first snapshot;

determining an overall backward compatibility score for the second snapshot, based on the rated differences; and

issuing an alert message to registered authors of the set of software module source code when the overall backward compatibility exceeds a backward compatibility threshold, wherein the alert message is issued only to users associated with objects for which differences are detected.

24. The computer-readable storage medium of claim 23, wherein the constructing is performed a plurality of times, to construct a plurality of successive snapshots, each successive snapshot having a version and being stored in a snapshot history database.

25. The computer-readable storage medium of claim 24, where the each successive snapshot is constructed on a periodic basis.

26. The computer-readable storage medium of claim 25, wherein the periodic basis is a set timetable.

27. The computer-readable storage medium of claim 24, wherein the periodic basis is responsive to a predefined event.

28. The computer-readable storage medium of claim 23, wherein the issuing is performed for only the authors of affected software modules.

29. The computer-readable storage medium of claim 23, wherein the alert message is issued only when the overall backward compatibility score indicates the updated version is not backward compatible.

30. The computer-readable storage medium of claim 23, wherein the compatibility metric comprises a table of software modifications including backward-compatible software modifications and backward-incompatible software modifications.

31. The computer-readable storage medium of claim 23, wherein the backward-incompatible detected differences include:

a deleted parameter from a subroutine, a deleted field from a public data structure, an added mandatory parameter to a subroutine, an added mandatory field to a public data structure, an optional parameter redefined as a mandatory parameter, a changed parameter data type, and a changed public field data type.

32. A method for monitoring updates in a software repository in a multi-author software design environment, comprising:

associating a registered author of the software design environment with a subset of a plurality of software module source code stored by the software repository, the source code defining a plurality of objects, wherein the subset is based on input received from the registered author;

constructing a first snapshot of the subset at a first point in time;

constructing a second snapshot of the subset at a second point in time;

wherein each snapshot includes an aggregation of methods and parameters of the software module source code in the subset, with methods and parameters of any software module referenced by the software module source code in the subset;

comparing the first snapshot with the second snapshot, to detect differences in the source code;

rating each detected difference according to a backward compatibility metric, the backward compatibility metric representing a probability that the detected difference renders a source code attribute of the second snapshot incompatible with a similar source code attribute of the first snapshot;

determining an overall backward compatibility score for the second snapshot, based on the rated differences; and

issuing an alert message to the registered author of the subset when the overall backward compatibility exceeds a predetermined threshold set by input from the registered author, the alert message including a list of each rated difference, wherein the alert message is issued only to users associated with objects for which differences are detected.