////////////////////////////////////////////////////////////////////////////////
/// @brief test suite for StringUtils class
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2004-2012 triagens GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
/// @author Copyright 2007-2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

#include "Basics/Common.h"

#define BOOST_TEST_INCLUDED
#include <boost/test/unit_test.hpp>

#include <iomanip>

#include "Basics/StringUtils.h"
#include "Basics/Utf8Helper.h"

#if _WIN32
#include "Basics/win-utils.h"
#define FIX_ICU_ENV     TRI_FixIcuDataEnv()
#else
#define FIX_ICU_ENV
#endif

using namespace arangodb;
using namespace arangodb::basics;
using namespace std;

// -----------------------------------------------------------------------------
// --SECTION--                                                 private functions
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @brief hex dump with ':' separator
////////////////////////////////////////////////////////////////////////////////

static string hexedump (const string &s) {
  ostringstream oss;
  oss.imbue(locale());
  bool first = true;

  for (string::const_iterator it = s.begin();  it != s.end();  it++) {
    oss << (first ? "" : ":") << hex << setw(2) << setfill('y') << string::traits_type::to_int_type(*it);
    first = false;
  }

  return oss.str();
}

// -----------------------------------------------------------------------------
// --SECTION--                                                 setup / tear-down
// -----------------------------------------------------------------------------

struct StringUtilsSetup {
  StringUtilsSetup () {
    FIX_ICU_ENV;
    if (!arangodb::basics::Utf8Helper::DefaultUtf8Helper.setCollatorLanguage("")) {
      std::string msg =
        "cannot initialize ICU; please make sure ICU*dat is available; "
        "the variable ICU_DATA='";
      if (getenv("ICU_DATA") != nullptr) {
        msg += getenv("ICU_DATA");
      }
      msg += "' should point the directory containing the ICU*dat file.";
      BOOST_TEST_MESSAGE(msg);
      BOOST_CHECK_EQUAL(false, true);
    }
    BOOST_TEST_MESSAGE("setup StringUtils");
  }

  ~StringUtilsSetup () {
    BOOST_TEST_MESSAGE("teardown StringUtils");
  }
};

// -----------------------------------------------------------------------------
// --SECTION--                                                        test suite
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @brief setup
////////////////////////////////////////////////////////////////////////////////

BOOST_FIXTURE_TEST_SUITE (StringUtilsTest, StringUtilsSetup)

////////////////////////////////////////////////////////////////////////////////
/// @brief test_Split1
////////////////////////////////////////////////////////////////////////////////

BOOST_AUTO_TEST_CASE (test_Split1) {
  vector<string> lines = StringUtils::split("Hallo\nWorld\\/Me", '\n');

  BOOST_CHECK_EQUAL(lines.size(), (size_t) 2);

  if (lines.size() == 2) {
    BOOST_CHECK_EQUAL(lines[0], "Hallo");
    BOOST_CHECK_EQUAL(lines[1], "World/Me");
  }
}

////////////////////////////////////////////////////////////////////////////////
/// @brief test_Split2
////////////////////////////////////////////////////////////////////////////////

BOOST_AUTO_TEST_CASE (test_Split2) {
  vector<string> lines = StringUtils::split("\nHallo\nWorld\n", '\n');

  BOOST_CHECK_EQUAL(lines.size(), (size_t) 4);

  if (lines.size() == 4) {
    BOOST_CHECK_EQUAL(lines[0], "");
    BOOST_CHECK_EQUAL(lines[1], "Hallo");
    BOOST_CHECK_EQUAL(lines[2], "World");
    BOOST_CHECK_EQUAL(lines[3], "");
  }
}

////////////////////////////////////////////////////////////////////////////////
/// @brief test_Split3
////////////////////////////////////////////////////////////////////////////////

BOOST_AUTO_TEST_CASE (test_Split3) {
  vector<string> lines = StringUtils::split("Hallo\nWorld\\/Me", '\n', '\0');

  BOOST_CHECK_EQUAL(lines.size(), (size_t) 2);

  if (lines.size() == 2) {
    BOOST_CHECK_EQUAL(lines[0], "Hallo");
    BOOST_CHECK_EQUAL(lines[1], "World\\/Me");
  }
}

