juneau-rest/juneau-rest-server-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseHeader_Test.java

// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.rest.annotation;

import static org.apache.juneau.rest.testutils.TestUtils.*;
import static org.junit.Assert.*;
import static org.junit.runners.MethodSorters.*;

import org.apache.juneau.*;
import org.apache.juneau.dto.swagger.*;
import org.apache.juneau.http.annotation.*;
import org.apache.juneau.rest.client2.*;
import org.apache.juneau.rest.mock2.*;
import org.junit.*;

@FixMethodOrder(NAME_ASCENDING)
public class ResponseHeader_Test {

	//------------------------------------------------------------------------------------------------------------------
	// @ResponseHeader on method parameters
	//------------------------------------------------------------------------------------------------------------------

	@Rest
	public static class A {
		@RestMethod
		public void a(Value<A1> h) {
			h.set(new A1());
		}
		@RestMethod
		public void b(@ResponseHeader(name="Foo") Value<String> h) {
			h.set("foo");
		}
		@RestMethod
		public void c(@ResponseHeader(name="Bar") Value<A1> h) {
			h.set(new A1());
		}
	}

	@ResponseHeader(name="Foo")
	public static class A1 {
		@Override
		public String toString() {return "foo";}
	}

	@Test
	public void a01_methodParameters() throws Exception {
		RestClient a = MockRestClient.build(A.class);
		a.get("/a")
			.run()
			.assertCode().is(200)
			.assertStringHeader("Foo").is("foo");
		a.get("/b")
			.run()
			.assertCode().is(200)
			.assertStringHeader("Foo").is("foo");
		a.get("/c")
			.run()
			.assertCode().is(200)
			.assertStringHeader("Bar").is("foo");
	}

	//------------------------------------------------------------------------------------------------------------------
	// @ResponseHeader swagger on POJOs
	//------------------------------------------------------------------------------------------------------------------

	@Rest
	public static class B {

		@ResponseHeader(
			name="H",
			description="a",
			type="string"
		)
		public static class B1 {}
		@RestMethod
		public void a(Value<B1> h) {}

		@ResponseHeader(
			name="H",
			api={
				"description:'a',",
				"type:'string'"
			}
		)
		public static class B2 {}
		@RestMethod
		public void b(Value<B2> h) {}

		@ResponseHeader(
			name="H",
			api={
				"description:'b',",
				"type:'number'"
			},
			description="a",
			type="string"
		)
		public static class B3 {}
		@RestMethod
		public void c(Value<B3> h) {}

		@ResponseHeader(name="H", code=100)
		public static class B4 {}
		@RestMethod
		public void d(Value<B4> h) {}

		@ResponseHeader(name="H", code={100,101})
		public static class B5 {}
		@RestMethod
		public void e(Value<B5> h) {}

		@ResponseHeader(name="H", description="a")
		public static class B6 {}
		@RestMethod
		public void f(Value<B6> h) {}

		@ResponseHeader("H")
		public static class B7 {}
		@RestMethod
		public void g(Value<B7> h) {}
	}


	@Test
	public void b01_swagger_onPojo() throws Exception {
		HeaderInfo x;
		Swagger s = getSwagger(B.class);

		x = s.getResponseInfo("/a","get",200).getHeader("H");
		assertEquals("a", x.getDescription());
		assertEquals("string", x.getType());

		x = s.getResponseInfo("/b","get",200).getHeader("H");
		assertEquals("a", x.getDescription());
		assertEquals("string", x.getType());

		x = s.getResponseInfo("/c","get",200).getHeader("H");
		assertEquals("a", x.getDescription());
		assertEquals("string", x.getType());

		x = s.getResponseInfo("/d","get",100).getHeader("H");
		assertNotNull(x);

		Operation x2 = s.getOperation("/e","get");
		assertNotNull(x2.getResponse(100).getHeader("H"));
		assertNotNull(x2.getResponse(101).getHeader("H"));

		x = s.getResponseInfo("/f","get",200).getHeader("H");
		assertEquals("a", x.getDescription());

		x = s.getResponseInfo("/g","get",200).getHeader("H");
		assertNotNull(x);
	}

	//------------------------------------------------------------------------------------------------------------------
	// @ResponseHeader swagger on method parameters
	//------------------------------------------------------------------------------------------------------------------

	@Rest
	public static class C {

		public static class C1 {}
		@RestMethod
		public void a(
			@ResponseHeader(
				name="H",
				description="a",
				type="string"
			) Value<C1> h) {}

		public static class C2 {}
		@RestMethod
		public void b(
			@ResponseHeader(
				name="H",
				api={
					"description:'a',",
					"type:'string'"
				}
			) Value<C2> h) {}

		public static class C3 {}
		@RestMethod
		public void c(
			@ResponseHeader(
				name="H",
				api={
					"description:'b',",
					"type:'number'"
				},
				description="a",
				type="string"
			) Value<C3> h) {}

		public static class C4 {}
		@RestMethod
		public void d(@ResponseHeader(name="H", code=100) Value<C4> h) {}

		public static class C5 {}
		@RestMethod
		public void e(@ResponseHeader(name="H", code={100,101}) Value<C5> h) {}

		public static class C6 {}
		@RestMethod
		public void f(@ResponseHeader(name="H", description="a") Value<C6> h) {}

		public static class C7 {}
		@RestMethod
		public void g(@ResponseHeader("H") Value<C7> h) {}
	}

	@Test
	public void c01_swagger_onMethodParameters() throws Exception {
		HeaderInfo x;
		Swagger sc = getSwagger(C.class);

		x = sc.getResponseInfo("/a","get",200).getHeader("H");
		assertEquals("a", x.getDescription());
		assertEquals("string", x.getType());

		x = sc.getResponseInfo("/b","get",200).getHeader("H");
		assertEquals("a", x.getDescription());
		assertEquals("string", x.getType());

		x = sc.getResponseInfo("/c","get",200).getHeader("H");
		assertEquals("a", x.getDescription());
		assertEquals("string", x.getType());

		x = sc.getResponseInfo("/d","get",100).getHeader("H");
		assertNotNull(x);

		Operation x2 = sc.getOperation("/e","get");
		assertNotNull(x2.getResponse(100).getHeader("H"));
		assertNotNull(x2.getResponse(101).getHeader("H"));

		x = sc.getResponseInfo("/f","get",200).getHeader("H");
		assertEquals("a", x.getDescription());

		x = sc.getResponseInfo("/g","get",200).getHeader("H");
		assertNotNull(x);
	}
}