Object oriented framework mechanism for a source code repository

• US 5,878,432 A
• Filed: 10/29/1996
• Issued: 03/02/1999
• Est. Priority Date: 10/29/1996
• Status: Expired due to Fees

• Current Assignee: International Business Machines Corporation
• Original Assignee: International Business Machines Corporation
• Inventors: Nock, Clifton Malcolm, Misheski, David Joseph
• Primary Examiner(s): Black, Thomas G.
• Assistant Examiner(s): ROBINSON, GRETA LEE
• Application Number:
  US08/740,383
• Time in Patent Office: 854 Days
• Field of Search: 707/103, 707/200, 707/104, 707/203, 395/685, 395/704, 395/710, 395/712
• US Class Current: 1/1
• CPC Class Codes: G06F 16/289 Object oriented databases
• CPC Class Codes: G06F 8/71 Version control security arrangements therefor G06F21/57; Configuration management
• CPC Class Codes: Y10S 707/99944 Object-oriented database structure
• CPC Class Codes: Y10S 707/99945 Object-oriented database structure processing
• CPC Class Codes: Y10S 707/99953 Recoverability

Abstract

An object oriented framework mechanism provides a straightforward and convenient way to implement an source code repository for tracking the configuration of various releases of a software product. The source code repository framework includes several classes that are extensible according to the needs of the user. The class relationships define the core function of the framework mechanism. Extensible classes include a source class, a product class, a release class, a version class, a data class, and a lock state class. These extensible classes are extended by a programmer to implement a desired source code repository environment. The framework provides consistent programmer interfaces over a wide variety of different source code repository environments, which greatly enhances programmer efficiency and which makes the resultant code much easier to maintain.

Claims

1. A computer system, the computer system containing a source code repository to track at least one release for at least one software product, the computer system comprising:

a central processing unit; and

a main memory coupled to the central processing unit, the main memory containing an object-oriented framework mechanism executing on the central processing unit, the framework mechanism including at least one core function that cannot be modified by a user and at least one extensible function defined by a user to customize the framework mechanism and thereby define at least one source code repository environment.

2. The computer system of claim 1 wherein the framework mechanism comprises a source class, the source class defining:

at least one source object corresponding to the at least one source code repository environment; and

a first set of object methods to perform a plurality of predetermined functions to implement the source code repository environment.

3. The computer system of claim 2 wherein the first set of object methods comprises:

at least one object method that checks in a version of a source code module into the repository; and

at least one object method that checks out a version of a source code module from the repository.

4. The computer system of claim 3 wherein the first set of object methods further comprises:

at least one object method that extracts a version of a source code module from the repository; and

at least one object method that undoes the effect of a previous object method that checked in a version of the source code module into the repository.

5. The computer system of claim 2 wherein the source class is an extensible class of the framework mechanism, the implementation of which by a user defines a first portion of the source code repository environment.

6. The computer system of claim 1 wherein the framework mechanism comprises a product class, the product class defining:

at least one product object corresponding to a software product stored in the repository; and

a second set of object methods to add a source code module to the at least one product object.

7. The computer system of claim 1 wherein the framework mechanism comprises a release class, the release class defining:

at least one release object corresponding to a release of a software product stored in the repository; and

a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object.

8. The computer system of claim 1 wherein the framework mechanism comprises a version class, the version class defining:

at least one version object corresponding to a specified version of a source code module stored in the repository; and

a fourth set of object methods to determine the previous version of the source code module based on the current version.

9. The computer system of claim 1 wherein the framework mechanism comprises a data class and a lock state class, the data class defining:

at least one data object representing at least one source code module that is stored in the source code repository;

the lock state class defining;

at least one lock state object corresponding to each data object; and

a fifth set of object methods for locking and unlocking a specified version of the at least one source code module in a corresponding data object.

10. The computer system of claim 3 wherein the framework mechanism further comprises:

a product class, the product class defining;

at least one product object corresponding to a release of a software product stored in the repository; and

