This specification defines the OSLC Quality Management domain, a RESTful web services interface for the management of product, service or software quality artefacts, activities, tasks and relationships between those and related resources such as requirements, defects, change requests or architectural resources. To support these scenarios, this specification defines a set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, content type handling and resource formats.


Introduction

This specification builds on the OSLC Core Specification to define the resources and operations supported by an Open Services for Lifecycle Collaboration (OSLC) Quality Management (QM) provider.

Quality Management resources define the test plans, test cases, and test results of the software delivery lifecycle. They represent individual resources along with their relationships to other shared resource types such change requests and requirements. The intent of this specification is to define the set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, mime type handling and resource formats. The capabilities of the interface definitions are driven by key integration scenarios and therefore don't represent a complete setup of operations on resources or resource types. The resource formats and operations may not match exactly the native models supported by quality management service providers but are intended to be compatible with them.

A key approach to supporting these scenarios is to delegate operations, as driven by service provider contributed user interfaces, as much as possible and not require a service provider to expose its complete data model and application logic.

IPR Policy

This Committee Specification Public Review Draft is being developed under the RF on Limited Terms Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/oslc-domains/ipr.php).

Terminology

Terminology is based on OSLC Core Overview [[!OSLCCore3]], W3C Linked Data Platform [[LDP]], W3C's Architecture of the World Wide Web [[WEBARCH]], and Hyper-text Transfer Protocol [[HTTP11]].

Service Provider
An implementation of the OSLC Quality Management specifications as a server. OSLC QM clients consume these services
Quality Management Resource
A resource managed by an OSLC QM service provider. The types of resources defined by this specification are Test Plan, Test Case, Test Script, Test Execution Record, and Test Result.
Client
An implementation of the OSLC Quality Management specifications as a client. OSLC QM Clients consume services provided by servers
Server
An implementation of the OSLC Quality Management specifications as a server. OSLC QM clients consume services provided by Servers. The use of the terms Client and Server are intended to distinguish typical consumers and providers of OSLC resources in a distributed environment based on REST. A particular application component could be a client for some OSLC domain services and a server for the same or another domain.
Test Plan Resource
Defines the overall process and strategy for testing a system
Test Case Resource
Defines the criteria which determine whether a system exhibits the correct behavior under a specific set of circumstances
Test Script Resource
Defines a program or list of steps used to conduct a test
Test Execution Record Resource
Planning for execution of a test
Test Result Resource
Describes the outcome of attempting to execute a test

References

Conventions

Base Requirements

The following sub-sections define the mandatory and optional requirements for an OSLC Quality Management (OSLC QM) server.

Base Compliance

This specification is based on [[!OSLCCore3]]. OSLC QM servers MUST be compliant with both the core specification, MUST follow all the mandatory requirements in the normative sections of this specification, and SHOULD follow all the guidelines and recommendations in both these specifications.

An OSLC QM server MUST implement the domain vocabulary defined in OSLC Quality Management Version 2.1. Part 2: Vocabulary

The following table summarizes the requirements from OSLC Core Specification as well as some additional requirements specific to the QM domain. Note that this specification further restricts some of the requirements for OSLC Core Specification. See subsequent sections in this specification or the OSLC Core Specification to get further details on each of these requirements.

