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.swagger;
18  
19  import static org.apache.juneau.TestUtils.*;
20  import static org.apache.juneau.bean.swagger.SwaggerBuilder.*;
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 ExternalDocumentation}.
30   */
31  class ExternalDocumentation_Test extends TestBase {
32  
33  	@Nested class A_basicTests extends TestBase {
34  
35  		private static final BeanTester<ExternalDocumentation> TESTER =
36  			testBean(
37  				bean()
38  					.setDescription("a")
39  					.setUrl(URI.create("b"))
40  			)
41  			.props("description,url")
42  			.vals("a,b")
43  			.json("{description:'a',url:'b'}")
44  			.string("{'description':'a','url':'b'}".replace('\'', '"'))
45  		;
46  
47  		@Test void a01_gettersAndSetters() {
48  			TESTER.assertGettersAndSetters();
49  		}
50  
51  		@Test void a02_copy() {
52  			TESTER.assertCopy();
53  		}
54  
55  		@Test void a03_toJson() {
56  			TESTER.assertToJson();
57  		}
58  
59  		@Test void a04_fromJson() {
60  			TESTER.assertFromJson();
61  		}
62  
63  		@Test void a05_roundTrip() {
64  			TESTER.assertRoundTrip();
65  		}
66  
67  		@Test void a06_toString() {
68  			TESTER.assertToString();
69  		}
70  
71  		@Test void a07_keySet() {
72  			assertList(TESTER.bean().keySet(), "description", "url");
73  		}
74  
75  		@Test void a08_nullParameters() {
76  			var x = bean();
77  			assertThrows(IllegalArgumentException.class, () -> x.get(null, String.class));
78  			assertThrows(IllegalArgumentException.class, () -> x.set(null, "value"));
79  		}
80  
81  		@Test void a09_asMap() {
82  			assertBean(
83  				bean()
84  					.setDescription("a")
85  					.setUrl(URI.create("b"))
86  					.set("x1", "x1a")
87  					.asMap(),
88  				"description,url,x1",
89  				"a,b,x1a"
90  			);
91  		}
92  
93  		@Test void a10_extraKeys() {
94  			var x = bean().set("x1", "x1a").set("x2", "x2a");
95  			assertList(x.extraKeys(), "x1", "x2");
96  			assertEmpty(bean().extraKeys());
97  		}
98  
99  		@Test void a11_strictMode() {
100 			assertThrows(RuntimeException.class, () -> bean().strict().set("foo", "bar"));
101 			assertDoesNotThrow(() -> bean().set("foo", "bar"));
102 
103 			assertFalse(bean().isStrict());
104 			assertTrue(bean().strict().isStrict());
105 			assertFalse(bean().strict(false).isStrict());
106 		}
107 	}
108 
109 	@Nested class B_emptyTests extends TestBase {
110 
111 		private static final BeanTester<ExternalDocumentation> TESTER =
112 			testBean(bean())
113 			.props("description,url")
114 			.vals("<null>,<null>")
115 			.json("{}")
116 			.string("{}")
117 		;
118 
119 		@Test void b01_gettersAndSetters() {
120 			TESTER.assertGettersAndSetters();
121 		}
122 
123 		@Test void b02_copy() {
124 			TESTER.assertCopy();
125 		}
126 
127 		@Test void b03_toJson() {
128 			TESTER.assertToJson();
129 		}
130 
131 		@Test void b04_fromJson() {
132 			TESTER.assertFromJson();
133 		}
134 
135 		@Test void b05_roundTrip() {
136 			TESTER.assertRoundTrip();
137 		}
138 
139 		@Test void b06_toString() {
140 			TESTER.assertToString();
141 		}
142 
143 		@Test void b07_keySet() {
144 			assertEmpty(TESTER.bean().keySet());
145 		}
146 	}
147 
148 	@Nested class C_extraProperties extends TestBase {
149 
150 		private static final BeanTester<ExternalDocumentation> TESTER =
151 			testBean(
152 				bean()
153 					.set("description", "a")
154 					.set("url", URI.create("b"))
155 					.set("x1", "x1a")
156 					.set("x2", null)
157 			)
158 			.props("description,url,x1,x2")
159 			.vals("a,b,x1a,<null>")
160 			.json("{description:'a',url:'b',x1:'x1a'}")
161 			.string("{'description':'a','url':'b','x1':'x1a'}".replace('\'', '"'))
162 		;
163 
164 		@Test void c01_gettersAndSetters() {
165 			TESTER.assertGettersAndSetters();
166 		}
167 
168 		@Test void c02_copy() {
169 			TESTER.assertCopy();
170 		}
171 
172 		@Test void c03_toJson() {
173 			TESTER.assertToJson();
174 		}
175 
176 		@Test void c04_fromJson() {
177 			TESTER.assertFromJson();
178 		}
179 
180 		@Test void c05_roundTrip() {
181 			TESTER.assertRoundTrip();
182 		}
183 
184 		@Test void c06_toString() {
185 			TESTER.assertToString();
186 		}
187 
188 		@Test void c07_keySet() {
189 			assertList(TESTER.bean().keySet(), "description", "url", "x1", "x2");
190 		}
191 
192 		@Test void c08_get() {
193 			assertMapped(
194 				TESTER.bean(), (obj,prop) -> obj.get(prop, Object.class),
195 				"description,url,x1,x2",
196 				"a,b,x1a,<null>"
197 			);
198 		}
199 
200 		@Test void c09_getTypes() {
201 			assertMapped(
202 				TESTER.bean(), (obj,prop) -> simpleClassNameOf(obj.get(prop, Object.class)),
203 				"description,url,x1,x2",
204 				"String,URI,String,<null>"
205 			);
206 		}
207 
208 		@Test void c10_nullPropertyValue() {
209 			assertThrows(IllegalArgumentException.class, ()->bean().get(null));
210 			assertThrows(IllegalArgumentException.class, ()->bean().get(null, String.class));
211 			assertThrows(IllegalArgumentException.class, ()->bean().set(null, "a"));
212 		}
213 	}
214 
215 	//---------------------------------------------------------------------------------------------
216 	// Helper methods
217 	//---------------------------------------------------------------------------------------------
218 
219 	private static ExternalDocumentation bean() {
220 		return externalDocumentation();
221 	}
222 }