Difference between revisions of "UMDQualityCriteria"

From EGIWiki
Jump to navigation Jump to search
 
(52 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Generic acceptance criteria =
== UMD Quality Criteria ==


== Documentation ==
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.
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.
Any Technology Provider (TP) willing to have their software verified by the SA2 team should carefully read them.


== Testability ==
=== QC Documents ===
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.
The Quality Criteria (QC) is written following the classification of capabilities defined in can the [https://documents.egi.eu/secure/ShowDocument?docid=272 UMD RoadMap], one document for each type of capability. Take into account that a software component may cover QC specified in more than one of those documents.


== Configuration ==  
=== QC Roadmap ===
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.
QC definition is a continuous process driven by the requirements of users and operations communities, however the verification of new software releases will be done against fixed releases of the QC documents. At least every 6 months a new major version of the QC will be released, although more frequent releases may occur if necessary.


== Management and Monitoring ==
Each new release of the QC will be announced in this page and the TCB mailing list. Along with the announcement of each release of QC specification, a date for its use in verification will be specified. It is expected that verification will use new releases of the QC within 2 to 4 weeks from the release date.
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.
Each QC release will contain documentation with:
Monitorization should also be easily used in existing monitoring systems such as Nagios.  
* major changes introduced in the version.
* criteria to be deprecated in next release of the QC, if any.


'''Verification''':Test suite must include tests on this functionality.
As soon as a major update of the QC is released, the next version will be made available as draft in the DocDB. This draft will allow the TP to plan their testing efforts.  


== Interoperability ==
==== Current QC Specification ====
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.
Current QC Specification can be found at the [https://documents.egi.eu/public/ShowDocument?docid=240 QC document] in EGI DocDB.
Check the [[EGI-InSPIRE:UMDQualityCriteria:QC1 | release notes]].


== Source Code Quality and Availability ==
==== Future Releases ====
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.
{| class="wikitable sortable"  style="border:1px solid black" cellspacing="0" cellpadding="3" border="1"
|- style="background:Lightgray"  align="left"
! DocDB link
! Expected Release Date
! Expected Verification Date
! More information
|-
| [https://documents.egi.eu/public/ShowDocument?docid=240 240]
| 10. 02. 2011
| 10. 02. 2011
| [[EGI-InSPIRE:UMDQualityCriteria:QC1 | release notes]]
|-
| -
| 01. 08. 2011
| 15. 08. 2011
| -
|}


= Specific acceptance criteria =
==== Past QC releases ====
This section will detail the specific acceptance criteria for each of the services that are part of the UMD.


* Computing Services: [[EGI-InSPIRE:UMDQualityCriteria:ComputingServices]]
There are no past QC releases.
* Workload Management Services: [[EGI-InSPIRE:UMDQualityCriteria:WorkloadManagementServices]]

Latest revision as of 22:11, 24 December 2014

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.

Any Technology Provider (TP) willing to have their software verified by the SA2 team should carefully read them.

QC Documents

The Quality Criteria (QC) is written following the classification of capabilities defined in can the UMD RoadMap, one document for each type of capability. Take into account that a software component may cover QC specified in more than one of those documents.

QC Roadmap

QC definition is a continuous process driven by the requirements of users and operations communities, however the verification of new software releases will be done against fixed releases of the QC documents. At least every 6 months a new major version of the QC will be released, although more frequent releases may occur if necessary.

Each new release of the QC will be announced in this page and the TCB mailing list. Along with the announcement of each release of QC specification, a date for its use in verification will be specified. It is expected that verification will use new releases of the QC within 2 to 4 weeks from the release date.

Each QC release will contain documentation with:

  • major changes introduced in the version.
  • criteria to be deprecated in next release of the QC, if any.

As soon as a major update of the QC is released, the next version will be made available as draft in the DocDB. This draft will allow the TP to plan their testing efforts.

Current QC Specification

Current QC Specification can be found at the QC document in EGI DocDB. Check the release notes.

Future Releases

DocDB link Expected Release Date Expected Verification Date More information
240 10. 02. 2011 10. 02. 2011 release notes
- 01. 08. 2011 15. 08. 2011 -

Past QC releases

There are no past QC releases.