ArduinoJson/extras/tests/MsgPackDeserializer/errors.cpp

// ArduinoJson - https://arduinojson.org
// Copyright © 2014-2024, Benoit BLANCHON
// MIT License

#include <ArduinoJson.h>
#include <catch.hpp>

#include <sstream>

TEST_CASE("deserializeMsgPack() returns InvalidInput") {
  JsonDocument doc;

  SECTION("integer as key") {
    auto err = deserializeMsgPack(doc, "\x81\x01\xA1H", 3);
    REQUIRE(err == DeserializationError::InvalidInput);
  }
}

TEST_CASE("deserializeMsgPack() returns EmptyInput") {
  JsonDocument doc;

  SECTION("from sized buffer") {
    auto err = deserializeMsgPack(doc, "", 0);

    REQUIRE(err == DeserializationError::EmptyInput);
  }

  SECTION("from stream") {
    std::istringstream input("");

    auto err = deserializeMsgPack(doc, input);

    REQUIRE(err == DeserializationError::EmptyInput);
  }
}

static void testIncompleteInput(const char* input, size_t len) {
  JsonDocument doc;
  REQUIRE(deserializeMsgPack(doc, input, len) == DeserializationError::Ok);

  while (--len) {
    REQUIRE(deserializeMsgPack(doc, input, len) ==
            DeserializationError::IncompleteInput);
  }
}

TEST_CASE("deserializeMsgPack() returns IncompleteInput") {
  SECTION("empty input") {
    testIncompleteInput("\x00", 1);
  }

  SECTION("fixarray") {
    testIncompleteInput("\x91\x01", 2);
  }

  SECTION("array 16") {
    testIncompleteInput("\xDC\x00\x01\x01", 4);
  }

  SECTION("array 32") {
    testIncompleteInput("\xDD\x00\x00\x00\x01\x01", 6);
  }

  SECTION("fixmap") {
    testIncompleteInput("\x81\xA3one\x01", 6);
  }

  SECTION("map 16") {
    testIncompleteInput("\xDE\x00\x01\xA3one\x01", 8);
  }

  SECTION("map 32") {
    testIncompleteInput("\xDF\x00\x00\x00\x01\xA3one\x01", 10);
    testIncompleteInput("\xDF\x00\x00\x00\x01\xd9\x03one\x01", 11);
  }

  SECTION("uint 8") {
    testIncompleteInput("\xcc\x01", 2);
  }

  SECTION("uint 16") {
    testIncompleteInput("\xcd\x00\x01", 3);
  }

  SECTION("uint 32") {
    testIncompleteInput("\xCE\x00\x00\x00\x01", 5);
  }

#if ARDUINOJSON_USE_LONG_LONG
  SECTION("uint 64") {
    testIncompleteInput("\xCF\x00\x00\x00\x00\x00\x00\x00\x00", 9);
  }
#endif

  SECTION("int 8") {
    testIncompleteInput("\xD0\x01", 2);
  }

  SECTION("int 16") {
    testIncompleteInput("\xD1\x00\x01", 3);
  }

  SECTION("int 32") {
    testIncompleteInput("\xD2\x00\x00\x00\x01", 5);
  }

#if ARDUINOJSON_USE_LONG_LONG
  SECTION("int 64") {
    testIncompleteInput("\xD3\x00\x00\x00\x00\x00\x00\x00\x00", 9);
  }
#endif

  SECTION("float 32") {
    testIncompleteInput("\xCA\x40\x48\xF5\xC3", 5);
  }

  SECTION("float 64") {
    testIncompleteInput("\xCB\x40\x09\x21\xCA\xC0\x83\x12\x6F", 9);
  }

  SECTION("fixstr") {
    testIncompleteInput("\xABhello world", 12);
  }

  SECTION("str 8") {
    testIncompleteInput("\xd9\x05hello", 7);
  }

  SECTION("str 16") {
    testIncompleteInput("\xda\x00\x05hello", 8);
  }

  SECTION("str 32") {
    testIncompleteInput("\xdb\x00\x00\x00\x05hello", 10);
  }

  SECTION("bin 8") {
    testIncompleteInput("\xc4\x01X", 3);
  }

  SECTION("bin 16") {
    testIncompleteInput("\xc5\x00\x01X", 4);
  }

  SECTION("bin 32") {
    testIncompleteInput("\xc6\x00\x00\x00\x01X", 6);
  }

  SECTION("ext 8") {
    testIncompleteInput("\xc7\x01\x01\x01", 4);
  }

  SECTION("ext 16") {
    testIncompleteInput("\xc8\x00\x01\x01\x01", 5);
  }

  SECTION("ext 32") {
    testIncompleteInput("\xc9\x00\x00\x00\x01\x01\x01", 7);
  }

  SECTION("fixext 1") {
    testIncompleteInput("\xd4\x01\x01", 3);
  }

  SECTION("fixext 2") {
    testIncompleteInput("\xd5\x01\x01\x02", 4);
  }

  SECTION("fixext 4") {
    testIncompleteInput("\xd6\x01\x01\x02\x03\x04", 6);
  }

  SECTION("fixext 8") {
    testIncompleteInput("\xd7\x01\x01\x02\x03\x04\x05\x06\x07\x08", 10);
  }

  SECTION("fixext 16") {
    testIncompleteInput(
        "\xd8\x01\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E"
        "\x0F\x10",
        18);
  }
}

