xref: /aosp_15_r20/external/google-fruit/tests/test_normalized_component.py (revision a65addddcf69f38db5b288d787b6b7571a57bb8f)

#!/usr/bin/env python3
#  Copyright 2016 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS-IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from absl.testing import parameterized
from fruit_test_common import *

COMMON_DEFINITIONS = '''
    #include "test_common.h"

    struct X;

    struct Annotation1 {};
    using XAnnot1 = fruit::Annotated<Annotation1, X>;

    struct Annotation2 {};
    using XAnnot2 = fruit::Annotated<Annotation2, X>;
    '''

class TestNormalizedComponent(parameterized.TestCase):
    @parameterized.parameters([
        ('X', 'X', 'Y'),
        ('fruit::Annotated<Annotation1, X>', 'ANNOTATED(Annotation1, X)', 'fruit::Annotated<Annotation2, Y>'),
    ])
    def test_success_normalized_component_provides_unused(self, XAnnot, X_ANNOT, YAnnot):
        source = '''
            struct X {};

            struct Y {
              INJECT(Y(X_ANNOT)) {};
            };

            fruit::Component<fruit::Required<XAnnot>, YAnnot> getComponent() {
              return fruit::createComponent();
            }

            fruit::Component<XAnnot> getXComponent(X* x) {
              return fruit::createComponent()
                .bindInstance<XAnnot, X>(*x);
            }

            int main() {
              fruit::NormalizedComponent<fruit::Required<XAnnot>, YAnnot> normalizedComponent(getComponent);

              X x{};

              fruit::Injector<XAnnot> injector(normalizedComponent, getXComponent, &x);
              injector.get<XAnnot>();
            }
            '''
        expect_success(
            COMMON_DEFINITIONS,
            source,
            locals())

    @parameterized.parameters([
        ('X', 'X', 'Y'),
        ('fruit::Annotated<Annotation1, X>', 'ANNOTATED(Annotation1, X)', 'fruit::Annotated<Annotation2, Y>'),
    ])
    def test_success(self, XAnnot, X_ANNOT, YAnnot):
        source = '''
            struct X {};

            struct Y {
              INJECT(Y(X_ANNOT)) {};
            };

            fruit::Component<fruit::Required<XAnnot>, YAnnot> getComponent() {
              return fruit::createComponent();
            }

            fruit::Component<XAnnot> getXComponent(X* x) {
              return fruit::createComponent()
                .bindInstance<XAnnot, X>(*x);
            }

            int main() {
              fruit::NormalizedComponent<fruit::Required<XAnnot>, YAnnot> normalizedComponent(getComponent);

              X x{};

              fruit::Injector<YAnnot> injector(normalizedComponent, getXComponent, &x);
              injector.get<YAnnot>();
            }
            '''
        expect_success(
            COMMON_DEFINITIONS,
            source,
            locals())

    @parameterized.parameters([
        ('X', 'X', 'Y'),
        ('fruit::Annotated<Annotation1, X>', 'ANNOTATED(Annotation1, X)', 'fruit::Annotated<Annotation2, Y>'),
    ])
    def test_success_inline_component(self, XAnnot, X_ANNOT, YAnnot):
        source = '''
            struct X {};

            struct Y {
              INJECT(Y(X_ANNOT)) {};
            };

            fruit::Component<fruit::Required<XAnnot>, YAnnot> getComponent() {
              return fruit::createComponent();
            }

            fruit::Component<XAnnot> getAdditionalComponent(X* x) {
              return fruit::createComponent()
                .bindInstance<XAnnot, X>(*x);
            }

            int main() {
              fruit::NormalizedComponent<fruit::Required<XAnnot>, YAnnot> normalizedComponent(getComponent);

              X x{};

              fruit::Injector<YAnnot> injector(normalizedComponent, getAdditionalComponent, &x);
              injector.get<YAnnot>();
            }
            '''
        expect_success(
            COMMON_DEFINITIONS,
            source,
            locals())

    @parameterized.parameters([
        'X',
        'fruit::Annotated<Annotation1, X>',
    ])
    def test_injector_from_normalized_component_unsatisfied_requirements(self, XAnnot):
        source = '''
            struct X {};

            fruit::Component<fruit::Required<XAnnot>> getComponent();
            fruit::Component<> getEmptyComponent();

            int main() {
              fruit::NormalizedComponent<fruit::Required<XAnnot>> normalizedComponent(getComponent);
              fruit::Injector<> injector(normalizedComponent, getEmptyComponent);
            }
            '''
        expect_compile_error(
            'UnsatisfiedRequirementsInNormalizedComponentError<XAnnot>',
            'The requirements in UnsatisfiedRequirements are required by the NormalizedComponent but are not provided by the Component',
            COMMON_DEFINITIONS,
            source,
            locals())

    @parameterized.parameters([
        ('X', 'const X'),
        ('fruit::Annotated<Annotation1, X>', 'fruit::Annotated<Annotation1, const X>'),
    ])
    def test_normalized_component_providing_nonconst_from_component_providing_const_error(self, XAnnot, ConstXAnnot):
        source = '''
            struct X {};

            fruit::Component<XAnnot> getComponent();

            int main() {
              fruit::NormalizedComponent<ConstXAnnot> normalizedComponent(getComponent);
              (void) normalizedComponent;
            }
            '''
        expect_generic_compile_error(
            r'no matching function for call to .fruit::NormalizedComponent<ConstXAnnot>::NormalizedComponent\(fruit::Component<XAnnot> \(&\)\(\)\).'
            r'|no matching constructor for initialization of .fruit::NormalizedComponent<ConstXAnnot>.'
            r'|.fruit::NormalizedComponent<ConstXAnnot>::NormalizedComponent.: no overloaded function could convert all the argument types'
            r'|.fruit::NormalizedComponent<ConstXAnnot>::NormalizedComponent.: none of the .* overloads could convert all the argument types',
            COMMON_DEFINITIONS,
            source,
            locals())

    # TODO: we should probably return a more specific error here.
    @parameterized.parameters([
        ('X', 'Y'),
        ('fruit::Annotated<Annotation1, X>', 'fruit::Annotated<Annotation2, Y>'),
    ])
    def test_injector_from_normalized_component_nonconst_requirements_provided_as_const_error(self, XAnnot, YAnnot):
        source = '''
            struct X {};
            struct Y {};

            fruit::Component<const XAnnot> getXComponent();

            void f(fruit::NormalizedComponent<fruit::Required<XAnnot>, YAnnot> normalizedComponent) {
              fruit::Injector<YAnnot> injector(normalizedComponent, getXComponent);
            }
            '''
        expect_compile_error(
            'NonConstBindingRequiredButConstBindingProvidedError<XAnnot>',
            'The type T was provided as constant, however one of the constructors/providers/factories in this component',
            COMMON_DEFINITIONS,
            source,
            locals())

if __name__ == '__main__':
    absltest.main()