File GZipFilterTest.java

Branches:

Statements:

Methods:

Classes:

LOC:

284

NCLOC:

186

Total complexity:

Complexity density:

0.16

Statements/Method:

7.58

Methods/Class:

Average method complexity:

1.25

3.6% of code in this file is excluded from these metrics. Remove Filter

Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage
GZipFilterTest	74	86	3.9%	12	6	0.9387755493.9%
GZipFilterTest.DummyFilterChain	263	1	0%	1	0	1.0100%
GZipFilterTest.DummyWritingFilterChain	272	4	0%	2	2	0.7142857371.4%

Class GZipFilterTest

Class GZipFilterTest	Line # 74	Total Statements 86	% Filtered 3.9%	Complexity 12	Uncovered Elements 6	TOTAL Coverage 0.9387755493.9%
setUp() : void setUp() : void	7777	2.02	0.00%	1.01	0.00	1.0 1.0100%
hasMoreElements() : boolean hasMoreElements() : boolean	9595	1.01	0.00%	1.01	1.01	0.0 0.00%
nextElement() : Object nextElement() : Object	100100	2.02	0.00%	1.01	2.02	0.0 0.00%
getOutputStream() : ServletOutputStream getOutputStream() : ServletOutputStream	116116	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
answer(InvocationOnMock) : Object answer(InvocationOnMock) : Object	124124	8.08	0.00%	3.03	1.01	0.9 0.990%
testBufferIsFlushedProperlyWhenUsingWriterFurtherDownTheChainOfFilters() : void testBufferIsFlushedProperlyWhenUsingWriterFurtherDownTheChainOfFilters() : void	8484	24.024	0.00%	1.01	0.00	1.0 1.0100%
getOutputStream() : ServletOutputStream getOutputStream() : ServletOutputStream	173173	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
answer(InvocationOnMock) : Object answer(InvocationOnMock) : Object	181181	6.06	0.00%	1.01	0.00	1.0 1.0100%
testBufferIsFlushedAndGZipNotSetOnError() : void testBufferIsFlushedAndGZipNotSetOnError() : void	159159	16.016	0.00%	1.01	0.00	1.0 1.0100%
testCacheHeadersAreAddedToTheResponse() : void testCacheHeadersAreAddedToTheResponse() : void	210210	15.015	0.00%	1.01	0.00	1.0 1.0100%
write(int) : void write(int) : void	246246	1.01	0.00%	1.01	0.00	1.0 1.0100%
testResponseIsGzippedWhenThresholdExceeded() : void testResponseIsGzippedWhenThresholdExceeded() : void	236236	11.011	0.00%	1.01	0.00	1.0 1.0100%

Class GZipFilterTest.DummyFilterChain

Class GZipFilterTest.DummyFilterChain	Line # 263	Total Statements 1	% Filtered 0%	Complexity 1	Uncovered Elements 0	TOTAL Coverage 1.0100%
doFilter(ServletRequest,ServletResponse) : void doFilter(ServletRequest,ServletResponse) : void	266266	1.01	0.00%	1.01	0.00	1.0 1.0100%

Class GZipFilterTest.DummyWritingFilterChain

Class GZipFilterTest.DummyWritingFilterChain	Line # 272	Total Statements 4	% Filtered 0%	Complexity 2	Uncovered Elements 2	TOTAL Coverage 0.7142857371.4%
doFilter(ServletRequest,ServletResponse) : void doFilter(ServletRequest,ServletResponse) : void	274274	4.04	0.00%	2.02	2.02	0.6666667 0.666666766.7%

Contributing tests

This file is covered by 4 tests. .

Contributing tests

Test contribution	Test	Result
0.3271028	info.magnolia.module.cache.filter.GZipFilterTest.testBufferIsFlushedProperlyWhenUsingWriterFurtherDownTheChainOfFiltersinfo.magnolia.module.cache.filter.GZipFilterTest.testBufferIsFlushedProperlyWhenUsingWriterFurtherDownTheChainOfFilters	1PASS
0.22429906	info.magnolia.module.cache.filter.GZipFilterTest.testBufferIsFlushedAndGZipNotSetOnErrorinfo.magnolia.module.cache.filter.GZipFilterTest.testBufferIsFlushedAndGZipNotSetOnError	1PASS
0.17757009	info.magnolia.module.cache.filter.GZipFilterTest.testResponseIsGzippedWhenThresholdExceededinfo.magnolia.module.cache.filter.GZipFilterTest.testResponseIsGzippedWhenThresholdExceeded	1PASS
0.1682243	info.magnolia.module.cache.filter.GZipFilterTest.testCacheHeadersAreAddedToTheResponseinfo.magnolia.module.cache.filter.GZipFilterTest.testCacheHeadersAreAddedToTheResponse	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.module.cache.filter;

import static org.junit.Assert.*;

import static org.mockito.Matchers.any;

import static org.mockito.Matchers.isA;

import static org.mockito.Matchers.same;

import static org.mockito.Mockito.*;

import info.magnolia.cms.cache.CacheConstants;

