computer-playbook/tests/unit/python/utils/github/test_run_name.py

"""Unit tests for utils.github.run_name: the emoji head each input's segment
opens with, the openings that terminate a value, and the round trip through
the declared run name."""

from __future__ import annotations

import unittest

from tests.utils.ci.run_name import render
from utils.github import run_name

TPL = (
    "🕹️ "
    "${{ inputs.sequencing != 'auto'"
    " && format('🐛{0} ', inputs.sequencing == 'serial' && '序' || '并') || '' }}"
    "${{ inputs.mode_fail_fast && '🛑 ' || '' }}"
    "${{ inputs.workspace != 'auto'"
    " && format('🧑{0} ', inputs.workspace == 'true' && '是' || '否') || '' }}"
    "${{ inputs.distros != '' && format('🐧{0} ', inputs.distros) || '' }}"
    "${{ inputs.priority != '' && format('⭐{0} ', inputs.priority) || '' }}"
    "${{ inputs.whitelist != ''"
    " && format('🎯{0}', inputs.whitelist) || '🔀 diff (origin/main)' }}"
)


class SegmentTests(unittest.TestCase):
    def test_value_segments_map_their_input_to_a_head(self) -> None:
        self.assertEqual(
            run_name.heads(TPL),
            {
                "sequencing": "🐛",
                "workspace": "🧑",
                "distros": "🐧",
                "priority": "⭐",
                "whitelist": "🎯",
            },
        )

    def test_a_valueless_segment_is_a_marker(self) -> None:
        self.assertEqual(run_name.markers(TPL), {"mode_fail_fast": "🛑"})

    def test_an_input_without_a_value_segment_is_rejected(self) -> None:
        with self.assertRaises(ValueError):
            run_name.value_from_title("🕹️ 🐧arch", "lifecycles", TPL)


class HeadlessSegmentTests(unittest.TestCase):
    """An input whose ``format()`` opens with nothing carries no value.

    ``str.find('')`` matches at position 0, so an empty head would hand back
    the title's own prefix as the value. Such an input renders a glyph for the
    reader and is recovered from the job log instead."""

    NETWORK = (
        "${{ inputs.network != 'auto' && format('{0} ',"
        " inputs.network == 'clearnet' && '🌐'"
        " || inputs.network == 'tor' && '🧅' || '🌈') || '' }}"
    )

    TPL = (
        "🕹️ "
        + NETWORK
        + "${{ inputs.distros != '' && format('🐧{0} ', inputs.distros) || '' }}"
    )

    def test_it_is_the_network_segment_the_declared_run_name_renders(self) -> None:
        self.assertIn(self.NETWORK, run_name.template())

    def test_it_yields_no_segment(self) -> None:
        self.assertNotIn("network", run_name.heads(self.TPL))
        self.assertNotIn("network", run_name.markers(self.TPL))

    def test_its_glyphs_still_terminate_the_value_before_them(self) -> None:
        found = run_name.openings(self.TPL)
        self.assertIn("🌐", found)
        self.assertIn("🧅", found)
        self.assertIn("🌈", found)

    def test_a_neighbour_value_survives_the_glyph(self) -> None:
        self.assertEqual(
            run_name.value_from_title("🕹️ 🌈 🐧arch debian", "distros", self.TPL),
            "arch debian",
        )

    def test_the_title_reports_no_value_for_it(self) -> None:
        self.assertNotIn("network", run_name.values_from_title("🕹️ 🧅 🐧arch", self.TPL))


class OpeningTests(unittest.TestCase):
    def test_compared_operands_and_value_glyphs_are_not_openings(self) -> None:
        found = run_name.openings(TPL)
        self.assertNotIn("auto", found)
        self.assertNotIn("true", found)
        self.assertNotIn("是", found)
        self.assertNotIn("否", found)
        self.assertNotIn("序", found)

    def test_the_diff_fallback_is_an_opening(self) -> None:
        self.assertIn("🔀 diff (origin/main)", run_name.openings(TPL))


class ValueTests(unittest.TestCase):
    def test_a_following_segment_ends_the_value(self) -> None:
        title = "🕹️ 🐧debian ubuntu ⭐web-app-x 🎯__ALL__"
        self.assertEqual(
            run_name.value_from_title(title, "distros", TPL), "debian ubuntu"
        )

    def test_the_diff_fallback_ends_the_value(self) -> None:
        title = "🕹️ 🐧arch 🔀 diff (origin/main)"
        self.assertEqual(run_name.value_from_title(title, "distros", TPL), "arch")

    def test_a_glyph_reads_back_as_its_value(self) -> None:
        title = "🕹️ 🧑是 🐧arch"
        self.assertEqual(run_name.value_from_title(title, "workspace", TPL), "true")

    def test_a_marker_reads_back_by_its_presence(self) -> None:
        self.assertEqual(
            run_name.values_from_title("🕹️ 🛑 🐧arch", TPL)["mode_fail_fast"], "true"
        )
        self.assertEqual(
            run_name.values_from_title("🕹️ 🐧arch", TPL)["mode_fail_fast"], "false"
        )

    def test_a_default_input_records_nothing(self) -> None:
        title = "🕹️ 🐧arch 🔀 diff (origin/main)"
        self.assertEqual(run_name.value_from_title(title, "sequencing", TPL), "")

    def test_a_foreign_title_yields_nothing(self) -> None:
        self.assertEqual(run_name.values_from_title("CI: Pull Request", TPL), {})


class DeclaredTemplateTests(unittest.TestCase):
    def test_the_declared_run_name_round_trips(self) -> None:
        dispatched = {
            "chunk_gate": "true",
            "workspace": "true",
            "filesystem": "ext4",
            "distros": "debian arch",
            "lifecycles": "stable",
            "mode": "swarm",
        }
        self.assertEqual(run_name.values_from_title(render(dispatched)), dispatched)


if __name__ == "__main__":
    unittest.main()