DashletsTest.java

package com.belladati.sdk.dashboard.impl;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertFalse;
import static org.testng.Assert.assertNotEquals;
import static org.testng.Assert.assertTrue;

import java.util.Collections;

import org.testng.annotations.Test;

import com.belladati.sdk.dashboard.Dashboard;
import com.belladati.sdk.dashboard.Dashlet;
import com.belladati.sdk.dashboard.Dashlet.Type;
import com.belladati.sdk.dashboard.impl.DashletImpl;
import com.belladati.sdk.exception.impl.DashletException;
import com.belladati.sdk.exception.impl.UnknownViewTypeException;
import com.belladati.sdk.test.SDKTest;
import com.belladati.sdk.view.JsonView;
import com.belladati.sdk.view.TableView;
import com.belladati.sdk.view.View;
import com.belladati.sdk.view.ViewType;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;

/**
 * Tests behavior related to views.
 * 
 * @author Chris Hennigfeld
 */
@Test
public class DashletsTest extends SDKTest {

	private final String dashboardsUri = "/api/dashboards";

	private final String dashboardId = "dashboardId";
	private final String dashboardName = "dashboard name";
	private final String viewId = "viewId";
	private final String viewName = "view name";

	/** Dashlet view JSON is loaded correctly. */
	@Test(dataProvider = "viewTypes")
	public void loadDashletView(String stringType, ViewType viewType) throws UnknownViewTypeException {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode();
		dashletNode.put("canAccessViewReport", true).put("type", "viewReport").put("viewReport",
			builder.buildViewNode(viewId, viewName, stringType));

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets().size(), 1);
		Dashlet dashlet = dashboard.getDashlets().get(0);

		assertEquals(dashlet.getType(), Type.VIEW);
		assertEquals(dashlet.getName(), viewName);

		assertTrue(dashlet.toString().contains(Type.VIEW.toString()));

		View view = (View) dashlet.getContent();
		assertEquals(view.getId(), viewId);
		assertEquals(view.getName(), viewName);
		assertEquals(view.getType(), viewType);

		if (viewType == ViewType.TABLE) {
			assertTrue(view instanceof TableView, "Wrong view instance type, was " + view.getClass());
		} else {
			assertTrue(view instanceof JsonView, "Wrong view instance type, was " + view.getClass());
		}

