STAND-119: Add Support for Reference Application 3.x in OpenMRS Standalone (openmrs#76)

* Replace the embedded mysql with mariadb4j in Ref App 2.x

* removing nashorn-core

* updating to the latest snapshot

* resized MainFrame and updated readme

* added unit tests

* STAND-119: Support-reference-application-3-x-on-open-mrs-standalone

Author: Muta-Jonathan

README.md

@@ -2,8 +2,8 @@
 
 * Increase the maven memory: e.g. export MAVEN_OPTS="-Xms1012m -Xmx2024m"
 * mvn clean
-* mvn package -Dopenmrs.version=2.8.0-SNAPSHOT -Drefapp.version=2.14.0-SNAPSHOT
-* You can also use mvn package to build the default version on openmrs.version=2.8.0-SNAPSHOT and refapp.version=2.14.0-SNAPSHOT
+* mvn package -Dopenmrs.version=2.7.4 -Drefapp.version=3.4.0
+* You can also use mvn package to build the default version on openmrs.version=2.7.4 and refapp.version=3.4.0
 * If running a second time, ALWAYS check to make sure mysql processes on port 3326 and 3328 are stopped. 
   If you DON'T do that, then the "mvn clean" will not really clean. 
   A good command to use is: "pkill -f standalone"  (kills anything with "standalone" in the path) 
@@ -16,7 +16,7 @@
 - Copy your war file into the "tomcat/webapps" folder. Where the tomcat folder is at the root of the project.
 
 If you already have openmrs installed and do not want to interfere with it, just rename
-your war file to something different from openmrs.war. Examples are openmrs-2.8.0-SNAPSHOT.war, etc which suppoort Java 17 and above.
+your war file to something different from openmrs.war. Examples are openmrs-2.7.4.war, etc which suppoort Java 17 and above.
 
 - Right click on the project and select Run As -> Run Configurations
 
@@ -73,7 +73,7 @@ The release/distribution (end user) folder structure should look like this:
 NOTE: Without this folder structure, you will get errors while trying to run the standalone application.
 
 * contextname-runtime.properties 
- * e.g openmrs-runtime.properties, openmrs-2.14.0-SNAPSHOT-runtime.properties, etc
+ * e.g openmrs-runtime.properties, openmrs-3.4.0-runtime.properties, etc
  * If you want to use this runtime properties file, make sure that the web application context name does not match with any existing runtime properties file in say the user's home folder. This is because of the openmrs runtime properties file search order which will only look in the current application folder as the last resort if no runtime properties file has been found in any of the other possible locations.
 * standalone.jar
  * This is the output executable jar for this standalone project.
@@ -152,7 +152,7 @@ browser			Use to launch a new browser instance.
 4- The application will start the tomcat server and then the mariadb4j database engine.
 5- Follow the steps in the openmrs setup wizard to select where you want the demo database distribution or ciel database distribution to be created.
 6- After the setup wizard is done, you will have a database created in the location you selected.
-7- Open your browser and go to the openmrs setup wizard at http://localhost:8080/openmrs
+7- Open your browser and go to the openmrs setup wizard at http://localhost:8080/openmrs/spa
 NOTE: The default location of the "database" folder is that where the standalone.jar file is.
       You should also add the application_data_directory key to the runtime properties file. Something like this:
       application_data_directory=appdata 

pom-step-01.xml

@@ -4,15 +4,15 @@
 
     <groupId>org.openmrs</groupId>
     <artifactId>referenceapplication-standalone-01</artifactId>
-    <version>2.6.0-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <name>referenceapplication-standalone-01</name>
 
     <parent>
         <groupId>org.openmrs</groupId>
         <artifactId>referenceapplication-standalone</artifactId>
-        <version>2.6.0-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
         <relativePath>pom.xml</relativePath>
     </parent>
 

pom-step-02.xml

@@ -4,15 +4,15 @@
 
     <groupId>org.openmrs</groupId>
     <artifactId>referenceapplication-standalone-02</artifactId>
-    <version>2.6.0-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <name>referenceapplication-standalone-02</name>
 
     <parent>
         <groupId>org.openmrs</groupId>
         <artifactId>referenceapplication-standalone</artifactId>
-        <version>2.6.0-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
         <relativePath>pom.xml</relativePath>
     </parent>
 

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>org.openmrs</groupId>
 	<artifactId>referenceapplication-standalone</artifactId>
-	<version>2.6.0-SNAPSHOT</version>
+	<version>3.0.0-SNAPSHOT</version>
 
 	<name>referenceapplication-standalone</name>
 	<url>https://github.com/openmrs/openmrs-standalone/</url>
@@ -22,8 +22,8 @@
 		<liquibase.plugin.version>4.23.2</liquibase.plugin.version>
 
 		<tomcat.version>9.0.106</tomcat.version>
-		<openmrs.version>2.8.0-SNAPSHOT</openmrs.version>
-		<refapp.version>2.14.0-SNAPSHOT</refapp.version>
+		<openmrs.version>2.7.4</openmrs.version>
+		<refapp.version>3.4.0</refapp.version>
 		<mariadb4jVersion>3.2.0</mariadb4jVersion>
 		<junitVersion>5.12.2</junitVersion>
 		<mockitoVersion>3.12.4</mockitoVersion>
@@ -125,14 +125,14 @@
 								<requireProperty>
 									<property>refapp.version</property>
 									<message>refapp.version property is missing. This should be
-										something like 2.4, 2.5 Add
-										-Drefapp.version=2.5</message>
+										something like 3.4, 3.5 Add
+										-Drefapp.version=3.5</message>
 								</requireProperty>
 								<requireProperty>
 									<property>openmrs.version</property>
 									<message>openmrs.version property is missing. This should be
-										something like 2.0.2, 2.0.5 Add
-										-Dopenmrs.version=2.0.5</message>
+										something like 3.4.0, 3.3.1 Add
+										-Dopenmrs.version=3.4.1-SNAPSHOT</message>
 								</requireProperty>
 							</rules>
 							<fail>true</fail>

readme.txt

@@ -2,8 +2,8 @@
 ...............QUICK SUMMARY FOR BUILDING THE STANDALONE.....................
 * Increase the maven memory: e.g. export MAVEN_OPTS="-Xms1012m -Xmx2024m"
 * mvn clean
-* mvn package -Dopenmrs.version=2.8.0-SNAPSHOT -Drefapp.version=2.14.0-SNAPSHOT
-* You can also use mvn package to build the default version on openmrs.version=2.8.0-SNAPSHOT and refapp.version=2.14.0-SNAPSHOT
+* mvn package -Dopenmrs.version=2.7.4 -Drefapp.version=3.4.0
+* You can also use mvn package to build the default version on openmrs.version=2.7.4 and refapp.version=3.4.0
 * If running a second time, ALWAYS check to make sure mysql processes on port 3326 and 3328 are stopped.
   If you DON'T do that, then the "mvn clean" will not really clean.
   A good command to use is: "pkill -f standalone"  (kills anything with "standalone" in the path)
@@ -12,15 +12,15 @@
 -> the contents of that zip are in the similarly-named folder under /target, if you want to test in-place
 
 
-.......................OpenMRS Standalone README............................
+.......................OpenMRS Standalone 3.x README............................
 
 
 
 ........................HOW TO RUN FROM ECLIPSE.............................
 
 -	Copy your war file into the "tomcat/webapps" folder. Where the tomcat folder is at the root of the project.
 If you already have openmrs installed and do not want to interfere with it, just rename
-your war file to something different from openmrs.war. Examples are openmrs-2.8.0-SNAPSHOT.war, etc which suppoort Java 17 and above.
+your war file to something different from openmrs.war. Examples are openmrs-2.7.4.war, etc which suppoort Java 17 and above.
 
 -	Right click on the project and select Run As -> Run Configurations
 
@@ -197,7 +197,7 @@ browser			Use to launch a new browser instance.
 4- The application will start the tomcat server and then the mariadb4j database engine.
 5- Follow the steps in the openmrs setup wizard to select where you want the demo database distribution or ciel database distribution to be created.
 6- After the setup wizard is done, you will have a database created in the location you selected.
-7- Open your browser and go to the openmrs setup wizard at http://localhost:8080/openmrs
+7- Open your browser and go to the openmrs setup wizard at http://localhost:8080/openmrs/spa
 NOTE: The default location of the "database" folder is that where the standalone.jar file is.
       You should also add the application_data_directory key to the runtime properties file. Something like this:
       application_data_directory=appdata 

src/main/assembly/zip-standalone.xml

@@ -13,6 +13,16 @@
 			<outputDirectory>${project.build.finalName}/tomcat/webapps</outputDirectory>
 			<destName>openmrs.war</destName>
 		</file>
+		<file>
+			<source>${project.build.directory}/distro/web/spa-build-config.json</source>
+			<outputDirectory>${project.build.finalName}/appdata/</outputDirectory>
+			<destName>spa-build-config.json</destName>
+		</file>
+		<file>
+			<source>${project.build.directory}/distro/web/openmrs-distro.properties</source>
+			<outputDirectory>${project.build.finalName}/appdata/</outputDirectory>
+			<destName>openmrs-distro.properties</destName>
+		</file>
 	</files>
 	<fileSets>
 		<fileSet>
@@ -36,5 +46,13 @@
 			<directory>${project.build.directory}/distro/web/openmrs_owas</directory>
 			<outputDirectory>${project.build.finalName}/appdata/owa</outputDirectory>
 		</fileSet>
+		<fileSet>
+			<directory>${project.build.directory}/distro/web/openmrs_config</directory>
+			<outputDirectory>${project.build.finalName}/appdata/configuration</outputDirectory>
+		</fileSet>
+		<fileSet>
+			<directory>${project.build.directory}/distro/web/openmrs_spa</directory>
+			<outputDirectory>${project.build.finalName}/appdata/frontend</outputDirectory>
+		</fileSet>
 	</fileSets>
 </assembly>

src/main/java/org/openmrs/standalone/OpenmrsUtil.java

@@ -128,68 +128,6 @@ public static Properties getRuntimeProperties(String applicationName) {
 		System.out.println("Failed to get runtime properties file.");
 
 		return null;
-		
-		/*if (applicationName == null)
-			applicationName = "openmrs";
-		
-		runtimePropertiesPathName = null;
-		FileInputStream propertyStream = null;
-		
-		// first look for an environment variable
-		{
-			String envVarName = applicationName.toUpperCase() + "_RUNTIME_PROPERTIES_FILE";
-			runtimePropertiesPathName = System.getenv(envVarName);
-			if (runtimePropertiesPathName != null) {
-				try {
-					propertyStream = new FileInputStream(runtimePropertiesPathName);
-				}
-				catch (IOException e) {
-				}
-			}
-		}
-		
-		String filename = applicationName + "-runtime.properties";
-		
-		// next look in the OpenMRS application data directory
-		if (propertyStream == null) {
-			runtimePropertiesPathName = OpenmrsUtil.getApplicationDataDirectory() + filename;
-			System.out.println("Attempting to load property file from: " + runtimePropertiesPathName);
-			try {
-				propertyStream = new FileInputStream(runtimePropertiesPathName);
-			}
-			catch (FileNotFoundException e) {
-			}
-		}
-		
-		// last chance, look in the current directory (that java was started
-		// from)
-		if (propertyStream == null) {
-			runtimePropertiesPathName = filename;
-			System.out.println("Attempting to load properties file in current directory: " + runtimePropertiesPathName);
-			try {
-				propertyStream = new FileInputStream(runtimePropertiesPathName);
-			}
-			catch (FileNotFoundException e) {
-			}
-		}
-		
-		try {
-			if (propertyStream != null) {
-				Properties props = new Properties();
-				loadProperties(props, propertyStream);
-				propertyStream.close();
-				System.out.println("Using runtime properties file: " + runtimePropertiesPathName);
-				return props;
-			}
-		}
-		catch (Exception ex) {
-			ex.printStackTrace();
-			return null;
-		}
-		
-		System.out.println("Failed to get runtime properties file.");
-		
-		return null;*/
 	}
 
 	/**
@@ -227,7 +165,7 @@ private static String getApplicationDataDirectory() {
 	 * Convenience method used to load properties from the given file.
 	 * 
 	 * @param props the properties object to be loaded into
-	 * @param propertyFile the properties file to read
+	 * @param inputStream the properties file to read
 	 */
 	private static void loadProperties(Properties props, InputStream inputStream) {
 		try {

src/main/java/org/openmrs/standalone/StandaloneUtil.java

@@ -176,9 +176,6 @@ public static String setPortsAndMySqlPassword(String mariaDBPort, String tomcatP
 					}
 				}
 
-				//We change the mysql password only if it is test.
-				//if (password != null && password.toLowerCase().equals("test")) {
-
 				//Change the mysql password if instructed to.
 				if ("true".equalsIgnoreCase(resetConnectionPassword)) {
 					String newPassword = generateSecurePassword();
@@ -278,7 +275,7 @@ public static boolean launchBrowser(int port, String contextName) {
 				Desktop desktop = Desktop.getDesktop();
 
 				if (desktop.isSupported(Desktop.Action.BROWSE)) {
-					desktop.browse(new URI("http://localhost:" + port + "/" + contextName));
+					desktop.browse(new URI("http://localhost:" + port + "/" + contextName + "/spa"));
 					return true;
 				}
 			}