# Patent

## Title
System and method for installing, updating and uninstalling applications

## Abstract

One method includes mapping a set of environment independent attributes and tokenizing a set of environment dependent attributes in a user selected format. Optionally, the tokens may be replaced with values for the environment dependent attributes. The mapped attributes and the values for the environment dependent attributes may then be used to configure an environment(s). In one embodiment, the configuration is a transaction in a J2EE environment and the format is XML. Additionally, the transaction may tolerate the presence/absence of attributes which are to be installed/deleted. Moreover, the method may support uninstalling applications, change logging, version skipping, and generating prospective change and state reports. The mapping may be from an operational or development server. Likewise, the configuration can occur to an operational or development server. The sets of attributes may be identified by, for example, using predefined rules.

## Background
RELATED INFORMATION
This application claims priority under 35 U.S.C. §119(e) to U.S. Patent Application No. 60/901,990 filed on Feb. 16, 2007 by Robert Eric Reeves which is entitled System And Method For Installing, Updating And Uninstalling Applications and which is incorporated herein as if set forth in full.


TECHNICAL FIELD
Embodiments of the disclosure relate generally to supporting applications and more particularly to systems and methods for supporting applications which have potentially numerous versions and which are intended to be deployed into a variety of environments each requiring different support resources for the applications.
BACKGROUND
Software lifecycles begin in the development environment in which developers strive to create and perfect the program. As development proceeds various versions of the application evolve on the development server(s) used to code, test, and debug the application. Frequently, each version of the application requires different resources from the server in order to run properly. Likewise, because the environment of each server can differ from the others, the installation of an application on a particular server often requires resources from that server that may be unique to that server. Once the application is operational, each installation in a large scale deployment can be virtually unique thereby creating a nightmare for the support team called upon to deploy the application. These difficulties occur across a wide range of technologies other than application servers including, but not limited to, mobile telecommunication networks, database servers, computing networks (LANs or WANs), web servers, and enterprise service buses.
For instance, Java Platform Enterprise Edition (referred to as J2EE) is a platform for developing and executing distributed, multi-tiered, Java applications. In this case, deployment is the act of installing components for a J2EE application and configuring a J2EE Application Server to run the J2EE application. Deployment of these applications can occur multiple times to multiple targets during the development life cycle and can occur to application servers provided by a multiplicity of vendors. Because each application server may be configured differently, configuring application servers during deployment can be a time consuming and inefficient task.
Current deployment methods include manual deployment, using vendor specific GUI applications (i.e., installation “wizards”), using vendor specific command line tools (e.g., scripting etc.) and creating custom installation utilities. These current methods, however, suffer several shortcomings. Manual deployment is time consuming and error prone during both initial installation at a target and during updating. Furthermore, documentation related to the changes needed for the application server must be manually updated after changes to the application or the application server. Manual installation also provides limited, if any, versioning. Using vendor specific GUI applications also leads to time consuming and error prone installations and updates. Furthermore, installation applications are typically tied to the particular vendor's system, necessitating the purchase of multiple installation applications if the code is to be installed on multiple vendors' servers. Training is also typically required for each vendor's system. Likewise, vendor specific command line tools require developer intervention for changes and are also often tied to a single vendor's system. Thus, changes are difficult to synchronize across multiple vendors' systems. Moreover, vendor specific command line tools are time consuming for the developer, lack versioning, require training and also require manual updates. Similarly, existing custom utilities are generally expensive, time consuming and are not adequately robust to handle a variety of installations on multiple vendors' systems.
Thus, a long felt need exists for methods and systems for automating the installation and support of applications.
SUMMARY
Embodiments provide systems and methods of supporting applications that eliminate, or at least substantially reduce, the shortcomings of prior art systems and methods for supporting applications.
One embodiment makes installing applications (and performing other operations on the application) as easy as installing a desktop application. Today, typical J2EE applications include a configuration document or script, and a set of files that contain the actual program code, property files, and other settings. To install the application, the code and the other files have to be copied to the correct location on the target application server and the appropriate configuration settings made. The current embodiment, though, is different from these conventional techniques. Instead of a collection of files and configuration information, the current embodiment can include just the binary files and a relatively small XML document that describes how the application should be configured. IT support staff can then copy the files and execute a lightweight program constructed in accordance with the current embodiment to install the application in any environment (e.g., development, test, or production) or application server (for example JBoss, Websphere, or WebLogic) that the code supports. The program can then automatically configure and deploy the application correctly.
In one embodiment, once the developer has written the application and configured the development environment, the developer points the program to the development server. The program analyzes the server configuration and creates a representation of it. The program can take the configuration information it captured and the built application and deploy the application to different environments and to any server type that the application code supports. Furthermore, the program can make all of the necessary configuration translations automatically. Moreover, the current embodiment offers several advantages over the prior art. First, it is faster than manual deploying the application and requires a fraction of the development time that using custom utilities and other previously available techniques require. As a result, an installation performed in accordance with the current embodiment can take approximately 5% of the time required using previously available techniques.
Secondly, the current embodiment can vastly reduce configuration defects in part, by automating the deployment process and providing a single application configuration file for all different environments and server platforms. The current embodiment also avoids configuration errors attributable to oversight and human error, that is, unintentional mistakes.
Thirdly, the current embodiment makes deployment a non-technical task. One can simply double click on the program icon, answer a few questions, and the program can deploy the application to the specified server(s). Developers can therefore spend their time developing applications (a value-added activity), not deploying them (often considered an expense). Additionally, the current embodiment allows developers to version, upgrade, and even install applications in ways that the prior art cannot.
Furthermore, the current embodiment provides a flexible deployment and support architecture. For example, suppose a customer is having a difficult time getting the application installed. Using the provided architecture, the customer can pull down the configuration information of the faulty installation and send that XML file to IT support, where an exact replica of the customer's environment can be built in the support laboratory. In addition, the architecture can also be used to manage licensed software by generating reports on existing or suspected installations thereby allowing the identification of unlicensed installations.
One embodiment provides a method which includes querying a first server program for a first set of configuration information and identifying sets of environment independent and dependent attributes from the configuration information (using, for example, predefined rules). The values for the environment independent attributes are mapped to, and stored in, a user selected format (e.g., XML). Values for the environment dependent attributes are also stored in that format. The method may include querying other server programs and identifying another set of environment dependent attributes. If so, then the environment independent attributes and one of the sets of environment dependent attributes may be used to configure an environment (e.g., a J2EE environment). The configuration (and other operations provided herein) may be wrapped in a transaction which may include a look ahead sub-process. The look ahead process allows the operation to tolerate unexpected conditions that might be encountered during the operation such as the presence of an attribute which is to be installed or the absence of an attribute which is to be deleted. Change logging may occur during these operations and, indeed, state and prospective change reports may be generated to indicate which changes would occur were a given operation to be performed. Version skipping during application installations may also be provided. The method may also provide application un-installations. The environments in which these activities occur may be associated with either operational or development servers among other environments.
Another embodiment also provides a method which includes abstracting a set of configuration information associated with a first environment into a set of environment independent attributes and a set of environment dependent attributes. The environment independent attributes may be mapped to a user selected format whereas the environment dependent attributes are replaced with tokens and then, optionally, with values. A second environment may then be configured using the mapped environment independent attributes and the values for the set of environment dependent attributes.
One embodiment provides a computer readable medium carrying computer-executable program instructions implementing a method which includes abstracting a set of configuration information associated with a first environment into a set of environment independent attributes and a set of environment dependent attributes. The set of environment independent attributes are mapped to a user selected format and the set of environment dependent attributes are replaced with tokens. The mapped attributes and tokens are stored in a memory.
Another embodiment provides a configuration mapping system which includes an interface, a memory, and a processor in communication with the interface and the memory. The processor receives a user selected format and queries a first server program for a set of configuration information via the interface. The processor identifies a set of environment independent attributes and a set of environment dependent attributes from the set of configuration information. It also maps the set of environment independent attributes into the user selected format and creates tokens for the set of environment dependent attributes. The processor then stores the mapped environment independent attributes and the tokens in the memory. Optionally, the interface may include a wide area network which is in communication with a plurality of servers. Thus, the processor can configure each of the servers using the mapped environment independent attributes and the tokens stored in the memory.
In another embodiment, a method of supporting an application is provided. Since applications typically require resources to run due to the server environment and resources which they require regardless of the server on which they are installed, the method of the current embodiment determines a listing of the resources required to support the application due to the server environment. This listing is apart from the listing of resources required by the application itself regardless of the environment. More particularly, to determine how many resources of that type are required for the application, the application server can be queried for each type of resource known to be required for the application. The server can respond by, for instance, returning a JMX object(s) with the requested information. In turn, this object can be converted to an XML document. A rule set can then be used to determine which resources are required due to the server environment and which resources are required due to the application itself. In any event, the listing of server related requirements is then output. Of course, the non server related requirements may also be output and the two listings used as a “state report” for the server. If at a later time, it is desired to learn if any changes have occurred to the server, a second state report can be generated and compared to the first state report. In this way malicious changes can be detected and the server can be restored to the last known good state using the first report.
Where multiple servers have been analyzed, one of the lists of server related resources (and a list of the application related resources) may then be used to install the application on another server(s) or to re-install it on a server where it is already hosted. Of course, if a particular deployment requires installation on multiple servers, a server related resource listing may be selected for each of the servers individually. Optionally, the target server can be either an operational or a development server and the source server can be the other type of server. More particularly, if an operational application requires troubleshooting the resource listing related to the operational server can be used to configure a development server to re-create the application's operational environmental thereby facilitating the troubleshooting.
Installations performed in accordance with the current embodiment can also be performed automatically even if unexpected situations occur during the installation. For instance, if the installation encounters a required resource that is already configured for the application, the installation may proceed despite what might otherwise cause a script to fail. Likewise, if a resource that ought to be deleted does not exist on the server, the installation may proceed anyway (without failing as scripts often do). Additionally, the installations can be performed as transactions so that, should the transactions fail, the changes made to the servers will be automatically reversed. In a similar manner, an application can be uninstalled by using the resource lists to identify and remove resources particular to the application from the server.
The current embodiment also allows for the creation of a prospective change report detailing what should change during an installation (or de-installation). More specifically, an installation transaction can be started on a server, allowed to all but complete, and then aborted. If the changes made to the server are logged during the installation the log can be used to show what needs to be changed on the server. But, because the transaction was aborted, the changes are undone, or rolled back, leaving the server as it was before the change report was generated.
Furthermore, the current embodiment allows “version skipping” during application installations. That is, by using a resource list associated with the new version and a resource list for the server, all the resources required to support the new version may be configured without having to first install each intermediate version of the application. Otherwise, at least with many applications, it is possible that skipping a version will cause some configuration procedure associated with an intermediate version to be skipped. The result, of course, can be an inoperable application or, in other words, a failed installation.
In another embodiment, a method of supporting a mobile telecommunication network is provided. The method of the current embodiment includes determining, from a device with a mobile application installed thereon, a listing of the resources required to support the mobile application due to the device environment. The list of device related resources is then output. Optionally, the device may be a handset, a telecommunications network node, or a development platform. Thus applications may be installed on these (and other types of telecommunications equipment) using a list of device related resource requirements and a list of mobile application related requirements.
In yet another embodiment, a method of supporting a network is provided. The method of the current embodiment includes determining, from a device on the network, a listing of the resources required to support an application on the device. The list of device related resources required to support the application is also output in the current embodiment. Still another embodiment provides a method of supporting a database server. In the method of the current embodiment a listing of the server related resources required to support the database is determined and output. In yet another embodiment a method of supporting a web-server is provided. In the current embodiment, a list of server related support resources is determined for the web-server program. The list is then output.



