Add multi-platform builds

.azure-devops/azure-pipelines.yml

@@ -145,3 +145,38 @@ jobs:
       inputs:
         subFolder: github-tests/Dockerfile/build-only
 
+  - job: test_platform_with_runcmd
+    displayName: Test with platform and runCmd
+    steps:
+    - script: |
+        docker login -u $ACR_USERNAME -p $ACR_TOKEN $(ACR_NAME).azurecr.io
+      displayName: 'Log in to Azure Container Registry'
+      env:
+        ACR_NAME: $(ACR_NAME)
+        ACR_TOKEN: $(ACR_TOKEN)
+        ACR_USERNAME: $(ACR_USERNAME)
+
+    - script: |
+        printenv | sort
+      env:
+        IMAGE_TAG: $(IMAGE_TAG)
+
+    - script: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+      displayName: Set up QEMU
+
+    - script: docker buildx create --use
+      displayName: Set up docker buildx
+
+    - task: DevcontainersCi@0
+      inputs:
+        imageName: '$(ACR_NAME).azurecr.io/devcontainers-ci/azdo-devcontainer-build-run/test/platform-with-runcmd'
+        subFolder: github-tests/Dockerfile/platform-with-runcmd
+        platform: linux/amd64,linux/arm64
+        runCmd: echo $HOSTNAME && [[ $HOSTNAME == "my-host" ]]
+
+    - script: |
+        echo "'runCmdOutput' value: $runCmdOutput"
+        if [["$runCmdOutput" = *my-host*]]; then
+          echo "'runCmdOutput' output of test_simple job doesn't contain expected value 'my-host'"
+          exit 1
+        fi

.github/workflows/ci_common.yml

@@ -180,6 +180,7 @@ jobs:
       - test-compose-features
       - test-simple
       - test-no-run
+      - test-platform-with-runcmd
     runs-on: ubuntu-latest
     if: ${{ inputs.prHeadSha }}
     steps:
@@ -756,3 +757,52 @@ jobs:
         uses: ./
         with:
           subFolder: github-tests/Dockerfile/build-only
+
+  test-platform-with-runcmd:
+    name: Run GitHub platform and runCmd test
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+          # if the following value is missing (i.e. not triggered via comment workflow)
+          # then the default checkout will apply
+          ref: ${{ inputs.prRef }}
+
+      - name: Set up QEMU for multi-architecture builds
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1 
+        if: ${{ needs.build.outputs.image_push_option == 'filter' }}
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run test
+        uses: ./
+        id: platform-with-runcmd
+        with:
+          subFolder: github-tests/Dockerfile/platform-with-runcmd
+          imageName: ghcr.io/devcontainers/ci/tests/platform-with-runcmd
+          platform: linux/amd64,linux/arm64
+          runCmd: echo $HOSTNAME && [[ $HOSTNAME == "my-host" ]]
+          push: ${{ needs.build.outputs.image_push_option }}
+          eventFilterForPush: |
+            push
+            pull_request
+      - name: Validate runCmdOutput output
+        run: |
+          echo "'runCmdOutput' value: $runCmdOutput"
+          if [["$runCmdOutput" = *my-host*]]; then
+            echo "'runCmdOutput' output of platform-with-runcmd step doesn't contain expected value 'my-host'"
+            exit 1
+          fi
+        env:
+          runCmdOutput: ${{ steps.platform-with-runcmd.outputs.runCmdOutput }}

action.yml

@@ -11,6 +11,9 @@ inputs:
   imageTag:
     required: false
     description: Image tag (defaults to latest)
+  platform:
+    require: false
+    description: Platforms for which the image should be built. If omitted, defaults to the platform of the GitHub Actions Runner. Multiple platforms should be comma separated.
   runCmd:
     required: false
     description: Specify the command to run after building the dev container image. Can be omitted to skip starting the container.

azdo-task/DevcontainersCi/dist/dev-container-cli.d.ts

