Revised Unison support for Mac.

Fixed typo in m2unison.bat.

Author: Alan Kent

README.md

@@ -433,8 +433,6 @@ significant work on the project without Unison running to avoid merge conflicts
 
 **Mac**
 
-TODO: VERIFY WHEN TESTING FINISHED.
-
 On Mac, first install Unison using "brew". This installs the correct command
 line version of Unison. Also install "unox" for a companion file watching
 utility.
@@ -446,7 +444,7 @@ utility.
 For Mac, create a "profile" file in `~/.unison/m2devbox-{myproj}.prf` ({myproj}
 is the current directory name) by running the following command.
 
-    ./m2unison-profile   TODO: THIS SHOULD RUN SSH TO ACCEPT SSH FINGERPRINT
+    ./m2unison-profile
 
 To perform a "once off" file synchronization, run
 
@@ -459,6 +457,12 @@ To continuously synchronize files (recommended), run
 It is recommended to run Unison in a separate Terminal window so you can refer
 to its output if you ever need to do troubleshooting.
 
+If you ever restart the Docker containers, you may need to rerun
+`m2unison-profile` as the profile file containers the SSH port number used
+by the Unison container from the `docker-compose.yml` file. (Using the
+`2223:22` syntax for the SSH port number in `docker-composer.yml` can avoid
+this problem.)
+
 **Windows**
 
 On Windows, run the supplied BAT file to launch Unison in a separate window

docker-compose.yml

@@ -9,13 +9,19 @@ services:
         restart: always
         image: alankent/magento2devbox-web:latest
 
+        depends_on:
+          - db
+          #- rabbitmq
+          #- elastic
+          #- rabbitmq
+
         volumes:
 
-          # Uncomment the first line for use with Unison and the "unison" service
-          # below (Mac, Windows). Uncomment the second line instead to mount
-          # the volume directly (Linux). Comment out both lines if file sharing
-          # is not required.
-          - "src:/var/www"
+          # Uncomment the first line for use with Unison and the "unison"
+          # service below (Mac, Windows). Uncomment the second line instead
+          # to mount the volume directly (Linux). Comment out both lines if
+          # file sharing is not required.
+          - "/var/www"
           #- "./shared/www:/var/www"
 
           # Uncomment to share your ~/.ssh directory with the container.
@@ -74,11 +80,14 @@ services:
           - "3001"
 
     # This container contains the Unison process.
-    # Remove this service if not using Unison.
+    # Comment out / remove this service if not using Unison (e.g. on Linux).
     unison:
         restart: always
         image: alankent/magento2devbox-unison:latest
 
+        depends_on:
+          - "web"
+
         # Mount the /var/www directory from the "web" container.
         volumes_from:
           - "web"
@@ -90,6 +99,7 @@ services:
 
           # Pick a random port for ssh based Unison connections (developers
           # normally do not log in to this container).
+          # Use "2223:22" to lock the port number across container restarts.
           - "22"
 
     db:

m2unison-profile

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+
+# Unison can connect over SSH or via a socket. SSH is used be default as there
+# have been some reports of the socket mode hanging at times.
+USE_SOCKET=0
+
+
+PROJ=$COMPOSE_PROJECT_NAME
+if [[ -z $PROJ ]]; then
+    PROJ=$(basename $PWD)
+fi
+M2PROFILE=m2devbox-$PROJ
+
+mkdir -p ~/.unison
+
+LOCAL_ROOT=$(pwd)/shared/www
+if [[ $USE_SOCKET == 1 ]]; then
+    # Fetch the external Docker Unison port number
+    SSH_ARGS_LINE=
+    UNISON_PORT=$(docker-compose port unison 5000 | awk -F: '{print $2}')
+    REMOTE_ROOT=socket://localhost:$UNISON_PORT//var/www
+else
+    SSH_PORT=$(docker-compose port unison 22 | awk -F: '{print $2}')
+    echo "Testing 'ssh' connection to container..."
+    ssh -p $SSH_PORT magento2@localhost echo Connection successful
+    SSH_ARGS_LINE="sshargs = -p $SSH_PORT"
+    REMOTE_ROOT=ssh://magento2@localhost//var/www
+fi
+
+cat << EOF > ~/.unison/$M2PROFILE.prf
+
+# WARNING: This file is automatically generated. Changes may be over-written.
+
+$SSH_ARGS_LINE
+
+# Local root
+root = $LOCAL_ROOT
+
+# Remote root (Docker container)
+root = $REMOTE_ROOT
+
+# Magento files not worth pulling locally.
+ignore = Path magento2/var/cache
+ignore = Path magento2/var/composer_home
+ignore = Path magento2/var/log
+ignore = Path magento2/var/page_cache
+ignore = Path magento2/var/session
+ignore = Path magento2/var/tmp
+ignore = Path magento2/var/.setup_cronjob_status
+ignore = Path magento2/var/.update_cronjob_status
+
+# Magento files not worth pushing remotely.
+ignore = Path magento2/.git
+ignore = Path magento2/.gitignore
+ignore = Path magento2/.gitattributes
+ignore = Path magento2/.magento
+ignore = Name .idea
+ignore = Name .*.swp
+ignore = Name .unison.*
+
+prefer = $LOCAL_ROOT
+preferpartial = Path var -> $REMOTE_ROOT
+auto = true
+batch = true
+
+EOF
+
+echo "Unison profile '$M2PROFILE' has been created in '~/.unison'."
+echo "Run 'unison -repeat watch $M2PROFILE' for file syncing mode."
+

m2unison.bat

@@ -99,7 +99,7 @@ REM **** Entering file watch mode ****
         SET REMOTE_ROOT=socket://localhost:%UNISON_PORT%//var/www
     :done2
 
-    set UNISONARGS=%LOCAL_ROOT% %REMOTE_ROOT% -sshargs "%SSH_ARGS" -prefer %LOCAL_ROOT% -preferpartial "Path var -> %REMOTE_ROOT%" -auto -batch %IGNORE%
+    set UNISONARGS=%LOCAL_ROOT% %REMOTE_ROOT% -sshargs "%SSH_ARGS%" -prefer %LOCAL_ROOT% -preferpartial "Path var -> %REMOTE_ROOT%" -auto -batch %IGNORE%
 
     @ECHO ON
     REM **** Unison exited - Restarting file watch mode ****