BaseUrlGetTest.java

package org.mitre.rhex;

import edu.umd.cs.findbugs.annotations.NonNull;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.mitre.test.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.*;
import java.util.Collections;
import java.util.List;

/**
 * <pre>
 * 6.2.1 GET Operation on the Base URL
 *
 * The server MUST offer an Atom 1.0 compliant feed of all child sections specified in
 * HRF specification, as identified in corresponding sections node in the root document.
 *
 * Status Code: <B>200</B>, 404
 * </pre>
 *
 * @author Jason Mathews, MITRE Corp.
 * Date: 2/20/12 10:45 AM
 */
public class BaseUrlGetTest extends BaseXmlTest {

	@NonNull
	public String getId() {
		return "6.2.1.4";
	}

	@Override
	public boolean isRequired() {
		return true; // MUST
	}

	@NonNull
	public String getName() {
		return "GET operation on baseURL MUST return Atom 1.0 feed of child sections if accept header is application/atom+xml";
	}

	@NonNull
	public List<Class<? extends TestUnit>> getDependencyClasses() {
		return Collections.emptyList();
	}

	protected String getAcceptHeader() {
		return MIME_APPLICATION_ATOM_XML; // Header Accept: application/atom+xml
	}

	public void execute() throws TestException {
		// http://hc.apache.org/httpcomponents-client-ga/tutorial/html/fundamentals.html
		final Context context = Loader.getInstance().getContext();
		HttpClient client = context.getHttpClient();
        HttpGet req = null;
        HttpResponse response = null;
        try {
			req = new HttpGet(context.getBaseURL());
			String acceptHeader = getAcceptHeader();
			if (acceptHeader != null) {
				// System.out.println("set Accept=" + acceptHeader); // debug
				req.setHeader("Accept", acceptHeader);
			} else {
				req.removeHeaders("Accept");
			}
			if (log.isDebugEnabled()) {
				System.out.println("\nURL: " + req.getURI());
				// dump request headers
				for(Header header : req.getAllHeaders()) {
					System.out.println("  " + header.getName() + ": " + header.getValue());
				}
			}
			response = context.executeRequest(client, req);
            if (log.isDebugEnabled()) {
                dumpResponse(req, response, false);
            }
            validateContent(context, response);
		} catch (JDOMException e) {
			throw new TestException(e);
		} catch (IOException e) {
			throw new TestException(e);
		} finally {
			client.getConnectionManager().shutdown();
            if (response != null && !log.isDebugEnabled() && getStatus() != StatusEnumType.SUCCESS)
                dumpResponse(req, response, false);
		}
	}

	protected void validateContent(Context context, HttpResponse response)
			throws TestException, IOException, JDOMException
    {
        int code = response.getStatusLine().getStatusCode();
        if (code != 200) {
			setStatus(StatusEnumType.FAILED, "Unexpected HTTP response: " + code);
			return;
		}

		final HttpEntity entity = response.getEntity();
		final String contentType = ClientHelper.getContentType(entity);
		if (MIME_TEXT_HTML.equals(contentType)) {
            setStatus(StatusEnumType.FAILED, "Expected application/atom+xml content-type but was: text/html");
            return;
		}
		if (!MIME_APPLICATION_ATOM_XML.equals(contentType)) {
			addWarning("Expected application/atom+xml content-type but was: " + contentType);
		}
		// contentType value could be text/xml or application/xml and still be valid.
		// Return content-type is not explicitly mandated.

		// minimum length expected is 43 bytes or a negative number if unknown
		long len = entity.getContentLength();
		assertTrue(len < 0 || len >= 43, "Expecting valid ATOM XML document for baseURL; returned length was " + len);

		ByteArrayOutputStream bos = new ByteArrayOutputStream();
		entity.writeTo(bos);
		/*
		expecting:

		 <?xml version="1.0" encoding="UTF-8"?>
		 <feed xmlns="http://www.w3.org/2005/Atom">
		 ...
		 </feed>
		 */
		Document doc = getValidatingAtom(context, bos);
		// System.out.println("XXX: xmlErrors=" + xmlErrors + " warnings=" + getWarnings().size());
		// assertTrue(xmlErrors == 0, "Content has errors in ATOM feed");
		assertFalse(fatalXmlError, "Atom XML has a fatal XML error");
		final Element root = doc.getRootElement();
		assertEquals(NAMESPACE_W3_ATOM_2005, root.getNamespace().getURI());

		// only keep copy of the DOM and response if the test was successful if which case dependent tests may access it
		setDocument(doc);
		setResponse(response);

		setStatus(StatusEnumType.SUCCESS);
		/*
		 root.setAttribute("schemaLocation", NAMESPACE_W3_ATOM_2005 + " "
			 + "schema/atom.xsd", xsiNamespace);
		 */
	}

}