This documentation relates to an earlier version of FishEye.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata
Icon

The information on this page relates to the pre-release Early Access Program for FishEye 2.1. This feature is currently in alpha and undergoing testing. Do not use in production.

This page contains instructions for how to set up a ClearCase repository in FishEye, a configuration reference and a list of known issues.

(info) If you also have Crucible, once configured you will be able to run Crucible reviews on code from your ClearCase repository.

On this page:

Requirements

The instructions on this page require the following applications:

Setting up a ClearCase Repository

When adding or managing a ClearCase repository, carry out the following steps:
1. Open FishEye's 'Add Repository' dialog, by choosing 'Administration' > 'Repository List' > 'New'.
2. Set your repository details, as described below.

ClearCase Repository Details

Field

Description

Allowed values

Name

A name chosen by you to be displayed in the list of FishEye repositories.

Free text

Description

A description for this repository, if required.

Free text

Repository Type

Defines the repository type; these instructions apply to ClearCase, so select ClearCase.

ClearCase

Enable Immediately

Defines whether the repository will be accessible in FishEye right away.
(warning)
If you wish to exclude certain ClearCase projects, ensure 'No' is selected.

Yes / No

UCM

Indicates whether the underlying ClearCase repository uses UCM or Base ClearCase.

Yes / No

Integration Streams Only

Specifies whether FishEye should index content that has been delivered to development and streams or only integration streams. It is recommended that users choose 'Yes' for this option.

Yes / No

View Location

The location of a directory accessible to the FishEye instance where views can be created.

A system path

View Storage Location

The location where view storage files are stored.

A system path

Icon

If you have a large number of projects included on your ClearCase environment, we recommend that you configure FishEye to only index a specific set of source code. To do this, ensure that 'Enable immediately' is set to 'No' on the Add Repository page when creating the repository. Then configure the 'Includes' and 'Excludes' rules on the 'View Repository' page so that only specific ClearCase Projects are indexed. Once the Include and Exclude rules have been configured, start the repository to begin the indexing logic.



Screenshot: Adding a ClearCase Repository


View Creation

As part of the repository scanning logic, FishEye will create a view for each Project (for ClearCase UCM environments) or VOB (for Base ClearCase) using the locations defined in the 'View Location' and 'View Storage Location' fields. This is required in order for the underlying 'cleartool' commands to be executed in the correct context.

Indexing Logic

It may be helpful to understand how FishEye's ClearCase support carries out indexing.

UCM ClearCase

The ClearCase support will attempt to index all the available content within a ClearCase environment. The logic works as follows (ClearCase specific terms are underlined see definitions):

  • All PVOBs that are available are identified.
  • For each PVOB, find all the Projects contained within the PVOB.
  • For each Project, find all the Activities that have been delivered to the project.
  • Find the Versions that were included in each Activity and index the Version information.
  • Any Labels attached to Versions are also indexed.

(info) PVOB stands for Project Versioned Object Base.

Base ClearCase

The logic for the Base ClearCase support is similar to the UCM ClearCase support,

  • All non-UCM VOBs that are available are identified.
  • Find the check-ins for each VOB and index the version inforamtion.
  • Any Labels attached to Versions are also indexed.

Allocating Time for Repository Scanning

The initial scan of a repository is a time and resource intensive operation, more so if the ClearCase repository being indexed is large (both in terms of the number of ClearCase projects and the number of change sets included in each project). In the Atlassian test environment (running in a virtual machine), each commit included in a change set would take approximately one second to complete (the time taken in a non-VM environment seems to be slightly faster at approx 700ms). You can use these numbers to estimate the time it will take to scan your repository; it could take many hours or possible days to complete.

Known Issues

There are a number of known issues with the ClearCase Alpha support in FishEye. These are listed below.

  • Currently XML files cannot be viewed as 'Annotated' source. By default, ClearCase using a specific type manager to store XML files. This type manager does not support the 'cleartool annotate' command, which is used by the logic in FishEye that displays the Annotated source.

Further to this, by default ClearCase treats any files not defined in the 'default.magic' file as 'compressed' (for instance, property files are not included in the default.magic file). Only text-based type managers can be annotated (and hence, can be displayed via the 'Annotated Source' link). The type manager can be updated by performing the following steps:

1. Update the default.magic file to include appropriate rules that specify the type manager to use for files of a given naming convention (this will take effect for newly created elements)
2. Modify the type manager for existing elements through the 'cleartool chtype' command.

Further information on the ClearCase type manager is available on the following pages:

Type Manager white paper
cleartool chtype command reference
cc.magic reference

  • There is a known bug with earlier versions of ClearCase that limit the cleartool output to 64K of data. This may affect projects that contain a large amount of changes included in a changeset. This bug can be fixed by upgrading ClearCase — see this page for more information.

Feedback and Support

Please visit the FishEye forums to seek assistance with the alpha release of FishEye ClearCase support.

  • No labels