////////////////////////////////////////////////////////////////////////////////
/// @brief test_Tolower
////////////////////////////////////////////////////////////////////////////////

BOOST_AUTO_TEST_CASE (test_Tolower) {
  string lower = StringUtils::tolower("HaLlO WoRlD!");

  BOOST_CHECK_EQUAL(lower, "hallo world!");
}

////////////////////////////////////////////////////////////////////////////////
/// @brief test_convertUTF16ToUTF8
////////////////////////////////////////////////////////////////////////////////

BOOST_AUTO_TEST_CASE (test_convertUTF16ToUTF8) {
  string result;
  bool isOk;

  // both surrogates are valid
  isOk = StringUtils::convertUTF16ToUTF8("D8A4\0", "dd42\0", result);

  BOOST_CHECK(isOk);
  BOOST_CHECK_EQUAL(result.length(), (size_t) 4);
  BOOST_CHECK_EQUAL("f0:b9:85:82", hexedump(result));

  result.clear();

  // wrong low surrogate
  isOk = StringUtils::convertUTF16ToUTF8("DD42", "D8A4", result);

  BOOST_CHECK(! isOk);
  BOOST_CHECK(result.empty());

  result.clear();

  // wrong high surrogate
  isOk = StringUtils::convertUTF16ToUTF8("DC00", "DC1A", result);

  BOOST_CHECK(! isOk);
  BOOST_CHECK(result.empty());
}

////////////////////////////////////////////////////////////////////////////////
/// @brief test_uint64
////////////////////////////////////////////////////////////////////////////////

BOOST_AUTO_TEST_CASE (test_uint64) {
  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64("abc"));
  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64("ABC"));
  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64(" foo"));
  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64(""));
  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64(" "));
  BOOST_CHECK_EQUAL(12ULL, StringUtils::uint64(" 012"));
  BOOST_CHECK_EQUAL(1234ULL, StringUtils::uint64("1234a"));
  BOOST_CHECK_EQUAL(18446744073709551615ULL, StringUtils::uint64("-1"));
  BOOST_CHECK_EQUAL(18446744073709539271ULL, StringUtils::uint64("-12345"));
  BOOST_CHECK_EQUAL(1234ULL, StringUtils::uint64("1234.56"));
  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64("1234567890123456789012345678901234567890"));
  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64("@"));

  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64("0"));
  BOOST_CHECK_EQUAL(1ULL, StringUtils::uint64("1"));
  BOOST_CHECK_EQUAL(12ULL, StringUtils::uint64("12"));
  BOOST_CHECK_EQUAL(123ULL, StringUtils::uint64("123"));
  BOOST_CHECK_EQUAL(1234ULL, StringUtils::uint64("1234"));
  BOOST_CHECK_EQUAL(1234ULL, StringUtils::uint64("01234"));
  BOOST_CHECK_EQUAL(9ULL, StringUtils::uint64("9"));
  BOOST_CHECK_EQUAL(9ULL, StringUtils::uint64(" 9"));
  BOOST_CHECK_EQUAL(9ULL, StringUtils::uint64("0009"));
  BOOST_CHECK_EQUAL(12345678ULL, StringUtils::uint64("12345678"));
  BOOST_CHECK_EQUAL(1234567800ULL, StringUtils::uint64("1234567800"));
  BOOST_CHECK_EQUAL(1234567890123456ULL, StringUtils::uint64("1234567890123456"));
  BOOST_CHECK_EQUAL(UINT64_MAX, StringUtils::uint64(std::to_string(UINT64_MAX)));
}

////////////////////////////////////////////////////////////////////////////////
/// @brief test_uint64_check
////////////////////////////////////////////////////////////////////////////////

static bool InvalidArgument(std::invalid_argument const& ex) {
  return true;
}

static bool OutOfRange(std::out_of_range const& ex) {
  return true;
}

