Schema: robos:StepDefinition

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:StepDefinition in the testing package store.

Table of contents

  1. Specification Metadata
  2. Upstream Schema Basis (Refers From) & Global Standards Provenance
  3. Entity Relationship & Schema Context
  4. Property Constraints & SHACL Rules
  5. Canonical OSLC JSON-LD Example
  6. Programmatic SHACL Validation

Specification Metadata


Upstream Schema Basis (Refers From) & Global Standards Provenance

This RobOS schema is modeled after and directly aligns with two levels of global standards:


Entity Relationship & Schema Context

Step Definition robos:StepDefinition

Governed by W3C SHACL shape urn:robos:shape:StepDefinitionShape within the Testing, Quality & BDD (robos.testing) (robos.testing) package store.

dcterms:title robos:regexPattern robos:codeFile

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string Step Definition must have a title.
robos:regexPattern Regex Pattern 1..* xsd:string Step Definition must specify matching regex expression.
robos:codeFile Code File 1..* xsd:string Step Definition must link to implementation source file.

Canonical OSLC JSON-LD Example

{
  "@id": "urn:robos:stepdef:customer-submits-order",
  "@type": [
    "robos:StepDefinition",
    "schema:SoftwareSourceCode"
  ],
  "dcterms:title": "StepDef: Customer Submits Order",
  "robos:regexPattern": "^the customer submits order with total \\$(\\d+)$",
  "robos:codeFile": "tests/steps/checkout_steps.js",
  "robos:functionName": "submitOrderStep",
  "robos:package": "testing",
  "robos:namespace": "robos.testing",
  "robos:refersFrom": "https://cucumber.io/docs/cucumber/step-definitions/",
  "robos:schemaOrgType": "https://schema.org/SoftwareSourceCode",
  "robos:domainStandard": "https://cucumber.io/docs/cucumber/step-definitions/"
}

Programmatic SHACL Validation

const { SHACLValidator } = require('/usr/local/share/robos/robos-graph/lib/shacl-validator');
const { OSLCGraphParser, OSLC_CONTEXT } = require('/usr/local/share/robos/robos-graph/lib/oslc-parser');

const validator = new SHACLValidator();
const result = validator.validateGraph(new OSLCGraphParser({
  "@context": OSLC_CONTEXT,
  "robos:nodes": [
    {
        "@id": "urn:robos:stepdef:customer-submits-order",
        "@type": [
            "robos:StepDefinition",
            "schema:SoftwareSourceCode"
        ],
        "dcterms:title": "StepDef: Customer Submits Order",
        "robos:regexPattern": "^the customer submits order with total \\$(\\d+)$",
        "robos:codeFile": "tests/steps/checkout_steps.js",
        "robos:functionName": "submitOrderStep",
        "robos:package": "testing",
        "robos:namespace": "robos.testing",
        "robos:refersFrom": "https://cucumber.io/docs/cucumber/step-definitions/",
        "robos:schemaOrgType": "https://schema.org/SoftwareSourceCode",
        "robos:domainStandard": "https://cucumber.io/docs/cucumber/step-definitions/"
    }
  ],
}));

console.log("Conforms:", result.conforms); // Expected: true