feature request: Support build a project as monorepo-like (#14)

mthenw · May 6, 2021 · 382dabd · 382dabd
1 parent 0b71429
commit 382dabd
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -53,6 +53,7 @@ custom:
     binDir: .bin # target folder for binary files
     cgo: 0 # CGO_ENABLED flag
     cmd: GOOS=linux go build -ldflags="-s -w"' # compile command
+    monorepo: false # if enabled, builds function every directory (useful for monorepo where go.mod is managed by each function
 ```
 
 ## How does it work?

diff --git a/index.js b/index.js
@@ -12,6 +12,7 @@ const ConfigDefaults = {
   binDir: ".bin",
   cgo: 0,
   cmd: 'GOOS=linux go build -ldflags="-s -w"',
+  monorepo: false,
 };
 
 const GoRuntime = "go1.x";
@@ -102,13 +103,25 @@ module.exports = class Plugin {
 
     const absHandler = path.resolve(config.baseDir);
     const absBin = path.resolve(config.binDir);
-    const compileBinPath = path.join(path.relative(absHandler, absBin), name); // binPath is based on cwd no baseDir
+    let compileBinPath = path.join(path.relative(absHandler, absBin), name); // binPath is based on cwd no baseDir
+    let cwd = config.baseDir;
+    let handler = func.handler;
+    if (config.monorepo) {
+      if (func.handler.endsWith(".go")) {
+        cwd = path.relative(absHandler, path.dirname(func.handler));
+        handler = path.basename(handler);
+      } else {
+        cwd = path.relative(absHandler, func.handler);
+        handler = ".";
+      }
+      compileBinPath = path.relative(cwd, compileBinPath);
+    }
     try {
       const [env, command] = parseCommand(
-        `${config.cmd} -o ${compileBinPath} ${func.handler}`
+        `${config.cmd} -o ${compileBinPath} ${handler}`
       );
       await exec(command, {
-        cwd: config.baseDir,
+        cwd: cwd,
         env: Object.assign(
           {},
           process.env,
@@ -119,7 +132,7 @@ module.exports = class Plugin {
     } catch (e) {
       this.serverless.cli.consoleLog(
         `Go Plugin: ${chalk.yellow(
-          `Error compiling "${name}" function (cwd: ${config.baseDir}): ${e.message}`
+          `Error compiling "${name}" function (cwd: ${cwd}): ${e.message}`
         )}`
       );
       process.exit(1);

diff --git a/index.test.js b/index.test.js
@@ -284,6 +284,54 @@ describe("Go Plugin", () => {
       );
       expect(execStub.firstCall.args[1].cwd).to.equal(".");
     });
+
+    it("compiles Go function w/ monorepo", async () => {
+      // given
+      const config = merge(
+        {
+          service: {
+            custom: {
+              go: {
+                monorepo: true,
+              },
+            },
+            functions: {
+              testFunc1: {
+                name: "testFunc1",
+                runtime: "go1.x",
+                handler: "functions/func1",
+              },
+              testFunc2: {
+                name: "testFunc2",
+                runtime: "go1.x",
+                handler: "functions/func2/main.go",
+              },
+            },
+          },
+        },
+        serverlessStub
+      );
+      const plugin = new Plugin(config);
+
+      // when
+      await plugin.hooks["before:package:createDeploymentArtifacts"]();
+
+      // then
+      expect(config.service.functions.testFunc1.handler).to.equal(
+        `.bin/testFunc1`
+      );
+      expect(execStub).to.have.been.calledWith(
+        `go build -ldflags="-s -w" -o ../../.bin/testFunc1 .`
+      );
+      expect(execStub.firstCall.args[1].cwd).to.equal("functions/func1");
+      expect(config.service.functions.testFunc2.handler).to.equal(
+        `.bin/testFunc2`
+      );
+      expect(execStub).to.have.been.calledWith(
+        `go build -ldflags="-s -w" -o ../../.bin/testFunc2 main.go`
+      );
+      expect(execStub.secondCall.args[1].cwd).to.equal("functions/func2");
+    });
   });
 
   describe(`serverless go build`, () => {