Merge pull request #2 from scality/feature/update-upstream

Update with master/upstream

Author: carlito-scality

.gitignore

@@ -12,3 +12,5 @@ examples/package-lock.json
 kubernetes-client-node-*.tgz
 **/*.swp
 .idea/
+docs/*
+.DS_Store

README.md

@@ -119,6 +119,16 @@ npm install
 npm run generate
 ```
 
+## Documentation
+
+Documentation is generated via typedoc:
+
+```
+npm run docs
+```
+
+To view the generated documentation, open `docs/index.html`
+
 ## Formatting
 
 Run `npm run format` or install an editor plugin like https://github.com/prettier/prettier-vscode and https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig

package-lock.json

@@ -25,7 +25,8 @@
     "generate": "./generate-client.sh",
     "watch": "tsc --watch",
     "test": "nyc mocha",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "docs": "typedoc src/gen/api"
   },
   "nyc": {
     "include": [
@@ -90,6 +91,7 @@
     "ts-mockito": "^2.3.1",
     "ts-node": "^8.2.0",
     "tslint": "^5.17.0",
+    "typedoc": "^0.15.0",
     "typescript": "^3.1.3"
   },
   "bugs": {

package.json

@@ -5,7 +5,5 @@ import { User } from './config_types';
 
 export interface Authenticator {
     isAuthProvider(user: User): boolean;
-    // TODO: Deprecate this and roll it into applyAuthentication
-    getToken(user: User): string | null;
     applyAuthentication(user: User, opts: request.Options | https.RequestOptions): Promise<void>;
 }

src/auth.ts

@@ -26,16 +26,19 @@ export class CloudAuth implements Authenticator {
         return user.authProvider.name === 'azure' || user.authProvider.name === 'gcp';
     }
 
-    public getToken(user: User): string | null {
+    public async applyAuthentication(user: User, opts: request.Options | https.RequestOptions) {
+        const token = this.getToken(user);
+        if (token) {
+            opts.headers!.Authorization = `Bearer ${token}`;
+        }
+    }
+
+    private getToken(user: User): string | null {
         const config = user.authProvider.config;
         if (this.isExpired(config)) {
             this.updateAccessToken(config);
         }
-        return 'Bearer ' + config['access-token'];
-    }
-
-    public async applyAuthentication(user: User, opts: request.Options | https.RequestOptions) {
-        // pass
+        return config['access-token'];
     }
 
     private isExpired(config: Config) {

src/cloud_auth.ts

@@ -12,6 +12,7 @@ import { Authenticator } from './auth';
 import { CloudAuth } from './cloud_auth';
 import { Cluster, Context, newClusters, newContexts, newUsers, User } from './config_types';
 import { ExecAuth } from './exec_auth';
+import { FileAuth } from './file_auth';
 import { OpenIDConnectAuth } from './oidc_auth';
 
 // fs.existsSync was removed in node 10
@@ -28,6 +29,7 @@ export class KubeConfig {
     private static authenticators: Authenticator[] = [
         new CloudAuth(),
         new ExecAuth(),
+        new FileAuth(),
         new OpenIDConnectAuth(),
     ];
 
@@ -190,7 +192,12 @@ export class KubeConfig {
         this.users = [
             {
                 name: userName,
-                token: fs.readFileSync(`${pathPrefix}${Config.SERVICEACCOUNT_TOKEN_PATH}`).toString(),
+                authProvider: {
+                    name: 'tokenFile',
+                    config: {
+                        tokenFile: `${pathPrefix}${Config.SERVICEACCOUNT_TOKEN_PATH}`,
+                    },
+                },
             },
         ];
         this.contexts = [
@@ -350,21 +357,15 @@ export class KubeConfig {
             return elt.isAuthProvider(user);
         });
 
-        let token: string | null = null;
+        if (!opts.headers) {
+            opts.headers = [];
+        }
         if (authenticator) {
-            token = authenticator.getToken(user);
             await authenticator.applyAuthentication(user, opts);
         }
 
         if (user.token) {
-            token = 'Bearer ' + user.token;
-        }
-
-        if (token) {
-            if (!opts.headers) {
-                opts.headers = [];
-            }
-            opts.headers.Authorization = token;
+            opts.headers.Authorization = `Bearer ${user.token}`;
         }
     }
 

src/config.ts

@@ -205,6 +205,7 @@ describe('KubeConfig', () => {
             kc.applytoHTTPSOptions(opts);
 
             expect(opts).to.deep.equal({
+                headers: [],
                 ca: new Buffer('CADATA2', 'utf-8'),
                 cert: new Buffer('USER2_CADATA', 'utf-8'),
                 key: new Buffer('USER2_CKDATA', 'utf-8'),
@@ -221,6 +222,7 @@ describe('KubeConfig', () => {
             };
             await kc.applyToRequest(opts);
             expect(opts).to.deep.equal({
+                headers: [],
                 ca: new Buffer('CADATA2', 'utf-8'),
                 auth: {
                     username: 'foo',
@@ -1000,7 +1002,9 @@ describe('KubeConfig', () => {
             const user = kc.getCurrentUser();
             expect(user).to.not.be.null;
             if (user) {
-                expect(user.token).to.equal(token);
+                expect(user.authProvider.config.tokenFile).to.equal(
+                    '/var/run/secrets/kubernetes.io/serviceaccount/token',
+                );
             }
         });