Number Requirement Level Meaning
QM-1 Unknown properties and content MAY / MUST OSLC services MAY ignore unknown content and OSLC clients MUST preserve unknown content
QM-2 Resource Operations MUST OSLC service MUST support resource operations via standard HTTP operations
QM-3 Resource Paging MAY OSLC services MAY provide paging for resources but only when specifically requested by client
QM-4 Partial Resource Representations MAY / MUST OSLC services MUST support request for a subset of a resource’s properties via the oslc.properties URL parameter retrieval via HTTP GET
QM-5 Partial Update MAY OSLC services MAY support partial update of resources using patch semantics and MAY support via HTTP PUT
QM-6 Discovery MUST / MAY / SHOULD OSLC servers MUST support OSLC Core 3.0 Discovery, MAY provide a ServiceProviderCatalog and SHOULD provide a ServiceProvider resource for Core v2 compatibility.
QM-6 Creation Factories MUST OSLC servers MUST provide LDPC creation factories to enable resource creation of Quality Management resources via HTTP POST
QM-7 Query Capabilities SHOULD OSLC servers SHOULD provide query capabilities to enable clients to query for resources
QM-8 Query Syntax SHOULD / MAY OSLC query capabilities SHOULD support the OSLC Core Query Syntax and MAY use other query syntax
QM-9 Delegated UI Dialogs MUST / SHOULD OSLC Services MUST offer delegated UI dialogs (creation and selections) specified via OSLC Core 3.0 Delegated Dialogs and SHOULD include discovery through a ServiceProvider resource for OSLC v2 compatibility
QM-10 UI Preview SHOULD OSLC Services SHOULD offer UI previews for resources that may be referenced by other resources specified via OSLC Core 3.0 Preview and SHOULD include discovery through a server resource for OSLC v2 compatibility
QM-11 HTTP Basic Authentication MAY OSLC Services MAY support Basic Auth and should do so only over HTTPS
QM-12 OAuth Authentication SHOULD OSLC Services SHOULD support OAuth and can indicate the required OAuth URLs via the ServiceProviderCatalog or ServiceProvider resources
QM-13 Error Responses SHOULD OSLC Services SHOULD provide error responses using OSLC Core 3.0 defined error formats
QM-14 Turtle Representations MUST OSLC services MUST provide a Turtle representation for HTTP GET requests and SHOULD support Turtle representations on POST and PUT requests.
QM-15 RDF/XML Representations SHOULD OSLC services SHOULD provide an RDF/XML representation for HTTP GET requests and SHOULD support RDF/XML representations on POST and PUT requests
QM-16 XML Representations SHOULD OSLC services SHOULD provide a XML representation for HTTP GET, POST and PUT requests that conform to the Core 2.0 Guidelines for XML.
QM-17 JSON Representations MUST OSLC services MUST provide JSON-LD representations for HTTP GET, POST and PUT requests that conform to the Core Guidelines for JSON-LD
QM-18 HTML Representations SHOULD OSLC services SHOULD provide HTML representations for HTTP GET requests

Specification Versioning

This specification follows the specification version guidelines given in [[!OSLCCore3]].

Namespaces

In addition to the namespace URIs and namespace prefixes oslc, rdf, dcterms and foaf defined in the [[!OSLCCore3]], OSLC QM defines the namespace URI of http://open-services.net/ns/qm# with a namespace prefix of oslc_qm.

This specification also uses these namespace prefix definitions:

Resource Formats

In addition to the requirements for resource representations in [[!OSLCCore3]], this section outlines further refinements and restrictions.

For HTTP GET requests on all OSLC QM and OSLC Core defined resource types,

For HTTP PUT/POST request formats for resource type of TestPlan, TestCase, TestScript, TestExecutionRecord and TestResult :

For HTTP GET response formats for Query requests,

QM servers MUST provide Turtle and JSON-LD, SHOULD provide RDF/XML, XML, and MAY provide Atom Syndication Format XML representations.

When QM clients request:

See Query Capabilities for additional information when Resource Shapes affect representation.

Content Negotiation

[[!OSLCCore3]] specifies RDF representations (and specifically Turtle and JSON-LD) as a convention that all OSLC server implementations minimally provide and accept. OSLC QM server implementations are strongly encouraged to adopt this convention. Future versions of this specification are expected to require RDF representations for all operations and relax requirements for specialized XML representations.

XML Representation - identified by the application/xml content type. Format representation rules are outlined in Core OSLC Core Resource Formats section

RDF/XML Representation - identified by the application/rdf+xml content type. No additional guidance is given.

JSON-LD Representation - identified by the application/ld+json content type. Format representation rules are specified in JSON-LD 1.0.

Atom Syndication Format XML Representation - identified by the application/atom+xml content type. Format representation rules are outlined in Core OSLC Core Resource Formats section.

Authentication

