TestPython.cpp

// Copyright (c) 2013-2020 Josh Blum
//                    2019 Nicholas Corgan
// SPDX-License-Identifier: BSL-1.0

#include <Pothos/Testing.hpp>
#include <Pothos/Proxy.hpp>
#include <Pothos/Framework/BufferChunk.hpp>
#include <Poco/File.h>
#include <Poco/Logger.h>
#include <Poco/SimpleFileChannel.h>
#include <Poco/TemporaryFile.h>
#include <iostream>
#include <complex>
#include <cstdlib>
#include <fstream>
#include <sstream>
#include <complex>
#include <limits>

POTHOS_TEST_BLOCK("/proxy/python/tests", test_basic_types)
{
    auto env = Pothos::ProxyEnvironment::make("python");

    auto noneProxy = env->convertObjectToProxy(Pothos::Object());
    auto nullObject = env->convertProxyToObject(noneProxy);
    POTHOS_TEST_TRUE(not nullObject);

    POTHOS_TEST_EQUAL(env->makeProxy(true).convert<bool>(), true);
    POTHOS_TEST_EQUAL(env->makeProxy(false).convert<bool>(), false);

    const auto intVal = int(std::rand()-RAND_MAX/2);
    POTHOS_TEST_EQUAL(env->makeProxy(intVal).convert<int>(), intVal);

    const auto longVal = (long long)(std::rand()-RAND_MAX/2);
    POTHOS_TEST_EQUAL(env->makeProxy(longVal).convert<long long>(), longVal);

    const auto ulongVal = (unsigned long long)((uint64_t(1) << 63) + std::rand());
    POTHOS_TEST_EQUAL(env->makeProxy(ulongVal).convert<unsigned long long>(), ulongVal);

    const auto floatVal = double(std::rand()-RAND_MAX/2);
    POTHOS_TEST_EQUAL(env->makeProxy(floatVal).convert<double>(), floatVal);

    const std::complex<double> complexVal(1.0*(std::rand()-RAND_MAX/2), 1.0*(std::rand()-RAND_MAX/2));
    POTHOS_TEST_EQUAL(env->makeProxy(complexVal).convert<std::complex<double>>(), complexVal);

    const std::string strVal = "Hello World!";
    POTHOS_TEST_EQUAL(env->makeProxy(strVal).convert<std::string>(), strVal);
}

template <typename T>
static void testTypeBounds(Pothos::ProxyEnvironment::Sptr env)
{
    POTHOS_TEST_EQUAL(
        std::numeric_limits<T>::min(),
        env->makeProxy(std::numeric_limits<T>::min()).template convert<T>());
    POTHOS_TEST_EQUAL(
        std::numeric_limits<T>::max(),
        env->makeProxy(std::numeric_limits<T>::max()).template convert<T>());
}

POTHOS_TEST_BLOCK("/proxy/python/tests", test_type_bounds)
{
    auto env = Pothos::ProxyEnvironment::make("python");

    std::cout << "Testing std::int8_t" << std::endl;
    testTypeBounds<std::int8_t>(env);
    std::cout << "Testing std::int16_t" << std::endl;
    testTypeBounds<std::int16_t>(env);
    std::cout << "Testing std::int32_t" << std::endl;
    testTypeBounds<std::int32_t>(env);
    std::cout << "Testing std::int64_t" << std::endl;
    testTypeBounds<std::int64_t>(env);

    std::cout << "Testing std::uint8_t" << std::endl;
    testTypeBounds<std::uint8_t>(env);
    std::cout << "Testing std::uint16_t" << std::endl;
    testTypeBounds<std::uint16_t>(env);
    std::cout << "Testing std::uint32_t" << std::endl;
    testTypeBounds<std::uint32_t>(env);
    std::cout << "Testing std::uint64_t" << std::endl;
    testTypeBounds<std::uint64_t>(env);

    std::cout << "Testing float" << std::endl;
    testTypeBounds<float>(env);
    std::cout << "Testing double" << std::endl;
    testTypeBounds<double>(env);
}

POTHOS_TEST_BLOCK("/proxy/python/tests", test_compare_to)
{
    auto env = Pothos::ProxyEnvironment::make("python");

    auto int0 = env->makeProxy(0);
    auto int1 = env->makeProxy(1);
    auto int2 = env->makeProxy(2);

    //test compare less, greater...
    POTHOS_TEST_TRUE(int0 < int1);
    POTHOS_TEST_TRUE(int0 < int2);
    POTHOS_TEST_TRUE(int1 < int2);
    POTHOS_TEST_TRUE(int0 < int2);

    POTHOS_TEST_TRUE(int1 > int0);
    POTHOS_TEST_TRUE(int2 > int0);
    POTHOS_TEST_TRUE(int2 > int1);
    POTHOS_TEST_TRUE(int2 > int0);

    //test equality with same value, different proxy
    auto int2Again = env->makeProxy(2);
    POTHOS_TEST_EQUAL(int2.compareTo(int2), 0);
    POTHOS_TEST_EQUAL(int2.compareTo(int2Again), 0);
}

