QueryBindingSetTest.java

/*******************************************************************************
 * Copyright (c) 2015 Eclipse RDF4J contributors, Aduna, and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Distribution License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *******************************************************************************/
package org.eclipse.rdf4j.query.algebra.evaluation;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.Set;

import org.eclipse.rdf4j.model.ValueFactory;
import org.eclipse.rdf4j.model.impl.SimpleValueFactory;
import org.eclipse.rdf4j.model.vocabulary.RDF;
import org.eclipse.rdf4j.query.Binding;
import org.eclipse.rdf4j.query.BindingSet;
import org.eclipse.rdf4j.query.impl.MapBindingSet;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class QueryBindingSetTest {

	private final MapBindingSet mbs = new MapBindingSet();
	private final QueryBindingSet qbs = new QueryBindingSet();

	private final ValueFactory vf = SimpleValueFactory.getInstance();

	@BeforeEach
	public void setup() {
		qbs.addBinding("foo", vf.createIRI("urn:foo"));
		mbs.addBinding("foo", vf.createIRI("urn:foo"));
	}

	@Test
	public void testEqualsMapBindingSet() {

		QueryBindingSet bs = new QueryBindingSet();
		assertFalse(bs.equals(qbs));
		assertFalse(bs.equals(mbs));

		bs.addBinding("foo", vf.createIRI("urn:foo"));

		assertEquals(bs, qbs);
		assertEquals(bs, mbs);
		assertEquals(qbs, mbs);
	}

	@Test
	public void testAddAll() {
		{
			QueryBindingSet bs = new QueryBindingSet();
			bs.addAll(new QueryBindingSet());
			assertEquals(0, bs.size());
		}
		{
			QueryBindingSet bs = new QueryBindingSet();
			bs.addBinding("foo", vf.createIRI("urn:foo"));
			bs.addAll(new QueryBindingSet());
			assertEquals(1, bs.size());
		}
		{
			QueryBindingSet bs = new QueryBindingSet();
			bs.addBinding("foo", vf.createIRI("urn:foo"));
			final QueryBindingSet bs2 = new QueryBindingSet();
			bs2.addBinding("foo", vf.createIRI("urn:foo"));
			bs.addAll(bs2);
			assertEquals(1, bs.size());
		}
		{
			QueryBindingSet bs = new QueryBindingSet();
			bs.addBinding("foo", vf.createIRI("urn:foo"));
			final QueryBindingSet bs2 = new QueryBindingSet();
			bs2.addBinding("foo", vf.createIRI("urn:foo"));
			bs2.addBinding("bar", vf.createIRI("urn:bar"));
			bs.addAll(bs2);
			assertEquals(2, bs.size());
		}
	}

	@Test
	public void testAdd() {
		try {
			QueryBindingSet bs = new QueryBindingSet();
			bs.addBinding("foo", vf.createIRI("urn:foo"));
			bs.addBinding("foo", vf.createIRI("urn:foo"));
			fail();
		} catch (AssertionError e) {
			// The current implementation sets an assertion.
			// however the behavior that is expected is that
			// after adding an existing binding only the last
			// set one is returned.
			return;
		}
	}

	@Test
	public void testNonSharedBackingMap() {
		QueryBindingSet bs = new QueryBindingSet();
		bs.addBinding("foo", vf.createIRI("urn:foo"));
		bs.addBinding("bar", vf.createIRI("urn:bar"));
		QueryBindingSet bs2 = new QueryBindingSet(bs);
		bs2.addBinding("boo", vf.createIRI("urn:boo"));
		assertNotEquals(bs.size(), bs2.size());
		assertFalse(bs.hasBinding("boo"));
	}

	@Test
	public void testSet() {
		QueryBindingSet bs = new QueryBindingSet();
		bs.setBinding("foo", vf.createIRI("urn:foo"));
		bs.setBinding("foo", vf.createIRI("urn:foo2"));
		assertEquals(1, bs.size());
		assertEquals(vf.createIRI("urn:foo2"), bs.getBinding("foo").getValue());
	}

	@Test
	public void testRemove() {
		QueryBindingSet bs = new QueryBindingSet();
		bs.setBinding("foo", vf.createIRI("urn:foo"));
		bs.removeBinding("foo");
		assertEquals(0, bs.size());
		bs = new QueryBindingSet();
		bs.setBinding("foo", vf.createIRI("urn:foo"));
		bs.removeBinding("bar");
		assertEquals(1, bs.size());
	}

	@Test
	public void retainAll() {
		QueryBindingSet bs = new QueryBindingSet();
		bs.setBinding("foo", vf.createIRI("urn:foo"));
		final Collection<String> asList = Arrays.asList("foo", "test");
		bs.retainAll(asList);
		assertEquals(1, bs.size());
	}

	@Test
	public void testBindingNames() {
		QueryBindingSet bs = new QueryBindingSet();
		for (int i = 0; i < 128; i++) {
			final String name = String.valueOf(i);
			bs.addBinding(name, RDF.ALT);
		}
		final Set<String> bN = bs.getBindingNames();
		for (int i = 0; i < 128; i++) {
			final String name = String.valueOf(i);
			assertTrue(bN.contains(name));
		}
		assertEquals(128, bs.size());
	}

	@Test
	public void testBindings() {
		QueryBindingSet bs = new QueryBindingSet();
		for (int i = 0; i < 128; i++) {
			final String name = String.valueOf(i);
			bs.addBinding(name, RDF.ALT);
		}
		Iterator<Binding> iter = bs.iterator();
		for (int i = 0; i < 128; i++) {
			assertTrue(iter.hasNext());
			assertEquals(RDF.ALT, iter.next().getValue());
		}
		assertFalse(iter.hasNext());
	}

	@Test
	public void testGetValue() {
		QueryBindingSet bs = new QueryBindingSet();
		for (int i = 0; i < 128; i++) {
			final String name = String.valueOf(i);
			bs.addBinding(name, RDF.ALT);
		}
		for (int i = 0; i < 128; i++) {
			final String name = String.valueOf(i);
			assertEquals(RDF.ALT, bs.getValue(name));
		}
		assertEquals(128, bs.size());
	}

	@Test
	public void testHashcodeMapBindingSet() {
		assertTrue(qbs.equals(mbs));
		assertTrue(mbs.equals(qbs));
		assertEquals(qbs.hashCode(), mbs.hashCode(),
				"objects that return true on their equals() method must have identical hash codes");
	}

	/**
	 * Verifies that the BindingSet implementation honors the API spec for {@link BindingSet#equals(Object)} and
	 * {@link BindingSet#hashCode()}.
	 */
	@Test
	public void testEqualsHashcode() {
		QueryBindingSet bs1 = new QueryBindingSet();
		QueryBindingSet bs2 = new QueryBindingSet();

		bs1.addBinding("x", RDF.ALT);
		bs1.addBinding("y", RDF.BAG);
		bs1.addBinding("z", RDF.FIRST);

		bs2.addBinding("y", RDF.BAG);
		bs2.addBinding("x", RDF.ALT);
		bs2.addBinding("z", RDF.FIRST);
		assertEquals(bs1.hashCode(), bs2.hashCode());
		assertEquals(bs1, bs2);
	}

	@Test
	public void testBigEqualsHashcode() {
		QueryBindingSet bs1 = new QueryBindingSet();
		QueryBindingSet bs2 = new QueryBindingSet();
		for (int i = 0; i < 128; i++) {
			bs1.addBinding(String.valueOf(i), RDF.ALT);
			bs2.addBinding(String.valueOf(i), RDF.ALT);
		}
		assertEquals(bs1.hashCode(), bs2.hashCode());
		assertEquals(bs1, bs2);
	}

}