a second set of object methods to add a source code module to the at least one product object;

a release class, the release class defining;

at least one release object corresponding to a release of a software product stored in the repository; and

a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object;

a version class, the version class defining;

at least one version object corresponding to a specified version of a source code module stored in the repository; and

a fourth set of object methods to determine the previous version of the source code module based on the current version;

a data class, the data class defining;

at least one data object representing at least one source code module that is stored in the source code repository;

a lock state class, the lock state class defining;

at least one lock state object corresponding to each data object; and

a fifth set of object methods for locking and unlocking a specified version of the at least one source code modules in a corresponding data object.

11. The computer system of claim 10 wherein the source class, the product class, the release class, the version class, the data class, and the lock state class are extensible classes of the framework mechanism, the implementation of which by a user defines the at least one source code repository environment.

12. The computer system of claim 10 wherein the source class has a "has by reference" relationship with the version class, the product class has a "has by reference" relationship with the source class, the release class has a "has by reference" relationship with the version class, and the version class has a "has by reference" relationship with the source class, the lock state class, and the data class.

13. The computer system of claim 1 wherein the main memory contains an application program that supports an object oriented programming environment containing the framework mechanism, and wherein the framework mechanism is extended by providing information that implements the at least one source code repository environment.

14. The computer system of claim 1 wherein:

the at least one core function is defined by the relationships between a plurality of classes within the framework mechanism; and

the at least one extensible function is defined by at least one extensible class, wherein the implementation of the at least one extensible function is defined by the user of the framework mechanism by extending the at least one extensible class.

15. A method for tracking at least one release of at least one software product, the method comprising the steps of:

providing an extensible object oriented framework mechanism that stores and retrieves at least one source code module in a source code repository according to extended portions of the framework mechanism that are customized to provide a desired source code repository environment, the framework mechanism including at least one core function that cannot be modified by a user, the extended portions being defined by a user to customize the framework mechanism and thereby define the desired source code repository environment; and

executing the object oriented framework mechanism on a computer system.

16. The method of claim 15 further comprising the step of:

extending the framework mechanism to define the desired source code repository environment.

17. The method of claim 15 further including the step of checking out at least one of the source code modules from the repository.

18. The method of claim 17 further including the step of locking the at least one source code module that is checked out of the repository.

19. The method of claim 18 wherein the step of locking the at least one source code module includes the steps of:

checking a lock state corresponding to the at least one source code module; and

if the lock state indicates that the at least one source code module is locked;

returning an indication of unsuccessful lock;

if the lock state indicates that the at least one source code module is unlocked;

locking the lock state; and

returning an indication of successful lock.

20. The method of claim 15 further including the step of checking in at least one of the source code modules into the repository.

21. The method of claim 20 further including the step of unlocking at least one source code module that is a previous version of the at least one source code module that is checked into the repository.

22. The method of claim 15 further including the step of extracting at least one of the source code modules from the repository.

23. The method of claim 15 further including the step of undoing the changes effected by a previous step of checking in at least one of the source code modules into the repository.

24. The method of claim 15 further including the step of building and maintaining a release object that has a plurality of version objects corresponding to a desired release of the software product.

25. The method of claim 15 further including the step of adding at least one source code module to the at least one release of the at least one software product.

26. A program product comprising:

an object-oriented framework mechanism for tracking at least one release of at least one software product, the framework mechanism including an extensible source code repository mechanism that stores and retrieves at least one source code module in a source code repository according to extended portions of the framework mechanism, the framework mechanism including at least one core function that cannot be modified by a user, the extended portions being defined by a user to customize the framework mechanism and thereby define at least one source code repository environment; and

signal bearing media bearing the framework mechanism.

27. The program product of claim 26 wherein the signal bearing media comprises recordable media.

28. The program product of claim 26 wherein the signal bearing media comprises transmission media.

29. The program product of claim 26 wherein the framework mechanism comprises:

a source object that has at least one version of the at least one source code module; and

