bundle/src/test/java/com/adobe/acs/commons/wcm/impl/AemEnvironmentIndicatorFilterTest.java
/*
* ACS AEM Commons
*
* Copyright (C) 2013 - 2023 Adobe
*
* Licensed 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 com.adobe.acs.commons.wcm.impl;
import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.same;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletResponse;
import com.day.cq.wcm.api.WCMMode;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.request.RequestProgressTracker;
import org.apache.sling.xss.XSSAPI;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import io.wcm.testing.mock.aem.junit.AemContext;
@RunWith(MockitoJUnitRunner.class)
public class AemEnvironmentIndicatorFilterTest {
@Rule
public AemContext context = new AemContext();
@Mock
FilterChain chain;
@Mock
XSSAPI xss;
public AemEnvironmentIndicatorFilter filter;
public Map<String, Object> props = new HashMap<>();
@Before
public void setup() {
context.load().json(getClass().getResourceAsStream("AemEnvironmentIndicatorFilterTest.json"), "/content");
AemEnvironmentIndicatorFilter aei = new AemEnvironmentIndicatorFilter();
filter = spy(aei);
context.registerService(XSSAPI.class, xss);
props.clear();
props.put("css-color", "blue");
props.put("browser-title-prefix", "prefix");
}
@Test
public void noHttpRequests() throws IOException, ServletException {
ServletRequest req = mock(ServletRequest.class);
ServletResponse resp = mock(ServletResponse.class);
filter.doFilter(req, resp, chain);
verify(chain, times(1)).doFilter(any(), any());
verify(filter, never()).accepts(any());
}
@Test
public void withNoConfiguration() throws IOException, ServletException {
context.registerInjectActivateService(filter);
filter.doFilter(context.request(), context.response(), chain);
verify(chain, times(1)).doFilter(same(context.request()), same(context.response()));
verify(filter, times(1)).accepts(same(context.request()));
}
@Test
public void testDoFilterWhenAcceptsIsTrue() throws IOException, ServletException {
context.registerInjectActivateService(filter, props);
context.request().setMethod("GET");
context.response().setContentType("text/html");
doAnswer(invocation -> {
HttpServletResponse response =
(HttpServletResponse) invocation.getArguments()[1];
response.getWriter().println("<html><body>somebody</body></html>");
return null;
}).when(chain).doFilter(any(), any());
doReturn(true).when(filter).accepts(any());
filter.doFilter(context.request(), context.response(), chain);
String response = context.response().getOutputAsString();
assertTrue(startsWith("<html><body>somebody<style>#acs-commons-env-indicator")
.matches(response));
assertTrue(containsString("background-color:blue").matches(response));
}
@Test
public void testDoFilterWhenAcceptsIsFalse() throws IOException, ServletException {
context.registerInjectActivateService(filter, props);
context.request().setMethod("GET");
context.response().setContentType("text/html");
doAnswer(invocation -> {
HttpServletResponse response =
(HttpServletResponse) invocation.getArguments()[1];
response.getWriter().println("<html><body>somebody</body></html>");
return null;
}).when(chain).doFilter(any(), any());
doReturn(false).when(filter).accepts(any());
filter.doFilter(context.request(), context.response(), chain);
verify(filter, never()).writeEnvironmentIndicator(any(), any(), any(), any());
}
@Test
public void testWriteEnvironmentIndicator() {
PrintWriter pw;
pw = mock(PrintWriter.class);
filter.writeEnvironmentIndicator("", "", "", pw);
verify(pw, never()).write(any(String.class));
verify(pw, never()).printf(any(), any());
pw = mock(PrintWriter.class);
filter.writeEnvironmentIndicator("css", "html", "", pw);
verify(pw).write(eq("<style>css </style>"));
verify(pw).write(eq("<div id=\"acs-commons-env-indicator\">html</div>"));
verify(pw, never()).printf(any(), any());
pw = mock(PrintWriter.class);
filter.writeEnvironmentIndicator("", "", "prefix", pw);
verify(pw, never()).write(any(String.class));
verify(pw).printf(
eq("<script>(function() { var c = 0; t = '%s' + ' | ' + document.title, "
+ "i = setInterval(function() { if (document.title === t && c++ > 10) { clearInterval(i); } else { document.title = t; } }, 1500); "
+ "document.title = t; })();</script>\n"),
eq("prefix"));
}
@Test
public void testAcceptGetRequest() {
context.registerInjectActivateService(filter, props);
assertTrue(filter.accepts(context.request()));
}
@Test
public void testRejectPostRequests() {
context.registerInjectActivateService(filter, props);
context.request().setMethod("POST");
assertFalse(filter.accepts(context.request()));
}
@Test
public void testRejectXhrRequests() {
context.registerInjectActivateService(filter, props);
context.request().setHeader("X-Requested-With", "XMLHttpRequest");
assertFalse(filter.accepts(context.request()));
}
@Test
public void testRejectEditorModeRequestClassic() {
context.registerInjectActivateService(filter, props);
context.request().setHeader("Referer", "/cf");
assertFalse(filter.accepts(context.request()));
}
@Test
public void testRejectEditorModeRequestTouch() {
context.registerInjectActivateService(filter, props);
context.request().setPathInfo("/content/we-retail.html");
context.request().setHeader("Referer", "/editor.html/content/we-retail.html");
assertFalse(filter.accepts(context.request()));
}
@Test
public void testIsEditExperienceFragmentVariation() {
context.registerInjectActivateService(filter, props);
context.request().setPathInfo("/content/experience-fragments/core-components-examples/library/simple-experience-fragment/simple-experience-fragment-livecopy.html");
context.request().setHeader("Referer", "/editor.html/content/experience-fragments/core-components-examples/library/simple-experience-fragment/master.html");
assertFalse(filter.accepts(context.request()));
}
@Test
public void testIsImproperlyConfigured() {
assertFalse(filter.isImproperlyConfigured("not-blank", "not-blank"));
assertFalse(filter.isImproperlyConfigured("", "not-blank"));
assertFalse(filter.isImproperlyConfigured("not-blank", ""));
assertTrue(filter.isImproperlyConfigured("", ""));
}
@Test
public void testIsUnsupportedRequestMethod() {
assertFalse(filter.isUnsupportedRequestMethod("get"));
assertTrue(filter.isUnsupportedRequestMethod("not-get"));
}
@Test
public void testIsXhr() {
assertFalse(filter.isXhr("not-XMLHttpRequest"));
assertTrue(filter.isXhr("XMLHttpRequest"));
}
@Test
public void testHasAemEditorReferrer() {
// not an editor referrer
assertFalse(filter.hasAemEditorReferrer("/not-cf-or-editor", "/does-not-matter"));
// request uri does not match referrer editor.html suffix
assertFalse(filter.hasAemEditorReferrer("/editor.html/uri", "/other-uri"));
// editor.html with matching uri
assertTrue(filter.hasAemEditorReferrer("/editor.html/uri", "/uri"));
// is /cf
assertTrue(filter.hasAemEditorReferrer("/cf", "/does-not-matter"));
}
@Test
public void testActivate() {
when(filter.shouldUseBaseCss(anyBoolean(), any(), any())).thenReturn(false);
when(filter.shouldUseColorCss(anyBoolean(), any(), any())).thenReturn(false);
context.registerInjectActivateService(filter);
verify(filter, never()).createBaseCss();
verify(filter, never()).createColorCss(any());
// when
when(filter.shouldUseBaseCss(anyBoolean(), any(), any())).thenReturn(true);
when(filter.shouldUseColorCss(anyBoolean(), any(), any())).thenReturn(true);
context.registerInjectActivateService(filter);
verify(filter).createBaseCss();
verify(filter).createColorCss(any());
}
@Test
public void testCreateBaseCss() {
assertEquals(filter.createBaseCss(),
"#acs-commons-env-indicator { "
+ ";background-image:url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA3NpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNS1jMDIxIDc5LjE1NDkxMSwgMjAxMy8xMC8yOS0xMTo0NzoxNiAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDo5ZmViMDk1Ni00MTMwLTQ0NGMtYWM3Ny02MjU0NjY0OTczZWIiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MDk4RTBGQkYzMjA5MTFFNDg5MDFGQzVCQkEyMjY0NDQiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MDk4RTBGQkUzMjA5MTFFNDg5MDFGQzVCQkEyMjY0NDQiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIChNYWNpbnRvc2gpIj4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5paWQ6Mjc5NmRkZmItZDVlYi00N2RlLWI1NDMtNDgxNzU2ZjIwZDc1IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjlmZWIwOTU2LTQxMzAtNDQ0Yy1hYzc3LTYyNTQ2NjQ5NzNlYiIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Ps64/vsAAAAkSURBVHjaYvz//z8DGjBmAAkiYWOwInQBZEFjZB0YAiAMEGAAVBk/wkPTSYQAAAAASUVORK5CYII=');"
+ "border-bottom: 1px solid rgba(0, 0, 0, .25);"
+ "box-sizing: border-box;"
+ "-moz-box-sizing: border-box;"
+ "-webkit-box-sizing: border-box;"
+ "position: fixed;"
+ "left: 0;"
+ "top: 0;"
+ "right: 0;"
+ "height: 5px;"
+ "z-index: 100000000000000;"
+ " }");
}
@Test
public void testCreateColorCss() {
assertEquals(filter.createColorCss("red"),
"#acs-commons-env-indicator { "
+ "background-color:red;"
+ " }");
}
@Test
public void testShouldWriteBaseCss() {
// "alwaysInclude is true
assertTrue(filter.shouldUseBaseCss(true, null, null));
// alwaysInclude is false, css blank, color not blank
assertTrue(filter.shouldUseBaseCss(false, "", "color"));
// alwaysInclude is false, css blank, color blank
assertFalse(filter.shouldUseBaseCss(false, "", ""));
// alwaysInclude is false, css not blank
assertFalse(filter.shouldUseBaseCss(false, "css", "color"));
}
@Test
public void testShouldWriteColorCss() {
// "alwaysInclude is true
assertTrue(filter.shouldUseColorCss(true, null, null));
// "alwaysInclude is false, css blank, color not blank
assertTrue(filter.shouldUseColorCss(false, "", "color"));
// "alwaysInclude is false, css blank, color blank
assertFalse(filter.shouldUseColorCss(false, "", ""));
// "alwaysInclude is false, css not blank
assertFalse(filter.shouldUseColorCss(false, "css", "color"));
}
@Test
public void testInnerFilter() throws IOException, ServletException {
Filter innerFilter = new AemEnvironmentIndicatorFilter.InnerEnvironmentIndicatorFilter(
new String[]{"design"});
FilterChain mockChain = mock(FilterChain.class);
SlingHttpServletRequest req = spy(context.request());
doReturn(mock(RequestProgressTracker.class)).when(req).getRequestProgressTracker();
context.request().setAttribute(WCMMode.REQUEST_ATTRIBUTE_NAME, WCMMode.valueOf("DESIGN"));
innerFilter.doFilter(req, context.response(), mockChain);
assertEquals(Boolean.FALSE, req.getAttribute(AemEnvironmentIndicatorFilter.INJECT_INDICATOR_PARAMETER));
}
@Test
public void isUnsupportedExtension_Defaults() {
context.currentResource("/content/test");
context.registerInjectActivateService(filter);
context.request().setPathInfo("/content/test.html");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test.htm");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test.jsp");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test.model.json");
assertTrue(filter.isUnsupportedExtension(context.request().getRequestURI()));
}
@Test
public void isUnsupportedExtension_Configured() {
context.currentResource("/content/test");
props.put("allowed-extensions", new String[]{"html", "htm", AemEnvironmentIndicatorFilter.NO_EXTENSION_PLACEHOLDER});
context.registerInjectActivateService(filter, props);
context.request().setPathInfo("/content/test.html/foo");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test.htm");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test.jsp");
assertTrue(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test.model.json");
assertTrue(filter.isUnsupportedExtension(context.request().getRequestURI()));
}
@Test
public void isUnsupportedExtension_Blank() {
context.currentResource("/content/test");
props.put("allowed-extensions", new String[]{});
context.registerInjectActivateService(filter, props);
context.request().setPathInfo("/content/test");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test.html");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
context.request().setPathInfo("/content/test.model.json");
assertFalse(filter.isUnsupportedExtension(context.request().getRequestURI()));
}
@Test
public void hasAemEditorReferrer() throws URISyntaxException {
String refererHeaderValue = "http://author.example.com/editor.html/content/example.html?_mr=foo-bar";
assertTrue(filter.hasAemEditorReferrer(refererHeaderValue, "/content/example.html"));
}
}