/*
* 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.sling.junit.impl.servlet;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.Collection;
import java.util.Map;
import javax.servlet.http.HttpServletResponse;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.commons.json.JSONException;
import org.apache.sling.commons.json.io.JSONWriter;
import org.apache.sling.junit.Renderer;
import org.apache.sling.junit.RendererFactory;
import org.apache.sling.junit.SlingTestContextProvider;
import org.apache.sling.junit.TestSelector;
import org.junit.runner.Description;
import org.junit.runner.Result;
import org.junit.runner.notification.Failure;
import org.junit.runner.notification.RunListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** JSON renderer for JUnit servlet */
@Component(immediate=false)
@Service
public class JsonRenderer extends RunListener implements Renderer,RendererFactory {
public static final String EXTENSION = "json";
public static final String INFO_TYPE_KEY = "INFO_TYPE";
public static final String INFO_SUBTYPE_KEY = "INFO_SUBTYPE";
public static final String TEST_METADATA = "test_metadata";
private final Logger log = LoggerFactory.getLogger(getClass());
private JSONWriter writer;
/** @inheritDoc */
public Renderer createRenderer() {
return new JsonRenderer();
}
/** @inheritDoc */
public boolean appliesTo(TestSelector selector) {
return EXTENSION.equals(selector.getExtension());
}
/** @inheritDoc */
public String getExtension() {
return EXTENSION;
}
/** @inheritDoc */
public void setup(HttpServletResponse response, String pageTitle) throws IOException, UnsupportedEncodingException {
if(writer != null) {
throw new IllegalStateException("Output Writer already set");
}
response.setContentType("application/json");
response.setCharacterEncoding("UTF-8");
writer = new JSONWriter(response.getWriter());
writer.setTidy(true);
try {
writer.array();
} catch(JSONException jex) {
throw (IOException)new IOException().initCause(jex);
}
}
/** @inheritDoc */
public void cleanup() {
if(writer != null) {
try {
writer.endArray();
} catch(JSONException jex) {
log.warn("JSONException in cleanup()", jex);
}
}
writer = null;
}
/** @inheritDoc */
public void info(String cssClass, String info) {
try {
startItem("info");
writer.key(INFO_SUBTYPE_KEY).value(cssClass);
writer.key("info").value(info);
endItem();
} catch(JSONException jex) {
log.warn("JSONException in info()", jex);
}
}
/** @inheritDoc */
public void list(String cssClass, Collection<String> data) {
try {
startItem("list");
writer.key(INFO_SUBTYPE_KEY).value(cssClass);
writer.key("data");
writer.array();
for(String str : data) {
writer.value(str);
}
writer.endArray();
endItem();
} catch(JSONException jex) {
log.warn("JSONException in list()", jex);
}
}
/** @inheritDoc */
public void title(int level, String title) {
// Titles are not needed in JSON
}
/** @inheritDoc */
public void link(String info, String url, String method) {
try {
startItem("link");
writer.key("info").value(info);
writer.key("method").value(method);
writer.key("url").value(url);
endItem();
} catch(JSONException jex) {
log.warn("JSONException in link()", jex);
}
}
/** @inheritDoc */
public RunListener getRunListener() {
return this;
}
@Override
public void testStarted(Description description) throws Exception {
super.testStarted(description);
startItem("test");
writer.key("description").value(description.toString());
}
@Override
public void testFinished(Description description) throws Exception {
super.testFinished(description);
if(SlingTestContextProvider.hasContext()) {
outputContextMap(SlingTestContextProvider.getContext().output());
}
endItem();
}
@Override
public void testFailure(Failure failure) throws Exception {
writer.key("failure").value(failure.toString());
}
@Override
public void testRunFinished(Result result) throws Exception {
// Not needed, info is already present in the output
}
void startItem(String name) throws JSONException {
writer.object();
writer.key(INFO_TYPE_KEY).value(name);
}
void endItem() throws JSONException {
writer.endObject();
}
void outputContextMap(Map<String, Object> data) throws JSONException {
writer.key(TEST_METADATA);
writer.object();
try {
for(Map.Entry<String, Object> e : data.entrySet()) {
writer.key(e.getKey());
writer.value(e.getValue());
}
} finally {
writer.endObject();
}
}
}