Fix 'Other' platform generation (hotfix 0.3.1) (#509) (#514)

microsoft · Sep 25, 2018 · aa62c93 · aa62c93
1 parent d468a0f
commit aa62c93
Show file tree

Hide file tree

Showing 5 changed files with 122 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 0.3.1 - 25 September 2018
+
+### Fixed
+
+* Error while generating Dockerfile for 'other' [#504](https://github.com/Microsoft/vscode-docker/issues/504)
+
 ## 0.3.0 - 21 September 2018
 
 ### Added

diff --git a/configureWorkspace/configure.ts b/configureWorkspace/configure.ts
@@ -20,6 +20,7 @@ import { configureAspDotNetCore, configureDotNetCoreConsole } from './configure_
 import { configureGo } from './configure_go';
 import { configureJava } from './configure_java';
 import { configureNode } from './configure_node';
+import { configureOther } from './configure_other';
 import { configurePython } from './configure_python';
 import { configureRuby } from './configure_ruby';
 
@@ -72,6 +73,7 @@ generatorsByPlatform.set('.NET Core Console', configureDotNetCoreConsole);
 generatorsByPlatform.set('Node.js', configureNode);
 generatorsByPlatform.set('Python', configurePython);
 generatorsByPlatform.set('Ruby', configureRuby);
+generatorsByPlatform.set('Other', configureOther);
 
 function genDockerFile(serviceNameAndRelativePath: string, platform: Platform, os: OS | undefined, port: string | undefined, { cmd, author, version, artifactName }: Partial<PackageInfo>): string {
     let generators = generatorsByPlatform.get(platform);

diff --git a/configureWorkspace/configure_other.ts b/configureWorkspace/configure_other.ts
@@ -0,0 +1,47 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { PackageInfo } from './configure';
+
+export let configureOther = {
+  genDockerFile,
+  genDockerCompose,
+  genDockerComposeDebug,
+  defaultPort: '3000'
+};
+
+function genDockerFile(serviceNameAndRelativePath: string, platform: string, os: string | undefined, port: string, { cmd, author, version, artifactName }: Partial<PackageInfo>): string {
+  return `FROM docker/whalesay:latest
+LABEL Name=${serviceNameAndRelativePath} Version=${version}
+RUN apt-get -y update && apt-get install -y fortunes
+CMD /usr/games/fortune -a | cowsay
+`;
+}
+
+function genDockerCompose(serviceNameAndRelativePath: string, platform: string, os: string | undefined, port: string): string {
+  return `version: '2.1'
+
+services:
+  ${serviceNameAndRelativePath}:
+    image: ${serviceNameAndRelativePath}
+    build: .
+    ports:
+      - ${port}:${port}
+`;
+}
+
+function genDockerComposeDebug(serviceNameAndRelativePath: string, platform: string, os: string | undefined, port: string, { fullCommand: cmd }: Partial<PackageInfo>): string {
+  return `version: '2.1'
+
+services:
+  ${serviceNameAndRelativePath}:
+    image: ${serviceNameAndRelativePath}
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - ${port}:${port}
+`;
+}
diff --git a/configureWorkspace/configure_python.ts b/configureWorkspace/configure_python.ts
@@ -54,7 +54,8 @@ services:
     image: ${serviceNameAndRelativePath}
     build: .
     ports:
-      - ${port}:${port}`;
+      - ${port}:${port}
+`;
 }
 
 function genDockerComposeDebug(serviceNameAndRelativePath: string, platform: string, os: string | undefined, port: string, { fullCommand: cmd }: Partial<PackageInfo>): string {
@@ -67,6 +68,6 @@ services:
       context: .
       dockerfile: Dockerfile
     ports:
-        - ${port}:${port}
+      - ${port}:${port}
 `;
 }
diff --git a/test/configure.test.ts b/test/configure.test.ts
@@ -41,7 +41,6 @@ as the easier to read:
             sub-indented text
         `;
 */
-
 function removeIndentation(text: string): string {
     while (text[0] === '\r' || text[0] === '\n') {
         text = text.substr(1);
@@ -1145,6 +1144,70 @@ suite("Configure (Add Docker files to Workspace)", function (this: Suite): void
         });
     });
 
+    suite("'Other'", () => {
+        testInEmptyFolder("with package.json", async () => {
+            await writeFile('', 'package.json', JSON.stringify({
+                "name": "myexpressapp",
+                "version": "1.2.3",
+                "private": true,
+                "scripts": {
+                    "start": "node ./bin/www"
+                },
+                "dependencies": {
+                    "cookie-parser": "~1.4.3",
+                    "debug": "~2.6.9",
+                    "express": "~4.16.0",
+                    "http-errors": "~1.6.2",
+                    "jade": "~1.11.0",
+                    "morgan": "~1.9.0"
+                }
+            }))
+            await testConfigureDocker(
+                'Other',
+                {
+                    configurePlatform: 'Other',
+                    configureOs: undefined,
+                    packageFileType: undefined,
+                    packageFileSubfolderDepth: undefined
+                },
+                [undefined /*port*/],
+                ['Dockerfile', 'docker-compose.debug.yml', 'docker-compose.yml', '.dockerignore', 'package.json']);
+
+            let dockerfileContents = await readFile('Dockerfile');
+            let composeContents = await readFile('docker-compose.yml');
+            let debugComposeContents = await readFile('docker-compose.debug.yml');
+
+            assert.strictEqual(dockerfileContents, removeIndentation(`
+                FROM docker/whalesay:latest
+                LABEL Name=testoutput Version=1.2.3
+                RUN apt-get -y update && apt-get install -y fortunes
+                CMD /usr/games/fortune -a | cowsay
+                `));
+            assert.strictEqual(composeContents, removeIndentation(`
+                version: '2.1'
+
+                services:
+                  testoutput:
+                    image: testoutput
+                    build: .
+                    ports:
+                      - 3000:3000
+                `));
+            assert.strictEqual(debugComposeContents, removeIndentation(`
+                version: '2.1'
+
+                services:
+                  testoutput:
+                    image: testoutput
+                    build:
+                      context: .
+                      dockerfile: Dockerfile
+                    ports:
+                      - 3000:3000
+                `));
+        });
+    });
+
     // API (vscode-docker.api.configure)
 
     suite("API", () => {