import info.magnolia.cms.filters.WebContainerResources;

import info.magnolia.cms.filters.WebContainerResourcesImpl;

import info.magnolia.module.cache.util.GZipUtil;

import info.magnolia.test.ComponentsTestUtil;

import info.magnolia.test.MgnlTestCase;

import java.io.ByteArrayOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.PrintWriter;

import java.util.Enumeration;

import java.util.List;

import javax.servlet.FilterChain;

import javax.servlet.ServletException;

import javax.servlet.ServletOutputStream;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpServletResponseWrapper;

import org.apache.commons.collections4.MultiMap;

import org.junit.Before;

import org.junit.Test;

import org.mockito.invocation.InvocationOnMock;

import org.mockito.stubbing.Answer;

/**

* Basic tests for gzip filter.

public class GZipFilterTest extends MgnlTestCase {

private static final String SOME_10CHARSLONG_CHAIN = "qwertzuiop";

@Override

@Before

public void setUp() throws Exception {

super.setUp();

ComponentsTestUtil.setImplementation(WebContainerResources.class, WebContainerResourcesImpl.class);

}

@Test

public void testBufferIsFlushedProperlyWhenUsingWriterFurtherDownTheChainOfFilters() throws Exception {

// GIVEN

final int iterations = 5000;

final FilterChain chain = mock(FilterChain.class);

final HttpServletRequest mockRequest = mock(HttpServletRequest.class);

when(mockRequest.getAttribute(any(String.class))).thenReturn(null);

when(mockRequest.getHeaders("Accept-Encoding")).thenReturn(new Enumeration() {

private boolean has = true;

@Override

public boolean hasMoreElements() {

return has;

}

100

@Override

101

public Object nextElement() {

has = false;

return "gzip";

}

});

final HttpServletResponse mockResponse = mock(HttpServletResponse.class);

107

when(mockResponse.containsHeader("Content-Encoding")).thenReturn(true);

108

when(mockResponse.containsHeader("Vary")).thenReturn(true);

109

when(mockResponse.getCharacterEncoding()).thenReturn("ISO-8859-1"); // called when creating the writer in CacheResponseWriter

110

111

// we need to wrap the mock response to be able to get the written output

112

final ByteArrayOutputStream finalOutput = new ByteArrayOutputStream();

113

final SimpleServletOutputStream servletOutput = new SimpleServletOutputStream(finalOutput);

114

final HttpServletResponse testReponse = new HttpServletResponseWrapper(mockResponse) {

115

// and we know GZipFilter will only call getOutputStream() on it.

116

@Override

117

public ServletOutputStream getOutputStream() throws IOException {

118

return servletOutput;

}

};

// fake some chained filter:

123

doAnswer(new Answer() {

124

@Override

125

public Object answer(InvocationOnMock invocation) {

126

final Object[] args = invocation.getArguments();

127

final ServletResponse responseFutherDownTheChain = (ServletResponse) args[1];

128

// let's pretend we're some filter writing some content

129

try {

130

final PrintWriter out = responseFutherDownTheChain.getWriter();

131

5001

for (int i = 0; i < iterations; i++) {

132

5000

out.println(SOME_10CHARSLONG_CHAIN);

133

}

134

} catch (IOException ex) {

135

ex.printStackTrace();

}

return null;

}

}).when(chain).doFilter(same(mockRequest), isA(CacheResponseWrapper.class));

140

141

// WHEN

142

final GZipFilter filter = new GZipFilter();

143

filter.doFilter(mockRequest, testReponse, chain);

144

145

// THEN

146

verify(mockResponse).addHeader("Content-Encoding", "gzip");

147

verify(mockResponse).addHeader("Vary", "Accept-Encoding");

148

verify(mockResponse).setContentLength(finalOutput.toByteArray().length);

149

verify(mockResponse).flushBuffer();

150

151

// now assert GZipFilter has written the expected amount of characters in the original response

152

final byte[] compressedBytes = finalOutput.toByteArray();

153

assertTrue("output should be gzipped", GZipUtil.isGZipped(compressedBytes));

154

final byte[] uncompressed = GZipUtil.ungzip(compressedBytes);

155

final int expectedLength = iterations * (SOME_10CHARSLONG_CHAIN.length() + System.getProperty("line.separator").length()); // n chars + newline

156

assertEquals(expectedLength, uncompressed.length);

}

@Test

public void testBufferIsFlushedAndGZipNotSetOnError() throws Exception {

161

// GIVEN

162

final FilterChain chain = mock(FilterChain.class);

163

final HttpServletRequest mockRequest = mock(HttpServletRequest.class);

164

165

final HttpServletResponse mockResponse = mock(HttpServletResponse.class);

166

when(mockResponse.getCharacterEncoding()).thenReturn("ISO-8859-1");

167

168

// we need to wrap the mock response to be able to get the written output

169

final ByteArrayOutputStream finalOutput = new ByteArrayOutputStream();

170

final SimpleServletOutputStream servletOutput = new SimpleServletOutputStream(finalOutput);

171

final HttpServletResponse testReponse = new HttpServletResponseWrapper(mockResponse) {

172

// and we know GZipFilter will only call getOutputStream() on it.

173

@Override

174

public ServletOutputStream getOutputStream() throws IOException {

175

return servletOutput;

}

};

// fake some chained filter:

180

doAnswer(new Answer() {

181

@Override

182

public Object answer(InvocationOnMock invocation) throws Throwable {

183

final Object[] args = invocation.getArguments();

184

final ServletResponse responseFutherDownTheChain = (ServletResponse) args[1];

185

// let's pretend we're some filter writing some content

186

final PrintWriter out = responseFutherDownTheChain.getWriter();

187

out.println(SOME_10CHARSLONG_CHAIN);

188

// fake the content denied

189

((HttpServletResponse) responseFutherDownTheChain).sendError(HttpServletResponse.SC_UNAUTHORIZED);

190

return null;

191

}

192

}).when(chain).doFilter(same(mockRequest), isA(CacheResponseWrapper.class));

193

194

// WHEN

195

final GZipFilter filter = new GZipFilter();

196

filter.doFilter(mockRequest, testReponse, chain);

197

198

// THEN

199

verify(mockResponse).sendError(HttpServletResponse.SC_UNAUTHORIZED);

200

verify(mockResponse, times(2)).flushBuffer();

201

202

// now assert GZipFilter has written the expected amount of characters in the original response

203

final byte[] uncompressed = finalOutput.toByteArray();

204

// errors should be uncompressed

205

assertFalse("output should be gzipped", GZipUtil.isGZipped(uncompressed));

206

final int expectedLength = SOME_10CHARSLONG_CHAIN.length() + System.getProperty("line.separator").length(); // n chars + newline

207

assertEquals(expectedLength, uncompressed.length);

}

@Test

public void testCacheHeadersAreAddedToTheResponse() throws Exception {

212

// GIVEN

213

final HttpServletRequest request = mock(HttpServletRequest.class);

214

final HttpServletResponse response = mock(HttpServletResponse.class);

215

final DummyFilterChain chain = new DummyFilterChain();

216

final GZipFilter filter = new GZipFilter();

217

final ServletOutputStream stream = mock(ServletOutputStream.class);

218

219

when(response.containsHeader("Content-Encoding")).thenReturn(true);

220

when(response.containsHeader("Vary")).thenReturn(true);

221

when(response.getOutputStream()).thenReturn(stream);

222

223

filter.doFilter(request, response, chain);

224

final CacheResponseWrapper wrapper = (CacheResponseWrapper) chain.response;

225

226

// WHEN

227

wrapper.setHeader(CacheConstants.HEADER_CACHE_CONTROL, CacheConstants.HEADER_VALUE_MAX_AGE + ":525600");

228

wrapper.setHeader(CacheConstants.HEADER_EXPIRES, "someDate");

229

230

// THEN

231

MultiMap map = ((CacheResponseWrapper) chain.response).getHeaders();

232

assertEquals("max-age:525600", ((List<String>) map.get(CacheConstants.HEADER_CACHE_CONTROL)).get(0));

233

assertEquals("someDate", ((List<String>) map.get(CacheConstants.HEADER_EXPIRES)).get(0));

}

@Test

public void testResponseIsGzippedWhenThresholdExceeded() throws IOException, ServletException {

238

// GIVEN

239

final HttpServletRequest request = mock(HttpServletRequest.class);

240

final HttpServletResponse response = mock(HttpServletResponse.class);

241

final DummyWritingFilterChain chain = new DummyWritingFilterChain();

242

final GZipFilter filter = new GZipFilter();

243

final ByteArrayOutputStream baos = new ByteArrayOutputStream();

244

245

final ServletOutputStream sos = new ServletOutputStream() {

246

143623

@Override

247

public void write(int b) throws IOException {

248

143623

baos.write(b);

}

};

when(response.containsHeader("Content-Encoding")).thenReturn(true);

253

when(response.containsHeader("Vary")).thenReturn(true);

254

when(response.getOutputStream()).thenReturn(sos);

255

256

// WHEN

257

filter.doFilter(request, response, chain);

258

259

// THEN

260

assertTrue(GZipUtil.isGZipped(baos.toByteArray()));

261

}

262

263

private static class DummyFilterChain implements FilterChain {

264

public ServletResponse response;

265

266

@Override

267

public void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException {

268

this.response = response;

}

}

private static class DummyWritingFilterChain implements FilterChain {

273

274

@Override

275

public void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException {

276

// styles.css have ~ 1mb size -> threshold will be exceeded

277

final InputStream fis = this.getClass().getClassLoader().getResourceAsStream("styles.css");

278

int i = 0;

279

while ((i = fis.read()) != -1) {

280

1016217

response.getOutputStream().write(i);

}

}

}

}

Magnolia Module Cache 5.5.9

File GZipFilterTest.java

Code metrics

Classes

Class GZipFilterTest

Class GZipFilterTest.DummyFilterChain

Class GZipFilterTest.DummyWritingFilterChain

Contributing tests

Contributing tests

Source view