plan-verify 0.0.0-stage → 0.1.0

package/test/golden/lint-clear.stdout

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

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

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

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

@@ -0,0 +1,80 @@
+{
+  "ok": false,
+  "spec": "examples/order-conflict.ears.md",
+  "conflicts": [
+    {
+      "ids": [
+        "R2",
+        "R3"
+      ],
+      "minimal": true,
+      "everySituation": false,
+      "summary": "R2 and R3 cannot both hold.",
+      "clash": "They clash when an order was submitted.",
+      "requirements": [
+        {
+          "id": "R2",
+          "line": 7,
+          "sentence": "When an order is submitted, the Order System shall fulfill the order."
+        },
+        {
+          "id": "R3",
+          "line": 8,
+          "sentence": "When an order is submitted, the Order System shall not fulfill the order."
+        }
+      ],
+      "situation": [
+        {
+          "name": "order_submitted",
+          "value": "true"
+        }
+      ],
+      "requires": [
+        {
+          "id": "R2",
+          "text": "that the order was fulfilled"
+        },
+        {
+          "id": "R3",
+          "text": "that the order was not fulfilled"
+        }
+      ],
+      "example": [
+        {
+          "name": "order_submitted",
+          "value": "true"
+        },
+        {
+          "name": "order_fulfilled",
+          "value": "true"
+        }
+      ],
+      "keeps": [
+        "R2"
+      ],
+      "breaks": "R3",
+      "fix": "Suggested fix: ask which requirement should win. To keep R2, remove R3. To keep R3, remove R2.",
+      "repairs": [
+        {
+          "kind": "drop",
+          "id": "R2",
+          "text": "One repair is to drop R2 and keep R3 as written.",
+          "sentence": "When an order is submitted, the Order System shall not fulfill the order."
+        },
+        {
+          "kind": "drop",
+          "id": "R3",
+          "text": "One repair is to drop R3 and keep R2 as written.",
+          "sentence": "When an order is submitted, the Order System shall fulfill the order."
+        }
+      ]
+    }
+  ],
+  "gaps": [],
+  "misuse": [],
+  "wording": [],
+  "redundant": [],
+  "duplicate": [],
+  "vacuous": [],
+  "unused": []
+}

package/test/golden/lint-conflict.exit

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

package/test/golden/lint-conflict.stdout

@@ -0,0 +1,41 @@
+spec: examples/order-conflict.ears.md
+conflicts: 1
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+conflict {R2, R3}
+R2 and R3 cannot both hold.
+
+R2 line 7
+When an order is submitted, the Order System shall fulfill the order.
+
+R3 line 8
+When an order is submitted, the Order System shall not fulfill the order.
+
+They clash when an order was submitted.
+R2 requires that the order was fulfilled.
+R3 requires that the order was not fulfilled.
+
+Example scenario:
+{
+  "order_submitted": true,
+  "order_fulfilled": true
+}
+This scenario keeps R2 and breaks R3.
+
+Suggested fix: ask which requirement should win. To keep R2, remove R3. To keep R3, remove R2.
+
+Candidate repairs follow. This report does not choose one.
+
+repair drop R2
+One repair is to drop R2 and keep R3 as written.
+When an order is submitted, the Order System shall not fulfill the order.
+
+repair drop R3
+One repair is to drop R3 and keep R2 as written.
+When an order is submitted, the Order System shall fulfill the order.

package/test/golden/lint-duplicate.exit

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

package/test/golden/lint-duplicate.stdout

@@ -0,0 +1,14 @@
+spec: examples/order-duplicate.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 1
+vacuous: 0
+unused: 0
+
+duplicate R2 line 7
+R2 duplicates R1. The condition and the response are the same.
+When an order is submitted, the Order System shall fulfill the order.
+Suggested fix: remove R2, or ask whether it was meant to differ from R1. Do not delete it until the PM agrees.

package/test/golden/lint-gap.exit

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

package/test/golden/lint-gap.stdout

@@ -0,0 +1,12 @@
+spec: examples/order.ears.md
+conflicts: 0
+gaps: 1
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+gap order_fulfilled
+Nothing says whether the order was fulfilled when an order was submitted and inventory was not available. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response.

