Merge pull request kubernetes-client#153 from brendandburns/yaml

Add some simple YAML load/dump helpers and an example.

Author: k8s-ci-robot

examples/yaml-example.js

@@ -0,0 +1,31 @@
+const k8s = require('@kubernetes/client-node');
+const fs = require('fs');
+
+const kc = new k8s.KubeConfig();
+kc.loadFromDefault();
+
+const k8sApi = kc.makeApiClient(k8s.Core_v1Api);
+
+const yamlString = k8s.dumpYaml({
+  metadata: {
+    name: 'test'
+  }
+});
+
+const yamlNamespace = k8s.loadYaml(k8s.dumpYaml(yamlString));
+
+k8sApi.createNamespace(yamlNamespace).then(
+  (response) => {
+    console.log('Created namespace');
+    console.log(response);
+    k8sApi.readNamespace(namespace.metadata.name).then(
+      (response) => {
+        console.log(response);
+	k8sApi.deleteNamespace(
+          namespace.metadata.name, {} /* delete options */);
+      });
+  },
+  (err) => {
+    console.log('Error!: ' + err);
+  }
+);

src/yaml.ts

@@ -0,0 +1,13 @@
+import * as yaml from 'js-yaml';
+
+export function loadYaml<T>(data: string, opts?: yaml.LoadOptions): T {
+    return yaml.safeLoad(data, opts) as T;
+}
+
+export function loadAllYaml(data: string, opts?: yaml.LoadOptions): any[] {
+    return yaml.safeLoadAll(data, undefined, opts);
+}
+
+export function dumpYaml(object: any, opts?: yaml.DumpOptions): string {
+    return yaml.safeDump(object, opts);
+}

src/yaml_test.ts

@@ -0,0 +1,48 @@
+import { expect } from 'chai';
+
+import { V1Namespace } from './api';
+import { dumpYaml, loadAllYaml, loadYaml } from './yaml';
+
+describe('yaml', () => {
+    it('should load safely', () => {
+        const yaml = 'apiVersion: v1\n' +
+                     'kind: Namespace\n' +
+                     'metadata:\n'       +
+                     '  name: some-namespace\n';
+        const ns = loadYaml<V1Namespace>(yaml);
+
+        expect(ns.apiVersion).to.equal('v1');
+        expect(ns.kind).to.equal('Namespace');
+        expect(ns.metadata.name).to.equal('some-namespace');
+    });
+    it('should load all safely', () => {
+        const yaml = 'apiVersion: v1\n' +
+                     'kind: Namespace\n' +
+                     'metadata:\n'       +
+                     '  name: some-namespace\n' +
+                     '---\n' +
+                     'apiVersion: v1\n' +
+                     'kind: Pod\n' +
+                     'metadata:\n' +
+                     '  name: some-pod\n' +
+                     '  namespace: some-ns\n';
+        const objects = loadAllYaml(yaml);
+
+        expect(objects.length).to.equal(2);
+        expect(objects[0].kind).to.equal('Namespace');
+        expect(objects[1].kind).to.equal('Pod');
+        expect(objects[0].metadata.name).to.equal('some-namespace');
+        expect(objects[1].metadata.name).to.equal('some-pod');
+        expect(objects[1].metadata.namespace).to.equal('some-ns');
+    });
+    it('should round trip successfully', () => {
+        const expected = {
+            metadata: {
+              name: 'test',
+            },
+          };
+        const yamlString = dumpYaml(expected);
+        const actual = loadYaml(yamlString);
+        expect(actual).to.deep.equal(expected);
+    });
+});