Clear Case Support Use Case Specification

Add a project to Clearcase (Import)

• Actor: User
• Action: Make an unversioned project versioned
• Priority: 3
• Precondition:
  • VOB and view are at least created, (maybe even mounted and setup)
  • The relevant project is opened in the IDE

A) The project is outside of a mounted VOB directory

• Scenario:
  • User selects the VOB
  • User selects the VIEW
  • User specifies the folder in the VOB directory into which the project has to be imported
  • User may fine tune the list of to be imported files (exclude?, ignore?, & co.)
  • Import

B) The project is already in a mounted VOB directory

• Comment: could be seen as an trivial checkin (mklement)
• Scenario:
  • User may fine tune the list of to be imported files (exclude?, ignore?, & co.)
  • Import

Modify a file

• Actor: User
• Action: Make modifications to a versioned file
• Priority: 1
• Precondition: VOB and view are setup, the file is accessible in the IDE
• Scenario:
  • User opens the file into IDE editor
  • User starts to modify the file (starts to edit)
  • The IDE automatically checks the file out for the user if the file is not already checked out

Checkout a file or more files

• Actor: User
• Action: Checkout files or folders
• Priority: 1
• Precondition: VOB and view are setup
• Scenario:
  • User selects files to be checked out and invokes Checkout from the main or context menu
  • User prompted for a checkout message and if the chekout is to be done reserved or not (has possibly also other options in the dialog?)
  • IDE Checks out the files - handle already checked out files, different versions, locks etc.

Cancel Checkout

• Actor: User
• Action: User needs to undo his checkout, undoing all local changes
• Priority: 1
• Precondition: VOB and view are setup
• Scenario:
  • User selects some files and invokes Undo Checkout either from the main or popup menu
  • Checkout is canceled for selected files

Check-in modifications into Clearcase

• Actor: User
• Action: Check-in changes or new/deleted files
• Priority: 1
• Precondition: VOB and view are setup, some local changes have been made
• Scenario:
  • User selects the context to be checked in and invokes Check-in from the main or context menu
  • User is presented with list of files that will be checked in
  • User may fine tune the list
  • User is prompted for a check-in message
  • Files get checked in

Add files to Source Control (Add to Clearcase)

• Actor: User
• Action: Add new files or folders to the repository
• Priority: 1
• Precondition: VOB and view are setup, there are some new files
• Scenario:
  • User selects new files/folders to be added to Clearcase
  • User invokes Add to Clearcase either from the main or context menu
  • User is presented with list of files that will be added
  • User may fine tune the list
  • User is prompted for an Add (Elements Description) message
  • Files are added to source control

Update files in snapshot view

• Actor: User
• Action: Update a snapshot view; get remote changes from the repository
• Priority: 1
• Precondition: VOB and a snapshot view are setup
• Scenario:
  • User selects the context to be updated and invokes Update from the main or context menu
  • The files are updated and listed in the Versioning output window
  • In case there were some errors during update user should inspect the Output log in the Output window and resolve them manually

View Modifications (Show Changes)

• Actor: User
• Action: Show list of files that are modified of checked out
• Priority: 2
• Precondition: VOB and view are setup
• Scenario:
  • User selects the context and invokes Show Changes either from the main menu or popup menu
  • All files which are not checked-in are listed in a special Clearcase View:
    • checked out by the user
    • checked out by others
    • hijacked
    • eclipsed
    • view private (if the user opts to see/work with them)
    • TODO: deleted?

Quick overview of file status in IDE

• Actor: User
• Action: Annotate Clearcase related file information in the IDE (nodes in Explorer views, Editor tabs, etc.)
• Priority: 2
• Precondition: VOB and view are setup
• Scenario:
  • no explicit actions required
  • most important status (checkedout, etc.) is color coded in node labels
  • folders containing files with important status have versioning badges

Browse history of files

• Actor: User
• Action: Browse history for a file or a group of files
• Priority: 2+
• Precondition: VOB and view are setup
• Scenario:
  • User selects some files and invokes Graphical History or Textual History commands
  • Graphical history will launch native Clearcase history browser
  • Textual history will display text history log in the IDE Output window

View specific revision of a file

• Actor: User
• Action: Show a previous revision of a file in the IDE
• Priority: 2
• Precondition: VOB and view are setup ...
• Scenario:
  • user selects a file
  • User specifies the revision in the form file@@rev
  • The file revision is opened in a separate editor tab

Show Annotations

• Actor: User
• Action: Show Annotations sidebar in the editor
• Priority: 2+
• Precondition: VOB and view are setup
• Scenario:
  • User selects some files and invokes Show Annotations
  • The relevant files are opened in editor and Clearcase annotations are shown beside each line

Inline diff

• Actor: User
• Action: Show the inline diff of a file in the editor
• Priority: 2+
• Precondition: VOB and view are setup ...
• Scenario:
  • no explicit action is required
  • diff editor sidebar shows local modifications made to the file

Diff - view local modifications

• Actor: User
• Action: Show the editable diff view for a file
• Priority: 2+
• Precondition: VOB and view are setup
• Scenario:
  • User selects som files or folders invokes Diff
  • Modified files from the selected context are shown in the Diff view
  • TODO: visualize also folder diffs - (minimalistic approach - output from ct diff in a textpane)

Merge

• Actor: User
• Action: Merge changes made in a branch into other branch
• Priority: 1
• Precondition: VOB and view are setup
• Scenario:
  • users selects some files and invokes Merge
  • native Clearcase Merge tool is launched

Exclude from checkin

• Actor: User
• Action: User wants to exclude some files from future checkins
• Priority: 2
• Precondition: VOB and view are setup
• Scenario:
  • User selects some checked out or new files and invokes 'Exclude from checkin'
  • Selected files are set as 'Excluded' - they won't be taken in caount by the checkin or add to source control

Reserve previously checked out files

• Actor: User
• Action: User wants to reserve his checked out files
• Priority: 2
• Precondition: VOB and view are setup
• Scenario:
  • User selects some checked out files and invokes Reserve
  • Selected checkouts are switched from unreserved to reserved

Unreserve previously checked out files

• Actor: User
• Action: User wants to unreserve his checked out files
• Priority: 2
• Precondition: VOB and view are setup
• Scenario:
  • User selects some checked out files and invokes Unreserve
  • Selected checkouts are switched from reserved to unreserved

Label

• Actor: User
• Action: User wants to label files in the selected context (and eventually create the label if it does not exist)
• Priority: 2+
• Precondition: VOB and view are setup
• Scenario:
  • User selects some files and invokes Label...
  • Label dialog pops up asking for the label name and allows for label creation
  • Selected elemts are label with the specified label