metanorma / mn-samples-ogc

Metanorma for OGC sample documents
1 stars 2 forks source link

Convert 14-065r2 requirements into Metanorma requirements #30

Closed ronaldtse closed 4 years ago

ronaldtse commented 4 years ago

14-065r2 contains Requirements.

Example:

[%unnumbered]
[cols="2"]
|===
2+^h|Requirements Class
2+|http://www.opengis.net/spec/WPS/2.0/req/conceptual-model/job-control

.^|*Target type* |Derived information model, encoding, and software implementation

.^|*Dependency* |http://www.opengis.net/spec/WPS/2.0/req/conceptual-model/capabilities

.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/conceptual-model/job/identifier +
_The service shall assign a unique identifier to each job._

.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/conceptual-model/job/identifier-unavailable-exception +
_The Service shall return an exception, if the client has attempted to use an invalid job identifier._

.^|*Requirement* a| http://www.opengis.net/spec/WPS/2.0/req/conceptual-model/job-control/execution +
_The service shall provide the ability to execute a process, i.e. to create a new job for a given process execution capability. This capability enables service clients to execute the process defined in capabilities._

.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/conceptual-model/job-control/dismiss +
_The service may provide the capability to dismiss a submitted job. This capability enables service clients to indicate that they are no longer interested in the job or its results and permit the server to free the associated resources as soon as possible._
|===

Contains Requirement Classes:

Example:

[%unnumbered]
[cols="2"]
|===
2+^h|Requirements Class
2+|http://www.opengis.net/spec/WPS/2.0/req/service/model

.^|*Target type* |Software implementation
.^|*Dependency* |http://www.opengis.net/spec/WPS/2.0/req/conceptual-model
.^|*Dependency* |OWS Common 2.0
.^|*Requirement* a| http://www.opengis.net/spec/WPS/2.0/req/service/model/data-transmission +
_Requirements class for data transmission._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/handling +
_Requirements class for WPS service handling._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/process-offering-properties +
_Requirements class for common process offering properties._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/status-info +
_Requirements class for the status information document._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/result +
_Requirements class for the processing result document._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/get-capabilities +
_Requirements class for the GetCapabilities operation._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/describe-process +
_Requirements class for the DescribeProcess operation._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/execute +
_Requirements class for the Execute operation._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/get-status +
_Requirements class for the GetStatus operation._
.^|*Requirement* a|http://www.opengis.net/spec/WPS/2.0/req/service/model/get-result +
_Requirements class for the GetResult operation._
|===

And also contains Tests:

[%unnumbered]
[cols="2"]
|===
|Test id:   |conf/service/profile/basic-wps
|Test purpose:  |Verify that the server implements the Basic WPS conformance class.
|Test method:   a|Verify that the server implements the Synchronous WPS and/or the Asynchronous WPS conformance class. Verify that the requests and responses to a supported operation are syntactically correct. Verify that the service supports the Synchronous WPS Conformance class, the Asynchronous WPS Conformance class or both. Verify that all process offerings implement the native process model. Verify the following list of conformance tests:

- <<annex-subsec-process-xml-encoding>>, <<annex-subsec-process-data-types-xml-encoding>>
- <<annex-subsec-synchronous-wps-conformance-class>> and/or <<annex-subsec-asynchronous-wps-conformance-class>>
|===

Metanorma supports encoding Requirements, Requirement Classes and Tests according to this syntax: https://www.metanorma.com/author/ogc/authoring/#recommendations-requirements-and-permissions

@manuel489 could you help convert all of these elements into the new syntax? Thanks!

manuelfuenmayor commented 4 years ago

Sure @ronaldtse , working on it!

manuelfuenmayor commented 4 years ago

Hi @ronaldtse , I'm not sure about how I should typeset the Tests. Could you please check a sample markup for me to see if I'm going well?

Ok, for example, for this part of the original doc:

capture-test

I'm using the following markup:

=== Basic WPS (Conformance Class)
The OGC URI identifier of this conformance class is: *http://www.opengis.net/spec/WPS/2.0/conf/service/profile/basic-wps*

[requeriment,type="verification"]
====

[requirement,type="general",label="Test id"]
======
conf/service/profile/basic-wps
======

[recommendation,type="general",label="Test purpose"]
======
Verify that the server implements the Basic WPS conformance class.
======

[requirement,type="general",label="Test method"]
======
Verify that the server implements the Synchronous WPS and/or the Asynchronous WPS conformance class. Verify that the requests and responses to a supported operation are syntactically correct. Verify that the service supports the Synchronous WPS Conformance class, the Asynchronous WPS Conformance class or both. Verify that all process offerings implement the native process model. Verify the following list of conformance tests:

- <<annex-subsec-process-xml-encoding>>, <<annex-subsec-process-data-types-xml-encoding>>
- <<annex-subsec-synchronous-wps-conformance-class>> and/or <<annex-subsec-asynchronous-wps-conformance-class>>
======

====

Which results in the following output:

capture-test-output

Am I right?

manuelfuenmayor commented 4 years ago

Am I right?

This question was answered here https://github.com/metanorma/mn-samples-ogc/pull/46

This task is pushed and merged. Closing.