package/test/golden/lint-misuse.exit

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

package/test/golden/lint-misuse.stdout

@@ -0,0 +1,18 @@
+spec: examples/order-misuse.ears.md
+conflicts: 0
+gaps: 0
+misuse: 1
+wording: 0
+redundant: 1
+duplicate: 0
+vacuous: 0
+unused: 0
+
+misuse R4 line 6
+"payment fails" is an unwanted event. Write if ... then, not when.
+When payment fails, the Order System shall reject the order.
+
+redundant R4 line 6
+R4 adds nothing. Whenever the other requirements hold, R4 holds too.
+When payment fails, the Order System shall reject the order.
+Suggested fix: remove R4, or ask whether it was meant to say something the others do not already require. Do not delete it until the PM agrees.

package/test/golden/lint-negation.exit

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

package/test/golden/lint-negation.stdout

@@ -0,0 +1,13 @@
+spec: examples/order-negation.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 1
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+wording line 6
+The trigger is a bare negation. Write a positive condition, such as "When a non-member asks", or declare a positive event.
+When not a member asks to take a copy home, the Desk shall not allow the loan.

package/test/golden/lint-quantity.exit

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

package/test/golden/lint-quantity.stdout

@@ -0,0 +1,41 @@
+spec: examples/order-quantity.ears.md
+conflicts: 1
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+conflict {R4, R5}
+R4 and R5 cannot both hold.
+
+R4 line 7
+When an order is submitted, the Order System shall accept at most 10 units.
+
+R5 line 8
+When an order is submitted, the Order System shall accept 12 units.
+
+They clash when an order was submitted.
+R4 requires that at most 10 units were accepted.
+R5 requires that 12 units were accepted.
+
+Example scenario:
+{
+  "order_submitted": true,
+  "quantity": 0
+}
+This scenario keeps R4 and breaks R5.
+
+Suggested fix: ask which requirement should win. To keep R4, remove R5. To keep R5, remove R4.
+
+Candidate repairs follow. This report does not choose one.
+
+repair drop R4
+One repair is to drop R4 and keep R5 as written.
+When an order is submitted, the Order System shall accept 12 units.
+
+repair drop R5
+One repair is to drop R5 and keep R4 as written.
+When an order is submitted, the Order System shall accept at most 10 units.

package/test/golden/lint-redundant.exit

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

package/test/golden/lint-redundant.stdout

@@ -0,0 +1,14 @@
+spec: examples/order-redundant.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 1
+duplicate: 0
+vacuous: 0
+unused: 0
+
+redundant R2 line 8
+R2 adds nothing. Whenever the other requirements hold, R2 holds too.
+When an order is submitted and inventory is available, the Order System shall fulfill the order.
+Suggested fix: remove R2, or ask whether it was meant to say something the others do not already require. Do not delete it until the PM agrees.

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

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

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

@@ -0,0 +1,127 @@
+{
+  "ok": false,
+  "spec": "examples/order-repair.ears.md",
+  "conflicts": [
+    {
+      "ids": [
+        "R1",
+        "R2"
+      ],
+      "minimal": true,
+      "everySituation": false,
+      "summary": "R1 and R2 cannot both hold.",
+      "clash": "They clash when the copy was in the building, the copy was out on loan, and a member asks to take a copy home.",
+      "requirements": [
+        {
+          "id": "R1",
+          "line": 8,
+          "sentence": "While the copy is in the building, when a member asks to take a copy home, the Desk shall allow the loan."
+        },
+        {
+          "id": "R2",
+          "line": 9,
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home, the Desk shall not allow the loan."
+        }
+      ],
+      "situation": [
+        {
+          "name": "copy_in_building",
+          "value": "true"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        }
+      ],
+      "requires": [
+        {
+          "id": "R1",
+          "text": "that the loan was allowed"
+        },
+        {
+          "id": "R2",
+          "text": "that the loan was not allowed"
+        }
+      ],
+      "example": [
+        {
+          "name": "copy_in_building",
+          "value": "true"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        },
+        {
+          "name": "loan_allowed",
+          "value": "true"
+        }
+      ],
+      "keeps": [
+        "R1"
+      ],
+      "breaks": "R2",
+      "fix": "Suggested fix: ask which requirement should win. To keep R1, remove R2. To keep R2, remove R1.",
+      "repairs": [
+        {
+          "kind": "drop",
+          "id": "R1",
+          "text": "One repair is to drop R1 and keep R2 as written.",
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home, the Desk shall not allow the loan."
+        },
+        {
+          "kind": "drop",
+          "id": "R2",
+          "text": "One repair is to drop R2 and keep R1 as written.",
+          "sentence": "While the copy is in the building, when a member asks to take a copy home, the Desk shall allow the loan."
+        },
+        {
+          "kind": "strengthen",
+          "id": "R1",
+          "text": "One repair is to add \"and the copy is not out on loan\" to the condition of R1. R2 stays as written.",
+          "sentence": "While the copy is in the building, when a member asks to take a copy home and the copy is not out on loan, the Desk shall allow the loan."
+        },
+        {
+          "kind": "strengthen",
+          "id": "R2",
+          "text": "One repair is to add \"and the copy is not in the building\" to the condition of R2. R1 stays as written.",
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home and the copy is not in the building, the Desk shall not allow the loan."
+        }
+      ]
+    }
+  ],
+  "gaps": [
+    {
+      "output": "loan_allowed",
+      "situation": [
+        {
+          "name": "copy_in_building",
+          "value": "true"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "borrow_requested",
+          "value": "false"
+        }
+      ],
+      "text": "Nothing says whether the loan was allowed when the copy was in the building, the copy was out on loan, and not a member asks to take a copy home. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response."
+    }
+  ],
+  "misuse": [],
+  "wording": [],
+  "redundant": [],
+  "duplicate": [],
+  "vacuous": [],
+  "unused": []
+}

package/test/golden/lint-repair.exit

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

package/test/golden/lint-repair.stdout

@@ -0,0 +1,54 @@
+spec: examples/order-repair.ears.md
+conflicts: 1
+gaps: 1
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+conflict {R1, R2}
+R1 and R2 cannot both hold.
+
+R1 line 8
+While the copy is in the building, when a member asks to take a copy home, the Desk shall allow the loan.
+
+R2 line 9
+While the copy is out on loan, when a member asks to take a copy home, the Desk shall not allow the loan.
+
+They clash when the copy was in the building, the copy was out on loan, and a member asks to take a copy home.
+R1 requires that the loan was allowed.
+R2 requires that the loan was not allowed.
+
+Example scenario:
+{
+  "copy_in_building": true,
+  "copy_on_loan": true,
+  "borrow_requested": true,
+  "loan_allowed": true
+}
+This scenario keeps R1 and breaks R2.
+
+Suggested fix: ask which requirement should win. To keep R1, remove R2. To keep R2, remove R1.
+
+Candidate repairs follow. This report does not choose one.
+
+repair drop R1
+One repair is to drop R1 and keep R2 as written.
+While the copy is out on loan, when a member asks to take a copy home, the Desk shall not allow the loan.
+
+repair drop R2
+One repair is to drop R2 and keep R1 as written.
+While the copy is in the building, when a member asks to take a copy home, the Desk shall allow the loan.
+
+repair strengthen R1
+One repair is to add "and the copy is not out on loan" to the condition of R1. R2 stays as written.
+While the copy is in the building, when a member asks to take a copy home and the copy is not out on loan, the Desk shall allow the loan.
+
+repair strengthen R2
+One repair is to add "and the copy is not in the building" to the condition of R2. R1 stays as written.
+While the copy is out on loan, when a member asks to take a copy home and the copy is not in the building, the Desk shall not allow the loan.
+
+gap loan_allowed
+Nothing says whether the loan was allowed when the copy was in the building, the copy was out on loan, and not a member asks to take a copy home. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response.

package/test/golden/lint-repeat.exit

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

package/test/golden/lint-repeat.stdout