POTHOS_TEST_BLOCK("/proxy/python/tests", test_containers)
{
    auto env = Pothos::ProxyEnvironment::make("python");

    //make test vector
    Pothos::ProxyVector testVec;
    testVec.push_back(env->makeProxy("mytest"));
    testVec.push_back(env->makeProxy(42));
    testVec.push_back(env->makeProxy(std::complex<double>(1, 2)));

    //convert to proxy and back
    auto proxyVec = env->makeProxy(testVec);
    auto resultVec = proxyVec.convert<Pothos::ProxyVector>();

    //check for equality
    POTHOS_TEST_EQUAL(testVec.size(), resultVec.size());
    POTHOS_TEST_EQUAL(testVec[0].convert<std::string>(), resultVec[0].convert<std::string>());
    POTHOS_TEST_EQUAL(testVec[1].convert<int>(), resultVec[1].convert<int>());
    POTHOS_TEST_EQUAL(testVec[2].convert<std::complex<double>>(), resultVec[2].convert<std::complex<double>>());

    //make test set
    Pothos::ProxySet testSet;
    testSet.insert(env->makeProxy("hi"));
    testSet.insert(env->makeProxy(1));

    //convert to proxy and back
    auto proxySet = env->makeProxy(testSet);
    auto resultSet = proxySet.convert<Pothos::ProxySet>();

    //check result
    auto findHiSet = resultSet.find(env->makeProxy("hi"));
    POTHOS_TEST_TRUE(findHiSet != resultSet.end());
    auto find1Set = resultSet.find(env->makeProxy(1));
    POTHOS_TEST_TRUE(find1Set != resultSet.end());

    //make test dictionary
    Pothos::ProxyMap testDict;
    testDict[env->makeProxy("hi")] = env->makeProxy("bye");
    testDict[env->makeProxy(1)] = env->makeProxy(2);

    //convert to proxy and back
    auto proxyDict = env->makeProxy(testDict);
    auto resultDict = proxyDict.convert<Pothos::ProxyMap>();

    //check result
    auto findHi = resultDict.find(env->makeProxy("hi"));
    POTHOS_TEST_TRUE(findHi != resultDict.end());
    POTHOS_TEST_EQUAL(findHi->second.convert<std::string>(), "bye");
    auto find1 = resultDict.find(env->makeProxy(1));
    POTHOS_TEST_TRUE(find1 != resultDict.end());
    POTHOS_TEST_EQUAL(find1->second.convert<int>(), 2);
}

POTHOS_TEST_BLOCK("/proxy/python/tests", test_call_module)
{
    auto env = Pothos::ProxyEnvironment::make("python");

    auto re = env->findProxy("re");
    auto m = re.call("search", "(?<=abc)def", "abcdef");
    std::string group = m.call("group", 0);
    POTHOS_TEST_EQUAL(group, "def");

    Pothos::ProxyMap myDict;
    myDict[env->makeProxy("hi")] = env->makeProxy("bye");
    myDict[env->makeProxy(1)] = env->makeProxy(2);

    auto datetime = env->findProxy("datetime");
    auto datetimeClass = datetime.get("datetime");
    auto datetime2000 = datetimeClass(2000, 1, 1);
    POTHOS_TEST_EQUAL(datetime2000.get<int>("year"), 2000);
}

POTHOS_TEST_BLOCK("/proxy/python/tests", test_serialization)
{
    auto env = Pothos::ProxyEnvironment::make("python");

    //make test dictionary
    Pothos::ProxyMap testDict;
    testDict[env->makeProxy("hi")] = env->makeProxy("bye");
    testDict[env->makeProxy(1)] = env->makeProxy(2);
    auto proxyDict = env->makeProxy(testDict);

    //serialize
    Pothos::Object serializeMe(proxyDict);
    std::stringstream ss;
    serializeMe.serialize(ss);
    std::cout << ss.str() << std::endl;

    //deserialize
    Pothos::Object deserializeMe;
    deserializeMe.deserialize(ss);
    POTHOS_TEST_TRUE(deserializeMe);
    auto resultDict = proxyDict.convert<Pothos::ProxyMap>();

    //check result
    auto findHi = resultDict.find(env->makeProxy("hi"));
    POTHOS_TEST_TRUE(findHi != resultDict.end());
    POTHOS_TEST_EQUAL(findHi->second.convert<std::string>(), "bye");
    auto find1 = resultDict.find(env->makeProxy(1));
    POTHOS_TEST_TRUE(find1 != resultDict.end());
    POTHOS_TEST_EQUAL(find1->second.convert<int>(), 2);
}

