Golang Wrap Support

.github/workflows/ci-golang.yaml

@@ -0,0 +1,45 @@
+name: CI-Golang
+
+on: 
+  push:
+    branches:
+      - origin
+      - origin-dev
+  pull_request:
+
+jobs:
+  Test-Cli:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Read .nvmrc
+        run: echo ::set-output name=NVMRC::$(cat .nvmrc)
+        id: nvm
+
+      - name: Setup Node.js
+        uses: actions/setup-node@master
+        with:
+          node-version: '${{ steps.nvm.outputs.NVMRC }}'
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v2
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: yarn install --nonInteractive --frozen-lockfile --prefer-offline
+
+      - name: Build
+        run: yarn build
+
+      - name: Test
+        run: yarn test:golang
+        working-directory: ./packages/cli

packages/cli/jest.config.js

@@ -11,7 +11,8 @@ module.exports = {
   modulePathIgnorePatterns: [
     "<rootDir>/build",
     "<rootDir>/src/__tests__/project/.polywrap",
-    "<rootDir>/src/__tests__/e2e/build-rs.spec.ts"
+    "<rootDir>/src/__tests__/e2e/build-rs.spec.ts",
+    "<rootDir>/src/__tests__/e2e/build-go.spec.ts"
   ],
   testPathIgnorePatterns: [
     "<rootDir>/src/__tests__/project/.polywrap"

packages/cli/jest.go.config.js

@@ -0,0 +1,22 @@
+module.exports = {
+  collectCoverage: true,
+  preset: "ts-jest",
+  testEnvironment: "node",
+  globals: {
+    "ts-jest": {
+      diagnostics: false
+    },
+  },
+  modulePathIgnorePatterns: [
+    "<rootDir>/build",
+    "<rootDir>/src/__tests__/project/.polywrap"
+  ],
+  testPathIgnorePatterns: [
+    "<rootDir>/src/__tests__/project/.polywrap"
+  ],
+  transformIgnorePatterns: [
+    "<rootDir>/src/__tests__/project/.polywrap"
+  ],
+  setupFilesAfterEnv: ["./jest.setup.js"],
+  testMatch: ["**/build-go.spec.ts"]
+};

packages/cli/lang/en.json

@@ -9,6 +9,7 @@
   "commands_build_description": "Build Polywrap Projects (type: interface, wasm)",
   "commands_build_error_manifestPathMissing": "{option} option missing {argument} argument",
   "commands_build_error_manifestNotFound": "Manifest not found. Search paths used: {paths}",
+  "commands_build_error_goModNotFound": "go.mod file not found. Search paths used: {paths}",
   "commands_build_error_outputDirMissingPath": "{option} option missing {argument} argument",
   "commands_build_error_unsupportedProjectType": "Unsupported project type. You can only build the following project types: {supportedTypes}",
   "commands_build_keypressListener_exit": "Exit: [CTRL + C], [ESC], or [Q]",
@@ -233,6 +234,8 @@
   "lib_helpers_deployManifestExt_loadError": "Failed to load deploy manifest extension from {path}",
   "lib_helpers_deployManifestExt_loadText": "Load manifest extension from {path}",
   "lib_helpers_deployManifestExt_loadWarning": "No manifest extension found in {path}",
+  "lib_helpers_gomod_unableToLoad": "Unable to load go.mod: {path}",
+  "lib_helpers_gomod_invalid": "Invalid format of go.mod: {path}",
   "lib_helpers_manifest_outputError": "Failed to output manifest to {path}",
   "lib_helpers_manifest_outputText": "Manifest written to {path}",
   "lib_helpers_manifest_outputWarning": "Warnings writing manifest to {path}",
@@ -272,6 +275,7 @@
   "lib_typescript_tsNodeNotInstalled": "Your project uses typescript, but ts-node is not installed",
   "lib_watcher_alreadyWatching": "Watcher session is already in progress. Directory: {dir}",
   "lib_wasm_rust_invalidModule": "Module paths must point to Cargo.toml files. Found: {path}",
+  "lib_wasm_golang_invalidModule": "Module paths must point to go.mod file. Found: {path}",
   "lib_docker_invalidImageId": "Invalid docker image ID returned: {imageId}",
   "lib_docker_noInstall": "Docker executable not found in PATH",
   "lib_infra_unrecognizedModule": "Unrecognized modules: {modules}. Default modules: {defaultModules}",

packages/cli/lang/es.json

@@ -9,6 +9,7 @@
   "commands_build_description": "Build Polywrap Projects (type: interface, wasm)",
   "commands_build_error_manifestPathMissing": "{option} option missing {argument} argument",
   "commands_build_error_manifestNotFound": "Manifest not found. Search paths used: {paths}",
+  "commands_build_error_goModNotFound": "go.mod file not found. Search paths used: {paths}",
   "commands_build_error_outputDirMissingPath": "{option} option missing {argument} argument",
   "commands_build_error_unsupportedProjectType": "Unsupported project type. You can only build the following project types: {supportedTypes}",
   "commands_build_keypressListener_exit": "Exit: [CTRL + C], [ESC], or [Q]",
@@ -233,6 +234,8 @@
   "lib_helpers_deployManifestExt_loadError": "Failed to load deploy manifest extension from {path}",
   "lib_helpers_deployManifestExt_loadText": "Load manifest extension from {path}",
   "lib_helpers_deployManifestExt_loadWarning": "No manifest extension found in {path}",
+  "lib_helpers_gomod_unableToLoad": "Unable to load go.mod: {path}",
+  "lib_helpers_gomod_invalid": "Invalid format of go.mod: {path}",
   "lib_helpers_manifest_outputError": "Failed to output manifest to {path}",
   "lib_helpers_manifest_outputText": "Manifest written to {path}",
   "lib_helpers_manifest_outputWarning": "Warnings writing manifest to {path}",
@@ -272,6 +275,7 @@
   "lib_typescript_tsNodeNotInstalled": "Your project uses typescript, but ts-node is not installed",
   "lib_watcher_alreadyWatching": "Watcher session is already in progress. Directory: {dir}",
   "lib_wasm_rust_invalidModule": "Module paths must point to Cargo.toml files. Found: {path}",
+  "lib_wasm_golang_invalidModule": "Module paths must point to go.mod file. Found: {path}",
   "lib_docker_invalidImageId": "Invalid docker image ID returned: {imageId}",
   "lib_docker_noInstall": "Docker executable not found in PATH",
   "lib_infra_unrecognizedModule": "Unrecognized modules: {modules}. Default modules: {defaultModules}",

packages/cli/package.json

@@ -32,6 +32,7 @@
     "test:e2e:p1": "yarn test:cmd -- ./src/__tests__/e2e/p1/*.spec.ts",
     "test:e2e:p2": "yarn test:cmd -- ./src/__tests__/e2e/p2/*.spec.ts",
     "test:rust": "yarn test:cmd -- --config ./jest.rs.config.js",
+    "test:golang": "yarn test:cmd -- --config ./jest.go.config.js",
     "test:watch": "yarn test -- --watch"
   },
   "resolutions": {

packages/cli/src/__tests__/e2e/build-go.spec.ts

@@ -0,0 +1,72 @@
+import { polywrapCli } from "./utils";
+import { Commands } from "@polywrap/cli-js";
+import { GetPathToCliTestFiles } from "@polywrap/test-cases";
+import fs from "fs";
+import path from "path";
+
+jest.setTimeout(1500000);
+
+describe("e2e tests for build command", () => {
+  const testCaseRoot = path.join(GetPathToCliTestFiles(), "build-cmd/wasm/golang");
+  const testCases = fs
+    .readdirSync(testCaseRoot, { withFileTypes: true })
+    .filter((dirent) => dirent.isDirectory())
+    .map((dirent) => dirent.name);
+
+  const getTestCaseDir = (index: number) =>
+    path.join(testCaseRoot, testCases[index]);
+
+  describe("Image strategy", () => {
+    it("Builds for go", async () => {
+      const { exitCode: code, stdout: output } = await Commands.build({
+        strategy: "image",
+        verbose: true
+      }, {
+        cwd: getTestCaseDir(0),
+        cli: polywrapCli,
+      });
+      const buildDir = `./build`;
+
+      expect(code).toEqual(0);
+      expect(output).toContain(`Artifacts written to ${buildDir}`);
+      expect(output).toContain(`WRAP manifest written in ${buildDir}/wrap.info`);
+    });
+  })
+
+  // NOTE: Skipped because CI needs system prequisites: golang
+  describe.skip("Local strategy", () => {
+    it("Builds for rust", async () => {
+      const { exitCode: code, stdout: output } = await Commands.build({
+        strategy: "local",
+        verbose: true
+      }, {
+        cwd: getTestCaseDir(0),
+        cli: polywrapCli,
+      });
+
+      const buildDir = `./build`;
+
+      expect(code).toEqual(0);
+      expect(output).toContain(`Artifacts written to ${buildDir}`);
+      expect(output).toContain(`WRAP manifest written in ${buildDir}/wrap.info`);
+    });
+  })
+
+  describe("VM strategy", () => {
+    it("Builds for go", async () => {
+      const { exitCode: code, stdout: output } = await Commands.build({
+        strategy: "vm",
+        verbose: true
+      }, {
+        cwd: getTestCaseDir(0),
+        cli: polywrapCli,
+      });
+
+      const buildDir = `./build`;
+
+      expect(code).toEqual(0);
+      expect(output).toContain(`Artifacts written to ${buildDir}`);
+      expect(output).toContain(`WRAP manifest written in ${buildDir}/wrap.info`);
+    });
+  })
+});

packages/cli/src/__tests__/e2e/p1/help.spec.ts

@@ -13,7 +13,6 @@ Commands:
   codegen|g [options]          Generate Code For Polywrap Projects
   create|c                     Create New Projects
   deploy|d [options]           Deploys Polywrap Projects
-  docgen|o [options] <action>  Generate wrapper documentation
   infra|i [options] <action>   Modular Infrastructure-As-Code Orchestrator
   manifest|m                   Inspect & Migrade Polywrap Manifests
   test|t [options]             Execute Tests

packages/cli/src/__tests__/e2e/p1/no-command.spec.ts

@@ -13,7 +13,6 @@ Commands:
   codegen|g [options]          Generate Code For Polywrap Projects
   create|c                     Create New Projects
   deploy|d [options]           Deploys Polywrap Projects
-  docgen|o [options] <action>  Generate wrapper documentation
   infra|i [options] <action>   Modular Infrastructure-As-Code Orchestrator
   manifest|m                   Inspect & Migrade Polywrap Manifests
   test|t [options]             Execute Tests

packages/cli/src/commands/build.ts

@@ -15,6 +15,7 @@ import {
   polywrapManifestLanguages,
   pluginManifestLanguages,
   parseWrapperEnvsOption,
+  parseDirOptionNoDefault,
 } from "../lib";
 import { CodeGenerator } from "../lib/codegen";
 import {
@@ -48,7 +49,7 @@ export interface BuildCommandOptions extends BaseCommandOptions {
   clientConfig: string | false;
   wrapperEnvs: string | false;
   noCodegen: boolean;
-  codegenDir: string;
+  codegenDir: string | false;
   watch: boolean;
   strategy: `${SupportedStrategies}`;
 }
@@ -112,7 +113,7 @@ export const build: Command = {
             wrapperEnvs: options.wrapperEnvs || false,
             outputDir: parseDirOption(options.outputDir, defaultOutputDir),
             noCodegen: !options.codegen || false,
-            codegenDir: parseDirOption(options.codegenDir, DEFAULT_CODEGEN_DIR),
+            codegenDir: parseDirOptionNoDefault(options.codegenDir),
             strategy: options.strategy || defaultStrategy,
             watch: options.watch || false,
             verbose: options.verbose || false,
@@ -241,7 +242,7 @@ async function run(options: Required<BuildCommandOptions>) {
         const codeGenerator = new CodeGenerator({
           project,
           schemaComposer,
-          codegenDirAbs: codegenDir,
+          codegenDirAbs: codegenDir || undefined,
         });
         const codegenSuccess = await codeGenerator.generate();
 

packages/cli/src/lib/Compiler.ts

@@ -43,7 +43,7 @@ export class Compiler {
       await this._outputWrapManifest();
 
       if (await this._isWasm()) {
-        // Build & Output: wasm.wrap
+        // Build & Output: wrap.wasm
         await this._buildModules();
 
         // Copy: Resources folder

packages/cli/src/lib/build-strategies/BuildOverrides.ts

@@ -0,0 +1,36 @@
+import { PolywrapManifestLanguage } from "../";
+
+import { PolywrapManifest } from "@polywrap/polywrap-manifest-types-js";
+import path from "path";
+import fs from "fs";
+
+export interface BuildOverrides {
+  validateManifest?: (manifest: PolywrapManifest) => Promise<void>;
+
+  sourcesSubDirectory?: string;
+}
+
+export async function tryGetBuildOverrides(
+  language: PolywrapManifestLanguage
+): Promise<BuildOverrides | undefined> {
+  const modulePath = path.join(
+    __dirname,
+    "..",
+    "defaults",
+    "language-overrides",
+    language,
+    "index.js"
+  );
+  let overrides: BuildOverrides | undefined;
+
+  if (fs.existsSync(modulePath)) {
+    const module = await import(modulePath);
+
+    // Get any build overrides for the given build-image
+    if (module.getBuildOverrides) {
+      overrides = module.getBuildOverrides() as BuildOverrides;
+    }
+  }
+
+  return Promise.resolve(overrides);
+}

packages/cli/src/lib/build-strategies/BuildStrategy.ts

@@ -1,18 +1,20 @@
+import { BuildOverrides, tryGetBuildOverrides } from "./BuildOverrides";
 import { PolywrapProject } from "../project";
 
 import fse from "fs-extra";
 import path from "path";
 
-export interface BuildStrategyArgs {
+export interface BuildStrategyConfig {
   project: PolywrapProject;
   outputDir: string;
 }
 
 export abstract class BuildStrategy<TBuildReturn = unknown> {
   protected project: PolywrapProject;
   protected outputDir: string;
+  protected overrides?: BuildOverrides;
 
-  constructor({ project, outputDir }: BuildStrategyArgs) {
+  constructor({ project, outputDir }: BuildStrategyConfig) {
     this.project = project;
     this.outputDir = outputDir;
   }
@@ -23,25 +25,33 @@ export abstract class BuildStrategy<TBuildReturn = unknown> {
 
   async build(): Promise<TBuildReturn> {
     const language = await this.project.getManifestLanguage();
-    const defaultsOfStrategyUsed = path.join(
+    const buildStrategyDir = path.join(
       __dirname,
       "..",
       "defaults",
       "build-strategies",
       language,
       this.getStrategyName()
     );
+
+    // Cache all build strategy files
     const strategyUsedCacheDir = this.project.getCachePath(
       PolywrapProject.cacheLayout.buildStrategyUsed
     );
-
     if (fse.existsSync(strategyUsedCacheDir)) {
       fse.removeSync(strategyUsedCacheDir);
     }
-
     fse.mkdirSync(strategyUsedCacheDir, { recursive: true });
+    fse.copySync(buildStrategyDir, strategyUsedCacheDir);
+
+    // Check if build overrides exist
+    this.overrides = await tryGetBuildOverrides(language);
+
+    // If they do, ensure the manifest if valid before build starts
+    if (this.overrides && this.overrides.validateManifest) {
+      await this.overrides.validateManifest(await this.project.getManifest());
+    }
 
-    fse.copySync(defaultsOfStrategyUsed, strategyUsedCacheDir);
     return this.buildSources();
   }
 }

packages/cli/src/lib/build-strategies/index.ts

@@ -1,3 +1,4 @@
+export * from "./BuildOverrides";
 export * from "./BuildStrategy";
 export * from "./strategies";
 

packages/cli/src/lib/build-strategies/strategies/DockerImageStrategy.ts

@@ -7,7 +7,7 @@ import {
   runCommand,
   runCommandSync,
 } from "../../system";
-import { BuildStrategyArgs, BuildStrategy } from "../BuildStrategy";
+import { BuildStrategyConfig, BuildStrategy } from "../BuildStrategy";
 import { intlMsg } from "../../intl";
 import { logActivity } from "../../logging";
 
@@ -21,8 +21,8 @@ type BuildImageId = string;
 export class DockerImageBuildStrategy extends BuildStrategy<BuildImageId> {
   private _dockerLock: FileLock;
 
-  constructor(args: BuildStrategyArgs) {
-    super(args);
+  constructor(config: BuildStrategyConfig) {
+    super(config);
 
     if (!isDockerInstalled(this.project.logger)) {
       throw new Error(intlMsg.lib_docker_noInstall());