File SwaggerRestDispatcherServletTest.java

Branches:

Statements:

Methods:

Classes:

LOC:

171

NCLOC:

Total complexity:

Complexity density:

0.07

Statements/Method:

15.33

Methods/Class:

Average method complexity:

Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
SwaggerRestDispatcherServletTest	76	46	0%	3	0	1.0100%

Class SwaggerRestDispatcherServletTest

Class SwaggerRestDispatcherServletTest	Line # 76	Total Statements 46	% Filtered 0%	Complexity 3	TOTAL Coverage 1.0100%
setUp() : void setUp() : void	8181	11.011	0.00%	1.01	1.0 1.0100%
tearDown() : void tearDown() : void	9999	1.01	0.00%	1.01	1.0 1.0100%
handleStaleSwaggerInServletContext() : void handleStaleSwaggerInServletContext() : void	104104	34.034	0.00%	1.01	1.0 1.0100%

Contributing tests

This file is covered by 1 test. .

Contributing tests

	Test contribution	Test	Result	Actions
	0.71428573	info.magnolia.rest.tools.SwaggerRestDispatcherServletTest.handleStaleSwaggerInServletContextinfo.magnolia.rest.tools.SwaggerRestDispatcherServletTest.handleStaleSwaggerInServletContext	1PASS

Source view

