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