View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.juneau.bean.openapi3;
18  
19  import static org.apache.juneau.TestUtils.*;
20  import static org.apache.juneau.bean.openapi3.OpenApiBuilder.*;
21  import static org.junit.jupiter.api.Assertions.*;
22  
23  import java.net.*;
24  
25  import org.apache.juneau.*;
26  import org.junit.jupiter.api.*;
27  
28  /**
29   * Testcase for {@link PathItem}.
30   */
31  class PathItem_Test extends TestBase {
32  
33  	@Nested class A_basicTests extends TestBase {
34  
35  		private static final BeanTester<PathItem> TESTER =
36  			testBean(
37  				bean()
38  					.setDelete(operation().setSummary("a"))
39  					.setGet(operation().setSummary("b"))
40  					.setHead(operation().setSummary("c"))
41  					.setOptions(operation().setSummary("d"))
42  					.setPatch(operation().setSummary("e"))
43  					.setPost(operation().setSummary("f"))
44  					.setPut(operation().setSummary("g"))
45  					.setTrace(operation().setSummary("h"))
46  			)
47  			.props("delete{summary},get{summary},head{summary},options{summary},patch{summary},post{summary},put{summary},trace{summary}")
48  			.vals("{a},{b},{c},{d},{e},{f},{g},{h}")
49  			.json("{'delete':{summary:'a'},get:{summary:'b'},head:{summary:'c'},options:{summary:'d'},patch:{summary:'e'},post:{summary:'f'},put:{summary:'g'},trace:{summary:'h'}}")
50  			.string("{'delete':{'summary':'a'},'get':{'summary':'b'},'head':{'summary':'c'},'options':{'summary':'d'},'patch':{'summary':'e'},'post':{'summary':'f'},'put':{'summary':'g'},'trace':{'summary':'h'}}".replace('\'','"'))
51  		;
52  
53  		@Test void a01_gettersAndSetters() {
54  			TESTER.assertGettersAndSetters();
55  		}
56  
57  		@Test void a02_copy() {
58  			TESTER.assertCopy();
59  		}
60  
61  		@Test void a03_toJson() {
62  			TESTER.assertToJson();
63  		}
64  
65  		@Test void a04_fromJson() {
66  			TESTER.assertFromJson();
67  		}
68  
69  		@Test void a05_roundTrip() {
70  			TESTER.assertRoundTrip();
71  		}
72  
73  		@Test void a06_toString() {
74  			TESTER.assertToString();
75  		}
76  
77  		@Test void a07_keySet() {
78  			assertList(TESTER.bean().keySet(), "delete", "get", "head", "options", "patch", "post", "put", "trace");
79  		}
80  
81  		@Test void a08_nullParameters() {
82  			var x = bean();
83  			assertThrows(IllegalArgumentException.class, () -> x.get(null, String.class));
84  			assertThrows(IllegalArgumentException.class, () -> x.set(null, "value"));
85  		}
86  
87  		@Test void a09_asMap() {
88  			assertBean(
89  				bean()
90  					.setSummary("a")
91  					.set("x1", "x1a")
92  					.asMap(),
93  				"summary,x1",
94  				"a,x1a"
95  			);
96  		}
97  
98  		@Test void a10_extraKeys() {
99  			var x = bean().set("x1", "x1a").set("x2", "x2a");
100 			assertList(x.extraKeys(), "x1", "x2");
101 			assertEmpty(bean().extraKeys());
102 		}
103 
104 		@Test void a11_strictMode() {
105 			assertThrows(RuntimeException.class, () -> bean().strict().set("foo", "bar"));
106 			assertDoesNotThrow(() -> bean().set("foo", "bar"));
107 
108 			assertFalse(bean().isStrict());
109 			assertTrue(bean().strict().isStrict());
110 			assertFalse(bean().strict(false).isStrict());
111 		}
112 	}
113 
114 	@Nested class B_emptyTests extends TestBase {
115 
116 		private static final BeanTester<PathItem> TESTER =
117 			testBean(bean())
118 			.props("get,put,post,delete,options,head,patch,trace")
119 			.vals("<null>,<null>,<null>,<null>,<null>,<null>,<null>,<null>")
120 			.json("{}")
121 			.string("{}")
122 		;
123 
124 		@Test void b01_gettersAndSetters() {
125 			TESTER.assertGettersAndSetters();
126 		}
127 
128 		@Test void b02_copy() {
129 			TESTER.assertCopy();
130 		}
131 
132 		@Test void b03_toJson() {
133 			TESTER.assertToJson();
134 		}
135 
136 		@Test void b04_fromJson() {
137 			TESTER.assertFromJson();
138 		}
139 
140 		@Test void b05_roundTrip() {
141 			TESTER.assertRoundTrip();
142 		}
143 
144 		@Test void b06_toString() {
145 			TESTER.assertToString();
146 		}
147 
148 		@Test void b07_keySet() {
149 			assertEmpty(TESTER.bean().keySet());
150 		}
151 	}
152 
153 	@Nested class C_extraProperties extends TestBase {
154 		private static final BeanTester<PathItem> TESTER =
155 			testBean(
156 				bean()
157 					.set("delete", operation().setSummary("a"))
158 					.set("description", "b")
159 					.set("get", operation().setSummary("c"))
160 					.set("head", operation().setSummary("d"))
161 					.set("options", operation().setSummary("e"))
162 					.set("parameters", list(parameter("f1", "f2")))
163 					.set("patch", operation().setSummary("g"))
164 					.set("post", operation().setSummary("h"))
165 					.set("put", operation().setSummary("i"))
166 					.set("servers", list(server().setUrl(URI.create("j"))))
167 					.set("summary", "k")
168 					.set("trace", operation().setSummary("l"))
169 					.set("x1", "x1a")
170 					.set("x2", null)
171 			)
172 			.props("delete{summary},description,get{summary},head{summary},options{summary},parameters{0{in,name}},patch{summary},post{summary},put{summary},servers{0{url}},summary,trace{summary},x1,x2")
173 			.vals("{a},b,{c},{d},{e},{{f1,f2}},{g},{h},{i},{{j}},k,{l},x1a,<null>")
174 			.json("{'delete':{summary:'a'},description:'b',get:{summary:'c'},head:{summary:'d'},options:{summary:'e'},parameters:[{'in':'f1',name:'f2'}],patch:{summary:'g'},post:{summary:'h'},put:{summary:'i'},servers:[{url:'j'}],summary:'k',trace:{summary:'l'},x1:'x1a'}")
175 			.string("{'delete':{'summary':'a'},'description':'b','get':{'summary':'c'},'head':{'summary':'d'},'options':{'summary':'e'},'parameters':[{'in':'f1','name':'f2'}],'patch':{'summary':'g'},'post':{'summary':'h'},'put':{'summary':'i'},'servers':[{'url':'j'}],'summary':'k','trace':{'summary':'l'},'x1':'x1a'}".replace('\'', '"'))
176 		;
177 
178 		@Test void c01_gettersAndSetters() {
179 			TESTER.assertGettersAndSetters();
180 		}
181 
182 		@Test void c02_copy() {
183 			TESTER.assertCopy();
184 		}
185 
186 		@Test void c03_toJson() {
187 			TESTER.assertToJson();
188 		}
189 
190 		@Test void c04_fromJson() {
191 			TESTER.assertFromJson();
192 		}
193 
194 		@Test void c05_roundTrip() {
195 			TESTER.assertRoundTrip();
196 		}
197 
198 		@Test void c06_toString() {
199 			TESTER.assertToString();
200 		}
201 
202 		@Test void c07_keySet() {
203 			assertList(TESTER.bean().keySet(), "delete", "description", "get", "head", "options", "parameters", "patch", "post", "put", "servers", "summary", "trace", "x1", "x2");
204 		}
205 
206 		@Test void c08_get() {
207 			assertMapped(
208 				TESTER.bean(), (obj,prop) -> obj.get(prop, Object.class),
209 				"delete{summary},description,get{summary},head{summary},options{summary},parameters{0{in,name}},patch{summary},post{summary},put{summary},servers{0{url}},summary,trace{summary},x1,x2",
210 				"{a},b,{c},{d},{e},{{f1,f2}},{g},{h},{i},{{j}},k,{l},x1a,<null>"
211 			);
212 		}
213 
214 		@Test void c09_getTypes() {
215 			assertMapped(
216 				TESTER.bean(), (obj,prop) -> simpleClassNameOf(obj.get(prop, Object.class)),
217 				"delete,description,get,head,options,parameters,patch,post,put,servers,summary,trace,x1,x2",
218 				"Operation,String,Operation,Operation,Operation,ArrayList,Operation,Operation,Operation,ArrayList,String,Operation,String,<null>"
219 			);
220 		}
221 
222 		@Test void c10_nullPropertyValue() {
223 			assertThrows(IllegalArgumentException.class, ()->bean().get(null));
224 			assertThrows(IllegalArgumentException.class, ()->bean().get(null, String.class));
225 			assertThrows(IllegalArgumentException.class, ()->bean().set(null, "a"));
226 		}
227 	}
228 
229 	//---------------------------------------------------------------------------------------------
230 	// Helper methods
231 	//---------------------------------------------------------------------------------------------
232 
233 	private static PathItem bean() {
234 		return pathItem();
235 	}
236 }