Changeset 45819

Timestamp:

08/16/2019 01:39:59 AM (5 years ago)

Author:

pento

Message:

Build Tools: Improve local-env start behaviour under Docker Toolbox.

Docker Toolbox requires port forwarding to be configured, but generates error when trying to forward a port that's already been taken.

This change removes clashing port forwarding rules before adding our own.

See #47767.

File:

• trunk/tools/local-env/scripts/start.js (modified) (1 diff)

trunk/tools/local-env/scripts/start.js

@@ -10 +10 @@
 if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) {
     // VBoxManage is added to the PATH on every platform except Windows.
-    const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${process.env.VBOX_MSI_INSTALL_PATH}/VBoxManage` : 'VBoxManage'
-    execSync( `"${vboxmanage}" controlvm "${process.env.DOCKER_MACHINE_NAME}" natpf1 "tcp-port${process.env.LOCAL_PORT},tcp,127.0.0.1,${process.env.LOCAL_PORT},,${process.env.LOCAL_PORT}"`, { stdio: 'inherit' } );
+    const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${ process.env.VBOX_MSI_INSTALL_PATH }/VBoxManage` : 'VBoxManage'
+
+    // Check if the port forwarding is already configured for this port.
+    const vminfoBuffer = execSync( `"${ vboxmanage }" showvminfo "${ process.env.DOCKER_MACHINE_NAME }" --machinereadable` );
+    const vminfo = vminfoBuffer.toString().split( /[\r\n]+/ );
+
+    vminfo.forEach( ( info ) => {
+        if ( ! info.startsWith( 'Forwarding' ) ) {
+            return;
+        }
+
+        // `info` is in the format: Forwarding(1)="tcp-port8889,tcp,127.0.0.1,8889,,8889"
+        // Parse it down so `rule` only contains the data inside quotes, split by ','.
+        const rule = info.replace( /(^.*?"|"$)/, '' ).split( ',' );
+
+        // Delete rules that are using the port we need.
+        if ( rule[ 3 ] === process.env.LOCAL_PORT || rule[ 5 ] === process.env.LOCAL_PORT ) {
+            execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 delete ${ rule[ 0 ] }`, { stdio: 'inherit' } );
+        }
+    } );
+
+    // Add our port forwarding rule.
+    execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 "tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }"`, { stdio: 'inherit' } );
 }