add watch using genericApi

Signed-off-by: Zahar Pecherichny <zfrhv2010@gmail.com>

Author: zfrhv

package-lock.json

@@ -62,6 +62,7 @@
     "isomorphic-ws": "^5.0.0",
     "js-yaml": "^4.1.0",
     "jsonpath-plus": "^8.0.0",
+    "pluralize": "^8.0.0",
     "request": "^2.88.0",
     "rfc4648": "^1.3.0",
     "stream-buffers": "^3.0.2",

package.json

@@ -0,0 +1,51 @@
+import querystring = require('querystring');
+import pluralize = require('pluralize');
+
+export interface K8sObject {
+    apiVersion: string;
+    kind: string;
+    metadata?: {
+        name?: string;
+        namespace?: string;
+        labels?: object;
+    };
+}
+
+export function CreatePath(object: K8sObject, include_name: boolean = true) {
+  if (!object.apiVersion) {
+    throw new Error('The object passed must contain apiVersion field')
+  }
+  if (!object.kind) {
+    throw new Error('The object passed must contain kind field')
+  }
+
+  let path = ""
+
+  // add apiVersion
+  if (object.apiVersion == "v1") {
+    path += "/api/v1"
+  } else {
+    path += "/apis/" + object.apiVersion
+  }
+
+  // add namespace if object namespaced
+  if (object.metadata?.namespace) {
+    path += "/namespaces/" + object.metadata.namespace
+  }
+
+  // add object kind
+  path += "/" + pluralize(object.kind.toLowerCase())
+
+  // add object name
+  if (include_name && object.metadata?.name) {
+    path += "/" + object.metadata.name
+  }
+
+  // add label selector
+  const labels = object.metadata?.labels
+  if (labels) {
+    path += "?" + querystring.stringify({labelSelector: Object.keys(labels).map(label => label + "=" + labels[label]).join(",")})
+  }
+
+  return path
+}

src/generic_api.ts

@@ -0,0 +1,84 @@
+import { expect } from 'chai';
+import { CreatePath } from './generic_api';
+
+
+
+describe('CreatePath', () => {
+    it('should convert namespace to path', async () => {
+        const obj1 = {
+            apiVersion: "v1",
+            kind: "Namespace"
+        };
+
+        const path1 = CreatePath(obj1);
+        expect(path1).to.equal("/api/v1/namespaces");
+
+        const obj2 = {
+            apiVersion: "v1",
+            kind: "Namespace",
+            metadata: {
+                name: "test"
+            }
+        };
+
+        const path2 = CreatePath(obj2);
+        expect(path2).to.equal("/api/v1/namespaces/test");
+    });
+
+    it('should convert custom resource to path', async () => {
+        const obj1 = {
+            apiVersion: "fake.crd.io/v1",
+            kind: "fakekind",
+            metadata: {
+              name: "fake-name",
+              namespace: "fake-namespace"
+            }
+        };
+
+        const path1 = CreatePath(obj1);
+        expect(path1).to.equal("/apis/fake.crd.io/v1/namespaces/fake-namespace/fakekinds/fake-name");
+    });
+
+    it('should convert objects with labels to path with labels selector', async () => {
+        const obj1 = {
+            apiVersion: "v1",
+            kind: "pod",
+            metadata: {
+                labels: {
+                    label1: "value1",
+                    label2: "value2"
+                }
+            }
+        };
+
+        const path1 = CreatePath(obj1);
+        expect(path1).to.equal("/api/v1/pods?labelSelector=label1%3Dvalue1%2Clabel2%3Dvalue2");
+    });
+
+    it('should convert cluster wide object to path', async () => {
+        const obj1 = {
+            apiVersion: "rbac.authorization.k8s.io/v1",
+            kind: "ClusterRoleBinding"
+        };
+
+        const path1 = CreatePath(obj1);
+        expect(path1).to.equal("/apis/rbac.authorization.k8s.io/v1/clusterrolebindings");
+    });
+
+    it('should convert object to path while skipping the name', async () => {
+        const obj1 = {
+            apiVersion: "rbac.authorization.k8s.io/v1",
+            kind: "RoleBinding",
+            metadata: {
+                name: "fake-name",
+                namespace: "fake-namespace"
+            }
+        };
+
+        const path1 = CreatePath(obj1);
+        expect(path1).to.equal("/apis/rbac.authorization.k8s.io/v1/namespaces/fake-namespace/rolebindings/fake-name");
+
+        const path2 = CreatePath(obj1, false);
+        expect(path2).to.equal("/apis/rbac.authorization.k8s.io/v1/namespaces/fake-namespace/rolebindings");
+    });
+});

