fix(container): honor .dockerignore when building a container (#277)

Author: norbjd

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.16
+
+### Fixed
+
+- Honor `.dockerignore` when building a container #277
+
 ## 0.4.15
 
 ### Added

deploy/lib/buildAndPushContainers.js

@@ -1,7 +1,8 @@
 "use strict";
 
 const Docker = require("dockerode");
-const tar = require("tar-fs");
+const path = require("path");
+const fs = require("fs");
 
 const docker = new Docker();
 
@@ -44,6 +45,34 @@ function findErrorInBuildOutput(buildOutput) {
   }
 }
 
+function getFilesInBuildContextDirectory(directory) {
+  let files = [];
+
+  try {
+    const dirents = fs.readdirSync(directory, { withFileTypes: true });
+
+    dirents.forEach((dirent) => {
+      const absolutePath = path.join(directory, dirent.name);
+      if (dirent.isDirectory()) {
+        const subFiles = getFilesInBuildContextDirectory(absolutePath);
+
+        // Prepend the current directory name to each subfile path
+        const relativeSubFiles = subFiles.map((subFile) =>
+          path.join(dirent.name, subFile)
+        );
+        files = files.concat(relativeSubFiles);
+      } else if (dirent.isFile() && dirent.name !== ".dockerignore") {
+        // Don't include .dockerignore file in result
+        files.push(dirent.name);
+      }
+    });
+  } catch (err) {
+    console.error(`Error reading directory ${directory}:`, err);
+  }
+
+  return files;
+}
+
 module.exports = {
   async buildAndPushContainers() {
     // used for pushing
@@ -71,7 +100,6 @@ module.exports = {
       if (container["directory"] === undefined) {
         return;
       }
-      const tarStream = tar.pack(`./${container.directory}`);
       const imageName = `${this.namespace.registry_endpoint}/${container.name}:latest`;
 
       this.serverless.cli.log(
@@ -80,10 +108,15 @@ module.exports = {
 
       // eslint-disable-next-line no-async-promise-executor
       return new Promise(async (resolve, reject) => {
-        const buildStream = await docker.buildImage(tarStream, {
-          t: imageName,
-          registryconfig: registryAuth,
-        });
+        let files = getFilesInBuildContextDirectory(container.directory);
+
+        const buildStream = await docker.buildImage(
+          { context: container.directory, src: files },
+          {
+            t: imageName,
+            registryconfig: registryAuth,
+          }
+        );
         const buildStreamEvents = await extractStreamContents(
           buildStream,
           this.provider.options.verbose

examples/go/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-scaleway-functions",
-  "version": "0.4.15",
+  "version": "0.4.16",
   "description": "Provider plugin for the Serverless Framework v3.x which adds support for Scaleway Functions.",
   "main": "index.js",
   "author": "scaleway.com",
@@ -57,8 +57,7 @@
     "axios": "^1.4.0",
     "bluebird": "^3.7.2",
     "dockerode": "^4.0.6",
-    "js-yaml": "^4.1.0",
-    "tar-fs": "^2.1.1"
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.27.0",

package-lock.json

@@ -1,7 +1,7 @@
 const axios = require("axios");
 const https = require("https");
 
-const version = "0.4.15";
+const version = "0.4.16";
 
 const invalidArgumentsType = "invalid_arguments";
 

package.json

@@ -3,7 +3,6 @@
 const Docker = require("dockerode");
 const fs = require("fs");
 const path = require("path");
-const tar = require("tar-fs");
 
 const { afterAll, beforeAll, describe, it, expect } = require("@jest/globals");
 
@@ -113,12 +112,16 @@ describe("Service Lifecyle Integration Test", () => {
 
     await docker.checkAuth(registryAuth);
 
-    const tarStream = tar.pack(path.join(tmpDir, "my-container"));
-
-    await docker.buildImage(tarStream, {
-      t: imageName,
-      registryconfig: registryAuth,
-    });
+    await docker.buildImage(
+      {
+        context: path.join(tmpDir, "my-container"),
+        src: ["Dockerfile", "server.py", "requirements.txt"],
+      },
+      {
+        t: imageName,
+        registryconfig: registryAuth,
+      }
+    );
     const image = docker.getImage(imageName);
     await image.push(auth);