correctly run php container from exec command if container is stopped

Author: ejnshtein

build-packages/magento-scripts/lib/tasks/docker/containers/container-api.d.ts

@@ -69,6 +69,8 @@ export interface ContainerRunOptions {
      * Run container in background and print container ID
      */
     detach?: boolean
+
+    tty?: boolean
     /**
      * Publish or expose port [docs](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose)
      */
@@ -126,3 +128,5 @@ export interface ContainerRunOptions {
 }
 
 export function run(containerOptions: ContainerRunOptions, execOptions?: ExecAsyncSpawnOptions<false>): Promise<false>
+
+export function runCommand(options: ContainerRunOptions): string[]

build-packages/magento-scripts/lib/tasks/docker/containers/container-api.js

@@ -3,9 +3,9 @@ const { execAsyncSpawn } = require('../../../util/exec-async-command');
 
 /**
  * @param {import('./container-api').ContainerRunOptions} options
- * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
+ * @returns {string[]}
  */
-const run = (options, execOptions = {}) => {
+const runCommand = (options) => {
     const {
         addHost,
         ports = [],
@@ -24,32 +24,35 @@ const run = (options, execOptions = {}) => {
         expose = [],
         detach = true,
         rm = false,
+        tty = false,
         user
     } = options;
 
     const detachArg = detach && '-d';
     const rmArg = rm && '--rm';
+    const ttyArg = tty && '-it';
     const exposeArg = expose && expose.map((e) => `--expose=${ e }`);
-    const restartArg = !rm && restart && `--restart ${ restart }`;
-    const networkArg = network && `--network ${ network }`;
-    const portsArgs = ports.map((port) => `-p ${ port }`).join(' ');
-    const mountsArgs = mounts.map((mount) => `--mount ${ mount }`).join(' ');
-    const mountVolumesArgs = mountVolumes.map((mount) => `-v ${mount}`).join(' ');
-    const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env ${ key }='${ value }'`).join(' ');
-    const nameArg = name && `--name ${name}`;
-    const entrypointArg = entrypoint && `--entrypoint "${entrypoint}"`;
-    const healthCheckArg = healthCheck && Object.entries(healthCheck).map(([key, value]) => `--health-${key} '${value}'`).join(' ');
-    const securityArg = securityOptions.length > 0 && securityOptions.map((opt) => `--security-opt ${opt}`).join(' ');
-    const tmpfsArg = tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs ${t}`).join(' ');
+    const restartArg = !rm && restart && `--restart=${ restart }`;
+    const networkArg = network && `--network=${ network }`;
+    const portsArgs = ports && ports.length > 0 && ports.map((port) => `-p=${ port }`).join(' ');
+    const mountsArgs = mounts && mounts.map((mount) => `--mount=${ mount }`).join(' ');
+    const mountVolumesArgs = mountVolumes && mountVolumes.map((mount) => `-v=${mount}`).join(' ');
+    const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env=${ key }='${ value }'`).join(' ');
+    const nameArg = name && `--name=${name}`;
+    const entrypointArg = entrypoint && `--entrypoint="${entrypoint}"`;
+    const healthCheckArg = healthCheck && Object.entries(healthCheck).map(([key, value]) => `--health-${key}='${value}'`).join(' ');
+    const securityArg = securityOptions.length > 0 && securityOptions.map((opt) => `--security-opt=${opt}`).join(' ');
+    const tmpfsArg = tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs=${t}`).join(' ');
     const userArg = user && `--user=${user}`;
     const addHostArg = addHost && `--add-host=${addHost}`;
 
     const dockerCommand = [
         'docker',
         'run',
+        nameArg,
+        ttyArg,
         detachArg,
         rmArg,
-        nameArg,
         networkArg,
         restartArg,
         portsArgs,
@@ -65,11 +68,17 @@ const run = (options, execOptions = {}) => {
         addHostArg,
         image,
         command
-    ].filter(Boolean).join(' ');
+    ].filter(Boolean).filter((arg) => typeof arg === 'string');
 
-    return execAsyncSpawn(dockerCommand, execOptions);
+    return dockerCommand;
 };
 
+/**
+ * @param {import('./container-api').ContainerRunOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
+ */
+const run = (options, execOptions = {}) => execAsyncSpawn(runCommand(options).join(' '), execOptions);
+
 /**
  * @param {string} command
  * @param {string} container container id or name
@@ -148,6 +157,7 @@ const ls = async (options = {}, execOptions = {}) => {
 
 module.exports = {
     run,
+    runCommand,
     exec,
     ls
 };

build-packages/magento-scripts/lib/tasks/execute.js

@@ -5,9 +5,8 @@ const getMagentoVersionConfig = require('../config/get-magento-version-config');
 const checkConfigurationFile = require('../config/check-configuration-file');
 const getProjectConfiguration = require('../config/get-project-configuration');
 const { getCachedPorts } = require('../config/get-port-config');
-const executeInContainer = require('../util/execute-in-container');
+const { executeInContainer, runInContainer } = require('../util/execute-in-container');
 const { containerApi } = require('./docker/containers');
-const { runPHPContainerCommand } = require('./php/php-container');
 const KnownError = require('../errors/known-error');
 
 /**
@@ -76,12 +75,12 @@ const executeTask = async (argv) => {
 
         if (container.name.endsWith('php')) {
             logger.logN(`Starting container ${logger.style.misc(container._)} with command: ${logger.style.command(argv.commands.join(' '))}`);
-            const result = await runPHPContainerCommand(
-                ctx,
-                argv.commands.join(' '),
+            const result = await runInContainer(
                 {
-                    logOutput: true
-                }
+                    ...container,
+                    name: `${container.name}_exec-${Date.now()}`
+                },
+                argv.commands
             );
 
             return result;

build-packages/magento-scripts/lib/util/execute-in-container.js

@@ -1,5 +1,6 @@
 const os = require('os');
 const { spawn } = require('child_process');
+const { runCommand } = require('../tasks/docker/containers/container-api');
 
 /**
  * @param {{ containerName: string, commands: string[] }} param0
@@ -29,4 +30,34 @@ const executeInContainer = ({ containerName, commands }) => {
     });
 };
 
-module.exports = executeInContainer;
+/**
+ * @param {import('../tasks/docker/containers/container-api').ContainerRunOptions} options
+ * @param {string[]} commands
+ */
+const runInContainer = (options, commands) => {
+    if (!process.stdin.isTTY) {
+        process.stderr.write('This app works only in TTY mode');
+        process.exit(1);
+    }
+
+    const runArgs = runCommand({
+        ...options,
+        tty: true,
+        detach: false,
+        rm: true,
+        command: commands.map((command) => command.split(' ')).flat().join(' ')
+    });
+
+    const args = runArgs.slice(1).map((command) => command.split(' ')).flat();
+
+    spawn('docker', args, { stdio: [0, 1, 2] });
+
+    return new Promise((_resolve) => {
+        // never resolve
+    });
+};
+
+module.exports = {
+    executeInContainer,
+    runInContainer
+};