plan-verify 0.0.0-stage → 0.1.0

package/test/golden/lint-unused-json.stdout

@@ -0,0 +1,37 @@
+{
+  "ok": false,
+  "spec": "examples/order-unused.ears.md",
+  "conflicts": [],
+  "gaps": [],
+  "misuse": [],
+  "wording": [],
+  "redundant": [],
+  "duplicate": [],
+  "vacuous": [],
+  "unused": [
+    {
+      "name": "loyalty",
+      "kind": "state",
+      "text": "loyalty (\"the customer is loyal\") is a state and no requirement mentions it.",
+      "fix": "Suggested fix: use loyalty in a requirement, or remove it from the schema."
+    },
+    {
+      "name": "region",
+      "kind": "input",
+      "text": "region (\"the region\") is an input and no requirement mentions it.",
+      "fix": "Suggested fix: use region in a requirement, or remove it from the schema."
+    },
+    {
+      "name": "receipt_sent",
+      "kind": "output",
+      "text": "Nothing sets receipt_sent (\"a receipt is sent\"). Requirements mention it, but no response says what it shall be.",
+      "fix": "Suggested fix: add a shall requirement that sets receipt_sent, or declare it as an input if the environment provides it. Do not choose the value."
+    },
+    {
+      "name": "Lane.refund",
+      "kind": "variant",
+      "text": "Lane.refund is never mentioned.",
+      "fix": "Suggested fix: use refund in a requirement, or remove it from Lane."
+    }
+  ]
+}

package/test/golden/lint-unused.exit

@@ -0,0 +1 @@
+1

package/test/golden/lint-unused.stdout

@@ -0,0 +1,25 @@
+spec: examples/order-unused.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 4
+
+unused loyalty
+loyalty ("the customer is loyal") is a state and no requirement mentions it.
+Suggested fix: use loyalty in a requirement, or remove it from the schema.
+
+unused region
+region ("the region") is an input and no requirement mentions it.
+Suggested fix: use region in a requirement, or remove it from the schema.
+
+unused receipt_sent
+Nothing sets receipt_sent ("a receipt is sent"). Requirements mention it, but no response says what it shall be.
+Suggested fix: add a shall requirement that sets receipt_sent, or declare it as an input if the environment provides it. Do not choose the value.
+
+unused Lane.refund
+Lane.refund is never mentioned.
+Suggested fix: use refund in a requirement, or remove it from Lane.

package/test/golden/lint-vacuous-json.exit

@@ -0,0 +1 @@
+1

package/test/golden/lint-vacuous-json.stdout

@@ -0,0 +1,27 @@
+{
+  "ok": false,
+  "spec": "examples/order-vacuous.ears.md",
+  "conflicts": [],
+  "gaps": [],
+  "misuse": [],
+  "wording": [],
+  "redundant": [],
+  "duplicate": [],
+  "vacuous": [
+    {
+      "id": "R1",
+      "line": 7,
+      "sentence": "When the cart is open and the cart is not open, the Checkout shall accept the order.",
+      "text": "R1 can never trigger. Its condition is impossible for every allowed value.",
+      "fix": "Suggested fix: rewrite the condition in R1 so a real situation can make it true, or remove the requirement. Do not invent a response."
+    },
+    {
+      "id": "R2",
+      "line": 8,
+      "sentence": "When the quantity is at least 9, the Checkout shall accept the order.",
+      "text": "R2 can never trigger. Its condition is impossible for every allowed value.",
+      "fix": "Suggested fix: rewrite the condition in R2 so a real situation can make it true, or remove the requirement. Do not invent a response."
+    }
+  ],
+  "unused": []
+}

package/test/golden/lint-vacuous.exit

@@ -0,0 +1 @@
+1

package/test/golden/lint-vacuous.stdout