BRIEF DESCRIPTION OF THE FIGURES
A more complete understanding of the disclosure and the advantages thereof may be acquired by referring to the following description, taken in conjunction with the accompanying drawings in which like reference numbers indicate like features and wherein:
FIG. 1 is a schematic diagram illustrating an exemplary system architecture constructed in accordance with an embodiment of the disclosure.
FIG. 2 is a schematic diagram illustrating another exemplary system architecture constructed in accordance with an embodiment of the disclosure.
FIG. 3 is a flowchart illustrating a method practice in accordance with an embodiment of the disclosure.
FIG. 4 is a flowchart depicting a method practiced in accordance with an embodiment of the disclosure.
FIG. 5 is a flowchart depicting another method practiced in accordance with an embodiment of the disclosure.
FIG. 6 is a diagrammatic representation of an object storing generic configuration information in accordance with an embodiment of the disclosure.



DETAILED DESCRIPTION
Various embodiments are illustrated in the FIGURES, like numerals being used to refer to like and corresponding parts of the various drawings.
Embodiments provide systems and methods for supporting applications in a variety of environments including, but not limited to, application servers, mobile telecommunication networks, database servers, computing networks (LANs or WANs), web servers, and enterprise service buses.
FIG. 1 is a block diagram illustrating an embodiment of an application installation method 10. Similarly, FIG. 2 shows a diagrammatic representation of deploying an application developed in a development environment 102 to a target environment 111. Typically, a developer develops an application in a known good environment (such as an application server 106, a database server, or other known good environment). Once a developer has written an application in the development environment 102 (i.e., the known good environment), the configuration of the development environment can be analyzed and mapped to a representation that is not specific to the development environment. For example, the development server 106 configuration can be analyzed and mapped to an environmentally agnostic, or environmentally independent, representation 104 of the configuration information. The configuration can then be mapped to the target environment.
FIG. 1 is a diagrammatic representation of one embodiment of a system 100 for deployment of an application. System 100 can include a development environment 102 and a target environment 111. Development environment 102 can include any number of development systems such as an application server 106. Similarly, target environment 111 can contain any number of target systems such as a target application server 117. A deployment system 50 can include deployment software 52. Deployment system 50 can include any suitable computer with processors, memory, and other components. Deployment software 52 can be responsible for mapping configuration information from server 106 to server 117. Deployment software 52 can include an export engine 110 and an install engine 115. Although shown separately in FIG. 1, export engine 110 and install engine 115 can be portions of monolithic code, modules, functions or subroutines of code, separate programs or be implemented in any suitable programming architecture.
Export engine 110 can query server 106 for configuration information related to a developed application (or other code). In general, the configuration information of an application server for an application can be of two types. First, the configuration information can be information that depends on the server environment such that the configuration information will change from application server to application server. The second type of configuration information does not change based on the server environment, though the format for expressing this information may change. Non-environmental configuration information can be extracted from a source environment and mapped to the information to the target environment. Environmental configuration information can be extracted from the source environment and the information changed appropriately for the target environment. The separation of configuration information into environmentally specific and non-environmentally specific information can greatly increase the efficiency of deployment as described below.
Environment dependent configuration information can be mapped to values specific to target server 117 while environment independent configuration information will remain equivalent between server 106 and server 117.
Install engine 115 can map environment dependent and environment independent configuration information to the appropriate format used at target server 117. FIG. 2 is a diagrammatic representation of one embodiment of deploying an application from a development server to an operational server in a J2EE environment. These two environments can vary widely. For instance, development environment 102 can be characterized by frequent changes in the application, the resources needed to support the application, and even in the development environment itself. In an operational environment on the other hand relatively few changes occur. However, the operational environment often requires that more and different parameters be tuned to properly configure the environment for the application.
Exporting Configuration Information
The mapping of source requirements to the target environment can begin with exporting an existing set of requirements. Accordingly, in one embodiment, the export functionality is generally a mapping and abstraction functionality. The general location of configuration information on a server is generally known. For example, J2EE servers typically have Mbeans that represent configuration information. An MBean 108 is a Java object that represents a manageable resource, such as an application, a service, a component, or a device. Thus, identifying the Mbeans associated with an application server's configuration information allows the identification of the resources necessary to operate the application. Depending on the vendor of the J2EE server application the configuration information will be stored in different Mbeans. Knowledge of a particular server application, however, allows a list, a tree, or other structure to be established that specifies the Mbeans that contain configuration information for the application server. For other types of service environments (e.g., database servers), the information on what data structures hold configuration information can similarly be specified based on knowledge of the vendor's database server application. As new data structures are added by a vendor, the data structures can be added to the knowledge base of deployment software 52.
In general, export engine 110 can interface with an application server through the application server's API and query the application server for the configuration information. Taking a J2EE application development server 106 as an example of a source environment, an export engine 110 can connect to the source environment 106 using the source environment API. To determine which MBeans 108 to export, the export engine 110 may utilize a series of properties files and an XML Schema Definition (XSD) tree associated with the application server which is typically known beforehand.
More particularly, the export engine 110 may walk through the XSD tree for the application server 106 and once it reaches an element type that represents an MBean 108, the export engine 110 can validate the MBean 108 type against the properties file. If the MBean type is valid and exists in the properties file, the export engine 110 can retrieve the MBean and create a development server 106 specific object modeled on the actual MBean object 108 found at the development server 106. All of the specified Mbeans for the server can be retrieved. Optionally, the configuration information from a server can be translated into a generic representation used by deployment program 52 to facilitate storage, translation, and management of the configuration information. For example, export engine 110 can translate object 108 to an XML object 112 (referred to as a JMX object herein) and persist the JMX object 112 to an object tree in the form of a generic XML file 104.
With reference again to FIG. 2, the various property files for the source environment 106 define how the attributes 114 (see FIG. 6) of the source environment specific objects 108 map to the JMX object 112. The attribute values 114 of the JMX object 112 can have any data type.
The mapping of the source environment MBeans to the generic XML file 104 can occur because, while there may be various types of source environments (such as WebSphere or WebLogic), they typically utilize equivalent information expressed in different formats. Consequently, that information can be mapped to a format that is not dependent on the type of environment from which it came based on knowledge of how the source environment 106 expresses that information. Therefore, as new source environments 106 are developed, or existing source environments 106 are modified, new mappings between the source environments 106 and the generic objects 104 can be developed to allow for the exporting of the configuration information from these new sources.
Generating Generic Configurations
The configuration information, as discussed above, can include environment independent and environment specific configuration information. According to one embodiment, whether a particular piece of configuration information is environment dependent or environment agnostic can be identified. This can occur in a variety of manners. For example, it may be known that a particular MBean contains information that should not vary based on target environment, while another MBean contains information that will vary depending on the target environment. Whether a particular piece of information is environmental dependent or environmental independent can be predefined in deployment program 52. In other embodiments, a user may review the configuration information or a subset of the configuration information to specify which pieces of configuration information are environment dependent and which are environment agnostic.
According to one embodiment, deployment software can generate a representation of the configuration information. According to one embodiment, the environment agnostic representation can preserve information that is already environment agnostic and tokenize environment specific configuration information. Continuing with the previous example, export engine 110 can generate an XML configuration file 104. XML configuration file 104 can hold the environment agnostic configuration information as JMX objects 112. On the other hand, for the JMX objects 112 that represent environment specific information, configuration file 104 can include a token for the attribute values. For example, if the development application server typically accesses a database at one domain name, but target environments use other domain names, the domain name can be represented as a token ${domain name} that indicates the domain name must be set for the target environment. Again, mapping of information from the source environment to an environment agnostic representation can be facilitated by the fact that while the schemes of the source environments 102 may vary, they generally express equivalent information in known structures.
Initializing a Program to Configure the Target
After the source configuration information is mapped, that information can be used to configure other target environments 111 and to install the application thereon. In one embodiment, a run time engine 115 (e.g., a program) uses an installation atomic 116 to configure and install the application into the target environment(s) 111. As shown in FIG. 2, one embodiment of installation atomic 116 includes three parts. However, the installation atomic 116 may also be a logical collection. For example, the application binaries 120 can be located in a remote location such as a shared drive accessible by the target environment 111. That being said, the XML configuration file 104 can also be one of the components of the installation atomic 116. The generic configuration file 104 holds the non-environment related configuration information (such as information defined by the MBeans 108 and the MBean attributes that are not specific to any environment). Further, it may hold this information in the form of references to environment specific information.
The second component of the installation atomic 116 can be the environment properties document 118. The properties document 118 can be in the form of a text file, object, or some other format Typically, the environment properties document 118 represents environment specific data that supplements the XML Configuration File 104 during subsequent installations. For instance, an application may need to access a data source provided by its environment but that is specified by the target environment user. Since different users may specify different data sources, the address of the data source can be represented generically rather than being blindly translated from the source environment 106. Thus, these particular properties typically represent information that varies depending on the target environment 111. These target specific requirements can be represented by tokens such as ${hostname} in configuration file 104 with a specific value provided for the token in environmental properties 118.
The third component of the installation atomic 116 of the current embodiment may be the compiled binary artifacts 120 (or in other words the application). In an application server environment, the binary artifacts 120 are typically EAR (enterprise archive), JAR (java archive), WAR (web archive), or RAR (Resource Adaptor Archive) files. These are typically provided by a SCM (source code management) build solution.
As mentioned previously, the run time engine 115 may use the installation atomic 116 to configure the target environment 111 and install the application thereon. The run time engine 115 can also uninstall, update, and status the application (and its environment) as well as run reports on the same. Regardless of the operation to be performed, once the run time engine 115 is initialized, the run time engine 115 can perform a sanity check on and validate the XML configuration file(s) 104, the environment related properties document 118, the compiled binaries 120, and the target environment 111. Since every target environment 111 may have a different methodology by which to install (and uninstall) the application, the runtime engine 115 may proceed based on the target's specific requirements. In this sense, the run time engine 115 can be described as being “target specific.” However, a generic run time engine which can operate on any target environment 111 by encapsulating the target's 111 procedures can also be used. Regardless of the type of engine employed (generic or target specific), the run time engine 115 may then be directed to perform one or more of the following exemplary tasks: install, update, uninstall, status, or report on the application and its configuration.
Configuring and Installing Applications
In one embodiment, the run time engine 115 may begin an installation by performing a set of directives that encapsulate the process by which the application(s) is to be installed. The run time engine 115 can then map the configuration information represented in the environment agnostic XML files 104 (potentially using the environment properties document 118) to create target environment specific objects according to the appropriate schema for the target environment 111. Again, the generic representation of the configuration properties (or target environment representation) can be mapped to the format used by the target environment because different application servers tend to utilize equivalent information in known structures. Consequently, equivalent information can be mapped from one structure to another. Run time engine 115 can configure the target environment 111 accordingly by installing the configuration information in structures used by target environment 111. In one embodiment, the process of configuring the target environment 111 and installing the binaries 120 can be wrapped in a transaction. Thus, if any part of the installation fails the installation will then be rolled back to the last known good state. Additionally, as with the other functions of the run time engine 115, the changes it effects on the target environment 111 may be logged for reporting to the user at a convenient time (e.g., at the end of the installation).
Updating Applications
The run time engine 115 can also perform application updates (i.e., installing a more recent version of the application). The update process of the current embodiment is similar to the install process previously discussed. However, a “look ahead” process may be used to verify the ongoing status of the target environment during the update. The look ahead process checks whether particular configuration information is already present at target environment 111. For example, the look ahead process checks, before each MBean (or similar object for non J2EE environments) is configured, to determine whether a particular MBean already exists (for cases in which an MBean is being added) and whether a particular MBean is already absent (for cases in which an MBean is being deleted).
While the look ahead process is not required, it does increase the efficiency of the process. Accordingly, each of the functions of the run time engine 115 can employ a look ahead process. Additionally, for non-transaction based variations of the run time engine 115, the look ahead process allows the engine 115 to detect situations which might abort script based configuration procedures. For instance, when a scripted configuration encounters an MBean that it expects to install (or fails to find one it expects to delete), the script fails resulting in an indeterminate and undesirable state for the target environment 111. Thus, the look ahead process avoids this “brittle” nature of scripts.
As an example of the benefits of using the look ahead process, if the run time engine 115 is to update a specific MBean in the target 111, the run time engine 115 can query the target 111 to determine the status of that MBean 108. If the MBean in question does not exist, but is needed, then the run time engine 115 will create the MBean and set its attributes accordingly. However, if the MBean already exists, the look ahead process allows the run time engine 115 to verify the MBean attributes and, if needed, to adjust them accordingly. Preferably, as with the install process, the update process can be wrapped in a transaction. Thus, if the update fails, the target environment 111 can be rolled back to its last known good state.
Uninstalling Applications
The uninstall process is similar to the install process except it operates in reverse so that configuration information can be deleted using the configuration file 101. For example, any MBean listed, or otherwise represented, in the configuration file 104 can be removed from the target environment 111. However, in one embodiment, the run time engine 115 queries the target environment 111 to determine if any other application might be using the MBean. If so, the MBean is left as is. Regardless of how MBean deletions are handled, the uninstall process can be wrapped in a transaction too and can log changes it causes for reporting, roll back, and other purposes.
Application Status Reporting
To status an application, the run time engine 115 may also use a look ahead process similar to the one described previously. One difference between the update and status processes is that objects are not changed in the status process. Instead, the run time engine 115 runs through the installation without actually executing the installation steps and logs and reports the changes that would otherwise have been made if the current version of the application had been installed. One benefit of this operation is that it allows the user to understand what will change if, and when, the installation does occur.
Reporting Configuration Changes and Differences
The Report Differences process allows the run time engine 115 to determine differences in a given target environment 111 that may have occurred over time, regardless of topology. This process may operate by querying a target environment to determine the environment specific and environment agnostic configuration information previously discussed. Then, by comparing the newly acquired configuration information with a previous version of the configuration information, the Report Differences Process may determine whether any differences exist between the two configurations. Regardless of whether the changes were caused by legitimate configuration activity, inadvertence, or malicious attack the process allows any changes in the environment to be identified.
For example, the run time engine 115 could accomplish this task by performing an export (as discussed herein) coupled with creating an object tree using the information obtained during the export. The configuration of the target environment following the last known operation on the environment (or last known good XML file 104) can be used to generate a second object tree. The two object trees can then be compared to identify changes such as the existence of Mbeans 108 in one environment or differences in the associated attributes or their values. In another embodiment, the run time engine 115 can create an XML file 104 for a particular target environment before a change (e.g., install, update, or uninstall) is made and compare it to the XML file 104 created after the operation. The differences thereby identified can then be committed to other similar target environments 111 to modify them in a similar manner.
Generally, with reference to FIG. 3, a flowchart illustrating one embodiment of a process of mapping a source environment to a target environment is shown. Application servers such as server 106 (shown in FIG. 1) can be queried for configuration information (operation 12). The queried configuration information can then be classified depending on whether the information is environmentally dependent (operation 14). Each piece of configuration information can be accessed (operation 16) and processed. A piece of configuration that is environmentally independent can be mapped to the data structure used by the target environment (operation 20). A piece of configuration information that is environmentally dependent can be mapped to the target environment by selecting the value of the parameter for the target environment (operation 22) and structuring the information in the format used by the target environment (operation 24). Operations 20, 22, and 24 can be repeated for each piece of configuration information. Mapping configuration information from a source environment to a target environment can take any number of steps and, as discussed below, can optionally include mapping configuration information to an environmentally agnostic representation as discussed below. The method of FIG. 3 can be repeated as needed or desired.
FIGS. 4 and 5 illustrate additional exemplary methods. More particularly, FIG. 4 shows a method for mapping source requirements to a generic configuration document 104 (see FIG. 2) and a target specific properties document 118 (see FIG. 2). FIG. 5 shows a method of reconfiguring the target environment 111 during several types of operations. These operations typically include installing, updating, de-installing (i.e., uninstalling), reporting, and providing status of the application.
The method of FIG. 4 can begin with identifying the environment already existing on the source server 106 (operation 202). Typically, application servers 106 run server programs such as WebLogic (available from BEA Systems), WebSphere (available from IBM), or other server program which in turn provide mechanisms for the applications running on the server 106 to access the various resources on the server 106. Other readily available server programs such as OAS, JBoss, Tomcat, Apache, Netweaver, and Sun One also fill similar rolls. With the source environment 106 identified, the method can then proceed with locating the XSD tree associated with the application of interest as shown at operation 204.
In operation 206, the application server 106 can be queried for each type of MBean 108 that might be associated with the application to determine how many MBeans 108 of that type exist and what properties and attributes they possess (operation 208). The query for a particular type of MBean 108 can continue until all of the MBeans 108 of the type have been identified and cataloged (along with their attributes)(operation 210). The next type of MBean 108 can then be cataloged until all of the MBeans 108 have been cataloged (operation 212). In operation 214, the cataloged MBeans 108 can then be converted to generic data structures such as JMX objects 112 (see FIG. 6).
At operation 216, a configuration file can be created that identifies environment dependent and environment agnostic configuration information. For example, XML file 104 can be created based on the JMX objects 112 that include the environmental agnostic attributes and provides indicators of the environment dependent attributes. The values for the environment dependent attributes can be stored, for example, as a set of property files. According to one embodiment, XML document 104 can include all the configuration information. The XML document 104 is then parsed with a set of rules for determining into which category each piece of configuration information falls. For example, suppose that a particular data source appears in the XML document 104 as:

    
    
        <DataSource Name=‘DS1’
        JNDIName=‘com/domain/datasource/DS1’/>

