ControlChannelTest.java

/**
Copyright 2013 project Ardulink http://www.ardulink.org/

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.github.pfichtner.ardulink;

import static com.github.pfichtner.ardulink.util.MqttMessageBuilder.mqttMessageWithBasicTopic;
import static com.github.pfichtner.ardulink.util.ProtoBuilder.alpProtocolMessage;
import static com.github.pfichtner.ardulink.util.ProtoBuilder.ALPProtocolKeys.START_LISTENING_ANALOG;
import static com.github.pfichtner.ardulink.util.ProtoBuilder.ALPProtocolKeys.START_LISTENING_DIGITAL;
import static com.github.pfichtner.ardulink.util.ProtoBuilder.ALPProtocolKeys.STOP_LISTENING_ANALOG;
import static com.github.pfichtner.ardulink.util.ProtoBuilder.ALPProtocolKeys.STOP_LISTENING_DIGITAL;
import static com.github.pfichtner.ardulink.util.TestUtil.createConnection;
import static com.github.pfichtner.ardulink.util.TestUtil.getField;
import static com.github.pfichtner.ardulink.util.TestUtil.set;
import static org.hamcrest.core.Is.is;
import static org.junit.Assert.assertThat;

import java.io.ByteArrayOutputStream;
import java.io.IOException;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.zu.ardulink.ConnectionContact;
import org.zu.ardulink.Link;
import org.zu.ardulink.connection.Connection;

import com.github.pfichtner.ardulink.util.Message;
import com.github.pfichtner.ardulink.util.MqttMessageBuilder;

/**
 * [ardulinktitle] [ardulinkversion]
 * @author Peter Fichtner
 * 
 * [adsense]
 */
public class ControlChannelTest {

	private static final String LINKNAME = "testlink";

	private final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
	private final ConnectionContact connectionContact = new ConnectionContact(
			null);
	private final Connection connection = createConnection(outputStream,
			connectionContact);
	private final Link link = Link.createInstance(LINKNAME, connection);

	private final AbstractMqttAdapter mqttClient = new AbstractMqttAdapter(
			link, Config.DEFAULT.withControlChannelEnabled()) {
		@Override
		void fromArduino(String topic, String message) {
			throw new UnsupportedOperationException("Receiving not supported");
		}
	};

	private final MqttMessageBuilder mqttMessage = mqttMessageWithBasicTopic(Config.DEFAULT_TOPIC);

	{
		// there is an extremely high coupling of ConnectionContact and Link
		// which can not be solved other than injecting the variables through
		// reflection
		set(connectionContact, getField(connectionContact, "link"), link);
		set(link, getField(link, "connectionContact"), connectionContact);

	}

	@Before
	public void setup() {
		link.connect();
	}

	@After
	public void tearDown() {
		link.disconnect();
		Link.destroyInstance(LINKNAME);
	}

	@Test
	public void canEnableListenerForDigitalPin() {
		int pin = 2;
		simulateMqttToArduino(mqttMessage.digitalListener(pin).enable());
		assertThat(serialReceived(),
				is(alpProtocolMessage(START_LISTENING_DIGITAL).forPin(pin)
						.withoutValue()));
	}

	@Test
	public void noMessageWhenConfigDoesNotSupportControlChannel() {
		int pin = 2;
		Message message = mqttMessage.digitalListener(pin).enable();
		new AbstractMqttAdapter(link, Config.DEFAULT) {
			@Override
			void fromArduino(String topic, String message) {
				throw new UnsupportedOperationException(
						"Receiving not supported");
			}
		}.toArduino(message.getTopic(), message.getMessage());
		assertThat(serialReceived(), is(empty()));
	}

	@Test
	public void canEnableListenerForAnalogPin() {
		int pin = 3;
		simulateMqttToArduino(mqttMessage.analogListener(pin).enable());
		assertThat(serialReceived(),
				is(alpProtocolMessage(START_LISTENING_ANALOG).forPin(pin)
						.withoutValue()));
	}

	@Test
	public void canDisableListenerForDigitalPin() {
		int pin = 4;
		simulateMqttToArduino(mqttMessage.digitalListener(pin).disable());
		assertThat(serialReceived(),
				is(alpProtocolMessage(STOP_LISTENING_DIGITAL).forPin(pin)
						.withoutValue()));
	}

	@Test
	public void canDisableListenerForAnalogPin() {
		int pin = 5;
		simulateMqttToArduino(mqttMessage.analogListener(pin).disable());
		assertThat(serialReceived(),
				is(alpProtocolMessage(STOP_LISTENING_ANALOG).forPin(pin)
						.withoutValue()));
	}

	@Test
	public void canHandleInvaldTypeOnEnabling() {
		int pin = 6;
		simulateMqttToArduino(mqttMessage.listener().appendTopic("X" + pin)
				.enable());
		assertThat(serialReceived(), is(empty()));
	}

	@Test
	public void canHandleInvaldTypeOnDisabling() {
		int pin = 6;
		simulateMqttToArduino(mqttMessage.listener().appendTopic("X" + pin)
				.disable());
		assertThat(serialReceived(), is(empty()));
	}

	@Test
	public void canHandleInvaldDigitalPins() {
		String pin = "X";
		simulateMqttToArduino(mqttMessage.listener().appendTopic("D" + pin)
				.enable());
		assertThat(serialReceived(), is(empty()));
	}

	@Test
	public void canHandleInvaldAnalogPins() {
		String pin = "X";
		simulateMqttToArduino(mqttMessage.listener().appendTopic("A" + pin)
				.enable());
		assertThat(serialReceived(), is(empty()));
	}

	private void simulateMqttToArduino(Message message) {
		mqttClient.toArduino(message.getTopic(), message.getMessage());
	}

	private String serialReceived() {
		try {
			outputStream.close();
		} catch (IOException e) {
			throw new RuntimeException(e);
		}
		return new String(outputStream.toByteArray());
	}

	private static String empty() {
		return "";
	}
}