tools/fidl/fidlgen_python/tests/test_union.py

# Copyright 2025 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import unittest

import fidl_fuchsia_controller_test as fc_test
import fidl_test_python_protocol as test_python_protocol
from fidl import FrameworkError


class UnionTestSuite(unittest.TestCase):
    """Tests for FIDL union types"""

    def test_union_equal(self) -> None:
        self.assertEqual(
            fc_test.NoopUnion(union_str="foo"),
            fc_test.NoopUnion(union_str="foo"),
        )

    def test_union_not_equal(self) -> None:
        self.assertNotEqual(
            fc_test.NoopUnion(union_str="foo"),
            fc_test.NoopUnion(union_str="bar"),
        )

    def test_union_equal_default(self) -> None:
        self.assertEqual(
            fc_test.NoopUnion.make_default(), fc_test.NoopUnion.make_default()
        )

    def test_union_not_equal_default(self) -> None:
        self.assertNotEqual(
            fc_test.NoopUnion.make_default(), fc_test.NoopUnion(union_str="foo")
        )

    def test_flexible_union_empty(self) -> None:
        fc_test.EmptyUnion()

    def test_union_multiple_variants(self) -> None:
        with self.assertRaises(TypeError):
            fc_test.NoopUnion(union_str="foo", union_bool=True)

    def test_union_no_variants(self) -> None:
        with self.assertRaises(TypeError):
            fc_test.NoopUnion()

    def test_union_result_with_none_response(self) -> None:
        fc_test.FlexibleMethodTesterFlexibleTwoWayUnionResult(response=None)

    def test_union_make_default_then_fill(self) -> None:
        obj = fc_test.NoopUnion.make_default()
        obj._union_str = "foo"
        self.assertEqual(obj.union_str, "foo")

    def test_union_result_make_default_then_fill_response(self) -> None:
        obj = (
            fc_test.FlexibleMethodTesterFlexibleTwoWayUnionResult.make_default()
        )
        obj._response = None
        self.assertIsNone(obj.response)

    def test_union_result_make_default_then_fill_framework_err(self) -> None:
        obj = (
            fc_test.FlexibleMethodTesterFlexibleTwoWayUnionResult.make_default()
        )
        obj._framework_err = FrameworkError.UNKNOWN_METHOD
        self.assertEqual(
            obj,
            fc_test.FlexibleMethodTesterFlexibleTwoWayUnionResult(
                framework_err=FrameworkError.UNKNOWN_METHOD
            ),
        )

    def test_union_unwrap_response(self) -> None:
        response = test_python_protocol.OpenProtocolFlexibleMethodNonEmptyResponseWithErrorResult(
            response=test_python_protocol.OpenProtocolFlexibleMethodNonEmptyResponseWithErrorResponse(
                b=True
            )
        ).unwrap()
        self.assertEqual(
            response,
            test_python_protocol.OpenProtocolFlexibleMethodNonEmptyResponseWithErrorResponse(
                b=True
            ),
        )

    def test_union_unwrap_response_none(self) -> None:
        test_python_protocol.OpenProtocolFlexibleMethodEmptyResponseWithErrorResult(
            response=None
        ).unwrap()

    def test_union_unwrap_framework_err(self) -> None:
        with self.assertRaises(AssertionError):
            test_python_protocol.OpenProtocolFlexibleMethodEmptyResponseWithErrorResult(
                framework_err=FrameworkError.UNKNOWN_METHOD
            ).unwrap()

    def test_union_unwrap__err(self) -> None:
        with self.assertRaises(AssertionError):
            test_python_protocol.OpenProtocolFlexibleMethodEmptyResponseWithErrorResult(
                err=3
            ).unwrap()