FILTER-12: Producing failing tests

api/pom.xml

@@ -43,6 +43,19 @@
             <artifactId>openmrs-test</artifactId>
             <type>pom</type>
         </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>mysql</artifactId>
+            <version>${mysqlTestContainerVersion}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>mysql</groupId>
+            <artifactId>mysql-connector-java</artifactId>
+            <version>8.0.22</version>
+            <type>jar</type>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

api/src/main/java/org/openmrs/module/datafilter/impl/api/db/hibernate/InterceptorUtil.java

@@ -14,7 +14,6 @@
 import org.hibernate.SessionFactory;
 import org.openmrs.api.context.Context;
 
-
 final class InterceptorUtil {
 
 	/**

api/src/test/java/org/openmrs/module/datafilter/impl/BaseFilterMySQLBackedTest.java

@@ -0,0 +1,204 @@
+/**
+ * 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.module.datafilter.impl;
+
+import java.io.IOException;
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.util.Properties;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.dbunit.DatabaseUnitException;
+import org.dbunit.DatabaseUnitRuntimeException;
+import org.dbunit.database.DatabaseConfig;
+import org.dbunit.database.DatabaseConnection;
+import org.dbunit.database.IDatabaseConnection;
+import org.dbunit.dataset.IDataSet;
+import org.dbunit.ext.mysql.MySqlDataTypeFactory;
+import org.dbunit.operation.DatabaseOperation;
+import org.hibernate.cfg.Environment;
+import org.hibernate.dialect.MySQL5Dialect;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.openmrs.GlobalProperty;
+import org.openmrs.api.AdministrationService;
+import org.openmrs.api.context.Context;
+import org.openmrs.api.context.UsernamePasswordCredentials;
+import org.openmrs.liquibase.ChangeLogVersionFinder;
+import org.openmrs.liquibase.ChangeSetExecutorCallback;
+import org.openmrs.module.datafilter.TestConstants;
+import org.openmrs.test.BaseModuleContextSensitiveTest;
+import org.openmrs.test.TestUtil;
+import org.openmrs.util.DatabaseUpdater;
+import org.openmrs.util.PrivilegeConstants;
+import org.testcontainers.containers.MySQLContainer;
+import liquibase.changelog.ChangeSet;
+
+public abstract class BaseFilterMySQLBackedTest extends BaseModuleContextSensitiveTest {
+
+	private static final Logger log = LoggerFactory.getLogger(BaseFilterMySQLBackedTest.class);
+
+	private static MySQLContainer<?> mysqlContainer = new MySQLContainer("mysql:5.7.31");
+
+	private static String databaseUrl = "jdbc:mysql://localhost:DATABASE_PORT/openmrs?autoReconnect=true&sessionVariables=default_storage_engine%3DInnoDB&useUnicode=true&characterEncoding=UTF-8";
+
+	private static String databaseUsername = "user";
+
+	private static String databaseUserPasswword = "12345678";
+
+	private static String databaseDialect = MySQL5Dialect.class.getName();
+
+	private static String databaseDriver = "com.mysql.jdbc.Driver";
+
+	@BeforeClass
+	public static void setupMySqlDb() throws IOException {
+
+		mysqlContainer.withDatabaseName("openmrs");
+		mysqlContainer.withUsername(databaseUsername);
+		mysqlContainer.withPassword(databaseUserPasswword);
+		mysqlContainer.start();
+		System.setProperty("useInMemoryDatabase", "false");
+	}
+
+	@Override
+	public void baseSetupWithStandardDataAndAuthentication() throws SQLException {
+		// Open a session if needed
+		if (!Context.isSessionOpen()) {
+			Context.openSession();
+		}
+
+		ChangeLogVersionFinder changeLogVersionFinder = new ChangeLogVersionFinder();
+
+		String liquibaseSchemaFileName = changeLogVersionFinder.getLatestSchemaSnapshotFilename().get();
+		//		String liquibaseCoreDataFileName = changeLogVersionFinder.getLatestCoreDataSnapshotFilename().get();
+
+		try {
+			DatabaseUpdater.executeChangelog(liquibaseSchemaFileName,
+			    new PrintingChangeSetExecutorCallback("OpenMRS schema file"));
+			String datafilterLiquibase = getClass().getClassLoader().getResource("liquibase.xml").toURI().getPath();
+			DatabaseUpdater.executeChangelog("liquibase.xml",
+			    new PrintingChangeSetExecutorCallback("Datafilter schema file"));
+		}
+		catch (Exception ex) {
+			throw new RuntimeException("Could not update database.", ex);
+		}
+		executeDataSet(INITIAL_XML_DATASET_PACKAGE_PATH);
+
+		//Commit so that it is not rolled back after a test.
+		getConnection().commit();
+
+		authenticate();
+		Context.clearSession();
+	}
+
+	@Override
+	public Properties getRuntimeProperties() {
+		if (runtimeProperties == null) {
+			runtimeProperties = TestUtil.getRuntimeProperties(getWebappName());
+		}
+		runtimeProperties.setProperty(Environment.URL,
+		    databaseUrl.replaceAll("DATABASE_PORT", String.valueOf(mysqlContainer.getMappedPort(3306))));
+
+		runtimeProperties.setProperty(Environment.USER, "user");
+		runtimeProperties.setProperty(Environment.PASS, "12345678");
+		runtimeProperties.setProperty("connection.username", "user");
+		runtimeProperties.setProperty("connection.password", "12345678");
+		runtimeProperties.setProperty("connection.url",
+		    databaseUrl.replaceAll("DATABASE_PORT", String.valueOf(mysqlContainer.getMappedPort(3306))));
+		runtimeProperties.setProperty(Environment.HBM2DDL_AUTO, "none");
+		runtimeProperties.setProperty(Environment.DIALECT, databaseDialect);
+		runtimeProperties.setProperty(Environment.DRIVER, databaseDialect);
+
+		return runtimeProperties;
+	}
+
+	@Override
+	public void executeDataSet(String dataset) {
+		try {
+			turnOffDBConstraints(getConnection());
+			super.executeDataSet(dataset);
+			turnOnDBConstraints(getConnection());
+		}
+		catch (SQLException e) {
+			throw new IllegalArgumentException(e);
+		}
+	}
+
+	@Override
+	public IDatabaseConnection setupDatabaseConnection(Connection connection) throws DatabaseUnitException {
+		IDatabaseConnection dbUnitConn = new DatabaseConnection(connection);
+
+		DatabaseConfig config = dbUnitConn.getConfig();
+		config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new MySqlDataTypeFactory());
+
+		return dbUnitConn;
+	}
+
+	@Before
+	public void beforeTestMethod() throws SQLException {
+		executeDataSet(TestConstants.MODULE_TEST_DATASET_XML);
+	}
+
+	protected void reloginAs(String username, String password) {
+		Context.logout();
+		Context.authenticate(new UsernamePasswordCredentials(username, password));
+	}
+
+	@Override
+	public void updateSearchIndex() {
+		//Disable the interceptor so we can update the search index
+		String originalValue = null;
+		Context.addProxyPrivilege(PrivilegeConstants.MANAGE_GLOBAL_PROPERTIES);
+		AdministrationService as = Context.getAdministrationService();
+		GlobalProperty gp = as.getGlobalPropertyObject(ImplConstants.GP_RUN_IN_STRICT_MODE);
+		if (gp == null) {
+			gp = new GlobalProperty(ImplConstants.GP_RUN_IN_STRICT_MODE);
+		} else {
+			originalValue = gp.getPropertyValue();
+		}
+
+		gp.setPropertyValue("false");
+		as.saveGlobalProperty(gp);
+		Context.removeProxyPrivilege(PrivilegeConstants.MANAGE_GLOBAL_PROPERTIES);
+		Context.flushSession();
+
+		try {
+			super.updateSearchIndex();
+		}
+		finally {
+			Context.addProxyPrivilege(PrivilegeConstants.MANAGE_GLOBAL_PROPERTIES);
+			gp.setPropertyValue(originalValue == null ? "" : originalValue);
+			as.saveGlobalProperty(gp);
+			Context.removeProxyPrivilege(PrivilegeConstants.MANAGE_GLOBAL_PROPERTIES);
+			Context.flushSession();
+		}
+	}
+
+	private static class PrintingChangeSetExecutorCallback implements ChangeSetExecutorCallback {
+
+		private int i = 1;
+
+		private String message;
+
+		public PrintingChangeSetExecutorCallback(String message) {
+			this.message = message;
+		}
+
+		/**
+		 * @see ChangeSetExecutorCallback#executing(liquibase.changelog.ChangeSet, int)
+		 */
+		@Override
+		public void executing(ChangeSet changeSet, int numChangeSetsToRun) {
+			log.info(message + " (" + i++ + "/" + numChangeSetsToRun + "): Author: " + changeSet.getAuthor() + " Comments: "
+			        + changeSet.getComments() + " Description: " + changeSet.getDescription());
+		}
+	}
+
+}

