Copyright 2006 Travelocity.com L.P. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
MidStream Developers Guide
Please review the ‘MidStream Users Guide’ for details and information of what the MidStream tool suite is about.
The MidStream project is broken up into four modules:
Module |
Description |
framework |
Contains the component wrappers for the different types of client/service classes MidStream supports |
plugin-ui |
Contains all of the plug-in’s UI components, plugin.xml, and IntelliJ integration points (actions, Pico components, etc.) |
plugin-core |
Contains the core non-UI logic for the plug-in |
plugin-lib |
Contains the plug-in’s library dependencies (both compile and runtime) |
Note: Because IntelliJ includes an older ‘xmlrpc-*.jar’ as one of its libraries, use a different JDK for the framework module so that the unit tests will run correctly.
The framework’s unit tests can be run from within IntelliJ by invoking the ‘midstream.framework unit tests’ configuration or running the module’s ‘test’ Ant target. Running the ‘coverage’ Ant target will generate a report (in ‘test/coverage/reports/index.html’) of the unit test’s coverage. Currently, there is 81% coverage for the framework module.
The core unit tests can be run from within IntelliJ by invoking the ‘midstream.core unit tests’ configuration or running the module’s ‘test’ Ant target. Running the ‘coverage’ Ant target will generate a report (in ‘test/coverage/reports/index.html’) of the unit test’s coverage.
Note: If running the core unit tests via the IDE, ensure that a rebuild of the project has occurred first so that all necessary resources are placed on the classpath.