@@ -15,8 +15,10 @@ export interface DevContainerCliBuildResult extends DevContainerCliSuccessResult
 export interface DevContainerCliBuildArgs {
     workspaceFolder: string;
     imageName?: string;
+    platform?: string;
     additionalCacheFroms?: string[];
     userDataFolder?: string;
+    output?: string;
 }
 declare function devContainerBuild(args: DevContainerCliBuildArgs, log: (data: string) => void): Promise<DevContainerCliBuildResult | DevContainerCliError>;
 export interface DevContainerCliUpResult extends DevContainerCliSuccessResult {

azdo-task/DevcontainersCi/dist/index.js

@@ -227,6 +227,7 @@ const path_1 = __importDefault(__nccwpck_require__(5622));
 const envvars_1 = __nccwpck_require__(9243);
 const dev_container_cli_1 = __nccwpck_require__(4624);
 const docker_1 = __nccwpck_require__(3758);
+const skopeo_1 = __nccwpck_require__(9898);
 const exec_1 = __nccwpck_require__(7757);
 function runMain() {
     var _a, _b, _c, _d, _e, _f, _g;
@@ -250,12 +251,21 @@ function runMain() {
             const checkoutPath = (_a = task.getInput('checkoutPath')) !== null && _a !== void 0 ? _a : '';
             const imageName = task.getInput('imageName');
             const imageTag = task.getInput('imageTag');
+            const platform = task.getInput('platform');
             const subFolder = (_b = task.getInput('subFolder')) !== null && _b !== void 0 ? _b : '.';
             const runCommand = task.getInput('runCmd');
             const envs = (_d = (_c = task.getInput('env')) === null || _c === void 0 ? void 0 : _c.split('\n')) !== null && _d !== void 0 ? _d : [];
             const inputEnvsWithDefaults = envvars_1.populateDefaults(envs);
             const cacheFrom = (_f = (_e = task.getInput('cacheFrom')) === null || _e === void 0 ? void 0 : _e.split('\n')) !== null && _f !== void 0 ? _f : [];
             const skipContainerUserIdUpdate = ((_g = task.getInput('skipContainerUserIdUpdate')) !== null && _g !== void 0 ? _g : 'false') === 'true';
+            if (platform) {
+                const skopeoInstalled = yield skopeo_1.isSkopeoInstalled();
+                if (!skopeoInstalled) {
+                    console.log('skopeo not available and is required for multi-platform builds - make sure it is installed on your build agent');
+                    return;
+                }
+            }
+            const buildxOutput = platform ? 'type=oci,dest=/tmp/output.tar' : undefined;
             const log = (message) => console.log(message);
             const workspaceFolder = path_1.default.resolve(checkoutPath, subFolder);
             const fullImageName = imageName
@@ -276,7 +286,9 @@ function runMain() {
             const buildArgs = {
                 workspaceFolder,
                 imageName: fullImageName,
+                platform,
                 additionalCacheFroms: cacheFrom,
+                output: buildxOutput,
             };
             console.log('\n\n');
             console.log('***');
@@ -350,7 +362,7 @@ function runMain() {
 }
 exports.runMain = runMain;
 function runPost() {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     return __awaiter(this, void 0, void 0, function* () {
         const pushOption = task.getInput('push');
         const imageName = task.getInput('imageName');
@@ -399,14 +411,85 @@ function runPost() {
             }
             return;
         }
-        const imageTag = task.getInput('imageTag');
-        console.log(`Pushing image ''${imageName}:${imageTag !== null && imageTag !== void 0 ? imageTag : 'latest'}...`);
-        yield docker_1.pushImage(imageName, imageTag);
+        const imageTag = (_f = task.getInput('imageTag')) !== null && _f !== void 0 ? _f : 'latest';
+        const platform = task.getInput('platform');
+        if (platform) {
+            console.log(`Copying multiplatform image ''${imageName}:${imageTag}...`);
+            const imageSource = 'oci-archive:/tmp/output.tar';
+            const imageDest = `docker://${imageName}:${imageTag}`;
+            yield skopeo_1.copyImage(true, imageSource, imageDest);
+        }
+        else {
+            console.log(`Pushing image ''${imageName}:${imageTag}...`);
+            yield docker_1.pushImage(imageName, imageTag);
+        }
     });
 }
 exports.runPost = runPost;
 
 
+/***/ }),
+
+/***/ 9898:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.copyImage = exports.isSkopeoInstalled = void 0;
+const task = __importStar(__nccwpck_require__(347));
+const skopeo = __importStar(__nccwpck_require__(2754));
+const exec_1 = __nccwpck_require__(7757);
+function isSkopeoInstalled() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield skopeo.isSkopeoInstalled(exec_1.exec);
+    });
+}
+exports.isSkopeoInstalled = isSkopeoInstalled;
+function copyImage(all, source, dest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log('📌 Copying image...');
+        try {
+            yield skopeo.copyImage(exec_1.exec, all, source, dest);
+            return true;
+        }
+        catch (error) {
+            task.setResult(task.TaskResult.Failed, error);
+            return false;
+        }
+    });
+}
+exports.copyImage = copyImage;
+
+
 /***/ }),
 
 /***/ 6526:
