Skip to content

Re-iterate on #194 again... #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
safl merged 2 commits into from
Oct 2, 2025
Merged

Re-iterate on #194 again... #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ba2583
refactor(core/scripts): rename wait_for_ssh to wait_for_transport
safl Oct 2, 2025
62c5df4
ver: bump to v0.9.57
safl Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/cijoe_docker.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ on:

env:
DOCKER_IMAGE: ghcr.io/${{ github.repository_owner }}/cijoe-docker
DOCKER_TAG: v0.9.56
DOCKER_TAG: v0.9.57

jobs:
build_and_push:
Expand Down
2 changes: 1 addition & 1 deletion src/cijoe/core/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.9.56"
__version__ = "0.9.57"
80 changes: 51 additions & 29 deletions src/cijoe/core/scripts/wait_for_ssh.py → src/cijoe/core/scripts/wait_for_transport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,56 @@
#!/usr/bin/env python3
"""
Wait for SSH transport state (up or down)
=========================================

This script is useful in CIJOE workflows where you want to block until a remote
transport becomes available (e.g., after a reboot) or until it goes away (e.g.,
while shutting down). A common usecase would look like the below steps in
a workflow:

- name: reboot
run: shutdown -r now

- name: wait_for_down
uses: wait_for_transport
with:
state: "down"
timeout: 60

- name: wait_for_up
uses: wait_for_transport
with:
state: "up"
timeout: 300

The transport is considered "up" if a trivial command can be executed
successfully over it. For portability across Linux, macOS, BSD, and Windows, the
probe command used is: hostname.

Retargetable: True
------------------
Wait for Transport State (Up or Down)
=====================================

This script is useful in CIJOE workflows where execution should block until a
transport becomes available (e.g., after a reboot) or unavailable (e.g., during
shutdown).

Transport Configuration
-----------------------

Transports are defined in ``config.toml`` under the key
``cijoe.transport.{transport_name}``. For example::

[cijoe.transport.ssh]
username = "foo"
hostname = "bar"

Note: ``ssh`` is a transport **name**, not a transport type.
So, ``transport_name = "ssh"``.

Example Use Case
----------------

A typical workflow might look like::

- name: reboot
run: shutdown -r now

- name: wait_for_down
uses: wait_for_transport
with:
state: "down"
timeout: 60

- name: wait_for_up
uses: wait_for_transport
with:
state: "up"
timeout: 300

Transport State Detection
-------------------------

The transport is considered *up* if a simple command can be executed
successfully over it. To ensure portability across Linux, macOS, BSD, and
Windows, the ``hostname`` command is used as the probe.

Retargetable
------------

**True**
"""

import logging as log
Expand Down
2 changes: 1 addition & 1 deletion src/cijoe/qemu/workflows/example_workflow_guest_aarch64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ steps:
guest_name: generic-uefi-tcg-aarch64

- name: guest_wait_start
uses: core.wait_for_ssh
uses: core.wait_for_transport
with:
transport_name: qemu_guest
timeout: 120
Expand Down
2 changes: 1 addition & 1 deletion src/cijoe/qemu/workflows/example_workflow_guest_x86_64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ steps:
guest_name: generic-bios-kvm-x86_64

- name: guest_wait_start
uses: core.wait_for_ssh
uses: core.wait_for_transport
with:
transport_name: qemu_guest
timeout: 120
Expand Down