GY-63_MS5611/libraries/Cozir/test/unit_test_001.cpp

//
//    FILE: unit_test_001.cpp
//  AUTHOR: Rob Tillaart
//    DATE: 2020-12-03
// PURPOSE: unit tests for the Cozir CO2 library
//          https://github.com/RobTillaart/Cozir
//          https://github.com/Arduino-CI/arduino_ci/blob/master/REFERENCE.md
//

// supported assertions
// https://github.com/Arduino-CI/arduino_ci/blob/master/cpp/unittest/Assertion.h#L33-L42
// ----------------------------
// assertEqual(expected, actual);               // a == b
// assertNotEqual(unwanted, actual);            // a != b
// assertComparativeEquivalent(expected, actual);    // abs(a - b) == 0 or (!(a > b) && !(a < b))
// assertComparativeNotEquivalent(unwanted, actual); // abs(a - b) > 0  or ((a > b) || (a < b))
// assertLess(upperBound, actual);              // a < b
// assertMore(lowerBound, actual);              // a > b
// assertLessOrEqual(upperBound, actual);       // a <= b
// assertMoreOrEqual(lowerBound, actual);       // a >= b
// assertTrue(actual);
// assertFalse(actual);
// assertNull(actual);

// // special cases for floats
// assertEqualFloat(expected, actual, epsilon);    // fabs(a - b) <= epsilon
// assertNotEqualFloat(unwanted, actual, epsilon); // fabs(a - b) >= epsilon
// assertInfinity(actual);                         // isinf(a)
// assertNotInfinity(actual);                      // !isinf(a)
// assertNAN(arg);                                 // isnan(a)
// assertNotNAN(arg);                              // !isnan(a)


#include <ArduinoUnitTests.h>


#include "Arduino.h"
#include "cozir.h"
#include "SoftwareSerial.h"


// NOTE: normally the COZIR lib is tested with software serial, at least in sketches
// to get the unit test up and running I (tried to) use Serial here.

// aspects of software serial
bool bigEndian = false;

unittest_setup()
{
  fprintf(stderr, "\n");
}

unittest_teardown()
{
}


unittest(test_software_serial)
{
  int receivePin = 4;
  int transmitPin = 5;

  GodmodeState* state = GODMODE();

  SoftwareSerial sws(receivePin, transmitPin);
  COZIR co(&sws);

  fprintf(stderr, "COZIR.init()\n");
  co.init();
  assertEqual("K 2\r\n", state->digitalPin[transmitPin].toAscii(1, bigEndian));
}