POTHOS_TEST_BLOCK("/proxy/python/tests", test_numpy_array)
{
    auto env = Pothos::ProxyEnvironment::make("python");

    Pothos::BufferChunk buffIn(typeid(float), 100);
    for (size_t i = 0; i < buffIn.elements(); i++)
        buffIn.as<float *>()[i] = float(std::rand());

    //convert into a python format with numpy
    auto pyBuff = env->makeProxy(buffIn);
    POTHOS_TEST_EQUAL(pyBuff.getClassName(), "numpy.ndarray");

    //convert back and check for equality
    const auto buffOut = pyBuff.convert<Pothos::BufferChunk>();
    POTHOS_TEST_EQUAL(buffIn.elements(), buffOut.elements());
    POTHOS_TEST_EQUAL(buffIn.dtype, buffOut.dtype);
    POTHOS_TEST_EQUALA(buffIn.as<const float *>(), buffOut.as<const float *>(), buffOut.elements());
}

POTHOS_TEST_BLOCK("/proxy/python/tests", test_numpy_types)
{
    auto env = Pothos::ProxyEnvironment::make("python");
    auto numpy = env->findProxy("numpy");

    POTHOS_TEST_EQUAL(numpy.call("int8", 100).convert<char>(), 100);
    POTHOS_TEST_EQUAL(numpy.call("int16", 123).convert<short>(), 123);
    POTHOS_TEST_EQUAL(numpy.call("int32", 123).convert<int>(), 123);
    POTHOS_TEST_EQUAL(numpy.call("int64", 123456789).convert<long>(), 123456789);
    POTHOS_TEST_EQUAL(numpy.call("int64", 123456789).convert<long long>(), 123456789);
    POTHOS_TEST_EQUAL(numpy.call("uint8", 100).convert<unsigned char>(), 100);
    POTHOS_TEST_EQUAL(numpy.call("uint16", 123).convert<unsigned short>(), 123);
    POTHOS_TEST_EQUAL(numpy.call("uint32", 123).convert<unsigned int>(), 123);
    POTHOS_TEST_EQUAL(numpy.call("uint64", 123456789).convert<unsigned long>(), 123456789);
    POTHOS_TEST_EQUAL(numpy.call("uint64", 123456789).convert<unsigned long long>(), 123456789);
    POTHOS_TEST_EQUAL(numpy.call("float32", 42.0f).convert<float>(), 42.0f);
    POTHOS_TEST_EQUAL(numpy.call("float64", 42.0).convert<double>(), 42.0);
    POTHOS_TEST_EQUAL(numpy.call("complex64", std::complex<float>(1.0f, -2.0f)).convert<std::complex<float>>(), std::complex<float>(1.0f, -2.0f));
    POTHOS_TEST_EQUAL(numpy.call("complex128", std::complex<double>(1.0, -2.0)).convert<std::complex<double>>(), std::complex<double>(1.0, -2.0));
}

POTHOS_TEST_BLOCK("/proxy/python/tests", test_logging_python_warnings)
{
    auto env = Pothos::ProxyEnvironment::make("python");

    const std::string logPath = Poco::TemporaryFile::tempName();
    POTHOS_TEST_TRUE(!Poco::File(logPath).exists());
    Poco::TemporaryFile::registerForDeletion(logPath);

    // Add a channel to the relevant Poco logger to write the output
    // to file. This will allow us to make sure output is written as
    // expected.
    auto& pyWarningsLogger = Poco::Logger::get("py.warnings");
    pyWarningsLogger.setChannel(new Poco::SimpleFileChannel(logPath));

    const std::string warningTypeName = "UserWarning";
    const std::string warningMessage = "This is a warning message.";
    env->findProxy("Pothos.TestPothos").call("CallWarning", warningMessage);
    POTHOS_TEST_TRUE(Poco::File(logPath).exists());

    // Get the contents of the log file.
    std::string fileContents;
    const auto fileSize = Poco::File(logPath).getSize();
    fileContents.resize(fileSize);

    std::fstream ifile(logPath.c_str(), std::ios::in);
    ifile.read(const_cast<char*>(fileContents.c_str()), fileSize);
    ifile.close();

    const std::vector<std::string> expectedStrings =
    {
        "TestPothos.py",
        ("UserWarning: " + warningMessage),
        "warnings.warn(msg, UserWarning, stacklevel=1)"
    };
    for(const auto& expectedString: expectedStrings)
    {
        POTHOS_TEST_TRUE(std::string::npos != fileContents.find(expectedString));
    }
}