Containers: improve error messages to users (#95)

- send a message if image could not be built
- send a message if image have the wrong architecture

Author: norbjd

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.4.1
+
+### Added
+
+- clearer error messages when building a container with a different architecture than expected `amd64` [#95](https://github.com/scaleway/serverless-scaleway-functions/pull/95)
+
+### Fixed
+
+- fix tests [#96](https://github.com/scaleway/serverless-scaleway-functions/pull/96)
+
 ## 0.4.0
 ### Added
 - `serverless info` command to work with serverless compose

deploy/lib/buildAndPushContainers.js

@@ -0,0 +1,67 @@
+'use strict';
+
+const Docker = require('dockerode');
+const tar = require('tar-fs');
+
+const docker = new Docker();
+
+const promisifyStream = (stream, verbose) => new Promise((resolve, reject) => {
+  stream.on('data', (data) => {
+    if (verbose) {
+      console.log(data.toString().replace('\n', ''));
+    }
+  });
+  stream.on('end', resolve);
+  stream.on('error', reject);
+});
+
+module.exports = {
+  buildAndPushContainers() {
+    const auth = {
+      username: 'any',
+      password: this.provider.scwToken,
+    };
+
+    const containerNames = Object.keys(this.containers);
+    const promises = containerNames.map((containerName) => {
+      const container = this.containers[containerName];
+      const tarStream = tar.pack(`./${container.directory}`);
+      const imageName = `${this.namespace.registry_endpoint}/${container.name}:latest`;
+
+      this.serverless.cli.log(`Building and pushing container ${container.name} to: ${imageName} ...`);
+
+      return new Promise(async (resolve, reject) => {
+        const buildStream = await docker.buildImage(tarStream, { t: imageName })
+        await promisifyStream(buildStream, this.provider.options.verbose);
+
+        const image = docker.getImage(imageName)
+
+        const inspectedImage = await image.inspect()
+          .catch(() => reject("Error during build of the image "+imageName+": run --verbose to see the error"));
+
+        if (inspectedImage === undefined) {
+          return
+        }
+
+        if (inspectedImage['Architecture'] !== 'amd64') {
+          reject("It appears that image have been built with " + inspectedImage['Architecture'] + " architecture. " +
+            "To build a compatible image with Scaleway serverless containers, " +
+            "the platform of the built image must be `linux/amd64`. " +
+            "Please pull your image's base image with platform `linux/amd64`: " +
+            "first (`docker pull --platform=linux/amd64 <your_base_image>`), " +
+            "and just after, run `serverless deploy`. You shouldn't pull the other " +
+            "image architecture between those two steps.")
+          return
+        }
+
+        const pushStream = await image.push(auth);
+        await promisifyStream(pushStream, this.provider.options.verbose);
+
+        resolve();
+      });
+    });
+
+    return Promise.all(promises);
+  },
+
+};

deploy/lib/pushContainers.js

@@ -4,7 +4,7 @@ const setUpDeployment = require('../shared/setUpDeployment');
 const createNamespace = require('./lib/createNamespace');
 const createFunctions = require('./lib/createFunctions');
 const createContainers = require('./lib/createContainers');
-const pushContainers = require('./lib/pushContainers');
+const buildAndPushContainers = require('./lib/buildAndPushContainers');
 const uploadCode = require('./lib/uploadCode');
 const deployFunctions = require('./lib/deployFunctions');
 const deployContainers = require('./lib/deployContainers');
@@ -28,7 +28,7 @@ class ScalewayDeploy {
       createNamespace,
       createFunctions,
       createContainers,
-      pushContainers,
+      buildAndPushContainers,
       uploadCode,
       deployFunctions,
       deployContainers,
@@ -42,7 +42,7 @@ class ScalewayDeploy {
           && this.provider.serverless.service.custom.containers
           && Object.keys(this.provider.serverless.service.custom.containers).length !== 0) {
         return this.createContainers()
-          .then(this.pushContainers)
+          .then(this.buildAndPushContainers)
           .then(this.deployContainers);
       }
       return undefined;

deploy/scalewayDeploy.js

@@ -10,7 +10,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/container-schedule/package.json

@@ -10,7 +10,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/container/package.json

@@ -9,7 +9,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/go/package.json

@@ -9,7 +9,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/go113/package.json

@@ -10,7 +10,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/multiple/package.json

@@ -11,7 +11,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/nodejs-es-modules/package.json

@@ -10,7 +10,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/nodejs-schedule/package.json

@@ -10,7 +10,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/nodejs/package.json

@@ -10,7 +10,7 @@
   "license": "ISC",
   "dependencies": {},
   "devDependencies": {
-    "serverless-scaleway-functions": "^0.4.0"
+    "serverless-scaleway-functions": "^0.4.1"
   },
   "description": ""
 }

examples/python3/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-scaleway-functions",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Provider plugin for the Serverless Framework v1.x which adds support for Scaleway Functions.",
   "main": "index.js",
   "author": "scaleway.com",