dsh-pstack 0.3.0-beta.1 → 0.3.1

package/dist/pstack/skills/statechart/scripts/test/corpus/MediaPlayer/MediaPlayer.tla

@@ -0,0 +1,103 @@
+---- MODULE MediaPlayer ----
+\* Generated by chart-to-tla.mjs from media-player-fixed.mmd.
+\* Each region is one variable and each transition label is one action.
+\* Once you add guards and variables from the real code, this file is the source.
+\* statechart.mjs from-chart media-player-fixed.mmd keeps it, checks it, and compares it with the chart.
+
+VARIABLES playback, volume
+vars == <<playback, volume>>
+
+\* Region Playback
+playbackStates == {"Buffering", "Paused", "Playing", "Stopped"}
+\* Region Volume
+volumeStates == {"Loud", "Muted", "Normal volume"}
+
+TypeOK ==
+    /\ playback \in playbackStates
+    /\ volume \in volumeStates
+
+Init ==
+    /\ playback = "Stopped"
+    /\ volume = "Normal volume"
+
+\* you press play
+YouPressPlay ==
+    /\ \/ (playback = "Stopped" /\ playback' = "Buffering")
+       \/ (playback = "Paused" /\ playback' = "Playing")
+    /\ UNCHANGED <<volume>>
+
+\* enough data arrives
+EnoughDataArrives ==
+    /\ \/ (playback = "Buffering" /\ playback' = "Playing")
+    /\ UNCHANGED <<volume>>
+
+\* the network slows
+TheNetworkSlows ==
+    /\ \/ (playback = "Playing" /\ playback' = "Buffering")
+    /\ UNCHANGED <<volume>>
+
+\* you press pause
+YouPressPause ==
+    /\ \/ (playback = "Playing" /\ playback' = "Paused")
+    /\ UNCHANGED <<volume>>
+
+\* a call comes in
+ACallComesIn ==
+    /\ (playback \in {"Playing"} \/ volume \in {"Normal volume", "Loud"})
+    /\ \/ (playback = "Playing" /\ playback' = "Paused")
+       \/ (playback \notin {"Playing"} /\ UNCHANGED playback)
+    /\ \/ (volume = "Normal volume" /\ volume' = "Muted")
+       \/ (volume = "Loud" /\ volume' = "Muted")
+       \/ (volume \notin {"Normal volume", "Loud"} /\ UNCHANGED volume)
+
+\* the track ends
+TheTrackEnds ==
+    /\ (playback \in {"Playing"} \/ volume \in {"Loud"})
+    /\ \/ (playback = "Playing" /\ playback' = "Stopped")
+       \/ (playback \notin {"Playing"} /\ UNCHANGED playback)
+    /\ \/ (volume = "Loud" /\ volume' = "Normal volume")
+       \/ (volume \notin {"Loud"} /\ UNCHANGED volume)
+
+\* you press stop
+YouPressStop ==
+    /\ (playback \in {"Playing", "Paused", "Buffering"} \/ volume \in {"Loud"})
+    /\ \/ (playback = "Playing" /\ playback' = "Stopped")
+       \/ (playback = "Paused" /\ playback' = "Stopped")
+       \/ (playback = "Buffering" /\ playback' = "Stopped")
+       \/ (playback \notin {"Playing", "Paused", "Buffering"} /\ UNCHANGED playback)
+    /\ \/ (volume = "Loud" /\ volume' = "Normal volume")
+       \/ (volume \notin {"Loud"} /\ UNCHANGED volume)
+
+\* you turn it up
+YouTurnItUp ==
+    /\ \/ (volume = "Normal volume" /\ volume' = "Loud")
+    /\ UNCHANGED <<playback>>
+
+\* you turn it down
+YouTurnItDown ==
+    /\ \/ (volume = "Loud" /\ volume' = "Normal volume")
+    /\ UNCHANGED <<playback>>
+
+\* you press mute
+YouPressMute ==
+    /\ \/ (volume = "Normal volume" /\ volume' = "Muted")
+       \/ (volume = "Loud" /\ volume' = "Muted")
+       \/ (volume = "Muted" /\ volume' = "Normal volume")
+    /\ UNCHANGED <<playback>>
+
+\* the call ends
+TheCallEnds ==
+    /\ \/ (volume = "Muted" /\ volume' = "Normal volume")
+    /\ UNCHANGED <<playback>>
+
+Next == YouPressPlay \/ EnoughDataArrives \/ TheNetworkSlows \/ YouPressPause \/ ACallComesIn \/ TheTrackEnds \/ YouPressStop \/ YouTurnItUp \/ YouTurnItDown \/ YouPressMute \/ TheCallEnds
+
+Spec == Init /\ [][Next]_vars
+
+\* The player stops at last.
+EventuallyStops == <>(playback = "Stopped")
+
+\* When nothing plays, the volume is never above the safe level.
+LoudWhenStopped == ~(playback = "Stopped" /\ volume = "Loud")
+
+====

package/dist/pstack/skills/statechart/scripts/test/corpus/MediaPlayer/chart.mmd

@@ -0,0 +1,43 @@
+stateDiagram-v2
+  direction LR
+  state "Legend" as legend {
+    lg0: Breaks LoudWhenStopped in some cases
+    lg1: Path to the LoudWhenStopped bug
+  }
+  class lg0 mayBreak
+  class lg1 bugPath
+  state "At the same time" as all {
+    state "Playback" as r0 {
+      s0: Stopped
+      s1: Buffering
+      s2: Playing
+      s3: Paused
+      [*] --> s0
+      s0 --> s1: you press play
+      s1 --> s0: you press stop
+      s1 --> s2: enough data arrives
+      s2 --> s0: the track ends or you press stop
+      s2 --> s1: the network slows
+      s2 --> s3: a call comes in or you press pause
+      s3 --> s0: you press stop
+      s3 --> s2: you press play
+    }
+    --
+    state "Volume" as r1 {
+      s4: Normal volume
+      s5: Loud
+      s6: Muted
+      [*] --> s4
+      s4 --> s5: you turn it up
+      s4 --> s6: a call comes in or you press mute
+      s5 --> s4: the track ends or you press stop or you turn it down
+      s5 --> s6: a call comes in or you press mute
+      s6 --> s4: the call ends or you press mute
+    }
+  }
+  classDef mayBreak fill:#fff3e6,stroke:#e8730c,stroke-width:2.5px,color:#b85a06
+  class s0 mayBreak
+  class s0 bugPath
+  class s4 bugPath
+  class s5 mayBreak
+  class s5 bugPath

package/dist/pstack/skills/statechart/scripts/test/corpus/MediaPlayer/graph.dot

@@ -0,0 +1,93 @@
+strict digraph DiskGraph {
+nodesep=0.35;
+subgraph cluster_graph {
+color="white";
+5563385505008591753 [label="/\\ volume = \"Normal volume\"\n/\\ playback = \"Stopped\"",style = filled]
+5563385505008591753 -> 5459496424546159692 [label="YouPressPlay",color="black",fontcolor="black"];
+5459496424546159692 [label="/\\ volume = \"Normal volume\"\n/\\ playback = \"Buffering\""];
+5563385505008591753 -> 5767665807507136125 [label="ACallComesIn",color="black",fontcolor="black"];
+5767665807507136125 [label="/\\ volume = \"Muted\"\n/\\ playback = \"Stopped\""];
+5563385505008591753 -> -2451015957366623459 [label="YouTurnItUp",color="black",fontcolor="black"];
+-2451015957366623459 [label="/\\ volume = \"Loud\"\n/\\ playback = \"Stopped\""];
+5563385505008591753 -> 5767665807507136125 [label="YouPressMute",color="black",fontcolor="black"];
+5459496424546159692 -> 1832028610407887694 [label="EnoughDataArrives",color="black",fontcolor="black"];
+1832028610407887694 [label="/\\ volume = \"Normal volume\"\n/\\ playback = \"Playing\""];
+5459496424546159692 -> -2694137276511983669 [label="ACallComesIn",color="black",fontcolor="black"];
+-2694137276511983669 [label="/\\ volume = \"Muted\"\n/\\ playback = \"Buffering\""];
+5459496424546159692 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+5459496424546159692 -> -4711367017372802180 [label="YouTurnItUp",color="black",fontcolor="black"];
+-4711367017372802180 [label="/\\ volume = \"Loud\"\n/\\ playback = \"Buffering\""];
+5459496424546159692 -> -2694137276511983669 [label="YouPressMute",color="black",fontcolor="black"];
+5767665807507136125 -> -2694137276511983669 [label="YouPressPlay",color="black",fontcolor="black"];
+5767665807507136125 -> 5563385505008591753 [label="YouPressMute",color="black",fontcolor="black"];
+5767665807507136125 -> 5563385505008591753 [label="TheCallEnds",color="black",fontcolor="black"];
+-2451015957366623459 -> -4711367017372802180 [label="YouPressPlay",color="black",fontcolor="black"];
+-2451015957366623459 -> 5767665807507136125 [label="ACallComesIn",color="black",fontcolor="black"];
+-2451015957366623459 -> 5563385505008591753 [label="TheTrackEnds",color="black",fontcolor="black"];
+-2451015957366623459 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+-2451015957366623459 -> 5563385505008591753 [label="YouTurnItDown",color="black",fontcolor="black"];
+-2451015957366623459 -> 5767665807507136125 [label="YouPressMute",color="black",fontcolor="black"];
+1832028610407887694 -> 5459496424546159692 [label="TheNetworkSlows",color="black",fontcolor="black"];
+1832028610407887694 -> -6282895301051251831 [label="YouPressPause",color="black",fontcolor="black"];
+-6282895301051251831 [label="/\\ volume = \"Normal volume\"\n/\\ playback = \"Paused\""];
+1832028610407887694 -> 7503646495610027487 [label="ACallComesIn",color="black",fontcolor="black"];
+7503646495610027487 [label="/\\ volume = \"Muted\"\n/\\ playback = \"Paused\""];
+1832028610407887694 -> 7503646495610027487 [label="ACallComesIn",color="black",fontcolor="black"];
+1832028610407887694 -> 5563385505008591753 [label="TheTrackEnds",color="black",fontcolor="black"];
+1832028610407887694 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+1832028610407887694 -> -8528256329721584678 [label="YouTurnItUp",color="black",fontcolor="black"];
+-8528256329721584678 [label="/\\ volume = \"Loud\"\n/\\ playback = \"Playing\""];
+1832028610407887694 -> 311712142880394938 [label="YouPressMute",color="black",fontcolor="black"];
+311712142880394938 [label="/\\ volume = \"Muted\"\n/\\ playback = \"Playing\""];
+-2694137276511983669 -> 311712142880394938 [label="EnoughDataArrives",color="black",fontcolor="black"];
+-2694137276511983669 -> 5767665807507136125 [label="YouPressStop",color="black",fontcolor="black"];
+-2694137276511983669 -> 5459496424546159692 [label="YouPressMute",color="black",fontcolor="black"];
+-2694137276511983669 -> 5459496424546159692 [label="TheCallEnds",color="black",fontcolor="black"];
+-4711367017372802180 -> -8528256329721584678 [label="EnoughDataArrives",color="black",fontcolor="black"];
+-4711367017372802180 -> -2694137276511983669 [label="ACallComesIn",color="black",fontcolor="black"];
+-4711367017372802180 -> 5459496424546159692 [label="TheTrackEnds",color="black",fontcolor="black"];
+-4711367017372802180 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+-4711367017372802180 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+-4711367017372802180 -> 5459496424546159692 [label="YouTurnItDown",color="black",fontcolor="black"];
+-4711367017372802180 -> -2694137276511983669 [label="YouPressMute",color="black",fontcolor="black"];
+-6282895301051251831 -> 1832028610407887694 [label="YouPressPlay",color="black",fontcolor="black"];
+-6282895301051251831 -> 7503646495610027487 [label="ACallComesIn",color="black",fontcolor="black"];
+-6282895301051251831 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+-6282895301051251831 -> 6295872152763217060 [label="YouTurnItUp",color="black",fontcolor="black"];
+6295872152763217060 [label="/\\ volume = \"Loud\"\n/\\ playback = \"Paused\""];
+-6282895301051251831 -> 7503646495610027487 [label="YouPressMute",color="black",fontcolor="black"];
+7503646495610027487 -> 311712142880394938 [label="YouPressPlay",color="black",fontcolor="black"];
+7503646495610027487 -> 5767665807507136125 [label="YouPressStop",color="black",fontcolor="black"];
+7503646495610027487 -> -6282895301051251831 [label="YouPressMute",color="black",fontcolor="black"];
+7503646495610027487 -> -6282895301051251831 [label="TheCallEnds",color="black",fontcolor="black"];
+-8528256329721584678 -> -4711367017372802180 [label="TheNetworkSlows",color="black",fontcolor="black"];
+-8528256329721584678 -> 6295872152763217060 [label="YouPressPause",color="black",fontcolor="black"];
+-8528256329721584678 -> 7503646495610027487 [label="ACallComesIn",color="black",fontcolor="black"];
+-8528256329721584678 -> 7503646495610027487 [label="ACallComesIn",color="black",fontcolor="black"];
+-8528256329721584678 -> 5563385505008591753 [label="TheTrackEnds",color="black",fontcolor="black"];
+-8528256329721584678 -> 5563385505008591753 [label="TheTrackEnds",color="black",fontcolor="black"];
+-8528256329721584678 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+-8528256329721584678 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+-8528256329721584678 -> 1832028610407887694 [label="YouTurnItDown",color="black",fontcolor="black"];
+-8528256329721584678 -> 311712142880394938 [label="YouPressMute",color="black",fontcolor="black"];
+311712142880394938 -> -2694137276511983669 [label="TheNetworkSlows",color="black",fontcolor="black"];
+311712142880394938 -> 7503646495610027487 [label="YouPressPause",color="black",fontcolor="black"];
+311712142880394938 -> 7503646495610027487 [label="ACallComesIn",color="black",fontcolor="black"];
+311712142880394938 -> 5767665807507136125 [label="TheTrackEnds",color="black",fontcolor="black"];
+311712142880394938 -> 5767665807507136125 [label="YouPressStop",color="black",fontcolor="black"];
+311712142880394938 -> 1832028610407887694 [label="YouPressMute",color="black",fontcolor="black"];
+311712142880394938 -> 1832028610407887694 [label="TheCallEnds",color="black",fontcolor="black"];
+6295872152763217060 -> -8528256329721584678 [label="YouPressPlay",color="black",fontcolor="black"];
+6295872152763217060 -> 7503646495610027487 [label="ACallComesIn",color="black",fontcolor="black"];
+6295872152763217060 -> -6282895301051251831 [label="TheTrackEnds",color="black",fontcolor="black"];
+6295872152763217060 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+6295872152763217060 -> 5563385505008591753 [label="YouPressStop",color="black",fontcolor="black"];
+6295872152763217060 -> -6282895301051251831 [label="YouTurnItDown",color="black",fontcolor="black"];
+6295872152763217060 -> 7503646495610027487 [label="YouPressMute",color="black",fontcolor="black"];
+{rank = same; 5563385505008591753;}
+{rank = same; -2451015957366623459;5767665807507136125;5459496424546159692;}
+{rank = same; -2694137276511983669;1832028610407887694;-4711367017372802180;}
+{rank = same; -8528256329721584678;7503646495610027487;-6282895301051251831;311712142880394938;}
+{rank = same; 6295872152763217060;}
+}
+}

package/dist/pstack/skills/statechart/scripts/test/corpus/MediaPlayer/report.md

@@ -0,0 +1,14 @@
+# MediaPlayer
+
+TLC reached 12 states and 64 steps. The chart draws 7 states and 13 arrows.
+The step a call comes in changes Playback and Volume at the same time.
+The step the track ends changes Playback and Volume at the same time.
+The step you press stop changes Playback and Volume at the same time.
+
+## LoudWhenStopped breaks
+The shortest path has 1 step:
+0. Playback Stopped, Volume Normal volume
+1. you turn it up: Playback Stopped, Volume Loud
+
+## Rules that hold
+TypeOK, NoDeadlock, EventuallyStops