Tutorial: Exploring the Rational Team Concert JUnit example project

This brief guide is a companion to the Rational Team Concert™ JUnit example project. It provides you with a high-level overview so that you can begin exploring on your own.
The JUnit project is based on a realistic software development project whose goal is to deliver JUnit Version 4.4. The team is using Rational Team Concert to plan, track, collaborate, and deliver the release. When the sample JUnit project is created on the Jazz™ Team Server, you will see existing artifacts as if the team has already begun its work.

Learning objectives

By reading this guide you should understand enough to start experimenting and learning more, but it does not guide you step by step through the project.

    1. Creating the JUnit example project

    2. JUnit Project Area users and Client Access Licenses

    3. JUnit project Sprints and planned work

    4. JUnit project source code

    5. JUnit project builds

    6. JUnit project reports (Standard edition only)

    7. Exploring the JUnit project in the Web interface

Time required

20 minutes

1. Creating the JUnit example project

To create the JUnit example project on a Jazz Team Server, you must have JazzAdmin permissions and be assigned a Developer Client Access License.
Open the Team Concert Example Project Setup wizard: Click File > New > Example and follow prompts to install the Team Concert example project

2. JUnit Project Area users and Client Access Licenses

The JUnit example project includes eight users. You can log in to the JUnit project as any of these team members to get different perspectives on roles and assignments. However, to fully explore the JUnit project as one of these users, the user needs to be assigned a Developer Client Access License. The number of licenses you can assign for this example is limited by the number of licenses remaining on your server.
Tip: Each user's initial password is the same as their user ID. For example, Bill's password is "bill". If you plan to do extensive exploring on a test server, you might want to change these initial passwords.
Table 1. Users in the JUnit Project Area
User user ID / password Role/Description
Bill Cassavelli bill / bill JUnit team lead. Bill is the component lead for the JUnit team. He set up the plans and is the owner of several high level work items for the release.
Build build / build Special user for running the builds
Freddy Freund freddy / freddy  
Jason Mitchell jason / jason JUnit team member. A number of work items are assigned to Jason.
Jennifer Ginness jennifer / jennifer  
Markus Kent markus / markus JUnit team member. A number of work items are assigned to Markus.
Marlene Stamp marlene / marlene  
Rick Yuen rick / rick  
Client Access Licenses control which users are granted access to certain features on the Jazz Team Server. The number of Client Access Licenses available depends on the edition of Rational Team Concert that you are using. In general, a user who has a Developer Client Access License has the authority to create artifacts, while a user with a Contributor Client Access License can create work items, but can only view most other artifacts.

For more information, see Rational Team Concert 2.0.0.2 editions and licenses and Managing client access licenses.

To assign licenses to users:

  1. Log in to the JUnit project area as a user who has administrator privileges (ADMIN/ADMIN on a new server installation).
  2. In the Team Organization view (Window > Show View > Team Organization), right-click Markus Kent; then click Open.
  3. In the User editor under Client Access Licenses, select Rational Team Concert - Developer and click Save.

    This image shows the User editor with Client Access Licenses being defined

The Team Organization view only shows the users who are part of the JUnit team. To assign Client Access Licenses for other users, use the Jazz Team Server Web interface (click Admin > User Management). This interface lists all users on the server:

User Management section of Jazz Team Server Web interface

Tip:

To log in as a different user, modify the properties of your repository connection and specify a different user ID:

Changing the connection properties to log in as a different user

3. JUnit project Sprints and planned work

The JUnit project uses Scrum as its process. Scrum is popular approach to managing projects in an agile way. For each iteration, called a Sprint, the team has created a plan document and has defined work items for that Sprint.
  1. You can see the Process Sprints by opening the JUnit project in the Project Area editor:

    JUnit process iterations

  2. To examine the iteration plans, from the Team Artifacts view, open a plan:

    Plans node in the Team Artifacts view showing JUnit plans

  3. Take a look at the JUnit 4.4 s2 Sprint Backlog plan. On the Planned Items tab, the plan editor has a work item preview mode that gives you an inline work item editor that shows planning important attributes.

    JUnit 4.4 s2 Sprint backlog plan

    Tip: In the Plan Editor, you can quickly change certain attributes of work items by using the drop-down menus:

    Changing a work item priority from the Plan Editor

  4. To see the details of a work item, from the Planned Items page, double-click the item. It opens in the work item editor, where you can make changes depending on your role and the process configuration.

    For example, if you are logged in as JUnit team member Markus Kent, try using the Discussion section to add a comment to the work item:

    Work item editor showing discussion

4. JUnit project source code

The JUnit code is under source control in the Jazz Team Server repository. Markus and other team members (to whom you assigned a Developer Client Access License) are able to deliver changes to the stream.

In the Team Artifacts view, you can see that the JUnit project includes a single source control stream called JUnit, owned by the JUnit Team. The stream includes a single component, also called JUnit. In the following screenshot, the JUnit component is at the initial baseline.

