The wiki is in the process of being deprecated and migrated to other supports.

UMDQualityCriteria

From EGIWiki
Jump to navigation Jump to search

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.

Testability

UMD software must support testing of its features and functionality. The tests must ensure the correctness, completeness, security and scalability of each service. Error situation and input validation have to be included in the test suite. The software provider must define a test plan for each service and provide a test suite and the results of running it against each new release. Interoperability with the rest of the UMD software must be explicitly tested. A global test suite for the UMD distribution will guarantee the correct behavior of the complete set of services in a controlled environment.

Verification: existence of the test plan, test suite and the results of the test plan.

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 casses while being customizable for advanced use cases. Complete manual configuration must be always allowed.

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

Management and Monitoring

All the services must include tools (and tests for them) 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 (expected ports open and expected answer to commands received)
  • Checking the correctness of the service components behavior (expected actions after a request are taken)

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 on this functionality.

Interoperability

UMD services should be interoperable between them. All the services should assure their correct functionality within the rest of the UMD middleware for a given major release before entering the distribution. Ideally, backward compatibility between major releases should be kept. Interoperability between other middleware distributions is recommended, therefore compliance to existing and future standards should be priority in all the distributed software.

Verification: interoperability test of the service, assuring the correct behavior within the environment.

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.

Specific acceptance criteria

This section will detail the specific acceptance criteria for each of the services that are part of the UMD.