The JNDI name will possibly change from environment to environment and that unless the JNDI name is adjusted for the target environment 111 the configuration will typically fail. Thus, one rule in the set can be that all JNDI names will be treated as environment related information and will be placed in the environment properties document 118. Another example arises from network topology. At times, it may be necessary to configure an application on two different environments. One environment may be a 2-way cluster while the second environment may be a 4-way cluster. Thus, one rule in the set can be that topology information will be treated as environment related information and will be placed in the environment properties document 118. Still another example relates to the specific database vendor being used. At times, an application may be deployed in different environments using different database vendors. Thus, one rule in the set can be that database vendor information and appropriate database connection libraries will be treated as environment related information and will be placed in the environment properties document 118. Thus, these rules can categorize individual pieces of configuration information and can be predefined based on knowledge of the application servers, the development environment, and/or the target environment. Exceptions and newly needed rules can be handled on a case-by-case basis. To account for the environmental information taken from the generic XML document 104, operation 217 replaces the environmentally related information with a token in the XML document 104. As a result of this abstraction, the XML document 104 becomes generic to the particular application and thus independent of any particular environment. Also, the environmental information can be collected in a separate document of environmental properties 118.

    
    


Other source environments can be queried to create a library of possible environmental property documents 118 (operation 218). When a new target 111 is identified, the library can be searched for a matching, or closely matching, set of environmental properties 118. The closest match can then be quickly adjusted or tuned to account for the actual target environment 111. Target environment properties can be determined based on querying target environment 111 to create a target environment properties file 118. Information can also be provided to target environment property file 118 by a user.
The collection of binary files 120 that define the application can be obtained as in operation 220. Then, operation 222 can be used to validate the installation atomic 116 at a convenient time. Likewise, if desired, operation 224 can be used to validate the target environment 111. In operation 226, the user can select which operation (install, update, uninstall, status, or report) to perform on the target environment 111. Also, at a convenient time, the run time engine 115 can encapsulate the procedures that the target environment 111 uses for the selected operation (or possibly all of the target operations if desired) (operation 228).
At this point it is noted that the run time engine 115 has available to it what will be installed (the application along with the application related generic configuration file 104); how to install it (the target environment 111 related procedures); and details regarding where it will be installed (the properties file 118). In other words, the “what,” the “where,” and the “how” have been separated in the abstraction hierarchy of the current embodiment. Thus, the configuration of the target environment 111 for the application is separated from the implementation of the “how” and the “where” thereby simplifying and facilitating the overall configuration and installation process. Accordingly, the run time engine 115 can simply execute the selected operation when desired (operation 230).
Now with reference to FIG. 5, an embodiment of a method of configuring the target environment 111 and pushing the application out to the target environment 111 is illustrated. Initially, the method 300 can begin by starting a transaction for the selected operation (operation 302). Preferably, as the method continues in operation 304, the run time engine 115 begins looking ahead at each specific configuration task before actually implementing it to determine if any unusual situations might exist (e.g. a resource to be installed or deleted is already installed or deleted). If the run time engine 115 determines that such a situation exists, operation 305 allows the engine 115 to adjust for the situation without failing (e.g., skipping the installation or deletion). Additionally, the run time engine 115 can log the configuration changes as they are made as reference 306 illustrates.
Otherwise, the method continues for each configuration task in the application related configuration document 104 replacing the tokens with target specific information from the environmental properties document 118 as it goes (see operation 307). If any target specific configuration tasks are found in the environmental properties document 118, they too can be executed in operation 308. Once the target 111 is configured, the run time engine 115 can install, update or delete the binary files 116 of the application (as determined by the operation selected in operation 226 of FIG. 2) and report to the user the changes made as shown by operation 312.
If the selected operation is the creation of a prospective change report (to determine what would change if an operation were to be performed), then operation 314 allows the run time engine 115 to abort the transaction. Doing so can cause the run time engine 115 to roll back the changes made during method 300 with the report of operation 312 optionally serving as the prospective change report. Operation 316 illustrates the roll back of the changes. Otherwise, the transaction terminates with operation 318 as shown in FIG. 5.
In some embodiments, the software code comprises computer program instructions which can be stored on one or more computer readable media and executable by a processor. The term “computer-readable media” encompasses all types of data storage media that can be accessed and read by a computer. Examples of computer-readable media include computer memories such as read-only memory (ROM), random access memory (RAM), flash memory, and data storage devices such as floppy disks, disk drives, compact-disc ROM, tape drives, data cartridges, optical disks, etc. Microcontrollers that can be programmed to implement embodiments generally include on-chip memories on which the special software code embodying the automatic ranging algorithm/gain selection routine can be stored.
As shown by the foregoing disclosures, various embodiments accelerate the deployment of J2EE applications as well as many other types of programs such as those used in conjunction with networks, database servers, mobile networks, web-servers, and enterprise service buses. Moreover, practicing the exemplary methods described herein eliminates the error-prone, repetitive heartaches associated with the set up, configuration and migration of software running on web application servers (for example) regardless of the vendors, programs, or program versions involved. Developers and system administrators in particular can use the systems and methods taught herein to reduce errors, save time and reduce overall deployment costs. Additionally, the systems and methods disclosed herein catch and eliminate many more configuration defects than heretofore possible. They can also repeatedly guide the migration of applications between environments (e.g., from development to test to production) and automatically transform configurations for server upgrades. As a result, these systems and methods improve the “time to value” associated with a migration by delivering production-ready systems faster than possible with the prior art. They also make comparing configurations manageable, useful and simple. Software designed in accordance with the described embodiments can also be lightweight, fast, and reliable.
In addition, these embodiments take much of the risk and complexity out of application deployments and help organizations create repeatable and predictable installations, updates and un-installs in any environment and on any server. By automating formerly manual tasks, these systems and methods let IT support staff accomplish more with less, minimizing business risk and eliminating “Frankenstein” deployments. Instead, the techniques described herein allow automated migrations and deployments of application changes across systems and networks from development to test, staging, and production. These embodiments also allow comparisons to be made between configurations in one proprietary environment (e.g., WebLogic) and in another proprietary environment (e.g., WebSphere). The environment comparisons of the current embodiment, in turn, allow application support requirements to be translated during an automatic deployment of the application.
These advantages also accrue throughout all aspects of the typical application lifecycle: install, un-install, update, migrate, rollback, logging and export. Furthermore, the disclosed systems and methods allow support staff to pinpoint problems quickly and to gracefully and efficiently roll back changes to the last state, if necessary. Moreover, the robust logging herein disclosed allows support staff to quickly determine the root cause of errors should they occur.
Another embodiment provides for automatically generated installations from a known good instance (e.g., an operational application server) thereby eliminating the need for configuration and installation documentation. Also, because the configuration(s) can be tied to source control, the current embodiment allows abstract configurations to be automatically generated.
Furthermore, the embodiments presented herein provide strong, flexible solutions for breaking through the obstacles of cost, complexity, delay and risk associated with supporting applications. In other words, they make application deployment repeatable, reliable and dependable and assist support staff in deploying and extending applications with greater speed, less cost, and better accuracy. As an added advantage, these embodiments also take the complexity out of understanding deployment environments and help support staff quickly understand each server configuration, what changes were made, and the impacts of those changes. Moreover, the disclosed embodiments also provide mechanisms to easily deploy an application on any application server and in any environment. The exemplary systems, software programs, and related services constructed, or practiced, in accordance with the foregoing embodiments are available from Phurnace Software, Inc. of Austin, Tex.
As used herein, the terms “comprises,” “comprising,” “includes,” “including,” “has,” “having” or any other variation thereof, are intended to cover a non-exclusive inclusion. For example, a process, process, article, or apparatus that comprises a list of elements is not necessarily limited only those elements but may include other elements not expressly listed or inherent to such process, process, article, or apparatus. Further, unless expressly stated to the contrary, “or” refers to an inclusive or and not to an exclusive or. For example, a condition A or B is satisfied by any one of the following: A is true (or present) and B is false (or not present), A is false (or not present) and B is true (or present), and both A and B are true (or present).
Additionally, any examples or illustrations given herein are not to be regarded in any way as restrictions on, limits to, or express definitions of, any term or terms with which they are utilized. Instead these examples or illustrations are to be regarded as being described with respect to one particular embodiment and as illustrative only. Those of ordinary skill in the art will appreciate that any term or terms with which these examples or illustrations are utilized will encompass other embodiments which may or may not be given therewith or elsewhere in the specification and all such embodiments are intended to be included within the scope of that term or terms. Language designating such nonlimiting examples and illustrations includes, but is not limited to: “for example”, “for instance”, “e.g.”, “in one embodiment”.
Although embodiments have been described in detail herein, it should be understood that the description is by way of example only and is not to be construed in a limiting sense. It is to be further understood, therefore, that numerous changes in the details of the embodiments and additional embodiments will be apparent, and may be made by, persons of ordinary skill in the art having reference to this description. It is contemplated that all such changes and additional embodiments are within scope of the claims below.

## Claims

1. A method comprising:
using an environment definition to identify server configuration items in a source environment;
determining, for each identified server configuration item, whether the server configuration item exists in a property file, the property file mapping server configuration items to respective objects in an environment agnostic format;
including the configuration items that exist in the property file in a first set of configuration information;
identifying a set of environment independent attributes from the first set of configuration information, wherein the set of environment independent attributes includes a set of attributes that is equivalent between the source environment and target environments;
identifying a set of environment dependent attributes from the first set of configuration information, wherein the set of environment dependent attributes includes a set of attributes with values that are specific to the target environment and that differ from the source environment;
converting the set of environment independent attributes to objects in the environment agnostic format using the property file;
converting the set of environment dependent attributes to objects in the environment agnostic format, including replacing environment dependent attribute values with corresponding tokens using the property file, the converting being performed prior to identification of a target environment;
receiving an indication of the target environment; and
automatically creating a set of target environment configuration information, including converting the attributes from the environment agnostic format to a format recognized by the target environment, including replacing the tokens for the one or more environment dependent attributes with a value specific to the target environment from a collection of environment properties for the target environment.

2. The method of claim 1, wherein the attribute values for the one or more of the set environment dependent attributes are replaced using values from an environment properties file for the target environment.

3. The method of claim 1, further comprising configuring the target environment according to the set of target environment configuration information.