[[!OSLCCore3]] specifies the recommended OSLC authentication mechanisms. In addition to the OSLC Core authentication requirements, OSLC QM services providers SHOULD support [[!OpenIDConnect]].

Error Responses

[[!OSLCCore3]] specifies the OSLC Core error responses. OSLC QM puts no additional constraints on error responses.

Pagination

OSLC QM servers SHOULD support pagination of query results and MAY support pagination of a single resource's properties as defined by [[!OSLCCore3]].

Requesting and Updating Properties

Requesting a Subset of Properties

A client MAY request a subset of a resource's properties as well as properties from a referenced resource. In order to support this behavior a server MUST support the oslc.properties and oslc.prefix URL parameter on a HTTP GET request on individual resource request or a collection of resources by query. If the oslc.properties parameter is omitted on the request, then all resource properties MUST be provided in the response.

Updating a Subset of Properties

A client MAY request that a subset of a resource's properties be updated by using the [[LDPPatch]] PATCH method.

For compatibility with [[!OSLCCore2]], QM servers MAY also support partial update by identifying those properties to be modified using the oslc.properties URL parameter on a HTTP PUT request.

If the parameter oslc.properties contains a valid resource property on the request that is not provided in the content, the server MUST set the resource's property to a null or empty value. If the parameter oslc.properties contains an invalid resource property, then a 409 Conflict MUST be returned.

Updating Multi-Valued Properties

For multi-valued properties that contain a large number of values, it may be difficult and inefficient to add or remove property values. OSLC QM servers SHOULD provide support for a partial update of the multi-valued properties as defined by OSLC Core Partial Update.

Labels for Relationships

QM resource relationships to other resources are represented by RDF properties. Instances of a relationship - often called links - are RDF triples with a subject URI, a predicate that is the property, and a value (or object) that is the URI of target resource. When a link is to be presented in a user interface, it may be helpful to display an informative and useful textual label instead of or in addition to the URI of the predicate and or object. There are three items that clients could display:

Turtle example using a reified statement:

@prefix ns0: <http://open-services.net/ns/qm#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix dcterms: <http://purl.org/dc/terms/> .

<http://example.com/tests/4321>
  a <http://open-services.net/ns/qm#TestCase> ;
  ns0:uses <http://anotherexample.com/testscript/123> .

<http://njh.me/#link1>
  a rdf:Statement ;
  rdf:subject <http://example.com//4321> ;
  rdf:predicate ns0:uses ;
  rdf:object <http://anotherexample.com/testscript/123> ;
  dcterms:title "Test Script 123: " .

JSON-LD example using reified statement:

{
  "@context": {
    "dcterms": "http://purl.org/dc/terms/",
    "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
    "oslc": "http://open-services.net/ns/core#",
    "oslc_qm": "http://open-services.net/ns/qm#"
  },
  "@id": "http://example.com/testscripts/4321",
  "@type": "oslc_qm:TestScript",
  "oslc_cm:relatedChangeRequest": {
    "@id": "http://anotherexample.com/defects/123",
    "dcterms:title": "Defect 123: Problems during install"
  }
}

Vocabulary Terms and Constraints

OSLC QM Resources 2.1 Defines the vocabulary terms and constraints for OSLC Quality Management resources. These terms and constraints are specified according to [[!OSLCCoreVocab]].

The intent is to define resources needed to support common integration scenarios and not to provide a comprehensive definition of QM resources like Test Case. The resource formats may not match exactly the native models supported by quality management service providers, but are intended to be compatible with them. The approach to supporting these scenarios is to delegate operations, as driven by service provider contributed user interfaces, as much as possible and not require a service provider to expose its complete data model and application logic.

QM Server Capabilities

Resource Shapes

OSLC QM servers SHOULD support Resource Shapes as defined in [[!OSLCShapes]].

Service Provider Resources

OSLC QM servers MUST support OSLC Discovery capabilities defined by [[!OSLCCore3]].

OSLC domain-name servers MAY provide a ServiceProvider Resource that can be retrieved at a implementation dependent URI.

OSLC QM servers MAY provide a ServiceProviderCatalog Resource that can be retrieved at a implementation dependent URI.

