Merge pull request #49 from cujomalainey/develop

Release initial tests

Author: cujomalainey

.circleci/config.yml

@@ -0,0 +1,39 @@
+# Python CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-python/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      # use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
+      - image: circleci/python:2.7
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            sudo pip install -U platformio
+
+      # other common Python testing frameworks include pytest and nose
+      # https://pytest.org
+      # https://nose.readthedocs.io
+      - run:
+          name: run tests
+          command: |
+            pio test -e native
+
+      - store_artifacts:
+          path: test-reports
+          destination: test-reports
+

README.md

@@ -5,6 +5,7 @@ Arduino library for communicating with ANT radios, with support for nrf51 device
 ## Status
 
 [![Build Status](https://travis-ci.org/cujomalainey/ant-arduino.svg?branch=master)](https://travis-ci.org/cujomalainey/ant-arduino)
+[![Test Status](https://img.shields.io/circleci/project/github/cujomalainey/ant-arduino/master.svg)](https://circleci.com/gh/cujomalainey/ant-arduino)
 
 ## News
 

platformio.ini

@@ -26,4 +26,9 @@ board = teensy31
 platform = nordicnrf52
 framework = arduino
 board = nrf52_dk
-build_flags = -DNRF52_S132
+build_flags = -DNRF52_S132
+
+[env:native]
+platform = native
+build_flags = -Wno-c++11-extensions -std=c++11
+

src/BaseClasses/ANT_BaseAnt.h

@@ -6,7 +6,12 @@
 
 #include <ANT_defines.h>
 
+#ifdef UNIT_TEST
+// Includes a mock stream object for unit testing
+#include "Util/Testing.h"
+#else
 #include "Arduino.h"
+#endif
 
 class BaseAnt {
 public:

src/TX/Config/ANT_SetNetworkKey.cpp

@@ -2,7 +2,11 @@
 
 #include <ANT_private_defines.h>
 
-#include <Arduino.h>
+#ifdef UNIT_TEST
+#include "Util/Testing.h"
+#else
+#include "Arduino.h"
+#endif
 
 SetNetworkKey::SetNetworkKey() : AntRequest(SET_NETWORK_KEY) {
     memset(_key, 0, NETWORK_KEY_SIZE);

src/Util/Testing.cpp

@@ -0,0 +1,35 @@
+#ifdef UNIT_TEST
+
+#include "Util/Testing.h"
+#include <sys/time.h>
+#include "unity.h"
+
+Stream Serial = Stream(NULL, NULL);
+
+unsigned long millis() {
+    struct timeval time;
+    gettimeofday(&time, NULL);
+    return time.tv_usec/1000;
+}
+
+Stream::Stream(const uint8_t* inBuffer, const uint8_t* outBuffer) {
+    _inBuffer = inBuffer;
+    _outBuffer = outBuffer;
+}
+
+uint8_t Stream::available() {
+    return sizeof(_inBuffer) - _read;
+}
+
+uint8_t Stream::read() {
+    return _inBuffer[_read++];
+}
+
+void Stream::write(uint8_t data) {
+    if (_wrote < sizeof(_outBuffer)) {
+        TEST_ASSERT_EQUAL(data, _outBuffer[_wrote++]);
+    }
+}
+
+
+#endif // UNIT_TEST

src/Util/Testing.h

@@ -0,0 +1,24 @@
+#ifdef UNIT_TEST
+#ifndef ANT_TESTING_h
+#define ANT_TESTING_h
+#include <string.h>
+#include <inttypes.h>
+
+unsigned long millis();
+
+class Stream {
+public:
+    Stream(const uint8_t* inBuffer, const uint8_t* outBuffer);
+    uint8_t available();
+    uint8_t read();
+    void write(uint8_t data);
+private:
+    const uint8_t* _inBuffer;
+    const uint8_t* _outBuffer;
+    uint8_t _read = 0;
+    uint8_t _wrote = 0;
+};
+
+extern Stream Serial;
+#endif // ANT_TESTING_h
+#endif // UNIT_TEST

test/TX_AddChannelIdToList/Test_AddChannelIdToList.cpp

@@ -0,0 +1,72 @@
+#include "unity.h"
+#include "ANT.h"
+#include "Util/Testing.h"
+
+#ifdef UNIT_TEST
+
+const uint8_t expectedOut[] = {0xA4, 6, 0x59, 2, 0x44, 0x33, 120, 34, 2, 214};
+Stream mock_stream = Stream(NULL, expectedOut);
+AntWithCallbacks ant = AntWithCallbacks();
+AddChannelIdToList msg;
+
+void test_constructors(void) {
+    msg = AddChannelIdToList(2, 3344, 120, 34, 2);
+    TEST_ASSERT_EQUAL_UINT8(2, msg.getChannel());
+    TEST_ASSERT_EQUAL_UINT16(3344, msg.getDeviceNumber());
+    TEST_ASSERT_EQUAL_UINT8(120, msg.getDeviceType());
+    TEST_ASSERT_EQUAL_UINT8(34, msg.getTransmissionType());
+    TEST_ASSERT_EQUAL_UINT8(2, msg.getListIndex());
+}
+
+void test_setChannel(void) {
+    msg.setChannel(3);
+    TEST_ASSERT_EQUAL_UINT8(3, msg.getChannel());
+}
+
+void test_setDeviceNumber(void) {
+    msg.setDeviceNumber(0x4455);
+    TEST_ASSERT_EQUAL_UINT16(0x4455, msg.getDeviceNumber());
+}
+
+void test_setDeviceType(void) {
+    msg.setDeviceType(100);
+    TEST_ASSERT_EQUAL_UINT8(100, msg.getDeviceType());
+}
+
+void test_setTransmisionType(void) {
+    msg.setTransmissionType(12);
+    TEST_ASSERT_EQUAL_UINT8(12, msg.getTransmissionType());
+}
+
+void test_setListIndex(void) {
+    msg.setListIndex(4);
+    TEST_ASSERT_EQUAL_UINT8(4, msg.getListIndex());
+}
+
+void test_getDataLength(void) {
+    TEST_ASSERT_EQUAL_UINT8(6, msg.getDataLength());
+}
+
+void test_serialize(void) {
+    // Asserts are in mock stream
+    ant.begin(mock_stream);
+    msg = AddChannelIdToList(2, 0x3344, 120, 34, 2);
+    ant.send(msg);
+}
+
+int main(int argc, char **argv) {
+    UNITY_BEGIN();
+    RUN_TEST(test_constructors);
+    RUN_TEST(test_setChannel);
+    RUN_TEST(test_setDeviceNumber);
+    RUN_TEST(test_setDeviceType);
+    RUN_TEST(test_setTransmisionType);
+    RUN_TEST(test_setListIndex);
+    RUN_TEST(test_getDataLength);
+    RUN_TEST(test_serialize);
+    UNITY_END();
+
+    return 0;
+}
+
+#endif // UNIT_TEST

test/TX_AddEncryptionIdToList/Test_AddEncryptionIdToList.cpp

@@ -0,0 +1,57 @@
+#include "unity.h"
+#include "ANT.h"
+#include "Util/Testing.h"
+
+#ifdef UNIT_TEST
+
+const uint8_t expectedOut[] = {0xA4, 6, 0x59, 1, 0x78, 0x56, 0x34, 0x12, 3, 241};
+Stream mock_stream = Stream(NULL, expectedOut);
+AntWithCallbacks ant = AntWithCallbacks();
+AddEncryptionIdToList msg;
+
+void test_constructors(void) {
+    msg = AddEncryptionIdToList(1, 0x12345678, 3);
+    TEST_ASSERT_EQUAL_UINT8(1, msg.getChannel());
+    TEST_ASSERT_EQUAL_UINT32(0x12345678, msg.getEncryptionId());
+    TEST_ASSERT_EQUAL_UINT8(3, msg.getListIndex());
+}
+
+void test_setChannel(void) {
+    msg.setChannel(3);
+    TEST_ASSERT_EQUAL_UINT8(3, msg.getChannel());
+}
+
+void test_setEncryptionId(void) {
+    msg.setEncryptionId(0x11223344);
+    TEST_ASSERT_EQUAL_UINT16(0x11223344, msg.getEncryptionId());
+}
+
+void test_setListIndex(void) {
+    msg.setListIndex(3);
+    TEST_ASSERT_EQUAL_UINT8(3, msg.getListIndex());
+}
+
+void test_getDataLength(void) {
+    TEST_ASSERT_EQUAL_UINT8(6, msg.getDataLength());
+}
+
+void test_serialize(void) {
+    // Asserts are in mock stream
+    ant.begin(mock_stream);
+    msg = AddEncryptionIdToList(1, 0x12345678, 3);
+    ant.send(msg);
+}
+
+int main(int argc, char **argv) {
+    UNITY_BEGIN();
+    RUN_TEST(test_constructors);
+    RUN_TEST(test_setEncryptionId);
+    RUN_TEST(test_setListIndex);
+    RUN_TEST(test_getDataLength);
+    RUN_TEST(test_serialize);
+    UNITY_END();
+
+    return 0;
+}
+
+#endif // UNIT_TEST