@portll/cobolwork 0.6.0 → 0.7.0

package/schema/cobolwork-capabilities.schema.json

@@ -0,0 +1,239 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://github.com/Portll/cobolwork/schema/cobolwork-capabilities.schema.json",
+ "title": "cobolwork capabilities",
+ "description": "What this cobolwork can do: cobolwork capabilities. A later minor release may add keys; a reader ignores keys it does not know.",
+ "type": "object",
+ "required": [
+  "tool",
+  "schemaVersion",
+  "toolVersion",
+  "toolRevision",
+  "commands",
+  "globalOptions",
+  "documents",
+  "identity",
+  "analysis",
+  "sourceKinds",
+  "evidenceKinds",
+  "build",
+  "gate",
+  "ironwork"
+ ],
+ "properties": {
+  "tool": {
+   "const": "cobolwork-capabilities"
+  },
+  "schemaVersion": {
+   "const": 1
+  },
+  "toolVersion": {
+   "type": "string"
+  },
+  "toolRevision": {
+   "$ref": "#/$defs/revision"
+  },
+  "commands": {
+   "type": "object",
+   "description": "Each command, what it takes and what it writes.",
+   "additionalProperties": {
+    "type": "object",
+    "required": [
+     "args",
+     "options",
+     "documents"
+    ],
+    "properties": {
+     "args": {
+      "$ref": "#/$defs/strings"
+     },
+     "options": {
+      "$ref": "#/$defs/strings"
+     },
+     "documents": {
+      "$ref": "#/$defs/strings",
+      "description": "The tool names of the documents the command writes."
+     }
+    }
+   }
+  },
+  "globalOptions": {
+   "$ref": "#/$defs/strings"
+  },
+  "documents": {
+   "type": "object",
+   "description": "Each document's tool name and its schemaVersion, or the standard version of a SARIF or CycloneDX document.",
+   "additionalProperties": {
+    "type": [
+     "integer",
+     "string"
+    ]
+   }
+  },
+  "identity": {
+   "type": "object",
+   "required": [
+    "version"
+   ],
+   "properties": {
+    "version": {
+     "const": "cobolwork/v1",
+     "description": "The fingerprint version."
+    }
+   }
+  },
+  "analysis": {
+   "type": "object",
+   "required": [
+    "flowModel",
+    "ruleSets",
+    "rules"
+   ],
+   "properties": {
+    "flowModel": {
+     "type": "string"
+    },
+    "ruleSets": {
+     "$ref": "#/$defs/strings"
+    },
+    "rules": {
+     "type": "integer",
+     "minimum": 0
+    }
+   }
+  },
+  "sourceKinds": {
+   "type": "object",
+   "description": "Which files are read as each kind of source.",
+   "additionalProperties": {
+    "type": [
+     "array",
+     "string"
+    ]
+   }
+  },
+  "evidenceKinds": {
+   "$ref": "#/$defs/strings"
+  },
+  "build": {
+   "type": "object",
+   "required": [
+    "tiers",
+    "classes",
+    "checks",
+    "compilers",
+    "defaultPolicy",
+    "exit"
+   ],
+   "properties": {
+    "tiers": {
+     "$ref": "#/$defs/strings"
+    },
+    "classes": {
+     "$ref": "#/$defs/strings"
+    },
+    "checks": {
+     "$ref": "#/$defs/strings"
+    },
+    "compilers": {
+     "$ref": "#/$defs/strings"
+    },
+    "defaultPolicy": {
+     "type": "object",
+     "description": "The policy a build applies when none is given, as schema/cobolwork.policy.schema.json describes it."
+    },
+    "exit": {
+     "$ref": "#/$defs/exit"
+    }
+   }
+  },
+  "gate": {
+   "type": "object",
+   "required": [
+    "exit"
+   ],
+   "properties": {
+    "exit": {
+     "$ref": "#/$defs/exit"
+    }
+   }
+  },
+  "ironwork": {
+   "type": "object",
+   "description": "The ironwork releases this cobolwork reads.",
+   "required": [
+    "minimum",
+    "formats",
+    "runEndings",
+    "notRunAbends"
+   ],
+   "properties": {
+    "minimum": {
+     "type": "string"
+    },
+    "formats": {
+     "type": "object",
+     "description": "Each format cobolwork reads from ironwork, and the first ironwork release that writes it.",
+     "additionalProperties": {
+      "type": "string"
+     }
+    },
+    "runEndings": {
+     "type": "object",
+     "description": "Each exit status ironwork keeps for itself, and what it means.",
+     "additionalProperties": {
+      "type": "string"
+     }
+    },
+    "notRunAbends": {
+     "$ref": "#/$defs/strings"
+    }
+   }
+  }
+ },
+ "$defs": {
+  "strings": {
+   "type": "array",
+   "items": {
+    "type": "string"
+   }
+  },
+  "exit": {
+   "type": "object",
+   "description": "Each verdict and the exit status that reports it.",
+   "additionalProperties": {
+    "type": "integer"
+   }
+  },
+  "revision": {
+   "type": [
+    "object",
+    "null"
+   ],
+   "description": "The commit cobolwork was built from, whether its tree held changes, the release tag, and whether this was read from a checkout or the release; null where none of them can be read.",
+   "properties": {
+    "commit": {
+     "type": [
+      "string",
+      "null"
+     ]
+    },
+    "dirty": {
+     "type": [
+      "boolean",
+      "null"
+     ]
+    },
+    "tag": {
+     "type": "string"
+    },
+    "from": {
+     "enum": [
+      "checkout",
+      "release"
+     ]
+    }
+   }
+  }
+ }
+}

