USECASE: Build component, system and/or project on a local machine

CHARACTERISTIC INFORMATION

Goal: Build component(s), system(s) and/or project on a local machine, following dependencies and version from VCS, as configured in the ETICS model instance.

Scope: Build on a local machine

Preconditions: Following packages already installed in the machine: Valid platform (as defined by ETICS), for example: Windows XP, Linux (different flavours), C++ compiler, Java runtime.

Success End Condition: component(s), system(s) and/or project built on the local machine

Failed End Condition: component(s), system(s) and/or project failed building, either because of errors in user code (e.g. cvs) or because of wrong information in ETICS model instance

Primary Actor: developer

Trigger: This usecase can be either triggered by the user, or by NMI


MAIN SUCCESS SCENARIO

  1. user installs etics client bootstrap script and the workspace setup script
  2. user executes the workshop setup of the ETICS client
  3. user specifies the project on which to work. Client contacts the service, which return meta data specifying the abstract definition of this project. The client persists the data in the workspace (to disk).
  4. user specifies a configuration and/or a corresponding component/subsyste/project to checkout. Client contacts the service, which returns corresponding metadata to the requested configuration. The client persists the data in the workspace (to disk). Using this data, the client checks-out from VCS (e.g. CVS) and/or downloads from the ETICS repository binary artefacts the components/subsystems/project configurations, including dependencies in the workspace.
  5. user specifies a component/subsyste/project to build. Client using stored meta data, builds the components/subsystems/project, following this recursive oder:
    • build dependencies
    • build children
    • already built configurations are skipt (TBD)

EXTENSIONS

  • (any step) If the user specifies wrong or incomplete parameters and/or options to any command, exit gracefully, giving explanation of the error
  • (any step) If a problem is encountered during a request to the web service, gather a report and email it to the appropriate mailing list, and exit gracefully, giving explanation of the error and stating that an email has been sent to the ETICS support.

5. The client detects a circular dependency and exists gracefully, specifying which configuration caused the circular dependency.


NOTES

  • None


CONSTRAINTS REQUIREMENTS

  • The user interface needs to remain responsive and indicate progress when long data access and/or processing is being performed
  • An email should be sent to the appropriate mailing list, when an unexpected or unrecoverable error is detected
  • A workspace can hold more then 1 project, but the user can only
  • The system needs to be able to perform partial build (i.e. detect automatically, if a build is required, based on e.g. time stamp)

-- MebSter - 07 Nov 2005


This topic: ETICS > WebHome > UseCases > BuildComponentOrSystemUseCase
Topic revision: r2 - 2006-03-07 - unknown
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback