[PATCH 1/2] Notify and handle dry-run mode in progress client

[Christian Storm]

When running SWUpdate in dry-run mode, also notify and handle
it in the progress client, i.e., don't reboot.

Signed-off-by: Christian Storm <christi...@siemens.com>
Reported-by: Felix Moessbauer <felix.mo...@siemens.com>
Helped-by: Mark Jonas <toe...@gmail.com>
---
core/stream_interface.c | 4 ++++
include/progress_ipc.h | 1 +
tools/swupdate-progress.c | 5 +++++
3 files changed, 10 insertions(+)

diff --git a/core/stream_interface.c b/core/stream_interface.c
index 10359c30..56e40486 100644
--- a/core/stream_interface.c
+++ b/core/stream_interface.c
@@ -727,6 +727,10 @@ void *network_initializer(void *data)
swupdate_progress_info(RUN, CAUSE_REBOOT_MODE , "{ \"reboot-mode\" : \"no-reboot\"}");
}

+ if (software->parms.dry_run) {
+ swupdate_progress_info(RUN, CAUSE_DRY_RUN_MODE , "{ \"dry-run\" : true }");
+ }
+
ret = install_images(software);
if (ret != 0) {
update_transaction_state(software, STATE_FAILED);
diff --git a/include/progress_ipc.h b/include/progress_ipc.h
index 8638fb97..11a1b0b4 100644
--- a/include/progress_ipc.h
+++ b/include/progress_ipc.h
@@ -20,6 +20,7 @@ extern "C" {
typedef enum progress_cause {
CAUSE_NONE,
CAUSE_REBOOT_MODE,
+ CAUSE_DRY_RUN_MODE,
} progress_cause_t;

extern char* SOCKET_PROGRESS_PATH;
diff --git a/tools/swupdate-progress.c b/tools/swupdate-progress.c
index bd5a7913..dbf8f698 100644
--- a/tools/swupdate-progress.c
+++ b/tools/swupdate-progress.c
@@ -378,6 +378,11 @@ int main(int argc, char **argv)
}
}
}
+
+ n = sscanf(msg.info, "{\"%d\": { \"dry-run\" : true }}", &cause);
+ if (n == 1 && cause == CAUSE_DRY_RUN_MODE) {
+ disable_reboot = true;
+ }
}
msg.cur_image[sizeof(msg.cur_image) - 1] = '\0';

--
2.51.0

[Christian Storm]

Add support for dry-run mode to suricatta/wfx on a per job basis.
To enable dry-run mode, the job definition's "type" list needs to
contain the label "dry-run", e.g.,
{
"type": [
"firmware",
"dry-run"
],
...
}

See https://github.com/siemens/wfx/blob/main/workflow/dau/README.md#job-definition

Signed-off-by: Christian Storm <christi...@siemens.com>
---
suricatta/server_wfx.lua | 49 +++++++++++++++++++++++++++++++--------
tools/swupdate-progress.c | 4 ++--
2 files changed, 41 insertions(+), 12 deletions(-)

diff --git a/suricatta/server_wfx.lua b/suricatta/server_wfx.lua
index d0b01bad..2b9a3a58 100644
--- a/suricatta/server_wfx.lua
+++ b/suricatta/server_wfx.lua
@@ -1156,6 +1156,16 @@ function M.job.definition:is_firmware()
return self.type[M.dau.DEFAULT_UPDATE_TYPE] ~= nil
end

+--- Test whether update artifact should be installed in dry-run mode.
+--
+-- If one of `.type`'s tags matches `dry-run`, a dry-run installation of the
+-- artifact is performed.
+--
+--- @return boolean # `true` if dry-run should be performed, `false` if not
+function M.job.definition:is_dry_run()
+ return self.type["dry-run"] ~= nil
+end
+
-- ┌───────────────────────────────────────────────────────────────────────────
-- │ DeviceArtifactUpdate :: Transitions
-- └───────────────────────────────────────────────────────────────────────────
@@ -1229,10 +1239,16 @@ local function send_progress_activation_msg(job)
"module": "wfx",
"state": "ACTIVATING",
"progress": 100,
- "message": "%s"
+ "message": "%s",
+ "dry_run": %s
}
]])
- :format(suricatta.ipc.sourcetype.SOURCE_SURICATTA, table.concat(job.definition.type, ":")))
+ :format(
+ suricatta.ipc.sourcetype.SOURCE_SURICATTA,
+ table.concat(job.definition.type, ":"),
+ job.definition:is_dry_run()
+ )
+ )
end