a first set of object methods to perform a plurality of predetermined functions to implement the source code repository environment.

30. The program product of claim 29 wherein the first set of object methods includes:

at least one object method that checks in a version of a source code module into the repository; and

at least one object method that checks out a version of a source code module from the repository.

31. The program product of claim 29 wherein the first set of object methods includes:

at least one object method that extracts a version of a source code module from the repository; and

at least one object method that undoes the effect of a previous object method that checked in a version of the source code module into the repository.

32. The program product of claim 29 wherein the source class is an extensible class of the framework mechanism, the implementation of which by a user defines a first portion of the source code repository environment.

33. The program product of claim 26 wherein the framework mechanism comprises a product class, the product class defining:

at least one product object corresponding to a release of a software product stored in the repository; and

a second set of object methods to add a source code module to the at least one product object.

34. The program product of claim 26 wherein the framework mechanism comprises a release class, the release class defining:

at least one release object corresponding to a release of a software product stored in the repository; and

a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object.

35. The program product of claim 26 wherein the framework mechanism comprises a version class, the version class defining:

at least one version object corresponding to a specified version of a source code module stored in the repository; and

a fourth set of object methods to determine the previous version of the source code module based on the current version.

36. The program product of claim 26 wherein the framework mechanism comprises a data class and a lock state class, the data class defining:

at least one data object representing at least one source code module that is stored in the source code repository;

the lock state class defining;

at least one lock state object corresponding to each data object; and

a fifth set of object methods for locking and unlocking a specified version of the at least one source code modules in a corresponding data object.

37. The program product of claim 33 wherein the framework mechanism further comprises:

a product class, the product class defining;

the repository; and

a second set of object methods to add a source code module to the at least one product object;

a release class, the release class defining;

at least one release object corresponding to a release of a software product stored in the repository; and

a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object;

a version class, the version class defining;

at least one version object corresponding to a specified version of the code module stored in the repository; and

a fourth set of object methods to determine the previous version of the source code module based on the current version;

a data class, the data class defining;

at least one data object representing at least one source code module that is stored in the source code repository;

a lock state class, the lock state class defining;

at least one lock state object corresponding to each data object; and

a fifth set of object methods for locking and unlocking a specified version of the at least one source code modules in a corresponding data object.

38. The program product of claim 37 wherein the source class, the product class, the release class, the version class, the data class, and the lock state class are extensible classes of the framework mechanism, the implementation of which by a user defines the at least one source code repository environment.

39. The program product of claim 26 wherein the main memory contains an application program that supports an object oriented programming environment containing the framework mechanism, and wherein the framework mechanism is extended by providing information that implements the at least one source code repository environment.

40. The program product of claim 26 wherein the framework mechanism comprises:

at least one core function defined by the relationships between a plurality of classes within the framework mechanism, wherein the implementation of the at least one core function is defined by the framework mechanism and cannot be modified by a user of the framework mechanism; and

at least one extensible function defined by at least one extensible class, wherein the implementation of the at least one extensible function is defined by the user of the framework mechanism by extending the at least one extensible class.

41. An object oriented framework mechanism for use in a computer system that supports an object oriented programming environment, the framework mechanism comprising:

at least one source object, the at least one source object including a first set of object methods to perform a plurality of predetermined functions to implement a source code repository environment;

at least one product object corresponding to a software product stored in the repository, the at least one product object including a second set of object methods to add a source code module to the at least one product object;

at least one release object corresponding to a release of the software product stored in the repository, the at least one release object including a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object;

at least one version object corresponding to a specified version of a source code module stored in the repository, the at least one version object including a fourth set of object methods to determine the previous version of the source code module based on the current version;

at least one data object representing at least one source code module that is stored in the source code repository; and

at least one lock state object corresponding to each data object, the at least one lock state object including a fifth set of object methods for locking and unlocking a specified version of the at least one source code modules in a corresponding data object.