@@ -0,0 +1,19 @@
+spec: examples/order-vacuous.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 2
+unused: 0
+
+vacuous R1 line 7
+R1 can never trigger. Its condition is impossible for every allowed value.
+When the cart is open and the cart is not open, the Checkout shall accept the order.
+Suggested fix: rewrite the condition in R1 so a real situation can make it true, or remove the requirement. Do not invent a response.
+
+vacuous R2 line 8
+R2 can never trigger. Its condition is impossible for every allowed value.
+When the quantity is at least 9, the Checkout shall accept the order.
+Suggested fix: rewrite the condition in R2 so a real situation can make it true, or remove the requirement. Do not invent a response.

package/test/golden/lint-vague.exit

@@ -0,0 +1 @@
+1

package/test/golden/lint-vague.stdout

@@ -0,0 +1,21 @@
+spec: examples/order-vague.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 3
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+wording line 4
+"fast" is too vague to test. Replace it with something a scenario can check.
+output order_fulfilled: Bool "The checkout is fast, appropriate, and user-friendly." phrase "fulfill the order" outcome "the order was fulfilled" / "the order was not fulfilled"
+
+wording line 4
+"appropriate" is too vague to test. Replace it with something a scenario can check.
+output order_fulfilled: Bool "The checkout is fast, appropriate, and user-friendly." phrase "fulfill the order" outcome "the order was fulfilled" / "the order was not fulfilled"
+
+wording line 4
+"user-friendly" is too vague to test. Replace it with something a scenario can check.
+output order_fulfilled: Bool "The checkout is fast, appropriate, and user-friendly." phrase "fulfill the order" outcome "the order was fulfilled" / "the order was not fulfilled"

package/test/golden/lint-wide.exit

@@ -0,0 +1 @@
+0

package/test/golden/lint-wide.stdout

@@ -0,0 +1,9 @@
+spec: examples/order-wide.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0

package/test/golden/lint-wording.exit

@@ -0,0 +1 @@
+1

package/test/golden/lint-wording.stdout

@@ -0,0 +1,21 @@
+spec: examples/order-wording.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 2
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 1
+
+wording line 4
+"quickly" is too vague to test. Replace it with something a scenario can check.
+output order_fulfilled: Bool "The system responds quickly." phrase "fulfill the order" outcome "the order was fulfilled" / "the order was not fulfilled"
+
+wording line 5
+"database" names a solution. Say what the system must do, not how to build it.
+state saved: Bool "Store the order in the database." phrase "the order is saved"
+
+unused saved
+saved ("the order is saved") is a state and no requirement mentions it.
+Suggested fix: use saved in a requirement, or remove it from the schema.

package/test/golden/malformed-scenario.exit

@@ -0,0 +1 @@
+2

package/test/golden/malformed-scenario.stderr

@@ -0,0 +1 @@
+error: examples/order-bad.json:2: expected '}'

package/test/golden/malformed-spec.exit

@@ -0,0 +1 @@
+2

package/test/golden/malformed-spec.stderr

@@ -0,0 +1 @@
+error: test/fixtures/malformed.ears.md:3: expected "shall"

package/test/golden/policy-counterexample.exit

@@ -0,0 +1 @@
+1

package/test/golden/policy-counterexample.stdout

@@ -0,0 +1,13 @@
+spec: examples/order.ears.md
+property: examples/order-always.ears.md
+counterexample:
+{
+  "order_submitted": false,
+  "inventory_available": false,
+  "order_fulfilled": false
+}
+This scenario satisfies every requirement and violates the property.
+
+P1 line 3
+The Order System shall fulfill the order.
+The order was not fulfilled.

package/test/golden/policy-covered.exit

@@ -0,0 +1 @@
+0

package/test/golden/policy-covered.stdout

@@ -0,0 +1,19 @@
+spec: examples/order-covered.ears.md
+accepted:
+{
+  "order_submitted": false,
+  "inventory_available": false,
+  "order_fulfilled": false
+}
+This scenario satisfies every requirement.
+rejected:
+{
+  "order_submitted": false,
+  "inventory_available": false,
+  "order_fulfilled": true
+}
+This scenario violates a requirement.
+
+R3 line 9
+When an order is not submitted, the Order System shall not fulfill the order.
+An order was not submitted, but the order was fulfilled.

