Shell script handlers by freq (#1166)

Handlers for per-boot/per-instance/per-once multipart MIME

Add handlers for adding scripts to userdata that can be run at various
frequencies. Scripts of type x-shellscript-per-boot,
x-shellscript-per-instance, or x-shellscript-per-once can be added
to a multipart MIME userdata message as part of instance userdata.
These scripts will then be added to the appropriate per-boot,
per-instance, or per-once directory in /var/lib/cloud/scripts/
during processing of userdata.

1 files changed, 48 insertions, 0 deletions

diff --git a/tests/integration_tests/test_shell_script_by_frequency.py b/tests/integration_tests/test_shell_script_by_frequency.py
new file mode 100644
index 00000000..25157722
--- /dev/null
+++ b/tests/integration_tests/test_shell_script_by_frequency.py
@@ -0,0 +1,48 @@
+"""Integration tests for various handlers."""
+
+from io import StringIO
+
+import pytest
+
+from cloudinit.cmd.devel.make_mime import create_mime_message
+from tests.integration_tests.instances import IntegrationInstance
+
+PER_FREQ_TEMPLATE = """\
+#!/bin/bash
+touch /tmp/test_per_freq_{}
+"""
+
+PER_ALWAYS_FILE = StringIO(PER_FREQ_TEMPLATE.format("always"))
+PER_INSTANCE_FILE = StringIO(PER_FREQ_TEMPLATE.format("instance"))
+PER_ONCE_FILE = StringIO(PER_FREQ_TEMPLATE.format("once"))
+
+FILES = [
+    (PER_ALWAYS_FILE, "always.sh", "x-shellscript-per-boot"),
+    (PER_INSTANCE_FILE, "instance.sh", "x-shellscript-per-instance"),
+    (PER_ONCE_FILE, "once.sh", "x-shellscript-per-once"),
+]
+
+USER_DATA, errors = create_mime_message(FILES)
+
+
+@pytest.mark.ci
+@pytest.mark.user_data(USER_DATA)
+def test_per_freq(client: IntegrationInstance):
+    # Sanity test for scripts folder
+    cmd = "test -d /var/lib/cloud/scripts"
+    assert client.execute(cmd).ok
+    # Test per-boot
+    cmd = "test -f /var/lib/cloud/scripts/per-boot/always.sh"
+    assert client.execute(cmd).ok
+    cmd = "test -f /tmp/test_per_freq_always"
+    assert client.execute(cmd).ok
+    # Test per-instance
+    cmd = "test -f /var/lib/cloud/scripts/per-instance/instance.sh"
+    assert client.execute(cmd).ok
+    cmd = "test -f /tmp/test_per_freq_instance"
+    assert client.execute(cmd).ok
+    # Test per-once
+    cmd = "test -f /var/lib/cloud/scripts/per-once/once.sh"
+    assert client.execute(cmd).ok
+    cmd = "test -f /tmp/test_per_freq_once"
+    assert client.execute(cmd).ok