42. The object oriented framework mechanism of claim 41 wherein the framework mechanism comprises:

at least one core function defined by relationships between a plurality of classes that define the plurality of objects within the framework mechanism, wherein the implementation of the at least one core function is defined by the framework mechanism and cannot be modified by a user of the framework mechanism; and

at least one extensible function defined by at least one extensible class, wherein the implementation of the at least one extensible function is defined by the user of the framework mechanism by extending the at least one extensible class.

43. A method for tracking at least one release of at least one software product, the method comprising the steps of:

(A) providing at least one source object, the at least one source object including a first set of object methods to perform a plurality of predetermined functions to implement a source code repository environment;

(B) providing at least one product object corresponding to a software product stored in the repository, the at least one product object including a second set of object methods to add a source code module to the at least one product object;

(C) providing at least one release object corresponding to a release of the software product stored in the repository, the at least one release object including a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object;

(D) providing at least one version object corresponding to a specified version of a source code module stored in the repository, the at least one version object including a fourth set of object methods to determine the previous version of the source code module based on the current version;

(E) providing at least one data object representing at least one source code module that is stored in the source code repository; and

(F) providing at least one lock state object corresponding to each data object, the at least one lock state object including a fifth set of object methods for locking and unlocking a specified version of the at least one source code modules in a corresponding data object; and

(G) executing the object oriented framework mechanism on a computer system to track the at least one release of the at least one software product.

44. The method of claim 43 further comprising the step of:

implementing the desired source code repository environment by extending the framework mechanism.

45. The method of claim 44 further comprising the steps of:

selecting at least one check-in criterion for determining at least one step to be performed during check-in; and

the step of implementing the desired source code repository environment further including the step of defining the extended portions in accordance with the at least one check-in criterion.

46. The method of claim 44 further comprising the steps of:

selecting at least one check-out criterion for determining at least one step to be performed during check-out; and

the step of implementing the desired source code repository environment further including the step of defining the extended portions in accordance with the selected at least one check-out criterion.

47. The method of claim 45 further comprising the steps of:

selecting at least one assigning criterion for assigning at least one version of at least one source code module to the at least one release object;

the step of implementing the desired source code repository environment further including the step of defining the extended portions in accordance with the selected at least one assigning criterion.

48. A program product comprising:

(A) an object oriented framework mechanism for tracking at least one release of at least one software product according to extended portions that are customized to provide a desired source code repository environment, the framework mechanism including;

at least one source object, the at least one source object including a first set of object methods to perform a plurality of predetermined functions to implement the source code repository environment;

at least one product object corresponding to a software product stored in the repository, the at least one product object including a second set of object methods to add a source code module to the at least one product object;

at least one release object corresponding to a release of the software product stored in the repository, the at least one release object including a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object;

at least one version object corresponding to a specified version of a source code module stored in the repository, the at least one version object including a fourth set of object methods to determine the previous version of the source code module based on the current version;

at least one data object representing at least one source code module that is stored in the source code repository; and

at least one lock state object corresponding to each data object, the at least one lock state object including a fifth set of object methods for locking and unlocking a specified version of the at least one source code modules in a corresponding data object;

wherein the object oriented framework mechanism tracks the at least one release of the at least one software product according to extended portions of the framework mechanism that are customized to provide the desired source code repository environment; and

(B) signal bearing media bearing the object oriented framework mechanism.

49. The program product of claim 48 wherein the signal bearing media comprises recordable media.

50. The program product of claim 48 wherein the signal bearing media comprises transmission media.

51. The program product of claim 48 wherein the source class, the product class, the release class, the version class, the data class, and the lock state class are extensible classes of the framework mechanism, the implementation of which by a user defines the at least one source code repository environment.

52. An object oriented framework mechanism for a source code repository, the framework mechanism comprising:

at least one core function defined by relationships between a plurality of classes within the framework mechanism, wherein the implementation of the at least one core function is defined by the framework mechanism and cannot be modified by a user of the framework mechanism; and