api/src/test/java/org/openmrs/module/datafilter/impl/BaseFilterTest.java

@@ -9,10 +9,12 @@
  */
 package org.openmrs.module.datafilter.impl;
 
+import java.io.IOException;
 import java.util.Properties;
 
 import org.hibernate.cfg.Environment;
 import org.junit.Before;
+import org.junit.BeforeClass;
 import org.openmrs.GlobalProperty;
 import org.openmrs.api.AdministrationService;
 import org.openmrs.api.context.Context;
@@ -31,6 +33,11 @@ public Properties getRuntimeProperties() {
 		return props;
 	}
 
+	@BeforeClass
+	public static void setupDb() throws IOException {
+		System.setProperty("useInMemoryDatabase", "true");
+	}
+
 	@Before
 	public void beforeTestMethod() {
 		executeDataSet(TestConstants.MODULE_TEST_DATASET_XML);

api/src/test/java/org/openmrs/module/datafilter/impl/BaseProgramBasedFilterTest.java

@@ -12,7 +12,7 @@
 import org.junit.Before;
 import org.openmrs.module.datafilter.FilterTestUtils;
 
-public abstract class BaseProgramBasedFilterTest extends BaseFilterTest {
+public abstract class BaseProgramBasedFilterTest extends BaseFilterMySQLBackedTest {
 
 	protected final static String ROLE_COORDINATOR_PROG_1 = "Program 1 Coordinator";
 

api/src/test/java/org/openmrs/module/datafilter/impl/UserProgramBasedFilterTest.java

@@ -11,7 +11,6 @@
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
-
 import java.util.Collection;
 import java.util.stream.Collectors;
 
@@ -26,6 +25,7 @@
 import org.openmrs.module.datafilter.TestConstants;
 import org.openmrs.module.datafilter.impl.api.DataFilterService;
 import org.openmrs.test.TestUtil;
+import org.openmrs.util.DatabaseUtil;
 import org.openmrs.util.PrivilegeConstants;
 import org.springframework.beans.factory.annotation.Autowired;
 
@@ -116,4 +116,24 @@ public void getUsers_shouldReturnAllUsersIfTheFilterIsDisabled() {
 		assertEquals(7, getUsers().size());
 	}
 
+	@Test
+	public void getProvidersByPerson_shouldFailWithSQLSyntaxErrorException() throws Exception {
+		// Setup
+		String exception = "You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near ')\n"
+		        + "                            OR datafilter_ur.role NOT IN ()\n" + "                  ' at line 6";
+		String sql = "DELETE FROM datafilter_entity_basis_map";
+		FilterTestUtils.enableFilter(ImplConstants.PROGRAM_BASED_FILTER_NAME_USER);
+		DatabaseUtil.executeSQL(getConnection(), sql, false);
+		Context.logout();
+
+		// Replay
+		Context.addProxyPrivilege(PrivilegeConstants.GET_PERSONS);
+		Context.addProxyPrivilege(PrivilegeConstants.GET_PROVIDERS);
+		try {
+			Context.getProviderService().getProvidersByPerson(Context.getPersonService().getPerson(1001));
+		}
+		catch (Exception e) {
+			assertEquals(e.getCause().getMessage(), exception);
+		}
+	}
 }

api/src/test/resources/TestingApplicationContext.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    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.
+
+-->
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans
+          http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
+
+    <!--
+    From applicationContext-service.xml in openmrs-api
+    Needed to override and add hibernate mappings to the classpath since omod is not packaged yet
+    -->
+    <bean id="sessionFactory" class="org.openmrs.api.db.hibernate.HibernateSessionFactoryBean">
+        <property name="configLocations">
+            <list>
+                <value>classpath:hibernate.cfg.xml</value>
+            </list>
+        </property>
+        <property name="mappingJarLocations">
+            <ref bean="mappingJarResources"/>
+        </property>
+        <!--  default properties must be set in the hibernate.default.properties -->
+        <property name="packagesToScan">
+            <list>
+                <value>org.openmrs</value>
+            </list>
+        </property>
+    </bean>
+
+</beans>

pom.xml

@@ -49,6 +49,7 @@
         <openmrsPlatformVersion>2.4.0</openmrsPlatformVersion>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <freemarkerVersion>2.3.29</freemarkerVersion>
+        <mysqlTestContainerVersion>1.15.2</mysqlTestContainerVersion>
     </properties>
 
     <dependencyManagement>
@@ -114,6 +115,16 @@
         </plugins>
         <pluginManagement>
             <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-surefire-plugin</artifactId>
+                    <version>2.22.1</version>
+                    <configuration>
+                        <reuseForks>false</reuseForks>
+                        <!-- prevent the annoying ForkedBooter process from stealing window focus on Mac OS -->
+                        <argLine>-Djava.awt.headless=true</argLine>
+                    </configuration>
+                </plugin>
                 <plugin>
                     <groupId>net.revelc.code.formatter</groupId>
                     <artifactId>formatter-maven-plugin</artifactId>