MqttTest.java

/*
 * Copyright (C) 2017 Samsung Electronics Co., Ltd.
 *
 * 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 cloud.artik.mqtt;

import static org.junit.Assert.*;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.IMqttToken;
import org.eclipse.paho.client.mqttv3.MqttMessage;
import org.junit.After;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;

import cloud.artik.config.*;

/**
 * This test case tests the basic mqtt functions using Junit framework. 
 * It is disabled by default. Consult the instruction below to enable and run the tests
 * 
 * How to run the tests of this test case
 * 
 * Follow the instruction in config/Config.java:
 *  Fill in device id/token for "Example Simple Smart Light"
 *  Run the test case: "mvn clean -Dtest=MqttTest test"
 *    
 */

public class MqttTest {
    // Device of "Example Simple Smart Light"
    private String deviceId      = null;
    private String deviceToken   = null;
    
    // The maximum time to wait for each mqtt operation to finish
    final int maxWaitingTimeInMs = 5000;
    private CountDownLatch lock  = null;
    
    final int qos                = 2;

    MqttSession mqttSession = null;
    ArtikCloudMqttCallback callback = new ArtikCloudMqttCallback() {
        @Override
        public void onFailure(OperationMode opMode, IMqttToken mqttToken, Throwable throwable) {
            System.out.println("ArtikCloudMqttCallback::onFailure is called with Mode " + opMode  + "; throwable (" + throwable.toString() + ")");
            lock.countDown();
            fail();
        }

        @Override
        public void onSuccess(OperationMode opMode, IMqttToken mqttToken) {
            System.out.println("ArtikCloudMqttCallback::onSuccess() with Mode " 
                    + opMode);
            lock.countDown();
        }

        @Override
        public void connectionLost(Throwable cause) {
            System.out.println("Connection is lost due to " + cause);
            fail();
        }

        @Override
        public void messageArrived(String topic, MqttMessage message) {
            System.out.println("Received message. Payload: " + new String(message.getPayload()) + ". Qos:" + message.getQos() + "; Topic:" + topic);
        }

        @Override
        public void deliveryComplete(IMqttDeliveryToken token) {
        }
    };
    
    @Before
    public void setup() {
        System.out.println("\nsetUp");
        deviceId = Config.smartLightDeviceId;
        assertNotNull(deviceId);
        assertFalse(deviceId.isEmpty());
        
        deviceToken = Config.smartLightdeviceToken;
        assertNotNull(deviceToken);
        assertFalse(deviceToken.isEmpty());
        
        System.out.println("Device ID:" + deviceId +"; Device Token:" + deviceToken);
        try {
            mqttSession = new MqttSession(deviceId, deviceToken, callback);
            System.out.println("Connecting to broker: "+ mqttSession.getBrokerUri());
            mqttSession.connect();
            lock = new CountDownLatch(1);
            lock.await(maxWaitingTimeInMs, TimeUnit.MILLISECONDS);//wait for mqtt operation finished
            assertEquals(true, mqttSession.isConnected());
        } catch(ArtikCloudMqttException|InterruptedException e) {
            e.printStackTrace();
            fail();
        }
        
    }
    

    @After
    public void cleanup() {
        System.out.println("cleanup");
        try {
            mqttSession.disconnect();
            lock = new CountDownLatch(1);
            lock.await(maxWaitingTimeInMs, TimeUnit.MILLISECONDS);
            assertEquals(false, mqttSession.isConnected());
        } catch(ArtikCloudMqttException|InterruptedException e) {
            e.printStackTrace();
            fail();
        } 
        System.out.println("====================");
    }

    @Test
    public void connectionSuccessTest() {
        System.out.println("Test: connectionSuccessTest()");
        // This test case will trigger setup() and cleanup(); 
        // Should anything is wrong, it will trigger assertion there.
    }
    
    @Test
    public void publishTest() {
        System.out.println("Test: publishTest()");
        try {
            String payload    =  "{\"state\":true}";
            System.out.println("Publishing to topic: " + mqttSession.getPublishTopicPath() + "; message payload: " + payload );
            mqttSession.publish(qos, payload);
            lock = new CountDownLatch(1);
            lock.await(maxWaitingTimeInMs, TimeUnit.MILLISECONDS);//wait for mqtt operation finished
        } catch(Exception e) {
            e.printStackTrace();
            fail();
        } 
    }

    @Test
    public void subscribeToActionsTopicTest() {
        System.out.println("Test: subscribeToActionTopicTest()");
        
        try {
            System.out.println("Subscribing to actions topic: " + mqttSession.getSubscribeActionsTopicPath());
            mqttSession.subscribe(Topics.SUBSCRIBE_TOPIC_ACTIONS);
            lock = new CountDownLatch(1);
            lock.await(maxWaitingTimeInMs, TimeUnit.MILLISECONDS);//wait for mqtt operation finished
        } catch(Exception e) {
            e.printStackTrace();
            fail();
        }
        
    }
    
    @Test
    public void subscribeToErrorsTopicTest() {
        System.out.println("Test: subscribeToErrorsTopicTest()");
        
        try {
            System.out.println("Subscribing to error topic: " + mqttSession.getSubscribeErrorsTopicPath());
            mqttSession.subscribe(Topics.SUBSCRIBE_TOPIC_ERRORS);
            lock = new CountDownLatch(1);
            lock.await(maxWaitingTimeInMs, TimeUnit.MILLISECONDS);//wait for mqtt operation finished
        } catch(Exception e) {
            e.printStackTrace();
            fail();
        }
    }

}