stepup 3.0.0__tar.gz → 3.0.2__tar.gz

{stepup-3.0.0 → stepup-3.0.2}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: stepup
-Version: 3.0.0
+Version: 3.0.2
 Summary: StepUp Core provides the basic framework for the StepUp build tool
 Author-email: Toon Verstraelen <toon.verstraelen@ugent.be>
+License-Expression: GPL-3.0-or-later
 Project-URL: Documentation, https://reproducible-reporting.github.io/stepup-core/
 Project-URL: Issues, https://github.com/reproducible-reporting/stepup-core/issues
 Project-URL: Source, https://github.com/reproducible-reporting/stepup-core/
@@ -11,7 +12,6 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Natural Language :: English
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: MacOS

{stepup-3.0.0 → stepup-3.0.2}/docs/changelog.md

@@ -12,6 +12,44 @@ and this project adheres to [Effort-based Versioning](https://jacobtomlinson.dev
 
 (no changes yet)
 
+## [3.0.2][] - 2025-05-18 {: #v3.0.2 }
+
+Improved return code and a bugfix.
+
+### Changed
+
+- The meaning of the `stepup` return codes has changed to a combination of flags:
+
+    - `1` = internal error (Python exception)
+    - `2` = at least one step failed
+    - `4` = at least one step remained pending
+    - `8` = at least one step was still runnable
+
+  Some sums of return codes are possible.
+  For example `6` means that at least one step failed and at least one step remained pending.
+
+## Fixed
+
+- Steps were not made pending when their inputs were created by a new step after a restart.
+  This is fixed.
+
+## [3.0.1][] - 2025-05-13 {: #v3.0.1 }
+
+Minor tweaks, improved progress format and `STEPUP_STEP_INP_DIGEST` environment variable.
+
+### Added
+
+- The `STEPUP_STEP_INP_DIGEST` environment variable is set in the worker processes to
+  the hex-formatted digest of the inputs of the step.
+
+### Changed
+
+- Improved timer format of running steps in progress bar.
+
+### Fixed
+
+- Minor documentation and configuration fixes.
+
 ## [3.0.0][] - 2025-05-11 {: #v3.0.0 }
 
 Major release with breaking changes.
@@ -540,6 +578,8 @@ This release fixes several bugs.
 Initial release
 
 [Unreleased]: https://github.com/reproducible-reporting/stepup-core
+[3.0.2]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v3.0.2
+[3.0.1]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v3.0.1
 [3.0.0]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v3.0.0
 [2.1.7]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v2.1.7
 [2.1.6]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v2.1.6

{stepup-3.0.0 → stepup-3.0.2}/docs/index.md

@@ -131,8 +131,8 @@ with "Step" reflecting how StepUp defines operations as individual *steps*.
 
 - A **keyboard shortcut** can be defined in most IDEs to start
   a new *run phase* of an active StepUp director.
-  The command `python -c 'from stepup.core.interact import run; run()'`
-  will instruct the director to run pending steps due to file changes.
+  The command `stepup run` will instruct the director to run pending steps due to file changes.
+  See [Interactive Usage Reference](./reference/interactive.md) for more details.
 
 - While a step is running, it can inform StepUp that it needs **additional inputs**,
   in which case the step will be rescheduled for later execution

{stepup-3.0.0 → stepup-3.0.2}/docs/plan.py

@@ -3,7 +3,7 @@
 
 from path import Path
 
-from stepup.core.api import glob, runsh, static
+from stepup.core.api import glob, runpy, static
 
 
 def scan_main(path_main: str) -> tuple[list[Path], Path, list[Path]]:
@@ -60,7 +60,7 @@ def main():
         static(inp)
         inp.append(Path("run_example.py"))
         inp.append(path_main)
-        runsh(f"./run_example.py {path_main} {root}", inp=inp, out=out)
+        runpy(f"./run_example.py {path_main} {root}", inp=inp, out=out)
 
 
 if __name__ == "__main__":

{stepup-3.0.0 → stepup-3.0.2}/docs/reference/environment_variables.md

@@ -1,5 +1,7 @@
 # Environment Variables
 
+## Configuration of StepUp
+
 The following environment variables can be used to configure StepUp.
 
 - `STEPUP_DEBUG`: Set to `"1"` to enable debug output.
@@ -45,3 +47,17 @@ export STEPUP_ROOT=${PWD}
 
 When you change to the project directory (or any of its subdirectories) in your shell,
 the environment variables will be set automatically.
+
+## Environment Variables in Worker Processes
+
+The following environment variables are set when a worker runs a step:
+
+- `HERE` and `ROOT`, as documented in the tutorial on [`HERE` and `ROOT` variables](../advanced_topics/here_and_root.md)
+- `STEPUP_STEP_I` is a unique integer index for the current step.
+  This is mainly relevant for StepUp and has little significance for users implementing workflows.
+- `STEPUP_STEP_INP_DIGEST` is a hex-formatted digest of all the inputs to the step
+  (including environment variables used).
+  This is useful in special cases.
+  For example, it can be used to decide if cached results from a previously interrupted run of the step
+  are still valid.
+  It can also be useful when action submit jobs to a scheduler, to decide if a running job is still valid.

stepup-3.0.2/docs/reference/returncode.md

@@ -0,0 +1,33 @@
+# StepUp Return Codes
+
+The StepUp return code indicates the status of the (last) run phase.
+It can be a sum of the following codes:
+
+- `1` = internal error (Python exception)
+- `2` = at least one step failed
+- `4` = at least one step remained pending
+- `8` = at least one step was still runnable
+
+A few example combinations are:
+
+- `0` = all steps finished successfully.
+- `1` = internal error (never combined with other codes).
+- `6` = at least one step failed and at least one step remained pending.
+- `12` = some steps remain pending and some steps are runnable when StepUp is restarted.
+
+To test for a specific flag in Bash, use the bitwise AND operator `&`:
+
+```bash
+#!/usr/bin/env bash
+stepup boot
+RET=$?
+if [ $(($RET & 2)) -gt 0 ]; then
+    echo "At least one step failed"
+fi
+if [ $(($RET & 4)) -gt 0 ]; then
+    echo "At least one step remained pending"
+fi
+if [ $(($RET & 8)) -gt 0 ]; then
+    echo "At least one step was still runnable"
+fi
+```

{stepup-3.0.0 → stepup-3.0.2}/mkdocs.yaml

@@ -108,6 +108,7 @@ nav:
     - reference/stepup.core.script.md
     - reference/stepup.core.stepinfo.md
     - reference/interactive.md
+    - reference/returncode.md
     - reference/environment_variables.md
   - Extending StepUp:
     - extending/introduction.md

{stepup-3.0.0 → stepup-3.0.2}/pyproject.toml

@@ -9,14 +9,13 @@ authors = [
 ]
 description = "StepUp Core provides the basic framework for the StepUp build tool"
 readme = "README.md"
-license = {file = "COPYING"}
+license = "GPL-3.0-or-later"
 requires-python = ">=3.11"
 classifiers = [
     "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Intended Audience :: Education",
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
     "Natural Language :: English",
     "Operating System :: POSIX",
     "Operating System :: MacOS",

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/__main__.py

@@ -43,7 +43,7 @@ def build_parser() -> tuple[argparse.ArgumentParser, list[callable]]:
     # Base argument parser
     parser = argparse.ArgumentParser(
         prog="stepup",
-        description="If no tool is specified, the default tool is 'boot'.",
+        description="General purpose dynamic build tool.",
     )
     version = get_version("stepup")
     parser.add_argument("--version", "-V", action="version", version="%(prog)s " + version)

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/api.py

@@ -698,7 +698,8 @@ def getenv(
     path = path or back or multi
     value = os.getenv(name, default)
     # Do not amend environment variables set by the worker.
-    if name not in ["HERE", "ROOT"]:
+    # See stepup.core.worker.WorkerHandler.run
+    if name not in ["HERE", "ROOT", "STEPUP_STEP_I", "STEPUP_STEP_INP_DIGEST"]:
         amend(env=name)
     if multi:
         if value is None:

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/cascade.py

@@ -472,6 +472,7 @@ class ConnectionWrapper:
         self._print_caller("execute")
         if self._explain:
             print(sql, file=sys.stderr)
+            print(f"  {data}", file=sys.stderr)
             nodes = {}
             from anytree import Node as TreeNode
             from anytree import RenderTree

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/enums.py

@@ -19,26 +19,26 @@
 # --
 """Enumerate objects used in other StepUp modules."""
 
-import enum
+from enum import Enum, Flag, auto
 
 __all__ = ("Change", "DirWatch", "FileState", "Mandatory", "ReturnCode", "StepState")
 
 
-class ReturnCode(enum.Enum):
-    SUCCESS = 0
-    """All (mandatory) steps completed successfully."""
-
-    INTERNAL = 1
+class ReturnCode(Flag):
+    INTERNAL = auto()
     """Exception raised, not related to failing steps in the workflow"""
 
-    FAILED = 2
-    """Some steps failed (and possibly some remain pending)."""
+    FAILED = auto()
+    """Some steps failed."""
+
+    PENDING = auto()
+    """Some steps remained pending."""
 
-    PENDING = 3
-    """Some steps remained pending (no failures)."""
+    RUNNABLE = auto()
+    """Some steps are runnable. Stopped early due to shutdown, drain, etc."""
 
 
-class FileState(enum.Enum):
+class FileState(Enum):
     """State of a file in the StepUp workflow.
 
     STATIC and BUILT files are ready to be used as inputs.
@@ -88,7 +88,7 @@ class FileState(enum.Enum):
     """
 
 
-class StepState(enum.Enum):
+class StepState(Enum):
     PENDING = 21
     """The step still needs to be executed."""
 
@@ -105,7 +105,7 @@ class StepState(enum.Enum):
     """The step has failed (exit code non-zero)."""
 
 
-class Mandatory(enum.Enum):
+class Mandatory(Enum):
     YES = 31
     """The step must be executed (default)."""
 
@@ -116,7 +116,7 @@ class Mandatory(enum.Enum):
     """The step is optional and not required by another mandatory or required step."""
 
 
-class Change(enum.Enum):
+class Change(Enum):
     UPDATED = 41
     """A file on disk has been added or changed."""
 
@@ -124,7 +124,7 @@ class Change(enum.Enum):
     """A file on disk has been deleted."""
 
 
-class DirWatch(enum.Enum):
+class DirWatch(Enum):
     """Flag to change the watched directories through the Workflow.dir_queue."""
 
     START = 51

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/reporter.py

@@ -130,10 +130,8 @@ class StepUpProgressBar(ProgressBar):
                     no_wrap=True,
                     overflow="crop",
                 )
-                text.append("   RUNNING", "bold cyan")
-                text.append(" │ ")
-                text.append(f"{elapsed:6.1f}", "gray50")
-                text.append(f" {description}")
+                text.append(f"{elapsed:10.0f}", "bold gray50")
+                text.append(f" │ {description}")
                 yield text
         yield from super().get_renderables()
 

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/runner.py

@@ -165,9 +165,10 @@ class Runner:
         """Final steps after the runner has executed a bunch of jobs."""
         async with self.dblock:
             self.returncode = await report_completion(self.workflow, self.scheduler, self.reporter)
-        if self.returncode != ReturnCode.SUCCESS:
+        if self.returncode.value != 0:
             await self.reporter("WARNING", "Skipping file cleanup due to incomplete build")
-            await clean_queue(self.scheduler, self.dblock, self.reporter)
+            if await clean_queue(self.scheduler, self.dblock, self.reporter):
+                self.returncode |= ReturnCode.RUNNABLE
         elif not self.do_remove_outdated:
             await self.reporter("WARNING", "Skipping file cleanup at user's request (--no-clean)")
         else:
@@ -259,16 +260,15 @@ async def report_completion(
     workflow: Workflow, scheduler: Scheduler, reporter: ReporterClient
 ) -> ReturnCode:
     """Report parts of the workflow that could not be executed."""
-    returncode = ReturnCode.SUCCESS
+    returncode = ReturnCode(0)
     steps_failed = list(workflow.steps(StepState.FAILED))
     num_failed = len(steps_failed)
     if num_failed > 0:
-        returncode = ReturnCode.FAILED
+        returncode |= ReturnCode.FAILED
         await reporter("WARNING", f"{num_failed} step(s) failed.")
 
     if scheduler.onhold:
-        if returncode == ReturnCode.SUCCESS:
-            returncode = ReturnCode.PENDING
+        returncode |= ReturnCode.PENDING
         await reporter("WARNING", "Scheduler is put on hold. Not reporting pending steps.")
         return returncode
 
@@ -325,8 +325,7 @@ async def report_completion(
             pending_pages.append(("PENDING Step", "\n".join(lines)))
 
         if num_pending > 0:
-            if returncode != ReturnCode.FAILED:
-                returncode = ReturnCode.PENDING
+            returncode |= ReturnCode.PENDING
             lead = f"{num_pending} step(s) remained pending due to"
             if len(block_lines) > 0:
                 block_page = ("Blocked steps", "\n".join(block_lines))
@@ -376,7 +375,7 @@ async def remove_outdated_outputs(workflow: Workflow, dblock: DBLock, reporter:
     workflow.to_be_deleted.clear()
 
 
-async def clean_queue(scheduler: Scheduler, dblock: DBLock, reporter: ReporterClient):
+async def clean_queue(scheduler: Scheduler, dblock: DBLock, reporter: ReporterClient) -> bool:
     """Clean the scheduler queue and make queued steps pending."""
     if scheduler.onhold:
         count = 0
@@ -387,3 +386,5 @@ async def clean_queue(scheduler: Scheduler, dblock: DBLock, reporter: ReporterCl
                 count += 1
         if count > 0:
             await reporter("WARNING", f"Made {count} step(s) in the queue pending.")
+            return True
+    return False

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/step.py

@@ -910,7 +910,8 @@ class Step(Node):
         """Set succeeded or failed step pending (again).
 
         There can be many reasons for making a step pending,
-        e.g. inputs changes, outputs disappaered, environment variables changed.
+        e.g. inputs changes, outputs disappeared, environment variables changed.
+        This is also called when orphaned steps are recreated whose inputs are no longer valid.
 
         Parameters
         ----------

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/worker.py

@@ -475,6 +475,15 @@ class WorkerStep:
     inp_messages: list = attrs.field(init=False, factory=list)
     """Messages related to input validation issues: unexpected changes and deleted inputs."""
 
+    inp_digest: bytes = attrs.field(init=False, default=b"")
+    """The input digest, which can be useful for some actions.
+
+    They may use this to decide if cached results from a previously interrupted run
+    of the same stepo are still valid.
+    This can also be useful when action submit jobs to a scheduler,
+    to decide if a running job is still valid.
+    """
+
     out_missing: list = attrs.field(init=False, factory=list)
     """List of expected output files that were not created."""
 
@@ -794,7 +803,11 @@ class WorkerHandler:
         label = self.step.action
         if self.step.workdir != "./":
             label += f"  # wd={self.step.workdir}"
-        return StepHash.from_inp(f"{label}", self.explain_rerun, all_inp_hashes, env_var_values), []
+        result = StepHash.from_inp(f"{label}", self.explain_rerun, all_inp_hashes, env_var_values)
+
+        # Copy the inp_digest, because it can be useful for some actions.
+        self.step.inp_digest = result.inp_digest
+        return result, []
 
     @allow_rpc
     def compute_out_step_hash(
@@ -897,11 +910,14 @@ class WorkerHandler:
         await self.reporter("START", self.step.description)
         await self.reporter.start_step(self.step.description, self.step.i)
 
-        # For internal use only:
+        # For internal use in actions:
         os.environ["STEPUP_STEP_I"] = str(self.step.i)
         # Client code may use the following:
+        os.environ["STEPUP_STEP_INP_DIGEST"] = self.step.inp_digest.hex()
         os.environ["ROOT"] = str(Path.cwd().relpath(self.step.workdir))
         os.environ["HERE"] = str(self.step.workdir.relpath())
+        # Note: the variables defined here should be listed in stepup.core.api.getenv
+
         # Create IO redirection for stdout and stderr
         step_err = io.StringIO()
         step_out = io.StringIO()
@@ -922,6 +938,12 @@ class WorkerHandler:
         self.step.stdout = step_out.getvalue()
         self.step.stderr = step_err.getvalue()
 
+        # Clean up environment variables (to avoid potential confusion)
+        del os.environ["STEPUP_STEP_I"]
+        del os.environ["STEPUP_STEP_INP_DIGEST"]
+        del os.environ["ROOT"]
+        del os.environ["HERE"]
+
         # Process results of the step.
         if self.show_perf:
             ru_final = resource.getrusage(resource.RUSAGE_CHILDREN)

{stepup-3.0.0 → stepup-3.0.2}/stepup/core/workflow.py

@@ -48,6 +48,8 @@ __all__ = ("Workflow",)
 logger = logging.getLogger(__name__)
 
 
+# Find all inputs of steps (recursively through creator-product relations) that are missing,
+# and whose creator is a deferred glob.
 RECURSE_DEFERRED_INPUTS = f"""
 WITH RECURSIVE missing(i, label, creator_kind) AS (
     SELECT node.i, node.label, cnode.kind FROM node
@@ -66,6 +68,22 @@ WITH RECURSIVE missing(i, label, creator_kind) AS (
 SELECT i, label FROM missing WHERE creator_kind = 'dg'
 """
 
+# Recursively find all product steps and finally select those whose inputs are awaited or outdated.
+RECURSE_OUTDATED_STEPS = f"""
+WITH RECURSIVE outdated(i, label) AS (
+    SELECT node.i, node.label FROM node
+    WHERE node.i = ?
+    UNION
+    SELECT product_node.i, product_node.label FROM node AS product_node
+    JOIN outdated ON product_node.creator = outdated.i
+    WHERE product_node.kind = 'step'
+)
+SELECT DISTINCT outdated.i, outdated.label FROM outdated
+JOIN dependency ON dependency.consumer = outdated.i
+JOIN file ON dependency.supplier = file.node
+WHERE file.state IN ({FileState.AWAITED.value}, {FileState.OUTDATED.value})
+"""
+
 
 @attrs.define
 class SupplyInfo:
@@ -922,8 +940,14 @@ class Workflow(Cascade):
         # Restore the step and its products (recursively).
         old_step.recreate(creator)
 
-        # Look for missing inputs and their parents and determine which match a deferred glob.
-        # These still need to be checked.
+        # If inputs of the recreated steps are AWAITED or OUTDATED, these steps must be rescheduled.
+        for i, label in self.con.execute(RECURSE_OUTDATED_STEPS, (old_step.i,)):
+            step = Step(self, i, label)
+            step.mark_pending(input_changed=True)
+
+        # Look for MISSING inputs and determine which were created by a deferred glob.
+        # Their existence still needs to be checked by the client and ideally confirmed as existing
+        # in a follow-up call to `confirm_static`.
         deferred = {
             File(self, i, label)
             for i, label in self.con.execute(RECURSE_DEFERRED_INPUTS, (old_step.i,))

{stepup-3.0.0 → stepup-3.0.2}/stepup.egg-info/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: stepup
-Version: 3.0.0
+Version: 3.0.2
 Summary: StepUp Core provides the basic framework for the StepUp build tool
 Author-email: Toon Verstraelen <toon.verstraelen@ugent.be>
+License-Expression: GPL-3.0-or-later
 Project-URL: Documentation, https://reproducible-reporting.github.io/stepup-core/
 Project-URL: Issues, https://github.com/reproducible-reporting/stepup-core/issues
 Project-URL: Source, https://github.com/reproducible-reporting/stepup-core/
@@ -11,7 +12,6 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Natural Language :: English
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: MacOS

{stepup-3.0.0 → stepup-3.0.2}/stepup.egg-info/SOURCES.txt

@@ -242,6 +242,7 @@ docs/getting_started/workdir/out/.keep
 docs/getting_started/workdir/out/hello.txt
 docs/reference/environment_variables.md
 docs/reference/interactive.md
+docs/reference/returncode.md
 docs/reference/stepup.core.api.md
 docs/reference/stepup.core.call.md
 docs/reference/stepup.core.nglob.md
@@ -791,6 +792,12 @@ tests/examples/here/main.sh
 tests/examples/here/source/plan.py
 tests/examples/here/source/www/index.md
 tests/examples/here/source/www/plan.py
+tests/examples/inp_digest/.gitignore
+tests/examples/inp_digest/README.txt
+tests/examples/inp_digest/expected_graph.txt
+tests/examples/inp_digest/expected_stdout.txt
+tests/examples/inp_digest/main.sh
+tests/examples/inp_digest/plan.py
 tests/examples/input_check_changed/.gitignore
 tests/examples/input_check_changed/README.txt
 tests/examples/input_check_changed/expected_graph.txt
@@ -1352,6 +1359,21 @@ tests/examples/restart_static_remove2/expected_stdout2.txt
 tests/examples/restart_static_remove2/main.sh
 tests/examples/restart_static_remove2/plan1.py
 tests/examples/restart_static_remove2/plan2.py
+tests/examples/restart_step_changed/.gitignore
+tests/examples/restart_step_changed/README.txt
+tests/examples/restart_step_changed/expected_graph1.txt
+tests/examples/restart_step_changed/expected_graph2.txt
+tests/examples/restart_step_changed/expected_stdout1.txt
+tests/examples/restart_step_changed/expected_stdout2.txt
+tests/examples/restart_step_changed/main.sh
+tests/examples/restart_step_changed/plan1.py
+tests/examples/restart_step_changed/plan2.py
+tests/examples/runnable/.gitignore
+tests/examples/runnable/README.txt
+tests/examples/runnable/expected_graph.txt
+tests/examples/runnable/expected_stdout.txt
+tests/examples/runnable/main.sh
+tests/examples/runnable/plan.py
 tests/examples/script_cases/.gitignore
 tests/examples/script_cases/README.txt
 tests/examples/script_cases/expected_graph.txt

{stepup-3.0.0 → stepup-3.0.2}/tests/examples/amend_delete_both/main.sh

@@ -40,7 +40,7 @@ stepup join
 
 # Wait for background processes, if any.
 set +e; wait -fn $PID; RETURNCODE=$?; set -e
-[[ "${RETURNCODE}" -eq 3 ]] || exit 1
+[[ "${RETURNCODE}" -eq 4 ]] || exit 1
 
 # Check files that are expected to be present and/or missing.
 [[ -f plan.py ]] || exit 1

{stepup-3.0.0 → stepup-3.0.2}/tests/examples/amend_missing/main.sh

@@ -15,7 +15,7 @@ stepup join
 
 # Wait for background processes, if any.
 set +e; wait -fn $PID; RETURNCODE=$?; set -e
-[[ "${RETURNCODE}" -eq 2 ]] || exit 1
+[[ "${RETURNCODE}" -eq 6 ]] || exit 1
 
 # Check files that are expected to be present and/or missing.
 [[ -f plan.py ]] || exit 1

{stepup-3.0.0 → stepup-3.0.2}/tests/examples/amend_validate2/main.sh

@@ -21,4 +21,4 @@ stepup join
 
 # Wait for background processes, if any.
 set +e; wait -fn $PID; RETURNCODE=$?; set -e
-[[ "${RETURNCODE}" -eq 3 ]] || exit 1
+[[ "${RETURNCODE}" -eq 4 ]] || exit 1

stepup-3.0.2/tests/examples/inp_digest/README.txt

@@ -0,0 +1 @@
+Minimal example checking that the input digest is present in the environment variables.

stepup-3.0.2/tests/examples/inp_digest/expected_graph.txt

@@ -0,0 +1,22 @@
+root:
+             creates   file:./
+             creates   file:plan.py
+             creates   step:runpy ./plan.py
+
+file:./
+               state = STATIC
+          created by   root:
+            supplies   file:plan.py
+            supplies   step:runpy ./plan.py
+
+file:plan.py
+               state = STATIC
+          created by   root:
+            consumes   file:./
+            supplies   step:runpy ./plan.py
+
+step:runpy ./plan.py
+               state = SUCCEEDED
+          created by   root:
+            consumes   file:./
+            consumes   file:plan.py

stepup-3.0.2/tests/examples/inp_digest/plan.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+from stepup.core.api import getenv
+
+digest = getenv("STEPUP_STEP_INP_DIGEST")
+assert digest is not None

stepup-3.0.2/tests/examples/no_data/expected_stdout2.txt

@@ -0,0 +1,21 @@
+        0/0 |    STARTUP │ Making failed steps pending
+        0/0 |    STARTUP │ Watching 1 director(y|ies) from initial database
+        0/0 |    STARTUP │ Scanning initial database for changed files
+        0/0 |    STARTUP │ Scanning initial database for new nglob matches
+        0/0 |    UPDATED │ data.txt
+        0/0 |   DIRECTOR │ Launched worker 0
+        1/2 |      PHASE │ run
+        0/1 |      START │ runpy ./plan.py
+        1/3 |    SUCCESS │ runpy ./plan.py
+        1/3 |      START │ runsh grep -i foo data.txt > analyzed.txt
+        2/3 |    SUCCESS │ runsh grep -i foo data.txt > analyzed.txt
+        2/3 |       SKIP │ runsh cat analyzed.txt
+───────────────────────────── No changes observed ──────────────────────────────
+Same step hash       explained, inp_digest f25e1ed7, out_digest 786a02f7
+Same inp hash        ./
+Same inp hash        analyzed.txt
+────────────────────────────────────────────────────────────────────────────────
+        3/3 |   DIRECTOR │ Trying to delete 0 outdated output(s)
+        3/3 |      PHASE │ watch
+        3/3 |   DIRECTOR │ Stopping workers
+        3/3 |   DIRECTOR │ See you!

{stepup-3.0.0 → stepup-3.0.2}/tests/examples/pending/main.sh

@@ -15,7 +15,7 @@ stepup join
 
 # Wait for background processes, if any.
 set +e; wait -fn $PID; RETURNCODE=$?; set -e
-[[ "${RETURNCODE}" -eq 3 ]] || exit 1
+[[ "${RETURNCODE}" -eq 4 ]] || exit 1
 
 # Check files that are expected to be present and/or missing.
 [[ -f plan.py ]] || exit 1

{stepup-3.0.0 → stepup-3.0.2}/tests/examples/pending_nested/main.sh

@@ -48,7 +48,7 @@ stepup join
 # Wait for background processes, if any.
 # There must be pending steps.
 set +e; wait -fn $PID; RETURNCODE=$?; set -e
-[[ "${RETURNCODE}" -eq 3 ]] || exit 1
+[[ "${RETURNCODE}" -eq 4 ]] || exit 1
 
 # Check files that are expected to be present and/or missing.
 [[ -f plan.py ]] || exit 1