OSLC QM servers MAY provide a oslc:serviceProvider property for their defined resources that will be the URI to a ServiceProvider Resource.

OSLC QM servers MUST supply a value of http://open-services.net/ns/qm# for the property oslc:domain on either oslc:Service or oslc:ServiceProviderCatalog resources.

Creation Factories

OSLC QM servers MUST support [[!OSLCCore3]] Creation Factories and list them in the Service Provider Resource as defined by OSLC Core. OSLC QM servers SHOULD support Resource Shapes for Creation Factories as defined in [[!OSLCShapes]].

Query Capabilities

OSLC QM servers SHOULD support the Query Capabilities as defined by [[!OSLCCore3]]. OSLC QM servers SHOULD support Resource Shapes for Query Capability as defined in [[!OSLCShapes]].

The Query Capability, if supported, MUST support these parameters:

If shape information is NOT present with the Query Capability, servers SHOULD use these default properties to contain the result:

Delegated UIs

OSLC QM servers MUST support the selection and creation of resources by delegated web-based user interface delegated dialogs Delegated as defined by [[!OSLCCore3]].

OSLC QM servers MAY support the pre-filling of creation dialogs based on the definition [[!OSLCCore3]].

Version Compatibility with 2.0 Specifications

Deprecated terms

A number of terms introduced in early development of the OSLC QM domain that were deprecated in the finalized V2.0. These terms are summarized here in order to indicate they remain deprecated.

Prefixed Name Occurs Read-only Value-type Represen-tation Range Description
deprecated dcterms:type zero-or-more unspecified String n/a n/a A short string representation for the type, example Defect.
Relationship properties: This grouping of properties are used to identify relationships between resources managed by other OSLC servers
deprecated oslc_cm:testedByTestCase zero-or-many False Resource Reference any Test case by which this Change Request is tested. It is likely that the target resource will be an oslc_qm:TestCase, but that is not necessarily the case.
deprecated oslc_cm:affectsTestResult zero-or-many False Resource Reference any Associated QM resource that is affected by this Change Request. It is likely that the target resource will be an oslc_qm:TestResult, but that is not necessarily the case.
deprecated oslc_cm:blocksTestExecutionRecord zero-or-many False Resource Reference any Associated QM resource that is blocked by this Change Request. It is likely that the target resource will be an oslc_cm:TestExecutionRecord, but that is not necessarily the case.

Changes from Version 2.0

There are no substantive changes from OSLC QM Specification 2.0. This document is a document maintenance update of the version 2.0 document to support migration from open-services.net to OASIS.The changes are all upward compatible additions and therefore do not introduce incompatibilities with version 2.0.

Observations in migration from Version 2.0

The following differences where noted when migrating the open-services.net verion 2.0 Quality Management specification to the version 2.1 OASIS template based upon Change Management

Item V2 status V3 status Remark
01 Service Provider Compliance requirements are listed These requirements appear to be hosted under the heading of Discovery No action
02 Query capability is MUST Query capability is SHOULD No action
03 Query MUST scope limited to oslc.where and oslc.select Query MUST scope extended oslc.properties and oslc.prefix No action
04 V1 compatibility included V1 compatibility not included No action

Acknowledgements

This section is non-normative.

The following individuals have participated in the creation of the V2.0 specification and are gratefully acknowledged:

Participants:

Gray Bachelor (IBM - Editor)
Dave Johnson (IBM)
Ingrid Jorgensen (Tieto)
Michael Pena (Sogeti)
Nigel Lawrence (IBM)
Paul McMahan (IBM, OSLC-QM Lead)
Scott Bosworth (IBM)
Scott Fairbrother (IBM)

Change History

This section is non-normative.

/tr>
Revision Date Editor Changes Made
01 06/10/2017 Gray Bachelor Initial migration version.
02 26/12/2017 Gray Bachelor Next edits towards migration version.
03 28/06/2018 Gray Bachelor Align with released CM 3.0.
04 27/07/2018 Gray Bachelor Align with RM and Asset 2.1.
05 08/08/2018 Gray Bachelor Check and fix some V2.1 labelling