blob: 270d126905d38a00c9b967ae79ca5c00574f1ed4 [file] [log] [blame]
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +02001# Copyright 2017-present Open Networking Foundation
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15import unittest
Scott Baker1f7791d2018-10-04 13:21:20 -070016from xosgenx.generator import XOSProcessor, XOSProcessorArgs
17from helpers import XProtoTestHelpers
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +020018
19
Matteo Scandolo727e19c2017-12-05 12:53:16 -080020class XProtoToscaTypeTest(unittest.TestCase):
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +020021
22 def setUp(self):
Matteo Scandolo727e19c2017-12-05 12:53:16 -080023 self.target_tosca_type = XProtoTestHelpers.write_tmp_target(
24 """
25 {%- for m in proto.messages %}
26 {% for f in m.fields %}
27 {{ xproto_tosca_field_type(f.type) }}
28 {% endfor -%}
29 {% endfor -%}
30 """)
31 def test_tosca_fields(self):
32 """
33 [XOS-GenX] should convert xproto types to tosca know types
34 """
35 xproto = \
36 """
37 option app_label = "test";
38
39 message Foo {
40 required string name = 1 [ null = "False", blank="False"];
41 required bool active = 1 [ null = "False", blank="False"];
42 required int32 quantity = 1 [ null = "False", blank="False"];
43 }
44 """
45
Scott Baker1f7791d2018-10-04 13:21:20 -070046 args = XOSProcessorArgs()
Matteo Scandolo727e19c2017-12-05 12:53:16 -080047 args.inputs = xproto
48 args.target = self.target_tosca_type
Sapan Bhatiabfb233a2018-02-09 14:53:09 -080049 output = XOSProcessor.process(args)
Matteo Scandolo727e19c2017-12-05 12:53:16 -080050 self.assertIn('string', output)
51 self.assertIn('boolean', output)
52 self.assertIn('integer', output)
53
54class XProtoToscaKeyTest(unittest.TestCase):
55
56 def setUp(self):
57 self.target_tosca_keys = XProtoTestHelpers.write_tmp_target(
58 """
59 {%- for m in proto.messages %}
Matteo Scandoloa17e6e42018-05-25 10:28:25 -070060 {{ xproto_fields_to_tosca_keys(m.fields, m) }}
Matteo Scandolo727e19c2017-12-05 12:53:16 -080061 {% endfor -%}
62 """)
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +020063
64 def test_xproto_fields_to_tosca_keys_default(self):
65 """
66 [XOS-GenX] if no "tosca_key" is specified, and a name attribute is present in the model, use that
67 """
68 xproto = \
69"""
70option app_label = "test";
71
72message Foo {
73 required string name = 1 [ null = "False", blank="False"];
74}
75"""
76
Scott Baker1f7791d2018-10-04 13:21:20 -070077 args = XOSProcessorArgs()
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +020078 args.inputs = xproto
Matteo Scandolo727e19c2017-12-05 12:53:16 -080079 args.target = self.target_tosca_keys
Sapan Bhatiabfb233a2018-02-09 14:53:09 -080080 output = XOSProcessor.process(args)
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +020081 self.assertIn('name', output)
82
83 def test_xproto_fields_to_tosca_keys_custom(self):
84 """
85 [XOS-GenX] if "tosca_key" is specified, use it
86 """
87 xproto = \
88 """
89 option app_label = "test";
90
91 message Foo {
92 required string name = 1 [ null = "False", blank="False"];
93 required string key_1 = 2 [ null = "False", blank="False", tosca_key=True];
94 required string key_2 = 3 [ null = "False", blank="False", tosca_key=True];
95 }
96 """
97
Scott Baker1f7791d2018-10-04 13:21:20 -070098 args = XOSProcessorArgs()
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +020099 args.inputs = xproto
Matteo Scandolo727e19c2017-12-05 12:53:16 -0800100 args.target = self.target_tosca_keys
Sapan Bhatiabfb233a2018-02-09 14:53:09 -0800101 output = XOSProcessor.process(args)
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +0200102 self.assertNotIn('name', output)
103 self.assertIn('key_1', output)
104 self.assertIn('key_2', output)
105
106 def test_xproto_fields_link_to_tosca_keys_custom(self):
107 """
108 [XOS-GenX] if "tosca_key" is specified, use it
109 """
110 xproto = \
111 """
112 option app_label = "test";
113
114 message Foo {
115 required string name = 1 [ null = "False", blank="False"];
116 required manytoone provider_service_instance->ServiceInstance:provided_links = 1 [db_index = True, null = False, blank = False, tosca_key=True];
117 }
118 """
119
Scott Baker1f7791d2018-10-04 13:21:20 -0700120 args = XOSProcessorArgs()
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +0200121 args.inputs = xproto
Matteo Scandolo727e19c2017-12-05 12:53:16 -0800122 args.target = self.target_tosca_keys
Sapan Bhatiabfb233a2018-02-09 14:53:09 -0800123 output = XOSProcessor.process(args)
Matteo Scandoloc3c0f0a2017-10-18 09:53:30 +0200124 self.assertNotIn('name', output)
Matteo Scandolo68ab5432017-12-06 15:38:13 -0800125 self.assertIn('provider_service_instance_id', output)
126
127 def test_xproto_model_to_oneof_key(self):
128 """
129 [XOS-GenX] in some models we need to have a combine key on variable fields, for example, keys can be subscriber_service_id + oneof(provider_service_id, provider_network_id)
130 """
131 xproto = \
132 """
133 option app_label = "test";
134
135 message Foo {
136
137 option tosca_key = "key1, oneof(key_2, key_3)";
138
139 required string name = 1 [ null = "False", blank="False"];
140 required string key_1 = 2 [ null = "False", blank="False", tosca_key_one_of = "key_2"];
141 required string key_2 = 3 [ null = "False", blank="False", tosca_key_one_of = "key_1"];
142 required string key_3 = 4 [ null = "False", blank="False", tosca_key_one_of = "key_4"];
143 required string key_4 = 5 [ null = "False", blank="False", tosca_key_one_of = "key_3"];
144 }
145 """
146
Scott Baker1f7791d2018-10-04 13:21:20 -0700147 args = XOSProcessorArgs()
Matteo Scandolo68ab5432017-12-06 15:38:13 -0800148 args.inputs = xproto
149 args.target = self.target_tosca_keys
Sapan Bhatiabfb233a2018-02-09 14:53:09 -0800150 output = XOSProcessor.process(args)
Matteo Scandolo68ab5432017-12-06 15:38:13 -0800151 self.assertIn("['name', ['key_4', 'key_3'], ['key_1', 'key_2']]", output)
152
153 xproto = \
154 """
155 option app_label = "test";
156
157 message Foo {
158
159 option tosca_key = "key1, oneof(key_2, key_3)";
160
161 required string name = 1 [ null = "False", blank="False"];
162 required manytoone key_1->Bar:key_1s = 2;
163 required manytoone key_2->Bar:key_2s = 3 [tosca_key_one_of = "key_1"];
164 required manytoone key_3->Bar:key_3s = 4 [tosca_key_one_of = "key_1"];
165 }
166 """
167
168 args.inputs = xproto
Sapan Bhatiabfb233a2018-02-09 14:53:09 -0800169 output = XOSProcessor.process(args)
170 self.assertIn("['name', ['key_1_id', 'key_3_id', 'key_2_id']]", output)