at least one extensible class wherein the implementation of the at least one extensible class is defined by the user of the framework mechanism, by extending the at least one extensible class, thereby defining at least one source code repository environment.

53. The object oriented framework mechanism of claim 52 further comprising:

at least one source object, the at least one source object including a first set of object methods to perform a plurality of predetermined functions to implement the source code repository environment;

at least one product object corresponding to a software product stored in the repository, the at least one product object including a second set of object methods to add a source code module to the at least one product object;

at least one release object corresponding to a release of the software product stored in the repository, the at least one release object including a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object;

at least one version object corresponding to a specified version of a source code module stored in the repository, the at least one version object including a fourth set of object methods to determine the previous version of the source code module based on the current version;

at least one data object representing at least one source code module that is stored in the source code repository; and

at least one lock state object corresponding to each data object, the at least one lock state object including a fifth set of object methods for locking and unlocking a specified version of the at least one source code modules in a corresponding data object.

54. A method for tracking at least one release of at least one software product using a computer system having a central processing unit and a main memory, the main memory having an application program that provides an object oriented programming environment, the method comprising the steps of:

(A) providing in the application program an object oriented framework mechanism that performs the tracking according to extended portions of the framework mechanism that are customized to provide a desired source code repository environment, the framework mechanism including;

a set of core functions wherein the implementation of the core functions is defined by the framework mechanism and cannot be modified by a user of the framework mechanism; and

a set of extensible functions wherein the implementation of the extensible functions is defined by the user of the framework mechanism;

(B) extending the extensible functions in the framework mechanism to define particular classes having predetermined protocols and defining particular object methods that perform the tracking, the extensible functions defining the desired source code repository environment;

(C) generating an executable source code repository program by integrating together the extensible functions and the core functions; and

(D) executing the executable source code repository program on the computer system to perform the tracking.

55. The method of claim 54 further comprising the steps of:

(a) checking in a version of a source code module into the repository; and

(b) checking out a version of a source code module from the repository.

56. The method of claim 55 further comprising the steps of:

(c) extracting a version of a source code module from the repository; and

(d) undoing the effect of a previous object method that checked in a version of the source code module into the repository.

57. A program product comprising:

an object oriented framework mechanism for tracking at least one release of at least one software product within a source code repository, the framework mechanism including at least one core function defined by relationships between a plurality of classes within the framework mechanism, wherein the implementation of the at least one core function is defined by the framework mechanism and cannot be modified by a user of the framework mechanism, the framework mechanism further including at least one extensible function defined by at least one extensible class, wherein the implementation of the at least one extensible class is defined by the user of the framework mechanism by extending the at least one extensible class, thereby defining a source code repository environment that governs the operation of the framework mechanism; and

signal bearing media bearing the object oriented framework mechanism.

58. The program product of claim 57 wherein the signal bearing media comprises recordable media.

59. The program product of claim 57 wherein the signal bearing media comprises transmission media.

60. The program product of claim 57 wherein the framework mechanism comprises:

at least one source object, the at least one source object including a first set of object methods to perform a plurality of predetermined functions to implement the source code repository environment;

at least one product object corresponding to a software product stored in the repository, the at least one product object including a second set of object methods to add a source code module to the at least one product object;

at least one release object corresponding to a release of the software product stored in the repository, the at least one release object including a third set of object methods to assign a specified version to the at least one release object and to identify a version specified in the release object for a specified source object;

at least one version object corresponding to a specified version of a source code module stored in the repository, the at least one version object including a fourth set of object methods to determine the previous version of the source code module based on the current version;

at least one data object representing at least one source code module that is stored in the source code repository; and

at least one lock state object corresponding to each data object, the at least one lock state object including a fifth set of object methods for locking and unlocking a specified version of the at least one source code modules in a corresponding data object;

wherein the object oriented framework mechanism tracks the at least one release of the at least one software product according to extended portions of the framework mechanism that are customized to provide the desired source code repository environment.