package/schema/cobolwork-diff.schema.json

@@ -0,0 +1,217 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://github.com/Portll/cobolwork/schema/cobolwork-diff.schema.json",
+ "title": "cobolwork diff report",
+ "description": "What a change between two revisions did: findings it introduced and resolved, and layout and call changes. A later minor release may add keys; a reader ignores keys it does not know.",
+ "type": "object",
+ "required": [
+  "tool",
+  "schemaVersion",
+  "summary",
+  "findings",
+  "introduced",
+  "resolved"
+ ],
+ "properties": {
+  "tool": {
+   "const": "cobolwork-diff"
+  },
+  "schemaVersion": {
+   "const": 3
+  },
+  "findings": {
+   "type": "array",
+   "items": {
+    "$ref": "cobolwork-finding.schema.json"
+   },
+   "description": "Findings about the change itself: layout and call changes."
+  },
+  "introduced": {
+   "type": "array",
+   "items": {
+    "$ref": "cobolwork-finding.schema.json"
+   }
+  },
+  "resolved": {
+   "type": "array",
+   "items": {
+    "$ref": "cobolwork-finding.schema.json"
+   }
+  },
+  "ruleText": {
+   "type": "object",
+   "additionalProperties": {
+    "type": "string"
+   }
+  },
+  "ruleEvidence": {
+   "type": "object",
+   "additionalProperties": {
+    "type": "string"
+   }
+  },
+  "summary": {
+   "type": "object",
+   "required": [
+    "flowModel",
+    "toolVersion",
+    "findings",
+    "byRule",
+    "introduced",
+    "resolved",
+    "coverageIncomplete"
+   ],
+   "properties": {
+    "flowModel": {
+     "type": "string"
+    },
+    "toolVersion": {
+     "type": "string"
+    },
+    "findings": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "byRule": {
+     "type": "object",
+     "additionalProperties": {
+      "type": "integer",
+      "minimum": 0
+     }
+    },
+    "introduced": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "resolved": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "programsCompared": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "programsAdded": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "programsRemoved": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "programsWithLayoutChange": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "reachedOnlyThroughCopybooks": {
+     "type": "integer",
+     "minimum": 0
+    },
+    "copybooksImplicated": {
+     "type": "array",
+     "items": {
+      "type": "string"
+     }
+    },
+    "unread": {
+     "type": "object",
+     "description": "What could not be read on each side, and the findings that could not be compared for it.",
+     "properties": {
+      "base": {
+       "type": "array"
+      },
+      "head": {
+       "type": "array"
+      },
+      "findingsNotCompared": {
+       "type": "array",
+       "items": {
+        "type": "string"
+       }
+      }
+     }
+    },
+    "configurationChanged": {
+     "type": "array",
+     "items": {
+      "type": "object",
+      "properties": {
+       "file": {
+        "type": "string"
+       },
+       "change": {
+        "type": "string"
+       }
+      }
+     }
+    },
+    "coverageIncomplete": {
+     "type": "boolean"
+    },
+    "nosrc": {
+     "type": "boolean"
+    },
+    "base": {
+     "type": "string"
+    },
+    "head": {
+     "type": "string"
+    },
+    "toolRevision": {
+     "type": [
+      "object",
+      "null"
+     ],
+     "description": "A commit and whether its tree held changes, with where it was read.",
+     "properties": {
+      "commit": {
+       "type": [
+        "string",
+        "null"
+       ]
+      },
+      "dirty": {
+       "type": [
+        "boolean",
+        "null"
+       ]
+      },
+      "tag": {
+       "type": "string"
+      },
+      "from": {
+       "type": "string"
+      }
+     }
+    },
+    "revision": {
+     "type": [
+      "object",
+      "null"
+     ],
+     "description": "A commit and whether its tree held changes, with where it was read.",
+     "properties": {
+      "commit": {
+       "type": [
+        "string",
+        "null"
+       ]
+      },
+      "dirty": {
+       "type": [
+        "boolean",
+        "null"
+       ]
+      },
+      "tag": {
+       "type": "string"
+      },
+      "from": {
+       "type": "string"
+      }
+     }
+    }
+   }
+  }
+ }
+}

package/schema/cobolwork-evidence.schema.json