4. The method of claim 3, further comprising installing an application in the target environment in conjunction with configuring the target environment.

5. The method of claim 3, further comprising updating an application in the target environment in conjunction with configuring the target environment.

6. The method of claim 3, further comprising uninstalling an application in the target environment in conjunction with configuring the target environment.

7. The method of claim 3, wherein the configuring is performed as a transaction.

8. The method of claim 1, further comprising comparing the set of target environment configuration information to a set of attributes in the target environment to generate a report.

9. A method comprising:
querying a first server program for a set of configuration information for a source environment;
identifying a set of environment independent attributes from the set of configuration information, wherein the set of environment independent attributes includes a set of attributes that is equivalent between the source environment and target environments, the set of environment independent attributes being server configuration items that exist in a property file that maps server configuration items to respective objects an environment independent representation;
identifying a set of environment dependent attributes from the set of configuration information, wherein the set of environment dependent attributes includes a set of attributes with values that are specific to target environments and that differ from the source environment, the set of environment dependent attributes being server configuration items that exist in the property file; and
creating an installation atomic used to install a server program in a target environment, the creation occurring prior to identification of a specific target environment, the installation atomic including:
an environment agnostic representation for members of the set of environment dependent attributes and members of the set of environment independent attributes, each representation for an environment dependent attribute including at least one token that replaces a value of the attribute in the representation, the creating of the environment agnostic representation being based on the mapping in the property file,
an environment properties data structure having values that correspond to the tokens for at least one environment of a plurality of target environments, and
compiled binary artifacts created based on the server program.