		server.assertRequestUris(dashboardsUri + "/" + dashboardId);
	}

	/** Dashlets pointing to inaccessible views are ignored. */
	public void inaccessibleView() {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode();
		dashletNode.put("canAccessViewReport", false).put("type", "viewReport").put("viewReport",
			builder.buildViewNode(viewId, viewName, "chart"));

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashlets pointing to views with unknown accessibility are ignored. */
	public void missingAccessibilityView() {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode();
		dashletNode.put("type", "viewReport").put("viewReport", builder.buildViewNode(viewId, viewName, "chart"));

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashlets pointing to views with unknown accessibility are ignored. */
	public void notBooleanAccessibilityView() {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode();
		dashletNode.put("canAccessViewReport", "not a boolean").put("type", "viewReport").put("viewReport",
			builder.buildViewNode(viewId, viewName, "chart"));

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashlets pointing to views with unknown type are ignored. */
	@Test(dataProvider = "unsupportedViewTypes")
	public void unknownTypeView(String stringType) {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode();
		dashletNode.put("canAccessViewReport", true).put("type", "viewReport").put("viewReport",
			builder.buildViewNode(viewId, viewName, stringType));

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashlets pointing to views without type are ignored. */
	public void noTypeView() {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode();
		ObjectNode viewNode = builder.buildViewNode(viewId, viewName, "");
		viewNode.remove("type");
		dashletNode.put("canAccessViewReport", true).put("type", "viewReport").put("viewReport", viewNode);

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashlets pointing to views without a view element are ignored. */
	public void noViewElement() {
		registerDashboardWith(new ObjectMapper().createObjectNode().put("canAccessViewReport", true).put("type", "viewReport"));

		Dashboard dashboard = service.loadDashboard(dashboardId);
		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashlet text content is loaded correctly. */
	public void loadDashletText() throws UnknownViewTypeException {
		String text = "some text here";
		ObjectNode dashletNode = new ObjectMapper().createObjectNode().put("type", "textContent").put("textContent", text)
			.put("name", viewName);

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets().size(), 1);
		Dashlet dashlet = dashboard.getDashlets().get(0);

		assertEquals(dashlet.getType(), Type.TEXT);
		assertEquals(dashlet.getName(), viewName);
		assertEquals(dashlet.getContent(), text);
	}

	/** Dashlet text content may be empty. */
	public void textDashletEmptyText() throws UnknownViewTypeException {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode().put("type", "textContent").put("textContent", "");

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets().size(), 1);
		Dashlet dashlet = dashboard.getDashlets().get(0);

		assertEquals(dashlet.getType(), Type.TEXT);
		assertEquals(dashlet.getContent(), "");
	}

	/** Text dashlets with null content are ignored. */
	public void textDashletNullText() throws UnknownViewTypeException {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode().put("type", "textContent").put("textContent",
			(String) null);

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Text dashlets without content are ignored. */
	public void textDashletNoText() throws UnknownViewTypeException {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode().put("type", "textContent");

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashboard dashlets field may be null. */
	public void dashletsNull() {
		ObjectNode node = builder.buildDashboardNode(dashboardId, dashboardName, null).put("dashlets", (String) null);
		server.register(dashboardsUri + "/" + dashboardId, node.toString());
		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashboard dashlets field may be not an array. */
	public void dashletsNotArray() {
		ObjectNode node = builder.buildDashboardNode(dashboardId, dashboardName, null).put("dashlets", "not an array");
		server.register(dashboardsUri + "/" + dashboardId, node.toString());
		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** Dashlets of unknown type are ignored. */
	public void loadDashletUnknownType() throws UnknownViewTypeException {
		ObjectNode dashletNode = new ObjectMapper().createObjectNode();
		dashletNode.put("canAccessViewReport", true).put("type", "not a dashlet type").put("viewReport",
			builder.buildViewNode(viewId, viewName, "chart"));

		registerDashboardWith(dashletNode);

		Dashboard dashboard = service.loadDashboard(dashboardId);

		assertEquals(dashboard.getDashlets(), Collections.emptyList());
	}

	/** equals/hashcode for text dashlets */
	public void textEquality() throws DashletException {
		Dashlet d1 = new DashletImpl(service,
			new ObjectMapper().createObjectNode().put("type", "textContent").put("textContent", "text"));
		Dashlet d2 = new DashletImpl(service,
			new ObjectMapper().createObjectNode().put("type", "textContent").put("textContent", "text"));
		Dashlet d3 = new DashletImpl(service,
			new ObjectMapper().createObjectNode().put("type", "textContent").put("textContent", "other text"));

		assertEquals(d1, d2);
		assertEquals(d1.hashCode(), d2.hashCode());

		assertFalse(d1.equals(new Object()));
		assertNotEquals(d1, d3);
	}

	/** equals/hashcode for view dashlets */
	public void viewEquality() throws DashletException {
		ObjectNode n1 = new ObjectMapper().createObjectNode().put("type", "viewReport").put("canAccessViewReport", true);
		n1.put("viewReport", builder.buildViewNode(viewId, viewName, "chart"));
		Dashlet d1 = new DashletImpl(service, n1);

		ObjectNode n2 = new ObjectMapper().createObjectNode().put("type", "viewReport").put("canAccessViewReport", true);
		n2.put("viewReport", builder.buildViewNode(viewId, "other name", "kpi"));
		Dashlet d2 = new DashletImpl(service, n2);

		ObjectNode n3 = new ObjectMapper().createObjectNode().put("type", "viewReport").put("canAccessViewReport", true);
		n3.put("viewReport", builder.buildViewNode("otherId", viewName, "chart"));
		Dashlet d3 = new DashletImpl(service, n3);

		assertEquals(d1, d2);
		assertEquals(d1.hashCode(), d2.hashCode());

		assertFalse(d1.equals(new Object()));
		assertNotEquals(d1, d3);
	}

	private void registerDashboardWith(ObjectNode dashlet) {
		ObjectNode dashboardNode = builder.buildDashboardNode(dashboardId, dashboardName, null);
		dashboardNode.put("dashlets", new ObjectMapper().createArrayNode().add(dashlet));
		server.register(dashboardsUri + "/" + dashboardId, dashboardNode.toString());
	}
}