IBM® Rational® Quality Manager is a collaborative, Web-based, quality-management tool that offers comprehensive test planning and test-asset management throughout the software lifecycle. Built on the IBM Jazz™ platform, it is designed for test teams of all sizes to use. Rational Quality Manager supports a variety of user roles, such as test manager, test architect, test lead, tester, lab manager, and roles outside of the test organization.
In this article, you look at the complete testing process using IBM® Rational® Quality Manager throughout the software development lifecycle. An online bookstore provides the example for the full process, including creating a test plan, executing test cases, submitting defects, and generating test reports. You also can create a test plan in IBM Rational RequisitePro when IBM Rational RequisitePro is integrated with RQM. Similarly, you see how to submit a defect to Rational Quality Manager from an integrated version IBM Rational Team Concert™. Before you start following the steps in the article, you need to install Rational RequisitePro v7.1 and IBM Rational Team Concert. In one procedure, you integrate Rational Quality Manager and IBM Rational Functional Tester. Make sure Rational Functional Tester is installed also.
In experiencing the complete testing process, you complete these major steps:
- Learn about the online bookstore application.
- Plan your test.
- Import a requirement from the integrated Rational RequisitePro application.
- Create and execute a test case.
- Submit a defect to the integrated Rational Team Concert application.
- Report the results of the test.
This article was written using IBM Rational Quality Manager Open Beta Version 184.108.40.20690310 running on a Microsoft® Windows® XP Professional SP2 server, using the Microsoft® Windows® XP Professional SP2 operating system with the Mozilla FireFox 3.0.4 browser. In addition, this article refers to a version of a bookstore demonstration application that was publicly available at the time of writing.
Welcome to the online bookstore
The online bookstore is a Web-based application that a team must test before deployment. These four steps capture the basic flow of the bookstore application. Users complete these procedures in the bookstore:
- Log in to the bookstore.
- Search for a book in the bookstore: Who Says Elephants Can't Dance?
- Add the book to shopping list.
- Pay for the book.
Figure 1. The bookstore search page
Plan your test
The test plan describes the overall scope of the test and the test schedule. The test plan provides a record of the test planning process. The plan also identifies test environments, entry and exit criteria, quality goals, and other aspects of the test.
When you create a test plan in Rational Quality Manager, you can base the plan on a default template or you can create a test plan. You can also define a default template or develop a new template. This flexibility makes creating test plans in Rational Quality Manager suitable for different teams that need to conduct one or numerous types of tests, such as functional verification tests, performance tests, system verification tests, globalization verification tests, and so on.
Figure 2. Sections of the default test-plan template
Each section has an editor, an area where you can add details and information about the test. Some sections, such as Business Objectives and Test Objections, provide a rich-text editor for input. These editors provide common capabilities for formatting text, such as creating tables, setting fonts, and creating bulleted and numbered lists.
Some sections, such as Requirements and Tests Cases, provide links to additional test artifacts. Other sections include tables where you can establish criteria and measure testing progress against those criteria, such as Quality Objectives, Entrance Criteria, Exit Criteria, and Test Schedules.
You can customize your own test-plan template by using the Manage Sections feature.
This screen capture shows the test plan for the online bookstore application:
Figure 3. The test-plan requirements and schedules
In addition to the test-plan requirements and schedules, you need to specify the environment or environments in which to test. Browsers that customers use and the software that you run to support the online bookstore are integral application components that an effective test must cover.
Figure 4. The test-plan environments and team members
Essential decisions in test planning include deciding when a test is ready to undergo the test you are developing. Moreover, you must decide when an application under test is ready to exit this testing stage. You can make the entry and exit criteria simple or complex depending on the test.
Figure 5. The entry and exit criteria in the test plan
Integrate requirements from Rational RequisitePro
For many teams, requirements management helps to ensure life-cycle traceability. By linking the test cases in your test plan with requirements that product managers, program managers, or other members of the larger, cross-functional team have assigned, you can verify that all requirements are tested.
If you define your requirements in an external tool, such as Rational RequisitePro, you can import the requirements into Rational Quality Manager, where they are accessible in the Requirements view. You can also associate requirements with test plans and test cases or add requirements to your test plan manually.
When requirements are updated or deleted in the original requirements application, the status of the requirement in Rational Quality Manager is updated with the Suspect icon (). You need to update the test plans or test cases that are associated with these suspect requirements.
Rational Quality Manager integrates with Rational RequisitePro Version 7.1 and requires the Rational RequisitePro client for Web to implement the integration. Be sure to select the Web Components option when you install Rational RequisitePro.
After you install and configure Rational RequisitePro, you can use the application to manage your requirements and import those requirements into Rational Quality Manager.
The following screen capture from Rational RequisitePro shows this requirement: The online bookstore application must provide a way for customers to search the extensive list of books:
Figure 6. The book-search requirement in Rational RequisitePro
To integrate Rational RequisitePro and Rational Quality manager and import requirements:
- Install Rational RequisitePro v7.1, and configure a Web server for the application.
- Create a Rational RequisitePro v7.1 project, and add one or more users to the project.
- Add requirements to the Rational RequisitePro project.
- In Rational Quality Manager, point to the Requirements icon (), and click Import Requirements.
- Select Import from an external requirement system, and click Browse; then select Rational RequisitePro.
Figure 7. Requirement source configuration
- In the Source, select RequisitePro.
- In Host Name, type the host name or IP address of the host.
- In Port, type the port number of the host, and click Next.
- Select the name of the project in the requirements repository.
- Type your user ID and password for the requirements repository, and click Next.
Figure 8. Requirement view customization
- In Type, select the requirement type of the requirements to import. A list of requirements is displayed.
- Select the requirements from the list. To import all the requirements that are listed, select the check box next to the Status column.
- Click Import, and then click OK. The requirements are imported into Rational Quality Manager.
- Point to the Requirements icon (), and click All Requirements. The requirements that you imported are displayed in the Requirements editor.
Figure 9. The Requirements view list
The next step is to associate each imported requirement with a test plan. You associate requirements with test plans to ensure that you test all product requirements thoroughly.
To associate one or more requirements with a test plan:
- Open a test plan.
- From the Table of Contents, click Requirements to display the Requirements section.
- Click the Add Requirement(s) icon ().
- Select the requirements to associate with the test plan, and click OK.
The requirements are associated with the test plan.
Create a test case
Test cases are essential to maintaining high quality throughout the testing process. Test cases define what you need to validate to ensure that the system under test works correctly.
Rational Quality Manager provides a test-case template with some defined sections. For example, the template includes sections for preconditions and post-conditions and test execution and descriptions of expected results. You can also create a test case for a current test plan and associate your requirements with the test case. When you add a test script to a test case, it is listed in the Test Scripts section of the test case.
Rational Quality Manager can integrate with IBM Rational Functional Tester version 8.0 or later, IBM Rational Robot version 7.0.2 or later, IBM Rational Performance Tester version 8.0 or later, and IBM Rational Service Tester version 8.0.
Here is a Rational Quality Manager test case and test script that pertains to a search for this book by using the online bookstore application: Who says elephants can't dance?.
Figure 10. A book-search test case in Rational Quality Manager
Listing 1. Test script of a search for a book titled, Who Says Elephants Can't Dance?
Associate a test script with your test case
If you have test scripts, you can add them to your test case. Of course, you can also create a script. This example provides all the steps to associate a test script with your test case.
- Create a test case, and then open it.
- Select the Test Scripts section in the Table of Contents.
- Click the Add Existing Test Script icon (). The Add Test Scripts window opens.
- Click Run to view all the test scripts in the project or use the View Builder to filter the result.
- Select the script or scripts to add to the test case, and click OK.
Figure 11. The Add Test Scripts window
- Save the changes to the test case.
- Point to the Construction icon (), and click View Test Case. The test case that you created is displayed in the Test Case editor, as shown in Figure 12.
Figure 12. A test-case list
Replace literal values with external test data in manual test scripts
To use external data in a manual test, you must associate test data with the manual test script. After you establish this association, you can use the values in the test data to replace literal values in the manual test script.
Before completing these steps, create test data and associate a test case with a manual test script.
To replace literal values with test data in a manual test script:
- Create the external test data, the file must be in a comma-separated value (CSV) format with the variable information in the first row.
- From the Test Scripts section of the test case, open the test script by clicking the name. The test script opens in the Manual Test editor.
- From the Test Data list, click the test name, and click Save. This action associates the test data with the test script.
- Insert the test data variable into the manual test script:
- Click the step to which to add a test data variable, and then move the cursor to the location to insert the variable.
- From the toolbar, click the Insert Test Data Column icon ().
- Select the variable, and click OK. The variable is inserted at that point in the step.
- Repeat these steps to add additional variables.
Figure 13. Adding external data to test scripts
During test execution, the literal values are replaced with the test data.
Figure 14. Running test-script steps with variables
Run a test case
Rational Quality Manager provides a variety of ways to run test cases, making the tool highly adaptable for many types of test teams. In this example, you run a Rational Functional Tester script.
- Integrate Rational Quality Manager with Rational Functional Tester:
- Click the
startadapter.batbatch file that is installed by default into the
C:\Program Files\IBM\SDP\FunctionalTester\RQMAdapterdirectory. The Rational Functional Tester Adapter window opens as shown in Figure 15.
- Click the
Figure 15.The Rational Functional Tester Adapter window
- Enter the Server URL for the Rational Quality Manager server, a valid login ID and password; then specify a unique adapter name. The adapter name is the name that is displayed in the Rational Quality Manager Web user interface (UI) to identify this instance of the adapter.
- If you do not want to enter your password each time you start the adapter, select Save Password.
- After you complete all fields, click Start Adapter.
- When the connection is made, the
Connectedis displayed at the bottom of the Rational Functional Tester Adapter window. You can also click the Adapter Console tab (Figure 16) to see the adapter status.
Figure 16. Checking the adapter status in the Rational Functional Tester adapter
- Point to the Construction icon (), and click View Test Case.
- Choose the test cases you want to run.
- In the upper-right corner of the test case, click Run Test Case, which opens the Run Test Case dialog box.
- Make selections based on your project. For example, choose selections in Test environment and Associate Results with a Test Plan (Figure 17).
Figure 17. The Run Test Case window
- Click OK. The Script Execution page opens as shown in Figure 18.
Figure 18. The Script Execution page
- After you run the test script, click Close and show results. You can see the test results in Rational Quality Manager as shown in Figure 19.
Figure 19. Test-run results in Rational Quality Manager
- On the Execution Result page, click the Rational Functional Tester Simple Log link. The test results open in your browser as shown in Figure 20.
Figure 20. The Rational Functional Tester simple log
After running your test, you can add attachments, log defects, and add comments to the script.
Submit defects in Rational Team Concert
You can set up communication between Rational Quality Manager and Rational Team Concert so you can create and track defects in Rational Team Concert. After you set up communication, you can also create and track defects in the Rational Quality Manager user interface, even though the defects themselves are maintained in Rational Team Concert.
Before you begin, verify that you can log in to Rational Quality Manager from the computer that hosts the Rational Team Concert server. Likewise, verify that you can log in to the Rational Team Concert Admin Web UI from the computer that hosts the Rational Quality Manager server.
To set up defect tracking in Rational Team Concert:
- Set up Rational Team Concert to accept cross-domain requests from Rational Quality Manager:
- In the Rational Team Concert Admin Web UI, click the Server tab.
- In the Configuration pane, click Advanced Properties.
- Under Core Repository Component, scroll to the com.ibm.team.repository.service.internal.xdomain.DynamicProxyFrameService component.
- In Current Value of the Cross Domain Host Whitelist property, type the various URLs that can be used to access the Rational Quality Manager Jazz Team Server. Separate each path with a comma, and try to include all possible paths. Consider these URLs, for example:
https://myserver:9443/jazz, https://myserver.ourdomain.mycompany.com:9443/jazz, https://9.12.345.67:9443/jazz
These examples include the simple host name, the host name with the domain name, and the IP address.
To configure multiple Rational Quality Manager servers, use commas to separate each server URL.
These paths must be the same that users use to access Rational Quality Manager.
- For the Enable Cross Domain Communication property, in Current Value select true.
- Scroll to the com.ibm.team.repository.servlet.internal.ServletConfigurationService component.
- Type the host name of the Rational Team Concert server.
- In Use Canonical Host Name, select false.
Figure 21. Rational Team Concert administrator configuration window
- Click Save.
- In the Rational Quality Manager user interface, click Admin, and then click Jazz Server Administration.
- Click Advanced Properties.
- In Adapter for RTC Component, go to the com.ibm.rqm.adapter.rtc.service.internal.RTCDefectsCollector component, and modify the properties as necessary.
- If necessary, in Current Value, type the correct user name and password for the Rational Team Concert Jazz Server administrator. At minimum, user-name account must have JazzUsers repository permissions and also have an assigned Client Access License.
- If necessary, specify a period in Delay or accept the
The delay value determines how frequently the Rational Quality Manager server synchronizes with the Rational Team Concert server. The default period is 500 seconds. To see changes more frequently, decrease the delay. If decreasing the delay produces too great a load on the Rational Quality Manager server, you can increase the delay.
- If necessary, update the period in Draft Link Lifespan
or accept the default value.
This value specifies the time before a draft defect expires automatically. The default period is 1000 seconds. If a user creates a defect or associates an existing defect, the user must save the defect before the draft link lifespan times out.
- Also in Adapter for RTC Component, go to the com.ibm.rqm.adapter.rtc.service.internal.rest.ConnectionRestService component, and modify the properties as necessary. In Current Value, type the correct user name and password for the Rational Team Concert Jazz Server user. This user-name account must have JazzUsers repository permissions and also have a Client Access License assigned to it.
Figure 22. Rational Quality Manager administrator configuration
- Scroll to the com.ibm.team.repository.servlet.internal.ServletConfigurationService component.
- Type the host name of the Rational Quality Manager server.
- In Use Canonical Host Name, select false.
- Click Save.
- In Rational Quality Manager, click Admin, and then click System Properties.
- Click Defects Provider, and in Provider select Rational Team Concert (Defects).
- Click Configure.
This action starts a wizard for setting up Rational Team Concert as the defect provider.
- In URL, type the full URL of the Rational Team Concert server, for example,
- In Name, type a name for this particular Rational Team Concert server.
- Optional: In Description, type a description of the server.
- Click Next.
If you receive a warning message,
Security Error: Domain Name Mismatch, click OK. If you receive the
Verify the Logged in Userrequest, click Continue or click Log in as different user.
- On the next wizard page, select the Rational Team Concert project area for which the defects will be created. The default value is the
RQM Defectsproject area.
- Click Finish.
Figure 23. Rational Quality Manager administrator configuration, continued>
After you complete the wizard, the Defects Provider page is updated, showing that the status is
After you complete these steps, you can create and track defects that are saved in Rational Team Concert.
If you create defects after running a test script, you can create and track the defects in Rational Team Concert. If you click Defects on the left navigation, the defect is only in Rational Quality Manager, and is not tracked in Rational Team Concert.
Report test results
Test managers and test leads are intensely interested in the status and results of tests. Reports from Rational Quality Manager provide this essential information.
Rational Quality Manager provides an array of reports that can be run anytime. Three reports represent some of the information that test managers and test leads can obtain from Rational Quality Manager. The following charts are generated from preformatted reports in Rational Quality Manger. You can also save report-generation parameters and export reports.
Plan Requirements Coverage by Test Case
This report lists the number of requirements that are associated with the test case.
Figure 24. Plan requirements coverage by test case
The Execution status by Test Schedule report
This report lists the status of execution work items by test schedule. You can select several plans to see the execution results for multiple plans.
Figure 25. The Execution by Test Schedule report
Execution and defects by owner
This report lists the status of execution work items and defects by different owners.
Figure 26. A report showing execution work item and defects by owner
Depending on your focus and requirements, you can look at the same information by tester, owner, plan, or computer that was tested. With these different views, you have different ways to get data for comparison.
The software developers receive information about the defects that testing found and work to correct the problems. After that, the application is tested again to ensure that the developers corrected the problem and introduced no other problems.
When quality criteria are met and all defects are resolved, the team can deploy the software.
You established requirements for the application and captured them in Rational RequisitePro, which can be integrated with Rational Quality Manager. You have developed test cases and test scripts for the test cases. After running a test case and script, you logged defects for the product. You provided reports to managers and others on the team. Rational Quality Manager, working with Rational RequisitePro, Rational Functional Tester, and Rational Team Concert, provides critical, end-to-end tools for developing and maintaining high quality software.
|Files to download for article||acompletetestingprocesswithrationalqualitymanager.zip||8MB|
- Check the Rational Quality Manager page on IBM® developerWorks® for links to product documentation, articles, tutorials, courses, downloads, and other useful areas.
- Explore the Rational Quality Manager Information Center for technical details.
- For tips, read these developerWorks articles by Michael Kelly: Getting started with IBM Rational Quality Manager (December 2008) and For Managing your first project with IBM Rational Quality Manager (October 2008).
- Browse the IBM Quality Management page to learn more about what is available.
- Find more information about IBM Rational Quality Manager and related products on the Software Testing and Quality Management of ibm.com.
- Get tips, tricks, and updates, from the IBM Rational Quality Manager blog for technical resources and best practices for Rational Software Delivery Platform products.
- See the Rational Quality Manager product roadmap on developerWorks -- a resource roadmap for all users.
- Find more articles about IBM Rational Quality Manager on the developerWorks Technical library.
- Learn about other applications in the IBM Rational Software Delivery Platform, including collaboration tools for parallel development and geographically dispersed teams, plus specialized software for architecture management, asset management, change and release management, integrated requirements management, process and portfolio management, and quality management.
- Visit the Rational software area on developerWorks for technical resources and best practices for Rational Software Delivery Platform products.
- Explore Rational computer-based, Web-based, and instructor-led online courses. Hone your skills and learn more about Rational tools with these courses, which range from introductory to advanced. The courses on this catalog are available for purchase through computer-based training or Web-based training. Additionally, some "Getting Started" courses are available free of charge.
- Subscribe to the IBM developerWorks newsletter, a weekly update on the best of developerWorks tutorials, articles, downloads, community activities, webcasts and events.
Get products and technologies
- See the information center that comes with Rational RequisitePro and the publicly-available Information Center.
- Download the free trial version of Rational Quality Manager.
- Download these IBM product evaluation versions and get your hands on application development tools and middleware products from Rational®, DB2®, Lotus®, Tivoli®, and WebSphere®.
- Join the Rational Quality Manager forum, which also includes discussions about Rational Test Lab Manager.
- Check out developerWorks blogs and get involved in the developerWorks community.
Dig deeper into Rational software on developerWorks
Get samples, articles, product docs, and community resources to help build, deploy, and manage your cloud apps.
Experiment with new directions in software development.
Software development in the cloud. Register today to create a project.
Evaluate IBM software and solutions, and transform challenges into opportunities.