/**

* This file is dual-licensed under both the Magnolia

* Network Agreement and the GNU General Public License.

* You may elect to use one or the other of these licenses.

* This file is distributed in the hope that it will be

* useful, but AS-IS and WITHOUT ANY WARRANTY; without even the

* implied warranty of MERCHANTABILITY or FITNESS FOR A

* PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.

* Redistribution, except as permitted by whichever of the GPL

* or MNA you select, is prohibited.

* 1. For the GPL license (GPL), you can redistribute and/or

* modify this file under the terms of the GNU General

* Public License, Version 3, as published by the Free Software

* Foundation. You should have received a copy of the GNU

* General Public License, Version 3 along with this program;

* if not, write to the Free Software Foundation, Inc., 51

* Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

* 2. For the Magnolia Network Agreement (MNA), this file

* and the accompanying materials are made available under the

* terms of the MNA which accompanies this distribution, and

* is available at http://www.magnolia-cms.com/mna.html

* Any modifications to this file must keep this entire header

* intact.

package info.magnolia.rest.tools;

import static info.magnolia.rest.tools.SwaggerRestDispatcherServlet.SWAGGER;

import static org.hamcrest.CoreMatchers.*;

import static org.hamcrest.MatcherAssert.assertThat;

import static org.junit.Assert.assertNull;

import static org.mockito.Matchers.any;

import static org.mockito.Mockito.*;

import info.magnolia.cms.util.CustomServletConfig;

import info.magnolia.config.registry.DefinitionMetadata;

import info.magnolia.config.registry.DefinitionProvider;

import info.magnolia.context.MgnlContext;

import info.magnolia.event.EventBus;

import info.magnolia.event.HandlerRegistration;

import info.magnolia.objectfactory.Components;

import info.magnolia.rest.EndpointDefinition;

import info.magnolia.rest.RestIntegrationModule;

import info.magnolia.rest.registry.ConfiguredEndpointDefinition;

import info.magnolia.rest.registry.EndpointDefinitionRegistry;

import info.magnolia.rest.registry.EndpointDefinitionRegistryEvent;

import info.magnolia.rest.registry.EndpointDefinitionRegistryEventHandler;

import info.magnolia.rest.registry.EndpointDefinitionRegistryEventType;

import info.magnolia.test.MgnlTestCase;

import info.magnolia.test.mock.MockWebContext;

import java.util.HashMap;

import javax.servlet.ServletConfig;

import javax.servlet.ServletContext;

import javax.servlet.http.HttpServletResponse;

import javax.ws.rs.HttpMethod;

import org.junit.Test;

import com.mockrunner.mock.web.MockHttpServletRequest;

import com.mockrunner.mock.web.MockHttpServletResponse;

import com.mockrunner.mock.web.MockServletContext;

import io.swagger.jaxrs.listing.ApiListingResource;

import io.swagger.models.Swagger;

public class SwaggerRestDispatcherServletTest extends MgnlTestCase {

SwaggerRestDispatcherServlet swaggerRestDispatcherServlet;

ServletContext servletContext;

@Override

public void setUp() throws Exception {

super.setUp();

RestIntegrationModule restIntegrationModule = mock(RestIntegrationModule.class);

EndpointDefinitionRegistry endpointDefinitionRegistry = mock(EndpointDefinitionRegistry.class);

EventBus eventBus = mock(EventBus.class);

HandlerRegistration handlerRegistration = mock(HandlerRegistration.class);

when(eventBus.addHandler(eq(EndpointDefinitionRegistryEvent.class), any(EndpointDefinitionRegistryEventHandler.class))).thenReturn(handlerRegistration);

RestToolsModule restToolsModule = mock(RestToolsModule.class);

servletContext = spy(new MockServletContext());

ServletConfig servletConfig = new CustomServletConfig("test servlet", servletContext, new HashMap<String, String>());

swaggerRestDispatcherServlet = new SwaggerRestDispatcherServlet(restIntegrationModule, endpointDefinitionRegistry, eventBus, restToolsModule, Components.getComponentProvider());

swaggerRestDispatcherServlet.init(servletConfig);

}

@Override

100

public void tearDown() throws Exception {

101

swaggerRestDispatcherServlet.destroy();

}

@Test

public void handleStaleSwaggerInServletContext() throws Exception {

106

// Stage 1: Init and make sure no swagger is in context yet

107

// GIVEN

108

final String endpointName = "turnMy$wagUp";

109

110

final ConfiguredEndpointDefinition endpointDefinition = new ConfiguredEndpointDefinition();

111

endpointDefinition.setImplementationClass(ApiListingResource.class);

112

endpointDefinition.setName(endpointName);

113

endpointDefinition.setEnabled(true);

114

115

final DefinitionMetadata endpointDefinitionMetadata = mock(DefinitionMetadata.class);

116

when(endpointDefinitionMetadata.getName()).thenReturn(endpointName);

117

when(endpointDefinitionMetadata.getReferenceId()).thenReturn(endpointName);

118

119

final DefinitionProvider<EndpointDefinition> definitionDefinitionProvider = mock(DefinitionProvider.class);

120

when(definitionDefinitionProvider.get()).thenReturn(endpointDefinition);

121

when(definitionDefinitionProvider.getMetadata()).thenReturn(endpointDefinitionMetadata);

122

123

final EndpointDefinitionRegistryEvent event = new EndpointDefinitionRegistryEvent(EndpointDefinitionRegistryEventType.REGISTERED, definitionDefinitionProvider);

124

assertThat(event.getEndpointDefinitionProvider(), notNullValue());

125

126

// WHEN

127

swaggerRestDispatcherServlet.onEndpointRegistered(event);

128

129

// THEN

130

assertNull(servletContext.getAttribute(SWAGGER));

131

132

// Stage 2: Send a request and make sure a swagger ends up in context

133

// GIVEN

134

MockWebContext mockWebContext = new MockWebContext();

135

mockWebContext.setServletContext(servletContext);

136

MgnlContext.setInstance(mockWebContext);

137

138

MockHttpServletRequest request = new MockHttpServletRequest();

139

request.setMethod(HttpMethod.GET);

140

request.setRequestURI("http://localhost:4321/swagger");

141

request.setRequestURL("http://localhost:4321/swagger");

142

request.setContextPath("/");

143

request.setContentType("text/json");

144

HttpServletResponse response = new MockHttpServletResponse();

145

146

// WHEN

147

swaggerRestDispatcherServlet.service(request, response);

148

149

// THEN

150

assertThat(servletContext.getAttribute(SWAGGER), instanceOf(Swagger.class));

151

152

// Stage 3: Fire another consecutive request and make sure swagger isn't accidentally removed from context

153

// WHEN

154

swaggerRestDispatcherServlet.service(request, response);

155

156

// THEN

157

assertThat(servletContext.getAttribute(SWAGGER), instanceOf(Swagger.class));

158

159

// Stage 4: Re-register endpoint, fire another request and double check the number of context swagger "flushes"

160

// GIVEN

161

endpointDefinition.setEnabled(false);

162

EndpointDefinitionRegistryEvent unregisterEvent = new EndpointDefinitionRegistryEvent(EndpointDefinitionRegistryEventType.REREGISTERED, definitionDefinitionProvider);

163

164

// WHEN

165

swaggerRestDispatcherServlet.onEndpointReregistered(unregisterEvent);

166

swaggerRestDispatcherServlet.service(request, response);

167

168

// THEN

169

verify(servletContext, times(2)).removeAttribute(SWAGGER);