UMDQualityCriteria

From EGIWiki
Revision as of 09:30, 3 August 2010 by Enolfc (talk | contribs) (Template for validation)
Jump to: navigation, search

UMD Quality Criteria

All the software included in the Unified Middleware Distribution (UMD) must meet a set of Quality Criteria defined by EGI. The Quality Criteria can be classified into generic criteria, i.e. criteria which sould hold for any component of the UMD, and specific criteria, i.e. criteria valid for a particular component only.

Validation of Criteria

In order to be verified, quality criteria is specified as a set of tests. Those tests must ensure the correctness, completeness and security of each service. Software providers must include with each component a complete test plan that covers all the quality criteria. The test plan is composed by:

  • General description of the test plan.
  • A Test Suite following the template described in the next section for each of the test cases included in:
    • Generic criteria.
    • Specific criteria applicable to the component.
    • Bugs detected by EGI

Template for test validation

For each test specified in the criteria, there must be a report. The report should contain several sections:

Description

Description of the test objectives. Include any references to specific bugs that are tested.

Set up

  • A description of required steps prior to the execution of the test, and if relevant, differences between this set up and the standard installation procedure for the software. Tests should be written in such a way that they can be integrated into different frameworks. Manual testing should be avoided.
  • Tests must be fully configurable either by options to the test script or a configuration file (key/value pairs resp. environment variables for export). There must be no hardcoded paths etc.
  • If the test has prerequisites on the grid (e.g. a valid proxy) this must be documented and a check at the beginning of the test has to be implemented.
  • Detailed documentation on how to run the test, that allows the validation team to repeat the test if necessary.

Results

Tests should have a simple output (text or simple html) that allows adding a post processing step to the results in order to be transformed for use with a particular presentation framework. Description of the test results for these cases:

Correct input/Normal workflow

Testing the software as it should work, with correct input. Describe different inputs combinations used for testing and when this test should pass or fail. Description of the output observed when running the test (most of the time a copy and paste of the commands or screenshot should be enough) that is reproducible by the validation team.

Error workflow - erroneous input

Testing the error codes: providing wrong input to the software should return the proper error messages. Describe different inputs combinations used for testing and when this test should pass or fail. Description of the output observed when running the test (most of the time a copy and paste of the commands or screenshot should be enough) that is reproducible by the validation team.

Non tested features

Describe in this section any features of the software that miss a test.

Generic acceptance criteria

Documentation

Services in UMD must include a comprehensive documentation written in a uniform and clear style, which reflects all of the following items:

  • Functional description of the software.
  • User documentation, including complete man pages of the commands and user guides.
  • Complete API documentation (if there is an API)
  • Administrator documentation that includes the installation procedure; detailed configuration of service; starting, stopping and querying service procedures; ports (or port ranges) used and expected connections to those ports; cron jobs needed for the service)
  • List of processes that are expected to run, giving a typical load of the service. List of how state information is managed and debugging information (e.g.: list of log files, any files or databases containing service information).
  • Notes on the testing procedure and expected tests results.

Verification: existence of the documentation with all the required items.

Source Code Quality and Availability

The source code of each component of the UMD middleware should follow a coherent and clear programming style that helps in the readability of the code and eases maintenance, testing, debugging, fixing, modification and portability of the software. Open source components must publicly offer their source code and the license with the binaries.

Verification: for Open Source components, availability of the code and license. Source code quality metrics are desirable.

Management, Monitoring, Traceability

All the services must include tools related to:

  • Starting, stopping, suspending, listing and querying the status of all the service daemons.
  • Checking the responsiveness of all the service components or daemons
  • Checking the correctness of the service components behavior (expected actions after a request are taken)
  • Tracing all the user actions in the system (e.g. by generating logs)

Ideally, these tools should be also available remotely, allowing operators to react timely to problems in the infrastructure. A uniform interface for remote management and monitoring should be followed by all the services. Monitorization should also be easily used in existing monitoring systems such as Nagios.

Verification: Test suite must include tests cases for:

  • start, stop, suspend, and query status of service
  • check responsiveness of service (expected ports open and expected answer to commands received)
  • check correctness of service behavior (expexted actions after a request are taken)
  • track of user actions in the system (generation of logs and accounting information)

Configuration

Tools for the automatic or semi-automatic configuration of the services must be provided with the software. These tools should allow the unassisted configuration of the services for the most common use cases while being customizable for advanced user. Complete manual configuration must be always allowed.

Verification: test suite must include the configuration mechanisms and tools. Yaim is considered as the preferred tool.

Specific acceptance criteria

There is a template for the creation of new critera at EGI-InSPIRE:UMDQualityCriteria:Template

The specific acceptance criteria of the UMD are classified according to the following areas: