Dag logic (#15)

Mostly full rewrite of the project, not exhaustive list of features:
- switched to PySide6, most of the widgets have been rewritten
- the steps are now declared as a DAG instead of an array
- cleaner set parameters passed to a step (context, settings and run_info)
- easier to overload settings widgets
- basic start screen for a run

Author: Taldrain

.github/workflows/setup-action/action.yml

@@ -23,6 +23,9 @@ runs:
       with:
         path: .venv
         key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+    - name: Install PySide dependencies
+      run: sudo apt install libegl1
+      shell: bash
     - name: Install dependencies
       if: inputs.disable_cache == 'true' || steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
       run: poetry install

.gitignore

@@ -3,3 +3,4 @@ dist/
 sopic.egg-info/
 __pycache__/
 .pytest_cache/
+dag-*.png

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
-## Unversioned
+## 1.0.0
 
-- Minor: switch to poetry
-
-## 0.1.0
+- New DAG logic to cycle through steps
+- New API for steps and station wrappers
+- New settings window

README.md

@@ -1,9 +1,10 @@
 Sopic
 ======
 
-Helper library for a test station in a production line.
+Test stations GUI library for your hardware on a production line.
 
 Define a station that will run a number of steps, in sequential order.
+Visualize the steps with the GUI
 
 
 # Screenshots
@@ -15,112 +16,87 @@ Define a station that will run a number of steps, in sequential order.
 
 # Installation
 
-After a clone of the repository
-
-`poetry install`
+`pip install sopic`
 
 
 # How to use
 
-Initialise a `MainWindow` with a station object, child of the `Station` class.
-
-In your station class you can set some parameters and define your list of steps.
+Initialise `MainWindow` with a station object, child of the `Station` class.
 
-You can also define a settings dialog when initializing the `MainWindow`.
-
-Check the examples directory (eg: `poetry run python examples/00_basic.py`)
+In your station class you can define the steps in a DAG and settings for the
+runs.
 
 
 # Keybinds
 
-### Exit the station
-Ctrl-Q
-
-### Settings
-**Ctrl-P**
-
-DIsplay the settings dialog. The configuration is saved. The settings can be
-reset to the default configuration set in the station class.
-
-### Step selection
-**Ctrl-T**
-
-Allow to enable/disable steps. The configuration is not saved.
-
-### Log and settings layout
-**Ctrl-B**
-
-Display settings and log window
-
+- `Ctrl-Q`: exit the station
+- `Ctrl-P`: display the settings dialog, when available
+- `Ctrl-B`: display the logs
 
 # Definitions
 
 A step is the smallest component, a class invoked at the start of the station.
-A method from this object will be called to start the step. The step has then
-access to data from previous steps, if they provided it, and global settings of
-the station.
-After being called, the step has to notify the station of the tests passed or
-not.
+The `start` method from this object will be called to start the step. The step
+has then access to data from previous steps, if they provided it, settings and
+current run info.
+After being called the step can either returns `self.OK()` or `self.KO()` to
+notify the station if the step has passed or not. These two methods take a
+parameters to select the next step.
 
-A station is a group of steps. It's also defined as a class and will store the
-default settings, station configuration and the steps.
+A station is a group of steps. The steps are defined in a Direct Acyclic Graph.
 
-A run is the term used to define the "list" of steps from the first to the last,
-as defined in the station class.
-So a station will perform multiple runs. Each one composed of multiple steps.
+A run is the succession of the steps. A run can either Pass or Fail. A station
+will perform multiple runs.
 
 
 # Features
 
 - GUI
 - Share data between steps
 - Settings for step configuration
-- Step selection
 - Logs
+- Easy to customize with wrappers
 
 # Define a station
 
 ```python
 from sopic import Station
 
 class MyStation(Station):
-    # Used as window title
-    DISPLAY_NAME = 'my station'
-    # Used for logs, filenames
+    # Used as window title, log file, settings file
     STATION_NAME = 'my-station'
-    # Same use as STATION_NAME, useful to when saving the previous station
+    # Same use as STATION_NAME
     STATION_ID = 0
-
-    # Allow to disable logging to files
-    disable_file_logging = False
-
-    # List of steps in the station
-    steps = [
-      Step1,
-      # Can deactivate step by default
-      # steps can be enabled with the step selection dialog
-      (Step2, False),
-    ]
-
-    # By default a fail in a step will force the run to go directly to the
-    # last step, skipping other steps.
-    # By defining the non blocking steps we allow the run to continue even
-    # if these steps failed. Useful when testing the station without caring
-    # about the step output
-    # Note that the run is still a fail if one of these steps fail.
-    nonBlockingSteps = [
-      Step1.STEP_NAME,
-    ]
-
-    # Steps that will always be skipped if one previous step has failed.
-    # Useful when also using nonBlockingSteps
-    stepsSkippedOnPreviousFail = [
-      Step2.STEP_NAME,
-    ]
+    # Optional, displayed in the bottom right corner of the main window
+    STATION_VERSION = "1.0.0"
+
+    # Will generate a png output of the dag
+    DEBUG = True
+
+    # Select the first step, via its key
+    start_step_key = "start"
+
+    # DAG of the steps
+    dag = {
+        # first step
+        # `StartButton` is the step class
+        # `["select"] is the child, no matter if the StartButton fails, the
+        # child will be the one with the `"select"` key
+        "start": (StartButton, ["select"]),
+        # This step define another step class, `Select`
+        # This step can select one of two childs
+        # - "foo", if the step returns the key "ok"
+        # - "bar", if the step returns the key "ko"
+        "select": (Select, {"ok": "foo", "ko": "bar"}),
+        # The next two steps don't have any child, returning for those step
+        # will end the run
+        "foo": (AlwaysOK, []),
+        "bar": (AlwaysKO, []),
+    }
 
     # Default settings of the station. Can be updated with the SettingsDialog.
-    defaultSettings = {
-      'random-setting': '42',
+    default_settings = {
+        "random-settings": {"value": 42, "label": "A random settings"},
     }
 ```
 
@@ -130,53 +106,41 @@ class MyStation(Station):
 from sopic import Step
 
 class MyStep(Step):
-    # name of the step, used for display and logs
+    # Name of the step, used for display and logs
     STEP_NAME = 'my-step'
-    # number of retries allowed on fail
+    # Number of retries allowed on fail
     MAX_RETRIES = 1
 
-    # called when the step is started
-    # stepsData contains data of the previous steps, if available.
-    # Data of steps is available via `stepsData[Step1.STEP_NAME]`.
-    # Settings is available at `stepsData['__settings']`.
-    # Check the End step in the example folder for more use of the stepsData.
-    def start(self, stepsData):
+    # Called when the step is started
+    # `context` contains value stored by previous steps
+    # `settings` contains the station settings
+    # `run_info` contains current run information
+    def start(self, context, settings, run_info):
         super().start()
 
         # Add your tests here
-        # You have access to `self.logger` to log some info.
-        # You have access to the object `self.stepData` to store data, it will
-        # be available for future the next steps. This object is reset on each run.
-        # The step will have to return either `OK` or `KO`
-
-        # A string can be passed to describe the success of the step.
-        return self.OK('all good')
-
-        # On error, the step should return `self.KO`
-        # terminate, flag will force the run to end.
-        # errorStr and errorCode is used to describe the error
-        # return self.KO(
-            terminate = False,
-            errorStr = "something happened",
-            errorCode = 42
-        )
-
-    # Used if the step define use a StepUI
-    # Check the steps in the examples directory
-    def getWidget(self):
-        if (self.widet === None):
-            self.widget = MyStepUI()
-        return self.widget
+
+        return self.OK()
 ```
 
 
 # Examples
 
 [Check the examples directory](./examples)
 
+To run the examples:
+```bash
+git clone https://github.com/Taldrain/sopic
+cd sopic
+poetry install
+poetry run examples/00_basic.py
+```
+
 
 # See also
 
 [exclave](https://github.com/exclave/exclave)
 
 [Exclave: Hardware Testing in Mass Production, Made Easier](https://www.bunniestudios.com/blog/?p=5450)
+
+[awesome-hardware-test](https://github.com/sschaetz/awesome-hardware-test)

assets/basic-run.png

@@ -1,35 +1,31 @@
 #!/usr/bin/env python3
 
 import sys
-from PyQt5.QtWidgets import QApplication
+from PySide6.QtWidgets import QApplication
 
-from sopic.station import Station
-from sopic.gui import MainWindow
+from sopic import MainWindow, Station
 
 from examples.steps import Select, AlwaysOK, AlwaysKO
 
 
 class BasicStation(Station):
-    DISPLAY_NAME = "basic station"
-    STATION_NAME = "basic-station"
+    STATION_NAME = "basic station"
     STATION_ID = 0
-    STATION_VERSION = "0.0.1"
+    STATION_VERSION = "1.0.0"
 
-    disableFileLogging = True
+    DEBUG = True
 
-    steps = [
-        Select,
-        AlwaysOK,
-        # This step will always return KO,
-        # the next step will always be skipped
-        AlwaysKO,
-        # Never called
-        Select,
-        Select,
-    ]
+    dag = {
+        # will allow to either go to step `foo` or `bar`
+        "select": (Select, {"ok": "foo", "ko": "bar"}),
+        "foo": (AlwaysOK, []),
+        "bar": (AlwaysKO, []),
+    }
+
+    start_step_key = "select"
 
 
 if __name__ == "__main__":
-    Q_APP = QApplication(sys.argv)
+    app = QApplication([])
     MainWindow(BasicStation).show()
-    sys.exit(Q_APP.exec_())
+    sys.exit(app.exec())

assets/basic.png

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+
+import sys
+from PySide6.QtWidgets import QApplication
+
+from sopic import MainWindow, Station
+
+from examples.steps import PrintSettings, GetSettings
+
+
+class SettingsStation(Station):
+    STATION_NAME = "settings-station"
+    STATION_ID = 1
+    STATION_VERSION = "1.0.0"
+
+    DEBUG = True
+
+    dag = {
+        "print": (PrintSettings, ["get"]),
+        "get": (GetSettings, []),
+    }
+
+    default_settings = {
+        "random-settings": {"value": 42, "label": "A random settings"},
+        "read-only": {"value": 12, "label": "Read-only settings", "edit": False},
+        "no-label": {"value": "hello"},
+    }
+
+
+if __name__ == "__main__":
+    app = QApplication([])
+    MainWindow(SettingsStation).show()
+    sys.exit(app.exec())