summaryrefslogtreecommitdiff
path: root/utils/ipc/mojo/public/tools/bindings/checks/mojom_attributes_check_unittest.py
blob: f1a50a4ab508007226960d69dde684aebc9b6186 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# Copyright 2022 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import unittest

import mojom.generate.check as check
from mojom_bindings_generator import LoadChecks, _Generate
from mojom_parser_test_case import MojomParserTestCase


class FakeArgs:
  """Fakes args to _Generate - intention is to do just enough to run checks"""

  def __init__(self, tester, files=None):
    """ `tester` is MojomParserTestCase for paths.
        `files` will have tester path added."""
    self.checks_string = 'attributes'
    self.depth = tester.GetPath('')
    self.filelist = None
    self.filename = [tester.GetPath(x) for x in files]
    self.gen_directories = tester.GetPath('gen')
    self.generators_string = ''
    self.import_directories = []
    self.output_dir = tester.GetPath('out')
    self.scrambled_message_id_salt_paths = None
    self.typemaps = []
    self.variant = 'none'


class MojoBindingsCheckTest(MojomParserTestCase):
  def _ParseAndGenerate(self, mojoms):
    self.ParseMojoms(mojoms)
    args = FakeArgs(self, files=mojoms)
    _Generate(args, {})

  def _testValid(self, filename, content):
    self.WriteFile(filename, content)
    self._ParseAndGenerate([filename])

  def _testThrows(self, filename, content, regexp):
    mojoms = []
    self.WriteFile(filename, content)
    mojoms.append(filename)
    with self.assertRaisesRegexp(check.CheckException, regexp):
      self._ParseAndGenerate(mojoms)

  def testLoads(self):
    """Validate that the check is registered under the expected name."""
    check_modules = LoadChecks('attributes')
    self.assertTrue(check_modules['attributes'])

  def testNoAnnotations(self):
    # Undecorated mojom should be fine.
    self._testValid(
        "a.mojom", """
      module a;
      struct Bar { int32 a; };
      enum Hello { kValue };
      union Thingy { Bar b; Hello hi; };
      interface Foo {
        Foo(int32 a, Hello hi, Thingy t) => (Bar b);
      };
    """)

  def testValidAnnotations(self):
    # Obviously this is meaningless and won't generate, but it should pass
    # the attribute check's validation.
    self._testValid(
        "a.mojom", """
      [JavaConstantsClassName="FakeClass",JavaPackage="org.chromium.Fake"]
      module a;
      [Stable, Extensible]
      enum Hello { [Default] kValue, kValue2, [MinVersion=2] kValue3 };
      [Native]
      enum NativeEnum {};
      [Stable,Extensible]
      union Thingy { Bar b; [Default]int32 c; Hello hi; };

      [Stable,RenamedFrom="module.other.Foo",
       Uuid="4C178401-4B07-4C2E-9255-5401A943D0C7"]
      struct Structure { Hello hi; };

      [ServiceSandbox=Hello.kValue,RequireContext=Hello.kValue,Stable,
       Uuid="2F17D7DD-865A-4B1C-9394-9C94E035E82F"]
      interface Foo {
        [AllowedContext=Hello.kValue]
        Foo@0(int32 a) => (int32 b);
        [MinVersion=2,Sync,UnlimitedSize,NoInterrupt]
        Bar@1(int32 b, [MinVersion=2]Structure? s) => (bool c);
      };

      [RuntimeFeature=test.mojom.FeatureName]
      interface FooFeatureControlled {};

      interface FooMethodFeatureControlled {
        [RuntimeFeature=test.mojom.FeatureName]
        MethodWithFeature() => (bool c);
      };
    """)

  def testWrongModuleStable(self):
    contents = """
      // err: module cannot be Stable
      [Stable]
      module a;
      enum Hello { kValue, kValue2, kValue3 };
      enum NativeEnum {};
      struct Structure { Hello hi; };

      interface Foo {
        Foo(int32 a) => (int32 b);
        Bar(int32 b, Structure? s) => (bool c);
      };
    """
    self._testThrows('b.mojom', contents,
                     'attribute Stable not allowed on module')

  def testWrongEnumDefault(self):
    contents = """
      module a;
      // err: default should go on EnumValue not Enum.
      [Default=kValue]
      enum Hello { kValue, kValue2, kValue3 };
      enum NativeEnum {};
      struct Structure { Hello hi; };

      interface Foo {
        Foo(int32 a) => (int32 b);
        Bar(int32 b, Structure? s) => (bool c);
      };
    """
    self._testThrows('b.mojom', contents,
                     'attribute Default not allowed on enum')

  def testWrongStructMinVersion(self):
    contents = """
      module a;
      enum Hello { kValue, kValue2, kValue3 };
      enum NativeEnum {};
      // err: struct cannot have MinVersion.
      [MinVersion=2]
      struct Structure { Hello hi; };

      interface Foo {
        Foo(int32 a) => (int32 b);
        Bar(int32 b, Structure? s) => (bool c);
      };
    """
    self._testThrows('b.mojom', contents,
                     'attribute MinVersion not allowed on struct')

  def testWrongMethodRequireContext(self):
    contents = """
      module a;
      enum Hello { kValue, kValue2, kValue3 };
      enum NativeEnum {};
      struct Structure { Hello hi; };

      interface Foo {
        // err: RequireContext is for interfaces.
        [RequireContext=Hello.kValue]
        Foo(int32 a) => (int32 b);
        Bar(int32 b, Structure? s) => (bool c);
      };
    """
    self._testThrows('b.mojom', contents,
                     'RequireContext not allowed on method')

  def testWrongMethodRequireContext(self):
    # crbug.com/1230122
    contents = """
      module a;
      interface Foo {
        // err: sync not Sync.
        [sync]
        Foo(int32 a) => (int32 b);
      };
    """
    self._testThrows('b.mojom', contents,
                     'attribute sync not allowed.*Did you mean: Sync')

  def testStableExtensibleEnum(self):
    # crbug.com/1193875
    contents = """
      module a;
      [Stable]
      enum Foo {
        kDefaultVal,
        kOtherVal = 2,
      };
    """
    self._testThrows('a.mojom', contents,
                     'Extensible.*?required.*?Stable.*?enum')