1#
2# Licensed to the Apache Software Foundation (ASF) under one
3# or more contributor license agreements. See the NOTICE file
4# distributed with this work for additional information
5# regarding copyright ownership. The ASF licenses this file
6# to you under the Apache License, Version 2.0 (the
7# "License"); you may not use this file except in compliance
8# with the License. You may obtain a copy of the License at
9#
10#   http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing,
13# software distributed under the License is distributed on an
14# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15# KIND, either express or implied. See the License for the
16# specific language governing permissions and limitations
17# under the License.
18#
19
20require 'spec_helper'
21
22describe 'Union' do
23
24  describe Thrift::Union do
25    it "should return nil value in unset union" do
26      union = SpecNamespace::My_union.new
27      expect(union.get_set_field).to eq(nil)
28      expect(union.get_value).to eq(nil)
29    end
30
31    it "should set a field and be accessible through get_value and the named field accessor" do
32      union = SpecNamespace::My_union.new
33      union.integer32 = 25
34      expect(union.get_set_field).to eq(:integer32)
35      expect(union.get_value).to eq(25)
36      expect(union.integer32).to eq(25)
37    end
38
39    it "should work correctly when instantiated with static field constructors" do
40      union = SpecNamespace::My_union.integer32(5)
41      expect(union.get_set_field).to eq(:integer32)
42      expect(union.integer32).to eq(5)
43    end
44
45    it "should raise for wrong set field" do
46      union = SpecNamespace::My_union.new
47      union.integer32 = 25
48      expect { union.some_characters }.to raise_error(RuntimeError, "some_characters is not union's set field.")
49    end
50
51    it "should raise for wrong set field when hash initialized and type checking is off" do
52      Thrift.type_checking = false
53      union = SpecNamespace::My_union.new({incorrect_field: :incorrect})
54      example = lambda { Thrift::Serializer.new.serialize(union) }
55      expect(example).to raise_error(RuntimeError, "set_field is not valid for this union!")
56    end
57
58    it "should not be equal to nil" do
59      union = SpecNamespace::My_union.new
60      expect(union).not_to eq(nil)
61    end
62
63    it "should not be equal with an empty String" do
64      union = SpecNamespace::My_union.new
65      expect(union).not_to eq('')
66    end
67
68    it "should not equate two different unions, i32 vs. string" do
69      union = SpecNamespace::My_union.new(:integer32, 25)
70      other_union = SpecNamespace::My_union.new(:some_characters, "blah!")
71      expect(union).not_to eq(other_union)
72    end
73
74    it "should properly reset setfield and setvalue" do
75      union = SpecNamespace::My_union.new(:integer32, 25)
76      expect(union.get_set_field).to eq(:integer32)
77      union.some_characters = "blah!"
78      expect(union.get_set_field).to eq(:some_characters)
79      expect(union.get_value).to eq("blah!")
80      expect { union.integer32 }.to raise_error(RuntimeError, "integer32 is not union's set field.")
81    end
82
83    it "should not equate two different unions with different values" do
84      union = SpecNamespace::My_union.new(:integer32, 25)
85      other_union = SpecNamespace::My_union.new(:integer32, 400)
86      expect(union).not_to eq(other_union)
87    end
88
89    it "should not equate two different unions with different fields" do
90      union = SpecNamespace::My_union.new(:integer32, 25)
91      other_union = SpecNamespace::My_union.new(:other_i32, 25)
92      expect(union).not_to eq(other_union)
93    end
94
95    it "should inspect properly" do
96      union = SpecNamespace::My_union.new(:integer32, 25)
97      expect(union.inspect).to eq("<SpecNamespace::My_union integer32: 25>")
98    end
99
100    it "should not allow setting with instance_variable_set" do
101      union = SpecNamespace::My_union.new(:integer32, 27)
102      union.instance_variable_set(:@some_characters, "hallo!")
103      expect(union.get_set_field).to eq(:integer32)
104      expect(union.get_value).to eq(27)
105      expect { union.some_characters }.to raise_error(RuntimeError, "some_characters is not union's set field.")
106    end
107
108    it "should serialize to binary correctly" do
109      trans = Thrift::MemoryBufferTransport.new
110      proto = Thrift::BinaryProtocol.new(trans)
111
112      union = SpecNamespace::My_union.new(:integer32, 25)
113      union.write(proto)
114
115      other_union = SpecNamespace::My_union.new(:integer32, 25)
116      other_union.read(proto)
117      expect(other_union).to eq(union)
118    end
119
120    it "should serialize to json correctly" do
121      trans = Thrift::MemoryBufferTransport.new
122      proto = Thrift::JsonProtocol.new(trans)
123
124      union = SpecNamespace::My_union.new(:integer32, 25)
125      union.write(proto)
126
127      other_union = SpecNamespace::My_union.new(:integer32, 25)
128      other_union.read(proto)
129      expect(other_union).to eq(union)
130    end
131
132    it "should raise when validating unset union" do
133      union = SpecNamespace::My_union.new
134      expect { union.validate }.to raise_error(StandardError, "Union fields are not set.")
135
136      other_union = SpecNamespace::My_union.new(:integer32, 1)
137      expect { other_union.validate }.not_to raise_error
138    end
139
140    it "should validate an enum field properly" do
141      union = SpecNamespace::TestUnion.new(:enum_field, 3)
142      expect(union.get_set_field).to eq(:enum_field)
143      expect { union.validate }.to raise_error(Thrift::ProtocolException, "Invalid value of field enum_field!")
144
145      other_union = SpecNamespace::TestUnion.new(:enum_field, 1)
146      expect { other_union.validate }.not_to raise_error
147    end
148
149    it "should properly serialize and match structs with a union" do
150      union = SpecNamespace::My_union.new(:integer32, 26)
151      swu = SpecNamespace::Struct_with_union.new(:fun_union => union)
152
153      trans = Thrift::MemoryBufferTransport.new
154      proto = Thrift::CompactProtocol.new(trans)
155
156      swu.write(proto)
157
158      other_union = SpecNamespace::My_union.new(:some_characters, "hello there")
159      swu2 = SpecNamespace::Struct_with_union.new(:fun_union => other_union)
160
161      expect(swu2).not_to eq(swu)
162
163      swu2.read(proto)
164      expect(swu2).to eq(swu)
165    end
166
167    it "should support old style constructor" do
168      union = SpecNamespace::My_union.new(:integer32 => 26)
169      expect(union.get_set_field).to eq(:integer32)
170      expect(union.get_value).to eq(26)
171    end
172
173    it "should not throw an error when inspected and unset" do
174      expect{SpecNamespace::TestUnion.new().inspect}.not_to raise_error
175    end
176
177    it "should print enum value name when inspected" do
178      expect(SpecNamespace::My_union.new(:some_enum => SpecNamespace::SomeEnum::ONE).inspect).to eq("<SpecNamespace::My_union some_enum: ONE (0)>")
179
180      expect(SpecNamespace::My_union.new(:my_map => {SpecNamespace::SomeEnum::ONE => [SpecNamespace::SomeEnum::TWO]}).inspect).to eq("<SpecNamespace::My_union my_map: {ONE (0): [TWO (1)]}>")
181    end
182
183    it "should offer field? methods" do
184      expect(SpecNamespace::My_union.new.some_enum?).to be_falsey
185      expect(SpecNamespace::My_union.new(:some_enum => SpecNamespace::SomeEnum::ONE).some_enum?).to be_truthy
186      expect(SpecNamespace::My_union.new(:im_true => false).im_true?).to be_truthy
187      expect(SpecNamespace::My_union.new(:im_true => true).im_true?).to be_truthy
188    end
189
190    it "should pretty print binary fields" do
191      expect(SpecNamespace::TestUnion.new(:binary_field => "\001\002\003").inspect).to eq("<SpecNamespace::TestUnion binary_field: 010203>")
192    end
193
194    it "should be comparable" do
195      relationships = [
196        [0,   -1, -1, -1],
197        [1,   0,  -1, -1],
198        [1,   1,  0,  -1],
199        [1,   1,  1,  0]]
200
201      objs = [
202        SpecNamespace::TestUnion.new(:string_field, "blah"),
203        SpecNamespace::TestUnion.new(:string_field, "blahblah"),
204        SpecNamespace::TestUnion.new(:i32_field, 1),
205        SpecNamespace::TestUnion.new()]
206
207      for y in 0..3
208        for x in 0..3
209          # puts "#{objs[y].inspect} <=> #{objs[x].inspect} should == #{relationships[y][x]}"
210          expect(objs[y] <=> objs[x]).to eq(relationships[y][x])
211        end
212      end
213    end
214  end
215end
216