opencog-atomspace / tests / atoms / join / GPNJoinUTest.cxxtest

/*
 * tests/atoms/join/GPNJoinUTest.cxxtest
 *
 * Copyright (C) 2020 Linas Vepstas
 * All Rights Reserved
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License v3 as
 * published by the Free Software Foundation and including the exceptions
 * at http://opencog.org/wiki/Licenses
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to:
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <opencog/atoms/value/LinkValue.h>
#include <opencog/atomspace/AtomSpace.h>
#include <opencog/guile/SchemeEval.h>
#include <opencog/util/Logger.h>

using namespace opencog;

class GPNJoinUTest: public CxxTest::TestSuite
{
private:
	AtomSpacePtr _as;
	SchemeEval* eval;

public:
	GPNJoinUTest(void)
	{
		logger().set_level(Logger::INFO);
		logger().set_print_to_stdout_flag(true);
		logger().set_timestamp_flag(false);
		logger().set_sync_flag(true);

		_as = createAtomSpace();
		eval = SchemeEval::get_scheme_evaluator(_as);
		eval->eval("(add-to-load-path \"" PROJECT_SOURCE_DIR "\")");
	}

	~GPNJoinUTest()
	{
		// Erase the log file if no assertions failed.
		if (!CxxTest::TestTracker::tracker().suiteFailed())
			std::remove(logger().get_filename().c_str());
	}

	void setUp(void);
	void tearDown(void);

	// Test the examples on the wiki page
	// https://wiki.opencog.org/w/JoinLink
	void test_gpn(void);
	void test_top(void);
};

void GPNJoinUTest::tearDown(void)
{
	_as->clear();
}

void GPNJoinUTest::setUp(void)
{
	_as->clear();
}

#define N _as->add_node
#define L _as->add_link

/*
 * Wiki page "User callbacks via GPN's"
 */
void GPNJoinUTest::test_gpn(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

	eval->eval("(load-from-path \"tests/atoms/join/gpn-join.scm\")");

	// ----------------------------------
	ValuePtr vp = eval->eval_v("(cog-execute! min-gpn)");
	printf("min-gpn = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	HandleSeq results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 1);

	Handle P = N(VARIABLE_NODE, "P");
	TS_ASSERT_EQUALS(results[0], P);

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! max-gpn)");
	printf("max-gpn = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 2);

	Handle A = L(EVALUATION_LINK, P, L(LIST_LINK, N(CONCEPT_NODE, "A")));
	Handle E = L(EVALUATION_LINK, P, L(LIST_LINK, N(CONCEPT_NODE, "E")));

	if (results[0] == A)
	{
		TS_ASSERT_EQUALS(results[0], A);
		TS_ASSERT_EQUALS(results[1], E);
	}
	else
	{
		TS_ASSERT_EQUALS(results[1], A);
		TS_ASSERT_EQUALS(results[0], E);
	}

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! min-gpn-rep)");
	printf("min-gpn-rep = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 1);

	Handle ILP = N(CONCEPT_NODE, "I Like Pie!");
	TS_ASSERT_EQUALS(results[0], ILP);

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! max-gpn-rep)");
	printf("max-gpn-rep = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 2);

	A = L(EVALUATION_LINK, ILP, L(LIST_LINK, N(CONCEPT_NODE, "A")));
	E = L(EVALUATION_LINK, ILP, L(LIST_LINK, N(CONCEPT_NODE, "E")));

	if (results[0] == A)
	{
		TS_ASSERT_EQUALS(results[0], A);
		TS_ASSERT_EQUALS(results[1], E);
	}
	else
	{
		TS_ASSERT_EQUALS(results[1], A);
		TS_ASSERT_EQUALS(results[0], E);
	}

	// ------------
	logger().info("END TEST: %s", __FUNCTION__);
}

/*
 * Wiki page "Naming the container"
 */
void GPNJoinUTest::test_top(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

	eval->eval("(load-from-path \"tests/atoms/join/gpn-container.scm\")");

	// ----------------------------------
	ValuePtr vp = eval->eval_v("(cog-execute! min-gpn)");
	printf("min-gpn = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	HandleSeq results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 1);

	Handle P = N(VARIABLE_NODE, "P");
	TS_ASSERT_EQUALS(results[0], P);

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! max-gpn)");
	printf("max-gpn = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 2);

	Handle A = L(EVALUATION_LINK, P, L(LIST_LINK, N(CONCEPT_NODE, "A")));
	Handle E = L(EVALUATION_LINK, P, L(LIST_LINK, N(CONCEPT_NODE, "E")));

	if (results[0] == A)
	{
		TS_ASSERT_EQUALS(results[0], A);
		TS_ASSERT_EQUALS(results[1], E);
	}
	else
	{
		TS_ASSERT_EQUALS(results[1], A);
		TS_ASSERT_EQUALS(results[0], E);
	}

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! both-gpn)");
	printf("both-gpn = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 2);

	if (results[0] == A)
	{
		TS_ASSERT_EQUALS(results[0], A);
		TS_ASSERT_EQUALS(results[1], E);
	}
	else
	{
		TS_ASSERT_EQUALS(results[1], A);
		TS_ASSERT_EQUALS(results[0], E);
	}

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! triple-gpn)");
	printf("triple-gpn = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 1);

	Handle RA = L(EVALUATION_LINK, P, L(LIST_LINK, N(VARIABLE_NODE, "A")));
	TS_ASSERT_EQUALS(results[0], RA);

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! min-gpn-rep)");
	printf("min-gpn-rep = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 1);

	Handle ILP = N(CONCEPT_NODE, "I Like Pie!");
	TS_ASSERT_EQUALS(results[0], ILP);

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! max-gpn-rep)");
	printf("max-gpn-rep = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 2);

	A = L(EVALUATION_LINK, ILP, L(LIST_LINK, N(CONCEPT_NODE, "A")));
	E = L(EVALUATION_LINK, ILP, L(LIST_LINK, N(CONCEPT_NODE, "E")));

	if (results[0] == A)
	{
		TS_ASSERT_EQUALS(results[0], A);
		TS_ASSERT_EQUALS(results[1], E);
	}
	else
	{
		TS_ASSERT_EQUALS(results[1], A);
		TS_ASSERT_EQUALS(results[0], E);
	}

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! both-gpn-rep)");
	printf("both-gpn-rep = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 2);

	if (results[0] == A)
	{
		TS_ASSERT_EQUALS(results[0], A);
		TS_ASSERT_EQUALS(results[1], E);
	}
	else
	{
		TS_ASSERT_EQUALS(results[1], A);
		TS_ASSERT_EQUALS(results[0], E);
	}

	// ----------------------------------
	vp = eval->eval_v("(cog-execute! triple-gpn-rep)");
	printf("triple-gpn-rep = %s\n", vp->to_string().c_str());
	TS_ASSERT(nameserver().isA(vp->get_type(), LINK_VALUE));
	results = LinkValueCast(vp)->to_handle_seq();
	TS_ASSERT_EQUALS(results.size(), 1);

	Handle LA = L(EVALUATION_LINK, ILP, L(LIST_LINK, N(CONCEPT_NODE, "Loser")));
	TS_ASSERT_EQUALS(results[0], LA);

	// ------------
	logger().info("END TEST: %s", __FUNCTION__);
}