10. The method of claim 9, wherein the environment agnostic representation uses an XML structure.

11. The method of claim 9, wherein the environment properties data structure contains values for a second environment.

12. The method of claim 9, further comprising converting the environment agnostic representation into a format used by the target environment including using the values for the target environment from the environment properties data structure to replace corresponding tokens in the environment agnostic representation, thereby creating a set of configuration information for the target environment.

13. The method of claim 12, further comprising configuring the target environment according to the set of configuration information for the target environment.

14. The method of claim 13, further comprising installing binary application files in conjunction with configuring the target environment.

15. The method of claim 13, further comprising un-installing an application in conjunction with configuring the target environment.

16. A method comprising:
querying a sever program operating in a first environment for a first set of configuration information in a source environment;
identifying a first set of environment independent attributes from the first set of configuration information, the first set being server configuration items that exist in a property file that maps server configuration items to respective objects an environment independent representation;
identifying a first set of environment dependent attributes from the first set of configuration information, wherein the first set of environment dependent attributes includes attributes with values that are specific to target environments and that differ from the source environment, the first set being server configuration items that exist in the property file;
generating a first environment independent representation of the first set of environment dependent attributes and the first set of environment independent attributes, the first environment independent representation including at least one token replacing one of the values specific to target environments in the first set of configuration information, the generating being based on the mapping in the property file and performed independently of identification of a target environment;
querying the server program operating in a second environment for a second set of configuration information, the second environment and the first environment having different server types;
generating a second environment independent representation of the second configuration information that includes a second set of environment independent attributes and a second set of environment dependent attributes with at least one token replacing a value in the representation, the generating being based on a mapping in a property file that maps the second set of environment independent attributes and the second set of environment dependent attributes to respective objects in the environment independent representation and being performed independently of identification of a target environment;
comparing the first environment independent representation to the second environment independent representation to identify differences between the configuration information for the server program operating in the first environment and the server program operating in the second environment; and
reporting the differences.