@@ -0,0 +1,161 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://github.com/Portll/cobolwork/schema/cobolwork-evidence.schema.json",
+ "title": "cobolwork evidence output",
+ "description": "What cobolwork evidence verify, seal and anchor report. evidence sign writes a DSSE envelope instead. docs/spec/evidence.md. A later minor release may add keys; a reader ignores keys it does not know.",
+ "type": "object",
+ "required": [
+  "tool",
+  "schemaVersion",
+  "verb"
+ ],
+ "properties": {
+  "tool": {
+   "const": "cobolwork-evidence"
+  },
+  "schemaVersion": {
+   "const": 1
+  },
+  "verb": {
+   "enum": [
+    "verify",
+    "seal",
+    "anchor"
+   ]
+  },
+  "verified": {
+   "type": "boolean",
+   "description": "verify: every record and seal checked out."
+  },
+  "broken": {
+   "type": "array",
+   "description": "verify: each check that failed, where.",
+   "items": {
+    "type": "object"
+   }
+  },
+  "unrecorded": {
+   "type": "array",
+   "items": {
+    "type": "object"
+   }
+  },
+  "open": {
+   "type": "array",
+   "items": {
+    "type": "object"
+   }
+  },
+  "anchored": {
+   "type": [
+    "object",
+    "boolean",
+    "null"
+   ]
+  },
+  "sealed": {
+   "type": [
+    "boolean",
+    "null"
+   ]
+  },
+  "sealedReason": {
+   "type": [
+    "string",
+    "null"
+   ]
+  },
+  "unsealedTail": {
+   "type": [
+    "integer",
+    "null"
+   ]
+  },
+  "signatures": {
+   "type": "array",
+   "items": {
+    "type": "object"
+   }
+  },
+  "seals": {
+   "type": "array",
+   "items": {
+    "type": "object"
+   }
+  },
+  "exit": {
+   "enum": [
+    0,
+    1,
+    3
+   ],
+   "description": "verify: the exit status the command ends with."
+  },
+  "compliance": {
+   "type": "array",
+   "items": {
+    "type": "object",
+    "required": [
+     "evidenceId",
+     "framework",
+     "clause"
+    ],
+    "properties": {
+     "evidenceId": {
+      "enum": [
+       "journal-records",
+       "journal-chain"
+      ]
+     },
+     "framework": {
+      "type": "string"
+     },
+     "clause": {
+      "type": "string"
+     },
+     "title": {
+      "type": "string"
+     }
+    }
+   },
+   "description": "verify: each framework clause the verified evidence answers (rules/compliance-*.json evidence): journal-records when a run journal is present, journal-chain when the chain verifies too."
+  },
+  "seq": {
+   "type": "integer",
+   "minimum": 0,
+   "description": "seal: the seal's number."
+  },
+  "path": {
+   "type": "string"
+  },
+  "sha256": {
+   "type": "string",
+   "pattern": "^[0-9a-f]{64}$"
+  },
+  "signed": {
+   "type": "boolean"
+  },
+  "ledgerLength": {
+   "type": "integer",
+   "minimum": 0
+  },
+  "tip": {
+   "type": "string",
+   "pattern": "^[0-9a-f]{64}$"
+  },
+  "anchor": {
+   "type": "object",
+   "description": "seal with --anchor-git or --tsq: what anchor reports."
+  },
+  "seal": {
+   "type": "string",
+   "description": "anchor: the seal anchored."
+  },
+  "git": {
+   "type": "object"
+  },
+  "tsq": {
+   "type": "object"
+  }
+ }
+}

package/schema/cobolwork-execution.schema.json

@@ -0,0 +1,53 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://github.com/Portll/cobolwork/schema/cobolwork-execution.schema.json",
+ "title": "What cobolwork reads from an execution coverage report",
+ "description": "COBOLWORK_EXECUTION names coverage reports that ironwork run --coverage writes, from ironwork 0.2.0. The format is ironwork's, so this schema describes only the keys lib/execution.mjs reads and allows every other key. docs/spec/evidence.md section 13.5.",
+ "type": "object",
+ "required": [
+  "programs"
+ ],
+ "properties": {
+  "programs": {
+   "type": "array",
+   "items": {
+    "type": "object",
+    "required": [
+     "program",
+     "detail"
+    ],
+    "properties": {
+     "program": {
+      "type": "string",
+      "description": "The PROGRAM-ID."
+     },
+     "detail": {
+      "type": "array",
+      "description": "Each paragraph of the program.",
+      "items": {
+       "type": "object",
+       "required": [
+        "name",
+        "line",
+        "entered"
+       ],
+       "properties": {
+        "name": {
+         "type": "string"
+        },
+        "line": {
+         "type": "integer"
+        },
+        "entered": {
+         "type": "integer",
+         "minimum": 0,
+         "description": "How many times a run entered the paragraph."
+        }
+       }
+      }
+     }
+    }
+   }
+  }
+ }
+}