unittest(test_constructor)
{
  GodmodeState* state = GODMODE();

  state->serialPort[0].dataIn = "";             // the queue of data waiting to be read
  state->serialPort[0].dataOut = "";            // the history of data written

  fprintf(stderr, "default there is no data on the Serial bus\n");
  assertEqual(-1, Serial.peek());
  assertEqual("", state->serialPort[0].dataIn);
  assertEqual("", state->serialPort[0].dataOut);

  COZIR co(&Serial);

  fprintf(stderr, "COZIR.init()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.init();
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.GetVersionSerial()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.GetVersionSerial();
  assertEqual("K 0\r\nY\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.GetConfiguration()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.GetConfiguration();
  assertEqual("K 0\r\n*\r\n", state->serialPort[0].dataOut);
}


unittest(test_setOperatingMode)
{
  GodmodeState* state = GODMODE();

  COZIR co(&Serial);

  fprintf(stderr, "COZIR.init()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.init();
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.SetOperatingMode(CZR_COMMAND)\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.SetOperatingMode(CZR_COMMAND);
  assertEqual("K 0\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.SetOperatingMode(CZR_STREAMING)\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.SetOperatingMode(CZR_STREAMING);
  assertEqual("K 1\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.SetOperatingMode(CZR_POLLING)\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.SetOperatingMode(CZR_POLLING);
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);
}


unittest(test_read_sensor)
{
   GodmodeState* state = GODMODE();

  COZIR co(&Serial);

  fprintf(stderr, "COZIR.init()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.init();
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.Celsius()\n");
  state->serialPort[0].dataIn = "T    750\r\n";   // 1000 = 0°C
  state->serialPort[0].dataOut = "";
  float Celsius = co.Celsius();
  assertEqual("T\r\n", state->serialPort[0].dataOut);
  assertEqualFloat(-25.0, Celsius, 0.0001);
  
  state->serialPort[0].dataIn = "T   1257\r\n";
  state->serialPort[0].dataOut = "";
  Celsius = co.Celsius();
  assertEqual("T\r\n", state->serialPort[0].dataOut);
  assertEqualFloat(25.7, Celsius, 0.0001);
  
  fprintf(stderr, "COZIR.Humidity()\n");
  state->serialPort[0].dataIn = "H 627\r\n";
  state->serialPort[0].dataOut = "";
  float Humidity = co.Humidity();
  assertEqual("H\r\n", state->serialPort[0].dataOut);
  assertEqualFloat(62.7, Humidity, 0.0001);

  fprintf(stderr, "COZIR.Light()\n");
  state->serialPort[0].dataIn = "L 189\r\n";
  state->serialPort[0].dataOut = "";
  float Light = co.Light();
  assertEqual("L\r\n", state->serialPort[0].dataOut);
  assertEqual(189, Light);

  fprintf(stderr, "COZIR.CO2()\n");
  state->serialPort[0].dataIn = "Z 432\r\n";
  state->serialPort[0].dataOut = "";
  float CO2 = co.CO2();
  assertEqual("Z\r\n", state->serialPort[0].dataOut);
  assertEqual(432, CO2);
}


unittest(test_calibrate)
{
  GodmodeState* state = GODMODE();

  COZIR co(&Serial);

  fprintf(stderr, "COZIR.init()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.init();
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.FineTuneZeroPoint(400, 382)\n");
  state->serialPort[0].dataIn = "F 32950\r\n";
  state->serialPort[0].dataOut = "";
  uint16_t FineTuneZeroPoint = co.FineTuneZeroPoint(400, 382);
  assertEqual("F 400 382\r\n", state->serialPort[0].dataOut);
  assertEqual(32950, FineTuneZeroPoint);
  
  
  fprintf(stderr, "COZIR.CalibrateFreshAir()\n");
  state->serialPort[0].dataIn = "G 32950\r\n";
  state->serialPort[0].dataOut = "";
  uint16_t CalibrateFreshAir = co.CalibrateFreshAir();
  assertEqual("G\r\n", state->serialPort[0].dataOut);
  assertEqual(32950, CalibrateFreshAir);

  fprintf(stderr, "COZIR.CalibrateNitrogen()\n");
  state->serialPort[0].dataIn = "U 32590\r\n";
  state->serialPort[0].dataOut = "";
  uint16_t CalibrateNitrogen = co.CalibrateNitrogen();
  assertEqual("U\r\n", state->serialPort[0].dataOut);
  assertEqual(32590, CalibrateNitrogen);

  fprintf(stderr, "COZIR.CalibrateKnownGas(100)\n");
  state->serialPort[0].dataIn = "X 33012\r\n";
  state->serialPort[0].dataOut = "";
  uint16_t CalibrateKnownGas = co.CalibrateKnownGas(100);
  assertEqual("X 100\r\n", state->serialPort[0].dataOut);
  assertEqual(33012, CalibrateKnownGas);
  
}


unittest(test_digi_filter)
{
  GodmodeState* state = GODMODE();

  COZIR co(&Serial);

  fprintf(stderr, "COZIR.init()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.init();
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.SetDigiFilter(42)\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.SetDigiFilter(42);
  assertEqual("A 42\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.GetDigiFilter()\n");
  state->serialPort[0].dataIn = "a 42\r\n";
  state->serialPort[0].dataOut = "";
  uint8_t digifilter = co.GetDigiFilter();
  assertEqual("a\r\n", state->serialPort[0].dataOut);
  assertEqual(42, digifilter);
}


unittest(test_streaming_mode)
{
  GodmodeState* state = GODMODE();

  COZIR co(&Serial);

  fprintf(stderr, "COZIR.init()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.init();
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);

  fprintf(stderr, "COZIR.SetOperatingMode(CZR_STREAMING)\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.SetOperatingMode(CZR_STREAMING);
  assertEqual("K 1\r\n", state->serialPort[0].dataOut);

  fprintf(stderr, "COZIR.SetOutputFields(CZR_HUMIDITY | CZR_RAWTEMP | CZR_RAWCO2)\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.SetOutputFields(CZR_HUMIDITY | CZR_RAWTEMP | CZR_RAWCO2);
  assertEqual("M 4226\r\n", state->serialPort[0].dataOut);

  fprintf(stderr, "COZIR.GetRecentFields()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.GetRecentFields();
  assertEqual("Q\r\n", state->serialPort[0].dataOut);
  
  fprintf(stderr, "COZIR.ClrOutputFields()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.ClrOutputFields();
  assertEqual("M 1\r\n", state->serialPort[0].dataOut);

  fprintf(stderr, "COZIR.GetRecentFields()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.GetRecentFields();
  assertEqual("Q\r\n", state->serialPort[0].dataOut);
  // USER MUST READ RETURNED DATA AS IT CAN BE QUITE A LOT.
}


unittest(test_eeprom)
{
  GodmodeState* state = GODMODE();

  COZIR co(&Serial);

  fprintf(stderr, "COZIR.init()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.init();
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);

  fprintf(stderr, "COZIR.SetEEPROM(10, 42)\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.SetEEPROM(10, 42);
  assertEqual("P 10 42\r\n", state->serialPort[0].dataOut);

  fprintf(stderr, "COZIR.GetEEPROM(100)\n");
  state->serialPort[0].dataIn = "p 42\r\n";
  state->serialPort[0].dataOut = "";
  uint8_t GetEEPROM = co.GetEEPROM(100);
  assertEqual("p 100\r\n", state->serialPort[0].dataOut);
  assertEqual(42, GetEEPROM);
}



unittest(test_PPM)
{
  GodmodeState* state = GODMODE();

  COZIR co(&Serial);

  fprintf(stderr, "COZIR.init()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.init();
  assertEqual("K 2\r\n", state->serialPort[0].dataOut);

  fprintf(stderr, "COZIR.getPPMFactor()\n");
  state->serialPort[0].dataIn = "";
  state->serialPort[0].dataOut = "";
  co.getPPMFactor();
  assertEqual(".\r\n", state->serialPort[0].dataOut);
}



unittest_main()

// --------