17. The method of claim 16, further comprising:
storing values for the first set of environment dependent attributes in a first environment dependent attribute data structure;
storing values for the second set of environment dependent attributes in a second environment dependent attribute data structure; and
comparing the first data structure to the second data structure to identify differences between the first environment and the second environment.

18. The method of claim 17, wherein the server program operating in the first environment and the server program operating in the second environment are the same server program.

19. The method of claim 16, wherein reporting the differences excludes reporting differences in the values specific to target environments.

20. The method of claim 1, wherein identifying the set of environment independent attributes and the set of environment dependent attributes is based on a set of predefined rules being used to parse the first set of configuration information.

21. The method of claim 16, wherein querying the server program for the first set of configuration information includes:
using an environment definition to identify the server configuration items.

22. The method of claim 1, wherein the source environment and the target environment include different server types.

23. The method of claim 5, wherein updating the application in the target environment further comprises:
selecting a particular target configuration item;
determining whether the particular target configuration item exists in the target environment; and
automatically creating the particular target configuration item when it is determined that the particular target item does not exist in the target environment.

24. The method of claim 9, wherein identifying the set of environment independent attributes and the set of environment dependent attributes is based on a set of predefined rules being used to parse the set of configuration information.

25. The method of claim 9, wherein querying the first server program for the set of configuration information includes:
using an environment definition to identify the server configuration items.