fix: unit and integration tests pass in windows

Author: danielcondemarin

__tests__/index.test.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const ServerlessPluginBuilder = require("../utils/test/ServerlessPluginBuilder");
 const parsedNextConfigurationFactory = require("../utils/test/parsedNextConfigurationFactory");
 const uploadStaticAssetsToS3 = require("../lib/uploadStaticAssetsToS3");
@@ -172,9 +173,10 @@ describe("ServerlessNextJsPlugin", () => {
     });
 
     it("should call uploadStaticAssetsToS3 with bucketName and next static dir", () => {
+      const distDir = 'build';
       parseNextConfiguration.mockReturnValueOnce(
         parsedNextConfigurationFactory({
-          distDir: "build"
+          distDir
         })
       );
 
@@ -184,7 +186,7 @@ describe("ServerlessNextJsPlugin", () => {
 
       return plugin.uploadStaticAssets().then(() => {
         expect(uploadStaticAssetsToS3).toBeCalledWith({
-          staticAssetsPath: "build/static",
+          staticAssetsPath: path.join(distDir, 'static'),
           bucketName: "my-bucket",
           providerRequest: expect.any(Function)
         });

classes/PluginBuildDir.js

@@ -2,13 +2,19 @@ const path = require("path");
 const fs = require("fs-extra");
 const logger = require("../utils/logger");
 
+const BUILD_DIR_NAME = "sls-next-build";
+
 class PluginBuildDir {
   constructor(nextConfigDir) {
     this.nextConfigDir = nextConfigDir;
   }
 
   get buildDir() {
-    return path.join(this.nextConfigDir, "sls-next-build");
+    return path.join(this.nextConfigDir, BUILD_DIR_NAME);
+  }
+
+  get posixBuildDir() {
+    return path.posix.join(this.nextConfigDir, BUILD_DIR_NAME);
   }
 
   setupBuildDir() {

classes/__tests__/NextPage.test.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const NextPage = require("../NextPage");
 
 describe("NextPage", () => {
@@ -12,7 +13,7 @@ describe("NextPage", () => {
 
   describe("When is the index page", () => {
     const buildDir = "build";
-    const pagePath = `${buildDir}/index.js`;
+    const pagePath = path.join(buildDir, 'index.js');
     let page;
 
     beforeEach(() => {
@@ -33,7 +34,7 @@ describe("NextPage", () => {
 
   describe("When is the _error page", () => {
     const buildDir = "build";
-    const pagePath = `${buildDir}/_error.js`;
+    const pagePath = path.join(buildDir, '_error.js');
     let page;
 
     beforeEach(() => {
@@ -58,7 +59,7 @@ describe("NextPage", () => {
 
   describe("When is a nested page", () => {
     const buildDir = "build";
-    const pagePath = `${buildDir}/categories/fridge/fridges.js`;
+    const pagePath = path.join(buildDir, 'categories/fridge/fridges.js');
     let page;
 
     beforeEach(() => {
@@ -103,11 +104,11 @@ describe("NextPage", () => {
     });
 
     it("should have pageCompatPath", () => {
-      expect(page.pageCompatPath).toEqual(`${buildDir}/admin.compat.js`);
+      expect(page.pageCompatPath).toEqual(path.join(buildDir, "admin.compat.js"));
     });
 
     it("should return pageOriginalPath", () => {
-      expect(page.pageOriginalPath).toEqual(`${buildDir}/admin.original.js`);
+      expect(page.pageOriginalPath).toEqual(path.join(buildDir, "admin.original.js"));
     });
 
     it("should return pageDir", () => {

classes/__tests__/PluginBuildDir.test.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const fs = require("fs-extra");
 const PluginBuildDir = require("../PluginBuildDir");
 const logger = require("../../utils/logger");
@@ -17,14 +18,19 @@ describe("PluginBuildDir", () => {
 
   describe("When a new instance is created", () => {
     let pluginBuildDir;
+    let nextConfigDir;
 
     beforeEach(() => {
-      const nextConfigDir = "path/to/nextApp";
+      nextConfigDir = "path/to/nextApp";
       pluginBuildDir = new PluginBuildDir(nextConfigDir);
     });
 
-    it("should have buildDir one level above nextBuild", () => {
-      expect(pluginBuildDir.buildDir).toEqual("path/to/nextApp/sls-next-build");
+    it("should have buildDir at same level as next config.", () => {
+      expect(pluginBuildDir.buildDir).toEqual(path.join(nextConfigDir, 'sls-next-build'));
+    });
+
+    it("should have posixBuildDir regardless the platform", () => {
+      expect(pluginBuildDir.posixBuildDir).toEqual("path/to/nextApp/sls-next-build");
     });
   });
 

index.js

@@ -53,7 +53,7 @@ class ServerlessNextJsPlugin {
     const servicePackage = this.serverless.service.package;
 
     servicePackage.include = servicePackage.include || [];
-    servicePackage.include.push(path.join(pluginBuildDir.buildDir, "**"));
+    servicePackage.include.push(path.posix.join(pluginBuildDir.posixBuildDir, "**"));
     return build(pluginBuildDir, this.getPluginConfigValue("pageConfig")).then(
       nextPages => this.setNextPages(nextPages)
     );

lib/__tests__/copyBuildFiles.test.js

@@ -13,8 +13,8 @@ describe("copyBuildFiles", () => {
 
   describe("when page files are copied correctly", () => {
     let pluginBuildDirObj;
-    const pluginBuildDir = "path/to/sls-next-build";
-    const nextBuildDir = "path/to/.next";
+    const pluginBuildDir = path.normalize("path/to/sls-next-build");
+    const nextBuildDir = path.normalize("path/to/.next");
 
     beforeEach(() => {
       fse.copy.mockResolvedValue(null);
@@ -39,7 +39,7 @@ describe("copyBuildFiles", () => {
 
     it("should copy serverless pages folder from next build directory", () => {
       expect(fse.copy).toBeCalledWith(
-        `${nextBuildDir}/serverless/pages`,
+        path.join(nextBuildDir, 'serverless/pages'),
         pluginBuildDir
       );
     });
@@ -51,7 +51,7 @@ describe("copyBuildFiles", () => {
     it("should call fs copy with the compatLayer file", () => {
       expect(fse.copy).toBeCalledWith(
         path.join(__dirname, "..", `compatLayer.js`),
-        `${pluginBuildDir}/compatLayer.js`
+        path.join(pluginBuildDir, 'compatLayer.js')
       );
     });
   });

lib/__tests__/getCompatLayerCode.test.js

@@ -1,30 +1,31 @@
+const path = require('path');
 const getCompatLayerCode = require("../getCompatLayerCode");
 
 describe("getCompatLayerCode", () => {
   it("should require compatLayer", () => {
     const compatHandlerContent = getCompatLayerCode(
-      "sls-next-build/my-page.js"
+      path.join("sls-next-build", "my-page.js")
     );
     expect(compatHandlerContent).toContain('require("./compatLayer")');
   });
 
   it("should require compatLayer with correct path when page is nested", () => {
     const compatHandlerContent = getCompatLayerCode(
-      "sls-next-build/categories/fridge/fridges.js"
+      path.join("sls-next-build", "categories/fridge/fridges.js")
     );
     expect(compatHandlerContent).toContain('require("../../compatLayer")');
   });
 
   it("should require next page provided", () => {
     const compatHandlerContent = getCompatLayerCode(
-      "sls-next-build/my-page.js"
+      path.join("sls-next-build", "my-page.js")
     );
     expect(compatHandlerContent).toContain('require("./my-page.original.js")');
   });
 
   it("should export render method", () => {
     const compatHandlerContent = getCompatLayerCode(
-      "sls-next-build/my-page.js"
+      path.join("sls-next-build", "my-page.js")
     );
     expect(compatHandlerContent).toContain("module.exports.render");
   });

lib/__tests__/getNextPagesFromBuildDir.test.js

@@ -26,7 +26,9 @@ describe("getNextPagesFromBuildDir", () => {
   it("should return an empty array when there are no pages", () => {
     expect.assertions(1);
 
-    const getPagesPromise = getNextPagesFromBuildDir("/path/to/build/dir").then(
+    const buildDir = path.normalize("/path/to/build/dir")
+
+    const getPagesPromise = getNextPagesFromBuildDir(buildDir).then(
       nextPages => {
         expect(nextPages).toEqual([]);
       }
@@ -46,9 +48,9 @@ describe("getNextPagesFromBuildDir", () => {
     const promise = getNextPagesFromBuildDir(buildDir).then(nextPages => {
       expect(nextPages).toHaveLength(2);
       expect(nextPages[0].pageName).toEqual("index");
-      expect(nextPages[0].pagePath).toEqual("build/index.js");
+      expect(nextPages[0].pagePath).toEqual(path.join('build', 'index.js'));
       expect(nextPages[1].pageName).toEqual("about");
-      expect(nextPages[1].pagePath).toEqual("build/about.js");
+      expect(nextPages[1].pagePath).toEqual(path.join('build', 'about.js'));
     });
 
     mockedStream.emit("data", {
@@ -73,7 +75,9 @@ describe("getNextPagesFromBuildDir", () => {
       about: aboutPageConfigOverride
     };
 
-    const promise = getNextPagesFromBuildDir("/path/to/build", pageConfig).then(
+    const buildDir = path.normalize('/path/to/build');
+
+    const promise = getNextPagesFromBuildDir(buildDir, pageConfig).then(
       nextPages => {
         expect(nextPages[0].serverlessFunctionOverrides).toEqual(
           indexPageConfigOverride
@@ -84,8 +88,8 @@ describe("getNextPagesFromBuildDir", () => {
       }
     );
 
-    mockedStream.emit("data", { path: `/path/to/build/index.js` });
-    mockedStream.emit("data", { path: `/path/to/build/about.js` });
+    mockedStream.emit("data", { path: path.join(buildDir, "index.js") });
+    mockedStream.emit("data", { path: path.join(buildDir, "about.js") });
     mockedStream.emit("end");
 
     return promise;
@@ -94,11 +98,13 @@ describe("getNextPagesFromBuildDir", () => {
   it("should log pages found", () => {
     expect.assertions(1);
 
-    const promise = getNextPagesFromBuildDir("/path/to/build").then(() => {
+    const buildDir = path.normalize('/path/to/build');
+
+    const promise = getNextPagesFromBuildDir(buildDir).then(() => {
       expect(logger.log).toBeCalledWith(`Found 1 next page(s)`);
     });
 
-    mockedStream.emit("data", { path: `/path/to/build/about.js` });
+    mockedStream.emit("data", { path: path.join(buildDir, "about.js") });
     mockedStream.emit("end");
 
     return promise;
@@ -107,7 +113,7 @@ describe("getNextPagesFromBuildDir", () => {
   it("should skip _app and _document pages", () => {
     expect.assertions(2);
 
-    const buildDir = "./build";
+    const buildDir = path.normalize("./build");
     const resolvedBuildDir = path.resolve(buildDir);
 
     const promise = getNextPagesFromBuildDir(buildDir).then(nextPages => {
@@ -130,15 +136,17 @@ describe("getNextPagesFromBuildDir", () => {
   it("should skip compatLayer file", () => {
     expect.assertions(2);
 
-    const promise = getNextPagesFromBuildDir("/path/to/build").then(
+    const buildDir = path.normalize('/path/to/build');
+
+    const promise = getNextPagesFromBuildDir(buildDir).then(
       nextPages => {
         expect(nextPages).toHaveLength(1);
         expect(nextPages[0].pageName).toEqual("home");
       }
     );
 
-    mockedStream.emit("data", { path: `/path/to/build/compatLayer.js` });
-    mockedStream.emit("data", { path: `/path/to/build/home.js` });
+    mockedStream.emit("data", { path: path.join(buildDir, "compatLayer.js") });
+    mockedStream.emit("data", { path: path.join(buildDir, "home.js") });
     mockedStream.emit("end");
 
     return promise;
@@ -147,22 +155,22 @@ describe("getNextPagesFromBuildDir", () => {
   it("should handle nested pages", () => {
     expect.assertions(5);
 
-    const buildDir = "./build";
+    const buildDir = path.normalize("./build");
     const resolvedBuildDir = path.resolve(buildDir);
 
     const promise = getNextPagesFromBuildDir(buildDir).then(nextPages => {
       expect(nextPages).toHaveLength(2);
       expect(nextPages[0].pageName).toEqual("hello-world");
-      expect(nextPages[0].pagePath).toEqual("build/one/hello-world.js");
+      expect(nextPages[0].pagePath).toEqual(path.join(buildDir, "one", "hello-world.js"));
       expect(nextPages[1].pageName).toEqual("hello-world");
-      expect(nextPages[1].pagePath).toEqual("build/one/two/hello-world.js");
+      expect(nextPages[1].pagePath).toEqual(path.join(buildDir, "one", "two", "hello-world.js"));
     });
 
     mockedStream.emit("data", {
-      path: path.join(resolvedBuildDir, "one/hello-world.js")
+      path: path.join(resolvedBuildDir, "one", "hello-world.js")
     });
     mockedStream.emit("data", {
-      path: path.join(resolvedBuildDir, "one/two/hello-world.js")
+      path: path.join(resolvedBuildDir, "one", "two", "hello-world.js")
     });
     mockedStream.emit("end");
 
@@ -172,7 +180,7 @@ describe("getNextPagesFromBuildDir", () => {
   it("should skip page directories", () => {
     expect.assertions(1);
 
-    const buildDir = "./build";
+    const buildDir = path.normalize("./build");
     const resolvedBuildDir = path.resolve(buildDir);
     fs.lstatSync.mockReturnValue({ isDirectory: () => true });
 
@@ -181,10 +189,10 @@ describe("getNextPagesFromBuildDir", () => {
     });
 
     mockedStream.emit("data", {
-      path: path.join(resolvedBuildDir, "one/")
+      path: path.join(resolvedBuildDir, "one")
     });
     mockedStream.emit("data", {
-      path: path.join(resolvedBuildDir, "one/two/")
+      path: path.join(resolvedBuildDir, "one", "two")
     });
     mockedStream.emit("end");