@@ -0,0 +1,48 @@
+spec: examples/order-repeat.ears.md
+conflicts: 1
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 1
+duplicate: 0
+vacuous: 0
+unused: 0
+
+conflict {R1, R2}
+R1 and R2 cannot both hold.
+
+R1 line 8
+When an order is submitted, the Order System shall fulfill the order.
+
+R2 line 9
+When an order is submitted, the Order System shall not fulfill the order.
+
+They clash when an order was submitted and inventory was not available.
+R1 requires that the order was fulfilled.
+R2 requires that the order was not fulfilled.
+
+Example scenario:
+{
+  "order_submitted": true,
+  "inventory_available": false,
+  "order_fulfilled": true,
+  "order_closed": false
+}
+This scenario keeps R1 and breaks R2.
+
+Suggested fix: ask which requirement should win. To keep R1, remove R2. To keep R2, remove R1.
+
+Candidate repairs follow. This report does not choose one.
+
+repair drop R1
+One repair is to drop R1 and keep R2 as written.
+When an order is submitted, the Order System shall not fulfill the order.
+
+repair drop R2
+One repair is to drop R2 and keep R1 as written.
+When an order is submitted, the Order System shall fulfill the order.
+
+redundant R5 line 12
+R5 adds nothing. Whenever the requirements outside a conflict hold, R5 holds too.
+When an order is submitted and inventory is available, the Order System shall close the order.
+Suggested fix: remove R5, or ask whether it was meant to say something the others do not already require. Do not delete it until the PM agrees.

package/test/golden/lint-status.exit

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

package/test/golden/lint-status.stdout

@@ -0,0 +1,44 @@
+spec: examples/order-status.ears.md
+conflicts: 1
+gaps: 0
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 1
+
+conflict {R6, R7}
+R6 and R7 cannot both hold.
+
+R6 line 6
+The Order System shall mark the order shipped.
+
+R7 line 7
+The Order System shall mark the order cancelled.
+
+They clash in every situation.
+R6 requires that the order was shipped.
+R7 requires that the order was cancelled.
+
+Example scenario:
+{
+  "status": "shipped"
+}
+This scenario keeps R6 and breaks R7.
+
+Suggested fix: ask which requirement should win. To keep R6, remove R7. To keep R7, remove R6.
+
+Candidate repairs follow. This report does not choose one.
+
+repair drop R6
+One repair is to drop R6 and keep R7 as written.
+The Order System shall mark the order cancelled.
+
+repair drop R7
+One repair is to drop R7 and keep R6 as written.
+The Order System shall mark the order shipped.
+
+unused Status.placed
+Status.placed is never mentioned.
+Suggested fix: use placed in a requirement, or remove it from Status.

package/test/golden/lint-unanswered.exit

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

package/test/golden/lint-unanswered.stdout

@@ -0,0 +1,12 @@
+spec: examples/order-unanswered.ears.md
+conflicts: 0
+gaps: 1
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+gap payment_declined
+No requirement states a response when "payment fails". Suggested fix: add an if ... then requirement, and ask what the system shall do. Do not choose the response.

package/test/golden/lint-unhandled.exit

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

package/test/golden/lint-unhandled.stdout

@@ -0,0 +1,12 @@
+spec: examples/order-unhandled.ears.md
+conflicts: 0
+gaps: 1
+misuse: 0
+wording: 0
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+gap order_cancelled
+No requirement handles "an order is cancelled". Suggested fix: add a requirement that says what the system shall do, or remove the event.

package/test/golden/lint-unmeasured.exit

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

package/test/golden/lint-unmeasured.stdout

@@ -0,0 +1,13 @@
+spec: examples/order-unmeasured.ears.md
+conflicts: 0
+gaps: 0
+misuse: 0
+wording: 1
+redundant: 0
+duplicate: 0
+vacuous: 0
+unused: 0
+
+wording line 4
+"as needed" is too vague to test. Replace it with something a scenario can check.
+output order_fulfilled: Bool "Handle it as needed." phrase "fulfill the order" outcome "the order was fulfilled" / "the order was not fulfilled"

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

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