src/generic_api_test.ts

@@ -1,7 +1,9 @@
 import byline = require('byline');
+import querystring = require('querystring');
 import request = require('request');
 import { Duplex } from 'stream';
 import { KubeConfig } from './config';
+import { K8sObject, CreatePath } from './generic_api'
 
 export interface WatchUpdate {
     type: string;
@@ -137,4 +139,15 @@ export class Watch {
         req.pipe(stream);
         return req;
     }
+
+    // watch by object instead of url path
+    public async genericWatch(
+        object: K8sObject,
+        queryParams: any,
+        callback: (phase: string, apiObj: any, watchObj?: any) => void,
+        done: (err: any) => void,
+    ): Promise<any> {
+      let path = CreatePath(object, false)
+      return this.watch(path, queryParams, callback, done)
+    }
 }

src/watch.ts

@@ -108,7 +108,7 @@ describe('Watch', () => {
             },
         });
 
-        const path = '/some/path/to/object';
+        const path = '/api/v1/pods';
 
         let doneCalled = false;
         let doneErr: any;
@@ -125,6 +125,23 @@ describe('Watch', () => {
         expect(doneCalled).to.equal(true);
         expect(doneErr.toString()).to.equal('Error: some error');
         expect(aborted).to.equal(true);
+
+        doneCalled = false;
+        doneErr = null;
+        await watch.genericWatch(
+            {
+                apiVersion: "v1",
+                kind: "pod"
+            },
+            {},
+            (phase: string, obj: string) => {},
+            (err: any) => {
+                doneCalled = true;
+                doneErr = err;
+            },
+        );
+        expect(doneCalled).to.equal(true);
+        expect(doneErr.toString()).to.equal('Error: some error');
     });
 
     it('should not call watch done callback more than once', async () => {
@@ -157,7 +174,7 @@ describe('Watch', () => {
 
         when(fakeRequestor.webRequest(anything())).thenReturn(fakeRequest);
 
-        const path = '/some/path/to/object';
+        const path = '/api/v1/pods';
 
         const receivedTypes: string[] = [];
         const receivedObjects: string[] = [];
@@ -223,7 +240,7 @@ describe('Watch', () => {
 
         when(fakeRequestor.webRequest(anything())).thenReturn(fakeRequest);
 
-        const path = '/some/path/to/object';
+        const path = '/api/v1/pods';
 
         const receivedTypes: string[] = [];
         const receivedObjects: string[] = [];
@@ -281,7 +298,7 @@ describe('Watch', () => {
 
         when(fakeRequestor.webRequest(anything())).thenReturn(fakeRequest);
 
-        const path = '/some/path/to/object';
+        const path = '/api/v1/pods';
 
         const receivedTypes: string[] = [];
         const receivedObjects: string[] = [];
@@ -338,7 +355,7 @@ describe('Watch', () => {
 
         when(fakeRequestor.webRequest(anything())).thenReturn(fakeRequest);
 
-        const path = '/some/path/to/object';
+        const path = '/api/v1/pods';
 
         const receivedTypes: string[] = [];
         const receivedObjects: string[] = [];
@@ -385,7 +402,7 @@ describe('Watch', () => {
 
         when(fakeRequestor.webRequest(anything())).thenReturn(fakeRequest);
 
-        const path = '/some/path/to/object';
+        const path = '/api/v1/pods';
 
         const receivedTypes: string[] = [];
         const receivedObjects: string[] = [];