Difference between revisions of "COSMOS QA Criteria"

From Eclipsepedia

Jump to: navigation, search
('''Is COSMOS 1.0 a consumable entity?''')
(References)
 
(29 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
== '''COSMOS Quality Expectations''' ==
 
== '''COSMOS Quality Expectations''' ==
  
This has been put together to address Bugzilla ER 214576.
+
This has been put together to address [https://bugs.eclipse.org/bugs/show_bug.cgi?id=214576 Bugzilla ER 214576].
 
+
 
+
 
+
 
+
  
 
== '''Terminologies/Acronyms''' ==
 
== '''Terminologies/Acronyms''' ==
Line 24: Line 20:
  
 
== '''Purpose''' ==
 
== '''Purpose''' ==
We intent to set the quality expectations of COSMOS (the software) and matching acceptance criteria that would serve as a preamble to the COSMOS QA team while executing their work.
+
The purpose of this document is to set the quality expectations of COSMOS (the software) and matching acceptance criteria that would serve as a preamble to the COSMOS QA team while executing their work.
  
 
<p>
 
<p>
The QA team will use these criteria as a specification to define and plan all their testing efforts.
+
The QA team will use these criteria as a specification to define and plan their testing efforts for any given iteration. Specific test scenario's, environments and methods are to be documented in the QA iteration activities document eg) [http://wiki.eclipse.org/COSMOS_QA_i9_Activities COSMOS_QA_i9_Activities]
 
</p>
 
</p>
  
Line 33: Line 29:
  
 
COSMOS QA perceives COSMOS 1.0 as being a well formed software if it is built upon valid use cases, on bug free technology, with accompanying API documentation and providing easy installations, on some widely used platforms.
 
COSMOS QA perceives COSMOS 1.0 as being a well formed software if it is built upon valid use cases, on bug free technology, with accompanying API documentation and providing easy installations, on some widely used platforms.
 
+
<p>
 
+
<hr>
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
 
|+{{BMTableCaptionStyle}}|Quality perspective 1: Is COSMOS well formed ?
 
|+{{BMTableCaptionStyle}}|Quality perspective 1: Is COSMOS well formed ?
Line 43: Line 39:
 
|-
 
|-
 
| align="left" | Valid use cases
 
| align="left" | Valid use cases
| COSMOS team to define use cases
+
| COSMOS team to define use cases [[COSMOS_Use_Cases]]
| Validate ERs against the use cases - manual
+
| Validate ER definition against the use cases - manual
 
|-
 
|-
| align="left" | Bug free implementation
+
| align="left" | Comprehensive Unit Test Coverage
| COSMOS team must provide JUnits covering 100% of code; code and JUnits walk-through to QA must be provided
+
| COSMOS team must provide unit test cases (Manual, TPTP/JUnits) to prove integrity of code changes; A unit test case walk-through to QA must be provided [https://bugs.eclipse.org/bugs/show_bug.cgi?id=215135 215135 (i9)][https://bugs.eclipse.org/bugs/show_bug.cgi?id=208604 208604 (i9)]
| Run the JUnits and validate their code / ER coverage – TPTP; Black box functional testing – manual / SOAPUI recorded as TPTP manual tests
+
| Validate the test case scope and validity and sign off on all ER's. QA are not required to execute unit tests.
 
|-
 
|-
| align="left" | API documentation
+
| align="left" | API documentation/JavaDoc
| COSMOS team must provide API documentation
+
| COSMOS team must provide API documentation/JavaDoc [https://bugs.eclipse.org/bugs/show_bug.cgi?id=197515 197515 (i9)] [https://bugs.eclipse.org/bugs/show_bug.cgi?id=216655 216655 (no target)]
| Manual verification of API documentation
+
| Manual verification of API documentation/JavaDoc
 
|-
 
|-
 
| align="left" | Easy to use deployment package
 
| align="left" | Easy to use deployment package
| Releas Engineeting team to provide an easy install
+
| Release Engineering team to provide an easy install [[Build_Packaging_for_COSMOS]]
 
| Validate the ease of use of the package and accompanying install instructions – manual; RE process will not be scrutinized
 
| Validate the ease of use of the package and accompanying install instructions – manual; RE process will not be scrutinized
 
|-
 
|-
 
| align="left" | Base platforms support
 
| align="left" | Base platforms support
| COSMOS team to specify the supported platforms
+
| COSMOS team to specify the supported platforms [http://wiki.eclipse.org/COSMOS_M2_Dependencies COSMOS M2 Dependencies]
| QA certifies release on specified platforms
+
| QA certifies release on specified platforms and runs Sanity tests on latest GA versions (where different). 
|-
+
| align="left" | Wiki documentation
+
| Owners take responsibility of the quality of content
+
| QA will not validate wiki content
+
 
|}
 
|}
  
 
== '''Is COSMOS 1.0 a consumable entity?''' ==
 
== '''Is COSMOS 1.0 a consumable entity?''' ==
  
COSMOS QA perceives COSMOS 1.0 as a consumable (adoptable) software if we can demostrate its capability to successfully integrate with participating data managers and MDRs through integration and performance testing reports, code samples and other adopter aids.
+
COSMOS QA perceives COSMOS 1.0 as a consumable (adoptable) software if we can demonstrate its capability to successfully integrate with participating data managers and MDRs through integration and performance testing reports, code samples and other adopter aids.
<p>
+
 
Clear documentation, process definition for fixing COSMOS bugs or supporting future COSMOS enhancements and a plan for scaling COSMOS as dependent software upgrade themselves can also contribute.
+
Clear documentation, process definition for fixing COSMOS bugs or supporting future COSMOS enhancements can also contribute. Dependencies on 3rd Party software must be specified.
 
</p>
 
</p>
  
Line 81: Line 73:
 
! QA Role
 
! QA Role
 
|-
 
|-
| align="left" | Successful integration of COSMOS components  
+
| align="left" | Successful Application integration of COSMOS components  
| COSMOS team must provide helper applications for integration testing with scenarios  
+
| COSMOS team must provide helper applications for integration with user scenarios [https://bugs.eclipse.org/bugs/show_bug.cgi?id=208274 208274 (i9)] [https://bugs.eclipse.org/bugs/show_bug.cgi?id=209990 209990 (future)]
| Perform integration testing and execute scenarios – manual.  Recorded as manual TPTP tests
+
| Test the function and effectivity of helper tools – manual.  Recorded as manual TPTP tests
|-
+
| align="left" | COSMOS stability during production deployments
+
| COSMOS team must state the minimum system requirements for production.  Also recommend parameters (number of data Managers / MDRs that may be added, volume of data that can be queried, etc.) that should be considered for these tests.
+
| Execute performance / scalability /volume/stress/ availability testing with minimum resources recommended
+
 
|-
 
|-
 
| align="left" | COSMOS support across products / data sources
 
| align="left" | COSMOS support across products / data sources
| COSMOS team must state the kinds of MDRs that can be integrated and provide samples
+
| COSMOS team must state the kinds of MDRs that can be integrated and provide samples [https://bugs.eclipse.org/bugs/show_bug.cgi?id=211093 211093 (future)] [https://bugs.eclipse.org/bugs/show_bug.cgi?id=214766 214766 (i8)] [https://bugs.eclipse.org/bugs/show_bug.cgi?id=209987 209987 (i9)] [https://bugs.eclipse.org/bugs/show_bug.cgi?id=212187 212187 (i8)] [https://bugs.eclipse.org/bugs/show_bug.cgi?id=212189 212189 (i8)]
| Execute integration tests with these samples – manual.  Recorded as TPTP manual tests
+
| Execute integration tests with these sample MDRs – manual.  Recorded as TPTP manual tests
 
|-
 
|-
 
| align="left" | User documentation
 
| align="left" | User documentation
| COSMOS team will write manuals
+
| COSMOS team will write manuals [https://bugs.eclipse.org/bugs/show_bug.cgi?id=214805 214805 (i9)]
 
| QA validates the information - manual
 
| QA validates the information - manual
|-
 
| align="left" | Samples / skeleton MDR implementation / any collateral
 
| COSMOS team must provide samples
 
| QA validates the existence and may require assistance from COSMOS Team while using the skeleton implementations – manual.  Recorded as TPTP manual tests
 
 
|-
 
|-
 
| align="left" | Additional platforms
 
| align="left" | Additional platforms
| COSMOS team must specifiy
+
| COSMOS team must specify [https://bugs.eclipse.org/bugs/show_bug.cgi?id=216210 216210 (i9)] [http://wiki.eclipse.org/COSMOS_M2_Dependencies COSMOS M2 Dependencies]
 
| QA will certify the product on these platforms - manual
 
| QA will certify the product on these platforms - manual
 
|-
 
|-
 
| align="left" | Dependencies on other open source software
 
| align="left" | Dependencies on other open source software
| COSMOS team to define a process to integrate with the newer versions of these dependent software
+
| COSMOS team to define a minimum version of the dependent software [https://bugs.eclipse.org/bugs/show_bug.cgi?id=215609 215609 (no target)] [http://wiki.eclipse.org/COSMOS_M2_Dependencies COSMOS M2 Dependencies]
| QA will validate the process - manual
+
| QA will validate at minumum versions and sanity test at latest GA versions where this differs
 
|-
 
|-
 
| align="left" | Future enhancements / bug reporting mechanism
 
| align="left" | Future enhancements / bug reporting mechanism
| COSMOS team to set a process
+
| COSMOS team to set a process [https://bugs.eclipse.org/bugs/ Bugzilla]
 
| QA validates the process - manual
 
| QA validates the process - manual
 
|}
 
|}
  
 
== '''Operational Efficiency considerations''' ==
 
== '''Operational Efficiency considerations''' ==
 +
 +
The operational efficiency of a system is considered to be the characteristics of a that system when deployed to a production environment and it's reaction to load.
  
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
|+{{BMTableCaptionStyle}}|COSMOS Operational Efficiency Related Quality Expectations
+
|+{{BMTableCaptionStyle}}|Quality Perspective 3: COSMOS Operational Efficiency  
 
|-{{BMTHStyle}}
 
|-{{BMTHStyle}}
 
! Quality Characteristic
 
! Quality Characteristic
 
! Acceptance Criteria
 
! Acceptance Criteria
|-
+
! QA Role
| align="left" | Availability
+
| There are no Availability quality expectations
+
|-
+
| align="left" | Capacity
+
| There are no Capacity quality expectations
+
 
|-
 
|-
 
| align="left" | Concurrency
 
| align="left" | Concurrency
| How many queries / clients may run simultaneously? Should there be any other concurrency considerations?
+
| Execution of multiple processes or operations simultaneously. The COSMOS components are required to be multi threaded and support queries / clients to be run simultaneously. [https://bugs.eclipse.org/bugs/show_bug.cgi?id=216210 216210 (i9)]
 +
| QA will perform basic concurrency testing by running 2 or more cosmos clients (command line and GUI) on same machine and by executing queries simultaneously.
 +
 
 
|-
 
|-
| align="left" | Data Volumes
+
| align="left" | Data Volumes/Performance
| Are there any restrictions on the amount of data that may be returned by a query?  How many queries / clients may run at a time?
+
| Restrictions on the amount of data that may be returned by a query/transaction. Data sets should be kept relatively small in a COSMOS implementation, however guidelines concerning data volumes and effect on performance should be determined and made available to adopters for a given scenario. More specific performance thresholds and metrics may be applied after further analysis of testing results. [https://bugs.eclipse.org/bugs/show_bug.cgi?id=216210 216210 (i9)]
 +
| QA to perform generic load/data volume tests to generate data points for further analysis. QA will incrementally increase load on Example MDR repository, which is an XML file based repository and try to test sample queries to monitor response time, CPU and memory utilization.
 
|-
 
|-
| align="left" | Performance
+
| align="left" | Scalability/Stability
| The Data Managers and MDRs should not degrade the performance of Data Adapters by more than 15%
+
| COSMOS 1.0 will support a single Data Broker and Management Domain. The scalable quantity of Data Managers within a COSMOS environment will not be artificially limited and should not present a practical restriction in a well designed system, however, guidelines concerning the number of Data Managers and effect on performance should be determined and made available to adopters for a given scenario. Any COSMOS environment must be considered stable, with predictable results under all conditions. Exceptions should be handled gracefully with informative messaging to the client. [https://bugs.eclipse.org/bugs/show_bug.cgi?id=216210 216210 (i9)]
|-
+
| QA to perform generic load/data volume tests to generate data points for further analysis. QA will incrementally increase the number of MDR's, and subject to a constant transaction load of sample queries to monitor response time, CPU and memory utilization.
| align="left" | Scalability
+
 
| COSMOS 1.0 will support a single Data Manager and Management Domain. How many MDRs and Data Managers may be added?  Should there be any other scalilbity considerations?
+
|-
+
| align="left" | Stability
+
| There are no Stability quality expectations
+
|-
+
| align="left" | Stress
+
| There are no Stress quality expectations
+
|-
+
| align="left" | Manageability
+
| System Administrator should have best practices, guidelines, and tooling to administer a COSMOS environment
+
 
|}
 
|}
  
Line 154: Line 128:
 
This section includes the tasks required to complete this enhancement.
 
This section includes the tasks required to complete this enhancement.
  
# Jimmy Mohsin has generated this page to address bugzilla 214576
+
# Jimmy Mohsin has generated this page to address [https://bugs.eclipse.org/bugs/show_bug.cgi?id=214576 bugzilla 214576]
 
# The COSMOS team needs to provide input to this page
 
# The COSMOS team needs to provide input to this page
# Shivvy, representing the QA team, is supposed to review and sign-off on these criteria
+
# SrinivasReddy Doma, representing the QA team, is supposed to review and sign-off on these criteria
  
 
== '''Open Issues/Questions '''==
 
== '''Open Issues/Questions '''==
Line 163: Line 137:
  
 
A formal review is required to agree the content and detail of the quality expectations laid out in the three ‘quality perspective’ tables. This is a three step process…
 
A formal review is required to agree the content and detail of the quality expectations laid out in the three ‘quality perspective’ tables. This is a three step process…
1. Review each quality expectation to agree whether it should be included.  
+
# Review each quality expectation to agree whether it should be included.  
2. If it is to be included then determine whether the acceptance criteria can be met with an r1.0 timeframe, or be postponed to a subsequent release.
+
# If it is to be included then determine whether the acceptance criteria can be met with an r1.0 timeframe, or be postponed to a subsequent release.
3. All acceptance criteria must be linked to an ER that delivers the required quality. This can be illustrated by linking the acceptance criteria table cell content to either other relevant wiki pages or an ER. If the link is to an ER then this should also state the ER’s status (e.g. not started / WIP /completed)
+
# All acceptance criteria must be linked to an ER that delivers the required quality. This can be illustrated by linking the acceptance criteria table cell content to either other relevant wiki pages or an ER. If the link is to an ER then this should also state the ER’s status (e.g. not started / WIP /completed)
 +
 
 +
== '''References'''==
 +
* http://wiki.eclipse.org/COSMOS_Use_Cases
 +
* http://wiki.eclipse.org/COSMOS_QA_End2End_Tests
 +
* http://wiki.eclipse.org/COSMOS_MDR_TestingFramework
 +
* http://wiki.eclipse.org/COSMOS_Performance_Testing
 +
* http://wiki.eclipse.org/COSMOS_QA_i14_Activities
  
 
----
 
----
 
[[Category:COSMOS_Bugzilla_Designs]]
 
[[Category:COSMOS_Bugzilla_Designs]]

Latest revision as of 05:30, 11 November 2008

Contents

[edit] COSMOS Quality Expectations

This has been put together to address Bugzilla ER 214576.

[edit] Terminologies/Acronyms

The terminologies/acronyms below are commonly used throughout this document. The list below defines each term regarding how it is used in this document.

Term Definition
Quality Expectations Is a statement of some behaviour, characteristic or operational facility that a product must exhibit for it to be deemed ‘fit for purpose’. Quality expectations are normally grouped into four main categories: functional/behavioural, operational efficiency, inter operability factors; and admin/management factors (to control TCO).
Acceptance Criteria This is a quantification of how a quality expectation is to be validated. For functional/behavioural quality expectations this is a simple Boolean test – it either works or it doesn’t. Hence, for most scope docs there is no need to specifically define functional acceptance criteria. However, other types of quality expectations – especially performance related areas – do require specific acceptance criteria because the quantification is normally some form of numeric threshold (with optional margin/tolerance) that states minimum levels of acceptable operational efficiency.

[edit] Purpose

The purpose of this document is to set the quality expectations of COSMOS (the software) and matching acceptance criteria that would serve as a preamble to the COSMOS QA team while executing their work.

The QA team will use these criteria as a specification to define and plan their testing efforts for any given iteration. Specific test scenario's, environments and methods are to be documented in the QA iteration activities document eg) COSMOS_QA_i9_Activities

[edit] Is COSMOS 1.0 well-formed software?

COSMOS QA perceives COSMOS 1.0 as being a well formed software if it is built upon valid use cases, on bug free technology, with accompanying API documentation and providing easy installations, on some widely used platforms.


Quality perspective 1: Is COSMOS well formed ?
Quality Expectation Acceptance Criteria QA Role
Valid use cases COSMOS team to define use cases COSMOS_Use_Cases Validate ER definition against the use cases - manual
Comprehensive Unit Test Coverage COSMOS team must provide unit test cases (Manual, TPTP/JUnits) to prove integrity of code changes; A unit test case walk-through to QA must be provided 215135 (i9)208604 (i9) Validate the test case scope and validity and sign off on all ER's. QA are not required to execute unit tests.
API documentation/JavaDoc COSMOS team must provide API documentation/JavaDoc 197515 (i9) 216655 (no target) Manual verification of API documentation/JavaDoc
Easy to use deployment package Release Engineering team to provide an easy install Build_Packaging_for_COSMOS Validate the ease of use of the package and accompanying install instructions – manual; RE process will not be scrutinized
Base platforms support COSMOS team to specify the supported platforms COSMOS M2 Dependencies QA certifies release on specified platforms and runs Sanity tests on latest GA versions (where different).

[edit] Is COSMOS 1.0 a consumable entity?

COSMOS QA perceives COSMOS 1.0 as a consumable (adoptable) software if we can demonstrate its capability to successfully integrate with participating data managers and MDRs through integration and performance testing reports, code samples and other adopter aids.

Clear documentation, process definition for fixing COSMOS bugs or supporting future COSMOS enhancements can also contribute. Dependencies on 3rd Party software must be specified.

Quality perspective 2: Is COSMOS consumable entity?
Quality Expectation Acceptance Criteria QA Role
Successful Application integration of COSMOS components COSMOS team must provide helper applications for integration with user scenarios 208274 (i9) 209990 (future) Test the function and effectivity of helper tools – manual. Recorded as manual TPTP tests
COSMOS support across products / data sources COSMOS team must state the kinds of MDRs that can be integrated and provide samples 211093 (future) 214766 (i8) 209987 (i9) 212187 (i8) 212189 (i8) Execute integration tests with these sample MDRs – manual. Recorded as TPTP manual tests
User documentation COSMOS team will write manuals 214805 (i9) QA validates the information - manual
Additional platforms COSMOS team must specify 216210 (i9) COSMOS M2 Dependencies QA will certify the product on these platforms - manual
Dependencies on other open source software COSMOS team to define a minimum version of the dependent software 215609 (no target) COSMOS M2 Dependencies QA will validate at minumum versions and sanity test at latest GA versions where this differs
Future enhancements / bug reporting mechanism COSMOS team to set a process Bugzilla QA validates the process - manual

[edit] Operational Efficiency considerations

The operational efficiency of a system is considered to be the characteristics of a that system when deployed to a production environment and it's reaction to load.

Quality Perspective 3: COSMOS Operational Efficiency
Quality Characteristic Acceptance Criteria QA Role
Concurrency Execution of multiple processes or operations simultaneously. The COSMOS components are required to be multi threaded and support queries / clients to be run simultaneously. 216210 (i9) QA will perform basic concurrency testing by running 2 or more cosmos clients (command line and GUI) on same machine and by executing queries simultaneously.
Data Volumes/Performance Restrictions on the amount of data that may be returned by a query/transaction. Data sets should be kept relatively small in a COSMOS implementation, however guidelines concerning data volumes and effect on performance should be determined and made available to adopters for a given scenario. More specific performance thresholds and metrics may be applied after further analysis of testing results. 216210 (i9) QA to perform generic load/data volume tests to generate data points for further analysis. QA will incrementally increase load on Example MDR repository, which is an XML file based repository and try to test sample queries to monitor response time, CPU and memory utilization.
Scalability/Stability COSMOS 1.0 will support a single Data Broker and Management Domain. The scalable quantity of Data Managers within a COSMOS environment will not be artificially limited and should not present a practical restriction in a well designed system, however, guidelines concerning the number of Data Managers and effect on performance should be determined and made available to adopters for a given scenario. Any COSMOS environment must be considered stable, with predictable results under all conditions. Exceptions should be handled gracefully with informative messaging to the client. 216210 (i9) QA to perform generic load/data volume tests to generate data points for further analysis. QA will incrementally increase the number of MDR's, and subject to a constant transaction load of sample queries to monitor response time, CPU and memory utilization.

[edit] Task Breakdown

This section includes the tasks required to complete this enhancement.

  1. Jimmy Mohsin has generated this page to address bugzilla 214576
  2. The COSMOS team needs to provide input to this page
  3. SrinivasReddy Doma, representing the QA team, is supposed to review and sign-off on these criteria

[edit] Open Issues/Questions

All reviewer feedback should go in the Talk page for 214576.

A formal review is required to agree the content and detail of the quality expectations laid out in the three ‘quality perspective’ tables. This is a three step process…

  1. Review each quality expectation to agree whether it should be included.
  2. If it is to be included then determine whether the acceptance criteria can be met with an r1.0 timeframe, or be postponed to a subsequent release.
  3. All acceptance criteria must be linked to an ER that delivers the required quality. This can be illustrated by linking the acceptance criteria table cell content to either other relevant wiki pages or an ER. If the link is to an ER then this should also state the ER’s status (e.g. not started / WIP /completed)

[edit] References