BOOST_AUTO_TEST_CASE (test_uint64_check) {
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check("abc"), std::invalid_argument, InvalidArgument);
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check("ABC"), std::invalid_argument, InvalidArgument);
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check(" foo"), std::invalid_argument, InvalidArgument);
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check(""), std::invalid_argument, InvalidArgument);
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check(" "), std::invalid_argument, InvalidArgument);
  BOOST_CHECK_EQUAL(12ULL, StringUtils::uint64_check(" 012"));
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check("1234a"), std::invalid_argument, InvalidArgument);
  BOOST_CHECK_EQUAL(18446744073709551615ULL, StringUtils::uint64_check("-1"));
  BOOST_CHECK_EQUAL(18446744073709539271ULL, StringUtils::uint64_check("-12345"));
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check("1234."), std::invalid_argument, InvalidArgument);
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check("1234.56"), std::invalid_argument, InvalidArgument);
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check("1234567889123456789012345678901234567890"), std::out_of_range, OutOfRange);
  BOOST_CHECK_EXCEPTION(StringUtils::uint64_check("@"), std::invalid_argument, InvalidArgument);

  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64_check("0"));
  BOOST_CHECK_EQUAL(1ULL, StringUtils::uint64_check("1"));
  BOOST_CHECK_EQUAL(12ULL, StringUtils::uint64_check("12"));
  BOOST_CHECK_EQUAL(123ULL, StringUtils::uint64_check("123"));
  BOOST_CHECK_EQUAL(1234ULL, StringUtils::uint64_check("1234"));
  BOOST_CHECK_EQUAL(1234ULL, StringUtils::uint64_check("01234"));
  BOOST_CHECK_EQUAL(9ULL, StringUtils::uint64_check("9"));
  BOOST_CHECK_EQUAL(9ULL, StringUtils::uint64_check(" 9"));
  BOOST_CHECK_EQUAL(9ULL, StringUtils::uint64_check("0009"));
  BOOST_CHECK_EQUAL(12345678ULL, StringUtils::uint64_check("12345678"));
  BOOST_CHECK_EQUAL(1234567800ULL, StringUtils::uint64_check("1234567800"));
  BOOST_CHECK_EQUAL(1234567890123456ULL, StringUtils::uint64_check("1234567890123456"));
  BOOST_CHECK_EQUAL(UINT64_MAX, StringUtils::uint64_check(std::to_string(UINT64_MAX)));
}

////////////////////////////////////////////////////////////////////////////////
/// @brief test_uint64_trusted
////////////////////////////////////////////////////////////////////////////////

BOOST_AUTO_TEST_CASE (test_uint64_trusted) {
  BOOST_CHECK_EQUAL(0ULL, StringUtils::uint64_trusted("0"));
  BOOST_CHECK_EQUAL(1ULL, StringUtils::uint64_trusted("1"));
  BOOST_CHECK_EQUAL(12ULL, StringUtils::uint64_trusted("12"));
  BOOST_CHECK_EQUAL(123ULL, StringUtils::uint64_trusted("123"));
  BOOST_CHECK_EQUAL(1234ULL, StringUtils::uint64_trusted("1234"));
  BOOST_CHECK_EQUAL(1234ULL, StringUtils::uint64_trusted("01234"));
  BOOST_CHECK_EQUAL(9ULL, StringUtils::uint64_trusted("9"));
  BOOST_CHECK_EQUAL(9ULL, StringUtils::uint64_trusted("0009"));
  BOOST_CHECK_EQUAL(12345678ULL, StringUtils::uint64_trusted("12345678"));
  BOOST_CHECK_EQUAL(1234567800ULL, StringUtils::uint64_trusted("1234567800"));
  BOOST_CHECK_EQUAL(1234567890123456ULL, StringUtils::uint64_trusted("1234567890123456"));
  BOOST_CHECK_EQUAL(UINT64_MAX, StringUtils::uint64_trusted(std::to_string(UINT64_MAX)));
}

////////////////////////////////////////////////////////////////////////////////
/// @brief generate tests
////////////////////////////////////////////////////////////////////////////////

BOOST_AUTO_TEST_SUITE_END()

// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
// End: