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

/*
 * tests/atoms/join/JoinLinkUTest.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 JoinLinkUTest: public CxxTest::TestSuite
{
private:
	AtomSpacePtr _as;
	SchemeEval* eval;

public:
	JoinLinkUTest(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 "\")");
	}

	~JoinLinkUTest()
	{
		// 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_basic(void);
	void test_basic_implicit(void);
	void test_replace(void);
	void test_replace_implicit(void);
	void test_shallow(void);
	void test_empty(void);
	void test_const(void);
	void test_const_empty(void);
};

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

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

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

/*
 * Most Basic test
 * wiki page: "Motivating example"
 */
void JoinLinkUTest::test_basic(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

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

	// ---------------------------------------------
	ValuePtr vp = eval->eval_v("(cog-execute! min-join)");
	printf("min-join = %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);
	TS_ASSERT_EQUALS(results[0], N(VARIABLE_NODE, "X"));

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! max-join)");
	printf("max-join = %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 X = N(VARIABLE_NODE, "X");
	Handle E = L(EVALUATION_LINK,
		N(PREDICATE_NODE, "P"), L(LIST_LINK, X));
	Handle M = L(MEMBER_LINK, X, N(CONCEPT_NODE, "S"));

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

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

/*
 * Implicit test
 * wiki page: "PresentLinks are implicit"
 */
void JoinLinkUTest::test_basic_implicit(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

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

	// ---------------------------------------------
	ValuePtr vp = eval->eval_v("(cog-execute! implicit-min-join)");
	printf("min-join = %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);
	TS_ASSERT_EQUALS(results[0], N(VARIABLE_NODE, "X"));

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! implicit-max-join)");
	printf("max-join = %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 X = N(VARIABLE_NODE, "X");
	Handle E = L(EVALUATION_LINK,
		N(PREDICATE_NODE, "P"), L(LIST_LINK, X));
	Handle M = L(MEMBER_LINK, X, N(CONCEPT_NODE, "S"));

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

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

/*
 * Basic Replacement
 * Wiki page: "Replacement"
 */
void JoinLinkUTest::test_replace(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

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

	ValuePtr vp = eval->eval_v("(cog-execute! min-replace)");
	printf("min-replace = %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);
	TS_ASSERT_EQUALS(results[0], N(CONCEPT_NODE, "B"));

	vp = eval->eval_v("(cog-execute! max-replace)");
	printf("max-replace = %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 B = N(CONCEPT_NODE, "B");
	Handle E = L(EVALUATION_LINK,
		N(PREDICATE_NODE, "P"), L(LIST_LINK, B));
	Handle M = L(MEMBER_LINK, B, N(CONCEPT_NODE, "S"));

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

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

/*
 * Implicit Replacement
 * Wiki page: "Replacement"
 * Wiki page: "PresentLinks are implicit"
 */
void JoinLinkUTest::test_replace_implicit(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

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

	ValuePtr vp = eval->eval_v("(cog-execute! implicit-min-replace)");
	printf("min-replace = %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);
	TS_ASSERT_EQUALS(results[0], N(CONCEPT_NODE, "B"));

	vp = eval->eval_v("(cog-execute! implicit-max-replace)");
	printf("max-replace = %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 B = N(CONCEPT_NODE, "B");
	Handle E = L(EVALUATION_LINK,
		N(PREDICATE_NODE, "P"), L(LIST_LINK, B));
	Handle M = L(MEMBER_LINK, B, N(CONCEPT_NODE, "S"));

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

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

/*
 * Shallow searches
 * wiki page: "Shallow types"
 */
void JoinLinkUTest::test_shallow(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

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

	ValuePtr vp = eval->eval_v("(cog-execute! shallow-join)");
	printf("shallow-join = %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(), 2);

	Handle X = N(VARIABLE_NODE, "X");
	Handle E = L(EVALUATION_LINK,
		N(PREDICATE_NODE, "P"), L(LIST_LINK, X));
	Handle M = L(MEMBER_LINK, X, X);

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

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

/*
 * Basic test but on empty atompsace (no data, unsatisfiable)
 * wiki page: "Motivating example"
 */
void JoinLinkUTest::test_empty(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

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

	// ---------------------------------------------
	ValuePtr vp = eval->eval_v("(cog-execute! min-join)");
	printf("min-join = %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);
	TS_ASSERT_EQUALS(results[0], N(VARIABLE_NODE, "X"));

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! max-join)");
	printf("max-join = %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);
	TS_ASSERT_EQUALS(results[0], N(VARIABLE_NODE, "X"));

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! min-replace)");
	printf("min-replace = %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);
	TS_ASSERT_EQUALS(results[0], N(CONCEPT_NODE, "B"));

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! max-replace)");
	printf("max-replace = %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);
	TS_ASSERT_EQUALS(results[0], N(CONCEPT_NODE, "B"));

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

/*
 * Constant test
 * wiki page: "Motivating example"
 */
void JoinLinkUTest::test_const(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

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

	// ---------------------------------------------
	ValuePtr vp = eval->eval_v("(cog-execute! min-const)");
	printf("min-const = %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 A = N(CONCEPT_NODE, "A");
	TS_ASSERT_EQUALS(results[0], A);

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! max-const)");
	printf("max-const = %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 E = L(EVALUATION_LINK,
		N(PREDICATE_NODE, "P"), L(LIST_LINK, A));
	Handle M = L(MEMBER_LINK, A, N(CONCEPT_NODE, "S"));

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

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! min-const-replace)");
	printf("min-const-replace = %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 B = N(CONCEPT_NODE, "B");
	TS_ASSERT_EQUALS(results[0], B);

	vp = eval->eval_v("(cog-execute! max-const-replace)");
	printf("max-const-replace = %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);

	E = L(EVALUATION_LINK,
		N(PREDICATE_NODE, "P"), L(LIST_LINK, B));
	M = L(MEMBER_LINK, B, N(CONCEPT_NODE, "S"));

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

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

/*
 * Const test, but on empty atompsace (no data, unsatisfiable)
 * wiki page: "Motivating example"
 */
void JoinLinkUTest::test_const_empty(void)
{
	logger().info("BEGIN TEST: %s", __FUNCTION__);

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

	// ---------------------------------------------
	ValuePtr vp = eval->eval_v("(cog-execute! min-const)");
	printf("min-const = %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 A = N(CONCEPT_NODE, "A");
	TS_ASSERT_EQUALS(results[0], A);

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! max-const)");
	printf("max-const = %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);
	TS_ASSERT_EQUALS(results[0], A);

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! min-const-replace)");
	printf("min-const-replace = %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);
	TS_ASSERT_EQUALS(results[0], N(CONCEPT_NODE, "B"));

	// ---------------------------------------------
	vp = eval->eval_v("(cog-execute! max-const-replace)");
	printf("max-const-replace = %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);
	TS_ASSERT_EQUALS(results[0], N(CONCEPT_NODE, "B"));

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