JUnit streams, components, and a loaded repository workspace shown in the Team Artifacts view

In the above screenshot, the current user has loaded a repository workspace called JUnit. You can search for other users' repository workspaces, then duplicate and load them; or you can create your own repository workspace.

When a repository workspace is loaded, the projects that are part of the loaded components will be available for you to work on within your development environment. In the JUnit component, there are three projects:

The JUnit source code projects loaded and visible in the Package Explorer
After you have explored a bit, you might want to learn more about some of the Jazz source control concepts and tasks.

Read the Overview of Rational Team Concert source control section to learn more about streams, components, repository workspaces, and other concepts.

Experiment by making a change to Java™ file and delivering that change in the Pending Changes view. The best practice is to associate your change with the related work item.
Delivering a change set in the Pending Changes view

5. JUnit project builds

The JUnit project includes one build definition and one build engine. To explore and experiment with the JUnit builds, you must set up and start a build engine using the separately installed build toolkit.
  • To run a build engine, you must have the Build System Toolkit installed. The toolkit can be installed from the installation launchpad or can be downloaded from jazz.net. If it is installed, you will have an installdir/buildsystem folder.
  • In this junit example, the user ID "build" must be assigned a Build System Client Access License.
To start a build engine for the JUnit project:
  1. From a command line, navigate to installdir/buildsystem/buildengine/eclipse, where installdir is the installation directory.
  2. Enter the following command:
    jbe -repository https://localhost:9443/jazz -userId build -pass build -engineId junit -sleeptime 5
    When you successfully start the engine with the build toolkit, it will wait for requests to come in. Only build definitions that are defined to run on this particular build engine will be supported.

    Command window showing a build engine running and waiting for a request

  3. Request a junit build:

    Requesting a build

  4. When the build has completed, from the Builds view, open the build results. View the Overview, Compilation, and JUnit tabs of the build result to learn about the types of information that you can view from a build result.
  5. Optional: To schedule the junit build to automatically run every 30 minutes:
    1. In the Team Artifacts view, right-click the junit build; then click Open Build Definition.
    2. In the Build Definition editor, click the Schedule tab.
    3. Select the Enabled check box.
    4. In the Continuous interval in minutes field, type 30.
    5. Click Save.
    Build definition Schedule tab
Read the Building with Jazz Team Build section in the Help to learn more about the Team Build, how to manage and administer builds. You can also start learning about the build Ant tasks that you can use when writing your own build scripts.

6. JUnit project reports (Standard edition only)

If you plan to explore JUnit project in depth, you can use reports to track the progress and monitor the JUnit project areas and teams. However, because reports require historical, aggregated data, the JUnit project does not have any initial data points to start building reports.
Reports use a data warehouse that typically takes daily snapshots of the repository data. These snapshots provide the historical data points that are required for reports. If you want to see reports for JUnit, you will need to initiate one or more snapshots over time. For example, you could take a snapshot now, then deliver some code changes, run some builds, or open some work items, then take another snapshot.

To manually initiate a snapshot of the data:

  1. Ensure that Markus Kent has JazzDWAdmin permissions, then log in to the Rational Team Concert Web interface as Markus.
    Note: If you gave Markus Kent the JazzAdmin permission, he can assign himself the JazzDWAdmin permission. Otherwise, you must log in with your own user ID to assign JazzDWAdmin permission to Markus.
  2. Go to the Reports page and click Administer Data Warehouse.
  3. Click Update All Snapshot Data.
After you have several snapshots that represent points in time, you will start seeing more value in the reports that you view for JUnit project.
You can run reports from two places:
  • The Reports page of the Web interface:

    Reports page of the Web interface

  • In the Team Artifacts view, under the JUnit project, under the Reports node:

    Reports opened from the Team Artifacts view

Read the Tracking data with reports section in the Help to learn more about the reporting features.

7. Exploring the JUnit project in the Web interface

Most of this guide has taken you through the rich client. The Rational Team Concert Web interface also provides a rich environment where you can meet many of the same goals of collaborating with your team.

JUnit project in the Web interface

To explore the JUnit project area in the Web interface:
  1. Open a browser to the Web interface. If you are running locally, the default URL is this:

    https://localhost:9443/jazz/web/projects/JUnit%20Project

  2. Navigate through the Web interface. For example:
    • On the Work Items page, find and create work items.
    • On the Source Control page, browse the source code in the repository.
    • On the Plans page, review project plans.
    • On the Dashboards page, work with team and personal dashboards (Standard edition only).
    • On the Builds page, view build definitions and results, and request builds.
    • On the Reports page, view project status and progress (Standard edition only).

Summary

In this mini-tutorial you learned about the basics of the JUnit example project. The JUnit project is a great way to explore and start learning how to use Rational Team Concert to collaborate with a team on a software development project.
Remember: When you are finished working with the JUnit example project, remove the Client Access Licenses from the example users. This frees up the licenses to be assigned to real users.

Feedback