static std::string msgPackToJson(const char* input, size_t inputSize) {
  JsonDocument doc;
  auto err = deserializeMsgPack(doc, input, inputSize);
  REQUIRE(err == DeserializationError::Ok);
  return doc.as<std::string>();
}

TEST_CASE("deserializeMsgPack() replaces unsupported types by null") {
  SECTION("bin 8") {
    REQUIRE(msgPackToJson("\x92\xc4\x01X\x2A", 5) == "[null,42]");
  }

  SECTION("bin 16") {
    REQUIRE(msgPackToJson("\x92\xc5\x00\x01X\x2A", 6) == "[null,42]");
  }

  SECTION("bin 32") {
    REQUIRE(msgPackToJson("\x92\xc6\x00\x00\x00\x01X\x2A", 8) == "[null,42]");
  }

  SECTION("ext 8") {
    REQUIRE(msgPackToJson("\x92\xc7\x01\x01\x01\x2A", 6) == "[null,42]");
  }

  SECTION("ext 16") {
    REQUIRE(msgPackToJson("\x92\xc8\x00\x01\x01\x01\x2A", 7) == "[null,42]");
  }

  SECTION("ext 32") {
    REQUIRE(msgPackToJson("\x92\xc9\x00\x00\x00\x01\x01\x01\x2A", 9) ==
            "[null,42]");
  }

  SECTION("fixext 1") {
    REQUIRE(msgPackToJson("\x92\xd4\x01\x01\x2A", 5) == "[null,42]");
  }

  SECTION("fixext 2") {
    REQUIRE(msgPackToJson("\x92\xd5\x01\x01\x02\x2A", 6) == "[null,42]");
  }

  SECTION("fixext 4") {
    REQUIRE(msgPackToJson("\x92\xd6\x01\x01\x02\x03\x04\x2A", 8) ==
            "[null,42]");
  }

  SECTION("fixext 8") {
    REQUIRE(msgPackToJson("\x92\xd7\x01\x01\x02\x03\x04\x05\x06\x07\x08\x2A",
                          12) == "[null,42]");
  }

  SECTION("fixext 16") {
    REQUIRE(msgPackToJson("\x92\xd8\x01\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A"
                          "\x0B\x0C\x0D\x0E"
                          "\x0F\x10\x2A",
                          20) == "[null,42]");
  }
}

TEST_CASE("deserializeMsgPack() returns NoMemory is string length overflows") {
  JsonDocument doc;
  auto maxLength = ArduinoJson::detail::StringNode::maxLength;

  SECTION("max length should succeed") {
    auto len = maxLength;
    std::string prefix = {'\xdb', char(len >> 24), char(len >> 16),
                          char(len >> 8), char(len)};

    auto err = deserializeMsgPack(doc, prefix + std::string(len, 'a'));
    REQUIRE(err == DeserializationError::Ok);
  }

  SECTION("one above max length should fail") {
    auto len = maxLength + 1;
    std::string prefix = {'\xdb', char(len >> 24), char(len >> 16),
                          char(len >> 8), char(len)};

    auto err = deserializeMsgPack(doc, prefix + std::string(len, 'a'));
    REQUIRE(err == DeserializationError::NoMemory);
  }
}