--- Helper function to set persistent bootloader state.
@@ -1495,7 +1511,11 @@ M.job.workflow.dispatch:set(
artifact.name,
source_uri
)
- local res, _, updatelog = suricatta.install { channel = M.channel.main, url = source_uri }
+ local res, _, updatelog = suricatta.install({
+ channel = M.channel.main,
+ url = source_uri,
+ dry_run = job.definition:is_dry_run()
+ })
-- Unconditionally remove the artifact file ignoring errors, e.g., if run in streaming mode.
os.remove(("%s%s_%d.swu"):format(suricatta.get_tmpdir(), job.id, count))
if not res then
@@ -1653,7 +1673,7 @@ M.job.workflow.dispatch:set(
--- @return transition.result
function(self, job)
if not job.definition:is_firmware() then
- if M.device.pstate ~= suricatta.pstate.OK then
+ if M.device.pstate ~= suricatta.pstate.OK and not job.definition:is_dry_run() then
suricatta.notify.warn("Persistent state is not OK (is %s).", suricatta.pstate[M.device.pstate])
if not save_pstate(suricatta.pstate.OK) then
return M.transition.result.FAIL_YIELD
@@ -1668,12 +1688,15 @@ M.job.workflow.dispatch:set(
return job.workflow:call(M.state.dau.ACTIVATING, M.state.dau.ACTIVATED, job)
end

- suricatta.notify.debug("Job activation mode is 'firmware'.")
- if suricatta.pstate.get() == suricatta.pstate.INSTALLED then
- suricatta.notify.warn("Persistent state is already set to INSTALLED.")
+ if job.definition:is_dry_run() then
+ suricatta.notify.info("Job mode is 'dry-run', not persisting state.")
else
- if not save_pstate(suricatta.pstate.IN_PROGRESS) or not save_pstate(suricatta.pstate.INSTALLED) then
- return M.transition.result.FAIL_YIELD
+ if suricatta.pstate.get() == suricatta.pstate.INSTALLED then
+ suricatta.notify.warn("Persistent state is already set to INSTALLED.")
+ else
+ if not save_pstate(suricatta.pstate.IN_PROGRESS) or not save_pstate(suricatta.pstate.INSTALLED) then
+ return M.transition.result.FAIL_YIELD
+ end
end
end
M.device.pstate = suricatta.pstate.INSTALLED
@@ -1716,6 +1739,12 @@ M.job.workflow.dispatch:set(
return job.workflow:call(M.state.dau.ACTIVATING, M.state.dau.ACTIVATED, job)
end

+ if job.definition:is_dry_run() then
+ sync_job_status { self, job, message = "Update installed. Notifying Progress Client(s) to dry-run activate." }
+ send_progress_activation_msg(job)
+ return job.workflow:call(M.state.dau.ACTIVATING, M.state.dau.ACTIVATED, job)
+ end
+
-- Refresh `pstate` if dispatched in response to wfx query.
M.device.pstate = pstate or suricatta.pstate.get()

@@ -1726,7 +1755,7 @@ M.job.workflow.dispatch:set(
end

if M.device.pstate == suricatta.pstate.INSTALLED then
- sync_job_status { self, job, message = "Update installed. Notifying Progress Client(s) to reboot." }
+ sync_job_status { self, job, message = "Update installed. Notifying Progress Client(s) to activate." }
send_progress_activation_msg(job)
return M.transition.result.COMPLETED
end
diff --git a/tools/swupdate-progress.c b/tools/swupdate-progress.c
index dbf8f698..70d91469 100644
--- a/tools/swupdate-progress.c
+++ b/tools/swupdate-progress.c
@@ -477,11 +477,11 @@ int main(int argc, char **argv)
psplash_progress(psplash_pipe_path, &msg);
psplash_ok = 0;
}
- if (opt_r && strcasestr(msg.info, "firmware")) {
+ if (opt_r && strcasestr(msg.info, "\"dry_run\": false") && strcasestr(msg.info, "firmware")) {
reboot_device(reboot_script);
break;
}
- fprintf(stdout, "\nDon't know how to activate this update, doing nothing.\n");
+ fprintf(stdout, "No --reboot given, dry run, or not type firmware, not rebooting.\n");
}
break;
default:
--
2.51.0