From 600b870b399feb9e072748e07ea223556261fbe7 Mon Sep 17 00:00:00 2001
From: Chris Lalos <chris.lalos@gmail.com>
Date: Thu, 10 Feb 2022 15:49:38 -0600
Subject: 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.
---
 .../test_shell_script_by_frequency.py              | 48 ++++++++++++++++++++++
 tests/unittests/test_builtin_handlers.py           | 25 ++++++++++-
 2 files changed, 72 insertions(+), 1 deletion(-)
 create mode 100644 tests/integration_tests/test_shell_script_by_frequency.py

(limited to 'tests')

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
diff --git a/tests/unittests/test_builtin_handlers.py b/tests/unittests/test_builtin_handlers.py
index a057be2a..0dae924d 100644
--- a/tests/unittests/test_builtin_handlers.py
+++ b/tests/unittests/test_builtin_handlers.py
@@ -12,6 +12,7 @@ from textwrap import dedent
 import pytest
 
 from cloudinit import handlers, helpers, subp, util
+from cloudinit.cmd.devel import read_cfg_paths
 from cloudinit.handlers.cloud_config import CloudConfigPartHandler
 from cloudinit.handlers.jinja_template import (
     JinjaTemplatePartHandler,
@@ -19,8 +20,12 @@ from cloudinit.handlers.jinja_template import (
     render_jinja_payload,
 )
 from cloudinit.handlers.shell_script import ShellScriptPartHandler
+from cloudinit.handlers.shell_script_by_frequency import (
+    get_script_folder_by_frequency,
+    path_map,
+)
 from cloudinit.handlers.upstart_job import UpstartJobPartHandler
-from cloudinit.settings import PER_ALWAYS, PER_INSTANCE
+from cloudinit.settings import PER_ALWAYS, PER_INSTANCE, PER_ONCE
 from tests.unittests.helpers import (
     CiTestCase,
     FilesystemMockingTestCase,
@@ -473,4 +478,22 @@ class TestRenderJinjaPayload(CiTestCase):
         self.assertIn(expected_log, self.logs.getvalue())
 
 
+class TestShellScriptByFrequencyHandlers:
+    def do_test_frequency(self, frequency):
+        ci_paths = read_cfg_paths()
+        scripts_dir = ci_paths.get_cpath("scripts")
+        testFolder = os.path.join(scripts_dir, path_map[frequency])
+        folder = get_script_folder_by_frequency(frequency, scripts_dir)
+        assert testFolder == folder
+
+    def test_get_script_folder_per_boot(self):
+        self.do_test_frequency(PER_ALWAYS)
+
+    def test_get_script_folder_per_instance(self):
+        self.do_test_frequency(PER_INSTANCE)
+
+    def test_get_script_folder_per_once(self):
+        self.do_test_frequency(PER_ONCE)
+
+
 # vi: ts=4 expandtab
-- 
cgit v1.2.3