WIP - Initial ideas for homebrew support

Author: abrousseau001

mariaDB4j-core/src/main/java/ch/vorburger/mariadb4j/DB.java

@@ -56,6 +56,8 @@ public class DB {
 
     private static final Logger logger = LoggerFactory.getLogger(DB.class);
 
+    private static final String homebrewInstallationPath = "/opt/homebrew/bin/brew";
+
     protected final DBConfiguration configuration;
 
     private File baseDir;
@@ -407,22 +409,35 @@ public synchronized void stop() throws ManagedProcessException {
      * on the configuration.
      */
     protected void unpackEmbeddedDb() {
-        if (configuration.getBinariesClassPathLocation() == null) {
-            logger.info("Not unpacking any embedded database (as BinariesClassPathLocation configuration is null)");
-            return;
+        // Check for Homebrew, before doing anything else
+        // If HomeBrew is not installed, then throw a runtime error, similar to how the below extraction method
+        // does below for other operating systems
+        if(configuration.isMacOs() && !Util.doesExecutableExistAndIsExecutable(new File(homebrewInstallationPath)))
+        {
+            throw new RuntimeException("Homebrew must be installed on the system before using this library");
+        }
+        else {
+            // All other OS except macOS needs to have a place where the binaries are to be extracted
+            if (configuration.getBinariesClassPathLocation() == null) {
+                logger.info("Not unpacking any embedded database (as BinariesClassPathLocation configuration is null)");
+                return;
+            }
         }
 
-        try {
-            Util.extractFromClasspathToFile(configuration.getBinariesClassPathLocation(), baseDir);
-            if (!configuration.isWindows()) {
-                Util.forceExecutable(configuration.getExecutable(PrintDefaults));
-                Util.forceExecutable(configuration.getExecutable(InstallDB));
-                Util.forceExecutable(configuration.getExecutable(Server));
-                Util.forceExecutable(configuration.getExecutable(Dump));
-                Util.forceExecutable(configuration.getExecutable(Client));
+        // Windows, Linux, and any other supported OS can have their binaries extracted as normal
+        else if(!configuration.isMacOs()) {
+            try {
+                Util.extractFromClasspathToFile(configuration.getBinariesClassPathLocation(), baseDir);
+                if (!configuration.isWindows()) {
+                    Util.forceExecutable(configuration.getExecutable(PrintDefaults));
+                    Util.forceExecutable(configuration.getExecutable(InstallDB));
+                    Util.forceExecutable(configuration.getExecutable(Server));
+                    Util.forceExecutable(configuration.getExecutable(Dump));
+                    Util.forceExecutable(configuration.getExecutable(Client));
+                }
+            } catch (IOException e) {
+                throw new RuntimeException("Error unpacking embedded DB", e);
             }
-        } catch (IOException e) {
-            throw new RuntimeException("Error unpacking embedded DB", e);
         }
     }
 

mariaDB4j-core/src/main/java/ch/vorburger/mariadb4j/DBConfiguration.java

@@ -93,6 +93,13 @@ public interface DBConfiguration {
      **/
     boolean isWindows();
 
+    /**
+     * Whether running on macOS (this is used to determine whether or not to check for Homebrew)
+     *
+     * @return returns boolean isMacOs
+     */
+    boolean isMacOs();
+
     List<String> getArgs();
 
     String getOSLibraryEnvironmentVarName();
@@ -132,6 +139,8 @@ static class Impl implements DBConfiguration {
         private final String tmpDir;
         private final boolean isDeletingTemporaryBaseAndDataDirsOnShutdown;
         private final boolean isWindows;
+
+        private final boolean isMacOs;
         private final List<String> args;
         private final String osLibraryEnvironmentVarName;
         private final String defaultCharacterSet;
@@ -141,7 +150,7 @@ static class Impl implements DBConfiguration {
         private final Map<Executable, Supplier<File>> executables;
 
         Impl(int port, String socket, String binariesClassPathLocation, String baseDir, String libDir, String dataDir, String tmpDir,
-                boolean isWindows, List<String> args, String osLibraryEnvironmentVarName, boolean isSecurityDisabled,
+                boolean isWindows, boolean isMacOs, List<String> args, String osLibraryEnvironmentVarName, boolean isSecurityDisabled,
                 boolean isDeletingTemporaryBaseAndDataDirsOnShutdown, Function<String, String> getURL, String defaultCharacterSet,
                 Map<Executable, Supplier<File>> executables, ManagedProcessListener listener) {
             this.port = port;
@@ -153,6 +162,7 @@ static class Impl implements DBConfiguration {
             this.tmpDir = tmpDir;
             this.isDeletingTemporaryBaseAndDataDirsOnShutdown = isDeletingTemporaryBaseAndDataDirsOnShutdown;
             this.isWindows = isWindows;
+            this.isMacOs = isMacOs;
             this.args = args;
             this.osLibraryEnvironmentVarName = osLibraryEnvironmentVarName;
             this.isSecurityDisabled = isSecurityDisabled;
@@ -198,6 +208,8 @@ static class Impl implements DBConfiguration {
             return isWindows;
         }
 
+        @Override public boolean isMacOs() { return isMacOs; };
+
         @Override public List<String> getArgs() {
             return args;
         }

mariaDB4j-core/src/main/java/ch/vorburger/mariadb4j/DBConfigurationBuilder.java

@@ -206,7 +206,7 @@ public DBConfigurationBuilder setSocket(String socket) {
     public DBConfiguration build() {
         frozen = true;
         return new DBConfiguration.Impl(_getPort(), _getSocket(), _getBinariesClassPathLocation(), getBaseDir(),
-                getLibDir(), _getDataDir(), _getTmpDir(), isWindows(), _getArgs(), _getOSLibraryEnvironmentVarName(),
+                getLibDir(), _getDataDir(), _getTmpDir(), isWindows(), isMacOs(), _getArgs(), _getOSLibraryEnvironmentVarName(),
                 isSecurityDisabled(), isDeletingTemporaryBaseAndDataDirsOnShutdown(), this::getURL,
                 getDefaultCharacterSet(), _getExecutables(), getProcessListener());
     }
@@ -395,6 +395,10 @@ public boolean isWindows() {
         return WINX64.equals(getOS());
     }
 
+    public boolean isMacOs(){
+        return OSX.equals(getOS());
+    }
+
     protected String getExtension() {
         return isWindows() ? ".exe" : "";
     }

mariaDB4j-core/src/main/java/ch/vorburger/mariadb4j/Util.java

@@ -89,6 +89,16 @@ public static boolean isTemporaryDirectory(String directory) {
         return directory.startsWith(SystemUtils.JAVA_IO_TMPDIR);
     }
 
+    /**
+     * Method to check for the existence of a prerequisite executable, like Homebrew on macOS,
+     * and determine if it is executable
+     * @param executableFile file that is being checked for
+     * @return boolean if the file exists and is executable
+     */
+    public static boolean doesExecutableExistAndIsExecutable(File executableFile){
+        return executableFile.exists() && executableFile.canExecute();
+    }
+
     public static void forceExecutable(File executableFile) throws IOException {
         if (executableFile.exists()) {
             if (!executableFile.canExecute()) {