Allow overriding memory limit on docker build/run (#6345)

Fixes #6342

Tasks/Docker/Strings/resources.resjson/en-US/resources.resjson

@@ -64,6 +64,8 @@
   "loc.input.help.enforceDockerNamingConvention": "If enabled docker image name will be modified to follow Docker naming convention. Converts upper case character to lower case and removes spaces in image name.",
   "loc.input.label.cwd": "Working Directory",
   "loc.input.help.cwd": "Working directory for the Docker command.",
+  "loc.input.label.memory": "Memory limit",
+  "loc.input.help.memory": "The maximum amount of memory available to the container as a integer with optional suffixes like '2GB'.",
   "loc.messages.ContainerPatternFound": "Pattern found in docker filepath parameter",
   "loc.messages.ContainerPatternNotFound": "No pattern found in docker filepath parameter",
   "loc.messages.ContainerDockerFileNotFound": "No Docker file matching  %s  was found.",

Tasks/Docker/Tests/L0.ts

@@ -19,6 +19,7 @@ describe('Docker Suite', function() {
         delete process.env[shared.TestEnvVars.imageName];
         delete process.env[shared.TestEnvVars.additionalImageTags];
         delete process.env[shared.TestEnvVars.enforceDockerNamingConvention];
+        delete process.env[shared.TestEnvVars.memory];
     });
     after(function () {
     });
@@ -37,6 +38,21 @@ describe('Docker Suite', function() {
         done();
     });
 
+    it('Runs successfully for docker build with memory limit', (done:MochaDone) => {
+        let tp = path.join(__dirname, 'TestSetup.js');
+        let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp);
+        process.env[shared.TestEnvVars.action] = shared.ActionTypes.buildImage;
+        process.env[shared.TestEnvVars.memory] = "2GB";
+        tr.run();
+
+        assert(tr.invokedToolCount == 1, 'should have invoked tool one times. actual: ' + tr.invokedToolCount);
+        assert(tr.stderr.length == 0 || tr.errorIssues.length, 'should not have written to stderr');
+        assert(tr.succeeded, 'task should have succeeded');
+        assert(tr.stdout.indexOf(`[command]docker build -f ${shared.formatPath("dir1/DockerFile")} -t test/test:2 -m 2GB`) != -1, "docker build should run");
+        console.log(tr.stderr);
+        done();
+    });
+
     it('Runs successfully for docker build for invalid image name', (done:MochaDone) => {
         let tp = path.join(__dirname, 'TestSetup.js');
         let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp);
@@ -116,6 +132,21 @@ describe('Docker Suite', function() {
         done();
     });
 
+    it('Runs successfully for docker run image with memory limit', (done:MochaDone) => {
+        let tp = path.join(__dirname, 'TestSetup.js');
+        let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp);
+        process.env[shared.TestEnvVars.action] = shared.ActionTypes.runImage;
+        process.env[shared.TestEnvVars.memory] = "2GB";
+        tr.run();
+
+        assert(tr.invokedToolCount == 1, 'should have invoked tool one times. actual: ' + tr.invokedToolCount);
+        assert(tr.stderr.length == 0 || tr.errorIssues.length, 'should not have written to stderr');
+        assert(tr.succeeded, 'task should have succeeded');
+        assert(tr.stdout.indexOf("[command]docker run --rm -m 2GB test/test:2") != -1, "docker run should run");
+        console.log(tr.stderr);
+        done();
+    });
+
     it('Runs successfully for docker tag image from image names file', (done:MochaDone) => {
         let tp = path.join(__dirname, 'TestSetup.js');
         let tr : ttm.MockTestRunner = new ttm.MockTestRunner(tp);

Tasks/Docker/Tests/TestSetup.ts

@@ -23,6 +23,7 @@ tr.setInput('azureSubscriptionEndpoint', 'AzureRMSpn');
 tr.setInput('azureContainerRegistry', '{"loginServer":"ajgtestacr1.azurecr.io", "id" : "/subscriptions/c00d16c7-6c1f-4c03-9be1-6934a4c49682/resourcegroups/ajgtestacr1rg/providers/Microsoft.ContainerRegistry/registries/ajgtestacr1"}')
 tr.setInput('additionalImageTags', process.env[shared.TestEnvVars.additionalImageTags] || '');
 tr.setInput('enforceDockerNamingConvention', process.env[shared.TestEnvVars.enforceDockerNamingConvention]);
+tr.setInput('memory', process.env[shared.TestEnvVars.memory] || '');
 
 console.log("Inputs have been set");
 
@@ -60,6 +61,10 @@ let a = {
            "code": 0,
             "stdout": "successfully ran test/test:2 image"
        },
+       "docker run --rm -m 2GB test/test:2": {
+           "code": 0,
+           "stdout": "successfully ran test/test:2 image"
+       },
        "docker pull test/test:2": {
            "code": 0,
            "stdout": "successfully pulled test/test:2 image"
@@ -74,6 +79,10 @@ a.exec[`docker build -f ${DockerFilePath} -t test/test:2`] = {
     "code": 0,
     "stdout": "successfully build test/test:2 image"
 };
+a.exec[`docker build -f ${DockerFilePath} -t test/test:2 -m 2GB`] = {
+    "code": 0,
+    "stdout": "successfully build test/test:2 image"
+};
 a.exec[`docker build -f ${DockerFilePath} -t test/Te st:2`] = {
     "code": 1,
     "stdout": "test/Te st:2 not valid imagename"

Tasks/Docker/Tests/TestShared.ts

@@ -8,7 +8,8 @@ export let TestEnvVars = {
     includeLatestTag: "__includeLatestTag__",
     imageName: "__imageName__",
     additionalImageTags: "__additionalImageTags__",
-    enforceDockerNamingConvention: "__enforceDockerNamingConvention__"
+    enforceDockerNamingConvention: "__enforceDockerNamingConvention__",
+    memory: "__memory__"
 };
 
 export let OperatingSystems = {

Tasks/Docker/containerbuild.ts

@@ -70,6 +70,11 @@ export function run(connection: ContainerConnection): any {
         command.arg(["-t", baseImageName]);
     }
 
+    var memory = tl.getInput("memory");
+    if (memory) {
+        command.arg(["-m", memory]);
+    }
+
     var context: string;
     var defaultContext = tl.getBoolInput("defaultContext");
     if (defaultContext) {

Tasks/Docker/containerrun.ts

@@ -65,7 +65,12 @@ export function run(connection: ContainerConnection): any {
     if (workDir) {
         command.arg(["-w", workDir]);
     }
-
+
+    var memory = tl.getInput("memory");
+    if (memory) {
+        command.arg(["-m", memory]);
+    }
+
     var imageName = utils.getImageName();
     var qualifyImageName = tl.getBoolInput("qualifyImageName");
     if (qualifyImageName) {

Tasks/Docker/task.json

@@ -13,7 +13,7 @@
     "version": {
         "Major": 0,
         "Minor": 3,
-        "Patch": 6
+        "Patch": 7
     },
     "demands": [],
     "preview": "false",
@@ -294,6 +294,14 @@
             "defaultValue": "$(System.DefaultWorkingDirectory)",
             "helpMarkDown": "Working directory for the Docker command.",
             "groupName": "advanced"
+        },
+        {
+            "name": "memory",
+            "type": "string",
+            "label": "Memory limit",
+            "visibleRule": "action = Build an image || action = Run an image",
+            "helpMarkDown": "The maximum amount of memory available to the container as a integer with optional suffixes like '2GB'.",
+            "groupName": "advanced"
         }
     ],
     "dataSourceBindings": [

Tasks/Docker/task.loc.json

@@ -13,7 +13,7 @@
   "version": {
     "Major": 0,
     "Minor": 3,
-    "Patch": 6
+    "Patch": 7
   },
   "demands": [],
   "preview": "false",
@@ -300,6 +300,14 @@
       "defaultValue": "$(System.DefaultWorkingDirectory)",
       "helpMarkDown": "ms-resource:loc.input.help.cwd",
       "groupName": "advanced"
+    },
+    {
+      "name": "memory",
+      "type": "string",
+      "label": "ms-resource:loc.input.label.memory",
+      "visibleRule": "action = Build an image || action = Run an image",
+      "helpMarkDown": "ms-resource:loc.input.help.memory",
+      "groupName": "advanced"
     }
   ],
   "dataSourceBindings": [