package/test/golden/policy-holds.exit

@@ -0,0 +1 @@
+0

package/test/golden/policy-holds.stdout

@@ -0,0 +1,3 @@
+spec: examples/order.ears.md
+property: examples/order-same.ears.md
+No scenario satisfies every requirement and violates the property.

package/test/golden/policy-json.exit

@@ -0,0 +1 @@
+1

package/test/golden/policy-json.stdout

@@ -0,0 +1,34 @@
+{
+  "ok": false,
+  "spec": "examples/order.ears.md",
+  "property": "examples/order-always.ears.md",
+  "holds": false,
+  "note": "",
+  "acceptedFound": false,
+  "accepted": [],
+  "rejectedFound": false,
+  "rejected": [],
+  "counterexampleFound": true,
+  "counterexample": [
+    {
+      "name": "order_submitted",
+      "value": "false"
+    },
+    {
+      "name": "inventory_available",
+      "value": "false"
+    },
+    {
+      "name": "order_fulfilled",
+      "value": "false"
+    }
+  ],
+  "breaks": [
+    {
+      "id": "P1",
+      "line": 3,
+      "sentence": "The Order System shall fulfill the order.",
+      "because": "The order was not fulfilled."
+    }
+  ]
+}

package/test/golden/policy-status.exit

@@ -0,0 +1 @@
+0

package/test/golden/policy-status.stdout

@@ -0,0 +1,16 @@
+spec: examples/order-status.ears.md
+accepted:
+No scenario satisfies every requirement.
+rejected:
+{
+  "status": "placed"
+}
+This scenario violates a requirement.
+
+R6 line 6
+The Order System shall mark the order shipped.
+The order was placed.
+
+R7 line 7
+The Order System shall mark the order cancelled.
+The order was placed.

package/test/golden/policy-vacuous.exit

@@ -0,0 +1 @@
+0

package/test/golden/policy-vacuous.stdout

@@ -0,0 +1,3 @@
+spec: examples/order-status.ears.md
+property: examples/status-placed.ears.md
+No scenario satisfies every requirement, so none violates the property.

package/test/golden/policy-wide.exit

@@ -0,0 +1 @@
+0

package/test/golden/policy-wide.stdout

@@ -0,0 +1,15 @@
+spec: examples/order-wide.ears.md
+accepted:
+{
+  "quantity": 0
+}
+This scenario satisfies every requirement.
+rejected:
+{
+  "quantity": 1
+}
+This scenario violates a requirement.
+
+R1 line 5
+The Counter shall count 0.
+The quantity was 1.

package/test/golden/policy.exit

@@ -0,0 +1 @@
+0

package/test/golden/policy.stdout

@@ -0,0 +1,19 @@
+spec: examples/order.ears.md
+accepted:
+{
+  "order_submitted": false,
+  "inventory_available": false,
+  "order_fulfilled": false
+}
+This scenario satisfies every requirement.
+rejected:
+{
+  "order_submitted": true,
+  "inventory_available": true,
+  "order_fulfilled": false
+}
+This scenario violates a requirement.
+
+R1 line 7
+WHEN an order is submitted AND inventory is available, THE Order System SHALL fulfill the order.
+An order was submitted and inventory was available, but the order was not fulfilled.

package/test/golden/scenarios-json.exit

@@ -0,0 +1 @@
+0

package/test/golden/scenarios-json.stdout

