BaseOpenmrsObjectTest

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs;

import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.junit.jupiter.api.Test;
import org.junit.platform.runner.JUnitPlatform;
import org.junit.runner.RunWith;
import org.openmrs.test.BaseContextSensitiveTest;

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

@RunWith(JUnitPlatform.class)
public class BaseOpenmrsObjectTest extends BaseContextSensitiveTest {

	private static class BaseOpenmrsObjectMock extends BaseOpenmrsObject {

		@Override
		public Integer getId() {
			return null;
		}

		@Override
		public void setId(Integer id) {
		}

	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnFalseIfGivenObjHasNullUuid() {
		//given
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();
		BaseOpenmrsObject obj = new BaseOpenmrsObjectMock();

		//when
		obj.setUuid(null);

		//then
		assertFalse(o.equals(obj));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnFalseIfGivenObjIsNotInstanceOfBaseOpenmrsObject() {
		//given
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();

		//when
		Object obj = new Object();

		//then
		assertFalse(o.equals(obj));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnFalseIfGivenObjIsNull() {
		//given
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();

		//when
		BaseOpenmrsObject obj = null;

		//then
		assertFalse(o.equals(obj));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnFalseIfUuidIsNull() {
		//given
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();
		BaseOpenmrsObject obj = new BaseOpenmrsObjectMock();

		//when
		o.setUuid(null);

		//then
		assertFalse(o.equals(obj));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnTrueIfObjectsAreTheSame() {
		//given
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();

		//when
		BaseOpenmrsObject obj = o;

		//then
		assertTrue(o.equals(obj));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnTrueIfUuidsAreEqual() {
		//given
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();
		BaseOpenmrsObject obj = new BaseOpenmrsObjectMock();

		//when
		obj.setUuid(o.getUuid());

		//then
		assertTrue(o.equals(obj));
	}

	/**
	 * @see BaseOpenmrsObject#hashCode()
	 */
	@Test
	public void hashCode_shouldNotFailIfUuidIsNull() {
		//given
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();

		//when
		o.setUuid(null);

		//then
		o.hashCode();
	}

	@Test
	public void shouldNotBeEqualWhenDifferentClassesAndSameId() {
		Encounter encounter = new Encounter(2);
		Order order = new Order(2);

		assertFalse(encounter.equals(order));
	}

	@Test
	public void shouldNotBeEqualWhenFirstIsNull() {
		Encounter encounter = new Encounter(2);
		assertFalse(encounter.equals(null));
	}

	/**
	 * @see BaseOpenmrsObject#toString()
	 */
	@Test
	public void toString_shouldIncludeUuidIfNotNull() {
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();

		assertEquals("BaseOpenmrsObjectTest.BaseOpenmrsObjectMock[hashCode=" + Integer.toHexString(o.hashCode()) + ",uuid="
		        + o.getUuid() + "]", o.toString());
	}

	/**
	 * @see BaseOpenmrsObject#toString()
	 */
	@Test
	public void toString_shouldIncludeHashCodeIfUuidIsNull() {
		//given
		BaseOpenmrsObject o = new BaseOpenmrsObjectMock();
		o.setUuid(null);

		//when
		//then
		assertEquals("BaseOpenmrsObjectTest.BaseOpenmrsObjectMock[hashCode=" + Integer.toHexString(o.hashCode())
		        + ",uuid=<null>]", o.toString());
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnTrueIfGivenObjectIsInstanceOfSuperOrExtendingClass() {
		Concept concept = new Concept(5);
		Concept numeric = new ConceptNumeric();
		numeric.setUuid(concept.getUuid());
		assertTrue(numeric.equals(concept));
		assertTrue(concept.equals(numeric));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnFalseIfGivenObjIsNotInstanceOfSuperOrExtendingClass() {
		Encounter encounter = new Encounter();
		Concept concept = new Concept(5);
		concept.setUuid(encounter.getUuid());
		assertFalse(encounter.equals(concept));
		assertFalse(concept.equals(encounter));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnTrueIfGivenObjectIsSubclassOfSuperOrExtendingClass() {
		Order order = new Order(21);
		DrugOrder type = new DrugOrder(21);
		type.setUuid(order.getUuid());
		assertTrue(type.equals(order));
		assertTrue(order.equals(type));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnFalseIfGivenObjectIsNotSubclassOfSuperOrExtendingClass() {
		Order order = new Order(21);
		OrderFrequency type = new OrderFrequency();
		type.setUuid(order.getUuid());
		assertFalse(type.equals(order));
		assertFalse(order.equals(type));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnfalseIfHibernateProxyOfOneThingIsComparedtoHibernateProxyofSomething() {
		SessionFactory sessionFactory = (SessionFactory) applicationContext.getBean("sessionFactory");
		Session session = sessionFactory.getCurrentSession();
		assertFalse((session.load(Patient.class, 2)).equals((session.load(Concept.class, 11))));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnFalseIfHibernateProxyOfOneThingIsComparedtoNonHibernateProxyofSomething() {
		SessionFactory sessionFactory = (SessionFactory) applicationContext.getBean("sessionFactory");
		Session session = sessionFactory.getCurrentSession();

		//NonHibernate managed class declaration
		class TestClass extends BaseOpenmrsObject {
			private Integer id;
			TestClass() {
			}
			@Override
			public Integer getId() {
				return id;
			}
			@Override
			public void setId(Integer id) {
				this.id = id;
			}
			@Override
			public int hashCode() {
				if (getUuid() == null) {
					return super.hashCode();
				}
				return getUuid().hashCode();
			}
			@Override
			public boolean equals(Object obj) {
				if (this == obj) {
					return true;
				}
				if (!(obj instanceof TestClass)) {
					return false;
				}
				TestClass other = (TestClass) obj;
				if (getUuid() == null) {
					return false;
				}
				return getUuid().equals(other.getUuid());
			}
			@Override
			public String toString() {
				return new org.apache.commons.lang3.builder.ToStringBuilder(this, org.apache.commons.lang3.builder.ToStringStyle.SHORT_PREFIX_STYLE).append("hashCode",
						Integer.toHexString(hashCode())).append("uuid", getUuid()).build();
			}
		}

		Patient patient = (Patient) session.get(Patient.class, 2);
		String uid = patient.getUuid();

		//NonHibernate managed class Instantiation
		TestClass obj = new TestClass();
		obj.setUuid(uid);

		assertFalse(obj.equals((session.load(Patient.class, 2))));
		assertFalse((session.load(Patient.class, 2)).equals(obj));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldWorkOnNonHibernateManagedClasses() {
		//NonHibernate managed class
		class TestClass extends BaseOpenmrsObject {
			private Integer id;
			TestClass() {
			}
			@Override
			public Integer getId() {
				return id;
			}
			@Override
			public void setId(Integer id) {
				this.id = id;
			}
			@Override
			public int hashCode() {
				if (getUuid() == null) {
					return super.hashCode();
				}
				return getUuid().hashCode();
			}
			@Override
			public boolean equals(Object obj) {
				if (this == obj) {
					return true;
				}
				if (!(obj instanceof TestClass)) {
					return false;
				}
				TestClass other = (TestClass) obj;
				if (getUuid() == null) {
					return false;
				}
				else {
					return getUuid().equals(other.getUuid());
				}
			}
			@Override
			public String toString() {
				return new org.apache.commons.lang3.builder.ToStringBuilder(this, org.apache.commons.lang3.builder.ToStringStyle.SHORT_PREFIX_STYLE).append("hashCode",
						Integer.toHexString(hashCode())).append("uuid", getUuid()).build();
			}
		}

		//Another NonHibernate managed class
		class AnotherTestClass extends BaseOpenmrsObject {
			private int id;
			@Override
			public boolean equals(Object obj) {
				if (this == obj) {
					return true;
				}
				if (!(obj instanceof AnotherTestClass)) {
					return false;
				}
				AnotherTestClass other = (AnotherTestClass) obj;
				if (getUuid() == null) {
					return false;
				}
				return getUuid().equals(other.getUuid());
			}

			@Override
			public Integer getId() {
				return id;
			}

			@Override
			public void setId(Integer id) {
				this.id = id;
			}
		}

		//Object of a NonHibernate managed class
		TestClass testObj = new TestClass();
		String uuid = testObj.getUuid();

		TestClass testObjsameuuid = new TestClass();
		testObjsameuuid.setUuid(uuid);
		//Object of Another NonHibernate managed class
		AnotherTestClass anotherTestObj = new AnotherTestClass();
		anotherTestObj.setUuid(uuid);

		AnotherTestClass anotherTestObjectsameUuid = new AnotherTestClass();
		anotherTestObjectsameUuid.setUuid(uuid);

		assertFalse(anotherTestObj.equals(testObj));
		assertFalse(testObj.equals(anotherTestObj));
		assertTrue(testObj.equals(testObjsameuuid));
		assertTrue(anotherTestObj.equals(anotherTestObjectsameUuid));
		assertTrue(testObjsameuuid.equals(testObj));
		assertTrue(anotherTestObjectsameUuid.equals(anotherTestObj));

	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnTrueIfHibernateProxyOfOneObjectComparedToNonHibernateProxyOfTheSameObject(){
		SessionFactory sessionFactory = (SessionFactory) applicationContext.getBean("sessionFactory");
		Session session = sessionFactory.getCurrentSession();

		Patient patient = (Patient) session.get(Patient.class, 2);
		Patient patientproxyobject = (Patient) session.load(Patient.class, 2);

		assertTrue(patient.equals(patientproxyobject));
	}

	/**
	 * @see BaseOpenmrsObject#equals(Object)
	 */
	@Test
	public void equals_shouldReturnTrueIfHibernateProxyOfSomeObjectComparedToAnotherHibernateProxyOfTheSameObject(){
		SessionFactory sessionFactory = (SessionFactory) applicationContext.getBean("sessionFactory");
		Session session = sessionFactory.getCurrentSession();

		assertTrue(session.load(Patient.class, 2).equals((session.load(Patient.class, 2)))) ;
	}
}