Use Case 1: Connecting to Automation Server

• Enter server information: URL, username, password
• Enter network parameters: http authentication, proxy information
• Specify server specific configuration parameters
• AutomationServiceProvider? houses AutomationPlans?
• AutomationServiceProvider? executes AutomationPlans? when AutomationRequests? are submitted

Use Case 2: Trigger Execution of Automation Plan

• User creates a build request(AutomationRequest? ) using an Eclipse native UI
  • Mylyn-OSLC builds connector provides a UI dialog created from information in the AutomationPlan? and it's related ParameterDefinitions?
  • There must be enough information in the ParamaterDefinitions? to build a Rich UI (SWT) without using delegated HTML UIs
  • Types of fields might include: Boolean, Number, Text String, single and multi value pickers (of strings)
  • In cases such as value pickers where the choice of values is constrained, all available values must known in advance as part of the ParameterDefinition? in order to build a rich UI
• AutomationPlan? is executed by creating an AutomationRequest? with appropriate ParameterInstances?
  • The Mylyn-OSLC connector provides client-side pre-validation and UI hints to user to ensure that their provided ParameterInstances? values meet the requirements of the ParameterDefinitions?
• AutomationResult? is generated as the result of executing the AutomationRequest? for the AutomationPlan?

Use Case 3: Review Status of Automation Plan

• Mylyn-OSLC connector periodically polls the AutomationProvider? to check on status of build jobs
  • AutomationProvider? returns AutomationPlans? /Requests are currently executing and their corresponding partial or complete AutomationResults?
  • AutomationProvider? returns full list of available AutomationResults? that have completed, with fields such as execution time, status, and associated result artifacts (build artifacts, test output, build logs, etc)
• Results of this request is used to populate the Eclipse UI showing recent build plan summaries.

Use Case 4: Review Automation

• Over its lifetime, an AutomationPlan? will produce many AutomationResults?
• AutomationResult? encapsulates a new instance or execution of an AutomationPlan?
• AutomationResult? holds the output of an AutomationPlan? execution (the compiled code, test suite output, or some other form of artifacts/results)

Use Case 5: Fixing failed TEST (Client/IDE specific)

• Import junit data into junit view for familiar visualization
• Allows for creation of bugs from test failures from developer's IDE
• Supports re-running tests if check out into workspace

Use Case 6: Notifications

• AutomationNotification? communicate updates to AutomationResult? state (i.e., Success -> Fail or Fail -> Success)
  • Email
  • Popups

Use Case 7: Automation Workflows

• AutomationResult? state triggers notification of remote OSLC provider (Change Management, Code Review, Quality)
• Examples:
  • Build test failure results in creation of Task in OSLC-CM provider.
  • Build success state results in contribution of approval vote in Code Review tool.

-- RobertElves - 09 Feb 2010

-- LucasPanjer - 31 Jan 2012