@@ -0,0 +1,75 @@
+{
+  "ok": true,
+  "spec": "examples/order.ears.md",
+  "scenarios": [
+    {
+      "id": "R1",
+      "line": 7,
+      "kind": "accepted",
+      "trigger": "true",
+      "found": true,
+      "sameAs": "",
+      "scenario": [
+        {
+          "name": "order_submitted",
+          "value": "true"
+        },
+        {
+          "name": "inventory_available",
+          "value": "true"
+        },
+        {
+          "name": "order_fulfilled",
+          "value": "true"
+        }
+      ],
+      "text": "An order was submitted and inventory was available, and the order was fulfilled."
+    },
+    {
+      "id": "R1",
+      "line": 7,
+      "kind": "accepted",
+      "trigger": "false",
+      "found": true,
+      "sameAs": "",
+      "scenario": [
+        {
+          "name": "order_submitted",
+          "value": "false"
+        },
+        {
+          "name": "inventory_available",
+          "value": "false"
+        },
+        {
+          "name": "order_fulfilled",
+          "value": "false"
+        }
+      ],
+      "text": "An order was not submitted and inventory was not available, and the order was not fulfilled."
+    },
+    {
+      "id": "R1",
+      "line": 7,
+      "kind": "rejected",
+      "trigger": "true",
+      "found": true,
+      "sameAs": "",
+      "scenario": [
+        {
+          "name": "order_submitted",
+          "value": "true"
+        },
+        {
+          "name": "inventory_available",
+          "value": "true"
+        },
+        {
+          "name": "order_fulfilled",
+          "value": "false"
+        }
+      ],
+      "text": "An order was submitted and inventory was available, but the order was not fulfilled."
+    }
+  ]
+}

package/test/golden/scenarios-status.exit

@@ -0,0 +1 @@
+0

package/test/golden/scenarios-status.stdout

@@ -0,0 +1,24 @@
+spec: examples/order-status.ears.md
+scenarios: 6
+
+R6 accepted, trigger true
+No scenario satisfies every requirement while this trigger is true.
+
+R6 accepted, trigger false
+R6 has no trigger, so there is no case where the trigger is false.
+
+R6 rejected, trigger true
+{
+  "status": "placed"
+}
+The order was placed.
+
+R7 accepted, trigger true
+No scenario satisfies every requirement while this trigger is true.
+
+R7 accepted, trigger false
+R7 has no trigger, so there is no case where the trigger is false.
+
+R7 rejected, trigger true
+Same scenario as R6 rejected, trigger true.
+The order was placed.

package/test/golden/scenarios.exit

@@ -0,0 +1 @@
+0

package/test/golden/scenarios.stdout

@@ -0,0 +1,26 @@
+spec: examples/order.ears.md
+scenarios: 3
+
+R1 accepted, trigger true
+{
+  "order_submitted": true,
+  "inventory_available": true,
+  "order_fulfilled": true
+}
+An order was submitted and inventory was available, and the order was fulfilled.
+
+R1 accepted, trigger false
+{
+  "order_submitted": false,
+  "inventory_available": false,
+  "order_fulfilled": false
+}
+An order was not submitted and inventory was not available, and the order was not fulfilled.
+
+R1 rejected, trigger true
+{
+  "order_submitted": true,
+  "inventory_available": true,
+  "order_fulfilled": false
+}
+An order was submitted and inventory was available, but the order was not fulfilled.

package/test/golden/unit.exit

@@ -0,0 +1 @@
+0

package/test/golden/unit.stdout

@@ -0,0 +1,2 @@
+soundness specs: 1010
+passed 277

package/test/golden/unknown-phrase.exit

@@ -0,0 +1 @@
+2

package/test/golden/unknown-phrase.stderr

@@ -0,0 +1 @@
+error: test/fixtures/unknown-phrase.ears.md:5: unknown phrase "an order was submitted". Closest: "an order is submitted", "inventory is available", "fulfill the order".

package/test/golden/usage.exit

@@ -0,0 +1 @@
+2

package/test/golden/usage.stderr

@@ -0,0 +1,9 @@
+error: missing command
+usage:
+  plan-verify check [--json] <spec> --input <scenario>
+  plan-verify emit-smt [--json] <spec>
+  plan-verify lint [--json] <spec>
+  plan-verify report <spec>
+  plan-verify scenarios [--json] <spec>
+  plan-verify policy [--json] <spec> [--property <file>]
+  plan-verify help