@@ -17008,6 +17091,12 @@ function devContainerBuild(args, log) {
         if (args.imageName) {
             commandArgs.push('--image-name', args.imageName);
         }
+        if (args.platform) {
+            commandArgs.push('--platform', args.platform);
+        }
+        if (args.output) {
+            commandArgs.push('--output', args.output);
+        }
         if (args.userDataFolder) {
             commandArgs.push("--user-data-folder", args.userDataFolder);
         }
@@ -17509,6 +17598,47 @@ function populateDefaults(envs) {
 }
 
 
+/***/ }),
+
+/***/ 2754:
+/***/ ((__unused_webpack_module, __webpack_exports__, __nccwpck_require__) => {
+
+"use strict";
+__nccwpck_require__.r(__webpack_exports__);
+/* harmony export */ __nccwpck_require__.d(__webpack_exports__, {
+/* harmony export */   "isSkopeoInstalled": () => (/* binding */ isSkopeoInstalled),
+/* harmony export */   "copyImage": () => (/* binding */ copyImage)
+/* harmony export */ });
+var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+function isSkopeoInstalled(exec) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { exitCode } = yield exec('skopeo', ['--help'], { silent: true });
+        return exitCode === 0;
+    });
+}
+function copyImage(exec, all, source, dest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const args = ['copy'];
+        if (all) {
+            args.push('--all');
+        }
+        args.push(source, dest);
+        const { exitCode } = yield exec('skopeo', args, {});
+        if (exitCode !== 0) {
+            throw new Error(`skopeo copy failed with ${exitCode}`);
+        }
+    });
+}
+
+
 /***/ }),
 
 /***/ 2357:

azdo-task/DevcontainersCi/dist/skopeo.d.ts

@@ -0,0 +1,3 @@
+import { ExecFunction } from './exec';
+export declare function isSkopeoInstalled(exec: ExecFunction): Promise<boolean>;
+export declare function copyImage(exec: ExecFunction, all: boolean, source: string, dest: string): Promise<void>;

azdo-task/DevcontainersCi/lib/main.js

@@ -38,6 +38,7 @@ const path_1 = __importDefault(require("path"));
 const envvars_1 = require("../../../common/src/envvars");
 const dev_container_cli_1 = require("../../../common/src/dev-container-cli");
 const docker_1 = require("./docker");
+const skopeo_1 = require("./skopeo");
 const exec_1 = require("./exec");
 function runMain() {
     var _a, _b, _c, _d, _e, _f, _g;
@@ -61,12 +62,21 @@ function runMain() {
             const checkoutPath = (_a = task.getInput('checkoutPath')) !== null && _a !== void 0 ? _a : '';
             const imageName = task.getInput('imageName');
             const imageTag = task.getInput('imageTag');
+            const platform = task.getInput('platform');
             const subFolder = (_b = task.getInput('subFolder')) !== null && _b !== void 0 ? _b : '.';
             const runCommand = task.getInput('runCmd');
             const envs = (_d = (_c = task.getInput('env')) === null || _c === void 0 ? void 0 : _c.split('\n')) !== null && _d !== void 0 ? _d : [];
             const inputEnvsWithDefaults = envvars_1.populateDefaults(envs);
             const cacheFrom = (_f = (_e = task.getInput('cacheFrom')) === null || _e === void 0 ? void 0 : _e.split('\n')) !== null && _f !== void 0 ? _f : [];
             const skipContainerUserIdUpdate = ((_g = task.getInput('skipContainerUserIdUpdate')) !== null && _g !== void 0 ? _g : 'false') === 'true';
+            if (platform) {
+                const skopeoInstalled = yield skopeo_1.isSkopeoInstalled();
+                if (!skopeoInstalled) {
+                    console.log('skopeo not available and is required for multi-platform builds - make sure it is installed on your build agent');
+                    return;
+                }
+            }
+            const buildxOutput = platform ? 'type=oci,dest=/tmp/output.tar' : undefined;
             const log = (message) => console.log(message);
             const workspaceFolder = path_1.default.resolve(checkoutPath, subFolder);
             const fullImageName = imageName
@@ -87,7 +97,9 @@ function runMain() {
             const buildArgs = {
                 workspaceFolder,
                 imageName: fullImageName,
+                platform,
                 additionalCacheFroms: cacheFrom,
+                output: buildxOutput,
             };
             console.log('\n\n');
             console.log('***');
@@ -161,7 +173,7 @@ function runMain() {
 }
 exports.runMain = runMain;
 function runPost() {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     return __awaiter(this, void 0, void 0, function* () {
         const pushOption = task.getInput('push');
         const imageName = task.getInput('imageName');
@@ -210,9 +222,18 @@ function runPost() {
             }
             return;
         }
-        const imageTag = task.getInput('imageTag');
-        console.log(`Pushing image ''${imageName}:${imageTag !== null && imageTag !== void 0 ? imageTag : 'latest'}...`);
-        yield docker_1.pushImage(imageName, imageTag);
+        const imageTag = (_f = task.getInput('imageTag')) !== null && _f !== void 0 ? _f : 'latest';
+        const platform = task.getInput('platform');
+        if (platform) {
+            console.log(`Copying multiplatform image ''${imageName}:${imageTag}...`);
+            const imageSource = 'oci-archive:/tmp/output.tar';
+            const imageDest = `docker://${imageName}:${imageTag}`;
+            yield skopeo_1.copyImage(true, imageSource, imageDest);
+        }
+        else {
+            console.log(`Pushing image ''${imageName}:${imageTag}...`);
+            yield docker_1.pushImage(imageName, imageTag);
+        }
     });
 }
 exports.runPost = runPost;