add some basic tests

Author: mms-gianni

.env.template

@@ -1,5 +1,6 @@
 PORT=2000
 KUBERO_WEBHOOK_SECRET=mysecret
+KUBERO_USERS=base64encodedJson
 
 # webhook configuration
 KUBERO_WEBHOOK_URL=https://kuberoXXXXXXXXXXXXX.loca.lt/api/repo/webhooks

.env.test

@@ -0,0 +1,46 @@
+PORT=2000
+KUBERO_WEBHOOK_SECRET=mysecret
+#KUBERO_USERS=base64encodedJson
+
+# webhook configuration
+KUBERO_WEBHOOK_URL=https://kuberoXXXXXXXXXXXXX.loca.lt/api/repo/webhooks
+
+KUBECONFIG_PATH=./kubeconfig
+KUBERO_CONFIG_PATH=./config.yaml
+KUBERO_CONTEXT=kind-kubero
+KUBERO_NAMESPACE=kubero-dev
+KUBERO_SESSION_KEY=randomString
+DEBUG=*.*
+
+##########################################
+# git repository configuration
+#
+#GITHUB_PERSONAL_ACCESS_TOKEN=
+
+#GITEA_PERSONAL_ACCESS_TOKEN=
+#GITEA_BASEURL=http://localhost:3000
+
+#GOGS_PERSONAL_ACCESS_TOKEN=
+#GOGS_BASEURL=http://localhost:3000
+
+#GITLAB_BASEURL=http://localhost:3080
+#GITLAB_PERSONAL_ACCESS_TOKEN=glpat-
+
+#BITBUCKET_USERNAME=XXXXXXXXX
+#BITBUCKET_APP_PASSWORD=
+
+
+################################################
+# authentication section
+#
+#GITHUB_CLIENT_SECRET=
+#GITHUB_CLIENT_ID=
+#GITHUB_CLIENT_CALLBACKURL=http://kubero.lacolhost.com/api/auth/github/callback
+#GITHUB_CLIENT_ORG=
+
+#OAUTO2_CLIENT_NAME=Gitea
+#OAUTO2_CLIENT_AUTH_URL=http://gitea.lacolhost.com:3000/login/oauth/authorize
+#OAUTO2_CLIENT_TOKEN_URL=http://gitea.lacolhost.com:3000/login/oauth/access_token
+#OAUTH2_CLIENT_ID=
+#OAUTH2_CLIENT_SECRET=
+#OAUTH2_CLIENT_CALLBACKURL=http://kubero.lacolhost.com/api/auth/oauth2/callback

jest.config.js

@@ -0,0 +1,12 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+
+  //verbose: true,
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  setupFiles: ["<rootDir>/jest.setup.js"],
+
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+};

jest.setup.js

@@ -0,0 +1 @@
+require("dotenv").config()

package.json

@@ -11,7 +11,8 @@
     "swaggerwatch": "npx swagger-ui-watcher swagger.json",
     "swaggergen": "node ./swagger.js",
     "dev": "concurrently \"npx tsc --watch\" \"nodemon -q  --ext 'ts,json' dist/index.js\"",
-    "debug": "concurrently \"npx tsc --watch\" \"nodemon -q dist/index.js\""
+    "debug": "concurrently \"npx tsc --watch\" \"nodemon -q dist/index.js\"",
+    "test": "ENV_FILE=.env.test jest"
   },
   "dependencies": {
     "@kubernetes/client-node": "^0.16.3",
@@ -51,6 +52,7 @@
     "@types/debug": "^4.1.7",
     "@types/express": "^4.17.13",
     "@types/express-session": "^1.17.5",
+    "@types/jest": "^29.2.4",
     "@types/lodash.set": "^4.3.7",
     "@types/node": "^17.0.34",
     "@types/passport": "^1.0.10",
@@ -61,7 +63,10 @@
     "@types/swagger-ui-express": "^4.1.3",
     "@types/uuid": "^8.3.4",
     "concurrently": "^7.2.0",
+    "jest": "^29.3.1",
     "nodemon": "^2.0.16",
-    "swagger-autogen": "^2.21.5"
+    "swagger-autogen": "^2.21.5",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1"
   }
 }

src/configure.ts

@@ -45,6 +45,7 @@ export const after = (app: Express, server: Server) => {
     const addons = new Addons({
         kubectl: kubero.kubectl
     });
+    addons.loadOperators();
     app.locals.addons = addons;
     app.use('/api', RouterAddons);
     app.use('/api', RouterAuth);

src/git/repo.test.ts

@@ -0,0 +1,40 @@
+import { GithubApi } from './github';
+import { GogsApi } from './gogs';
+import { GitlabApi } from './gitlab';
+import { BitbucketApi } from './bitbucket';
+import { GiteaApi } from './gitea';
+
+describe('GithubApi', () => {
+    it('should load config', () => {
+        const github = new GithubApi("token");
+        expect(github).toBeTruthy();
+    });
+});
+
+describe('GogsApi', () => {
+    it('should load config', () => {
+        const gogs = new GogsApi("http://localhost:3000", "token");
+        expect(gogs).toBeTruthy();
+    });
+});
+
+describe('GitlabApi', () => {
+    it('should load config', () => {
+        const gitlab = new GitlabApi("https://gitlab.com", "token");
+        expect(gitlab).toBeTruthy();
+    });
+});
+
+describe('GiteaApi', () => {
+    it('should load config', () => {
+        const gitea = new GiteaApi("https://codeberg.org", "token");
+        expect(gitea).toBeTruthy();
+    });
+});
+
+describe('Bitbucket', () => {
+    it('should load config', () => {
+        const bitbucket = new BitbucketApi("username", "password");
+        expect(bitbucket).toBeTruthy();
+    });
+});

src/modules/addons.test.ts

@@ -0,0 +1,21 @@
+import {Addons} from './addons';
+import { Kubectl } from './kubectl';
+import YAML from 'yaml';
+import * as fs from 'fs';
+import { IKuberoConfig} from '../types';
+
+describe('Addons', () => {
+    it('should load addons', async () => {
+        const numberOfAddons = 5;
+
+        const path = process.env.KUBERO_CONFIG_PATH as string || './config.yaml';
+        const config = YAML.parse(fs.readFileSync(path, 'utf8')) as IKuberoConfig;
+        const kubectl = new Kubectl(config);
+
+        const addons = new Addons({kubectl: kubectl});
+        await addons.loadOperators();
+        expect(addons).toBeTruthy();
+        expect(addons.addonsList.length).toBe(numberOfAddons);
+        expect(addons.getAddonsList()).resolves.toBeDefined();
+    });
+});

src/modules/addons.ts

@@ -63,33 +63,26 @@ export class Addons {
         options: AddonOptions
     ) {
         this.kubectl = options.kubectl
-        this.loadOperators()
     }
 
-    private loadOperators(): void {
-        this.kubectl.getOperators()
-        .then(operators => {
+    public async loadOperators(): Promise<void> {
 
-            this.operatorsList = operators;
+        this.operatorsList = await this.kubectl.getOperators()
 
-            const postgresCluster = new PostgresCluster(operators)
-            this.addonsList.push(postgresCluster)
+        const postgresCluster = new PostgresCluster(this.operatorsList)
+        this.addonsList.push(postgresCluster)
 
-            const redisCluster = new RedisCluster(operators)
-            this.addonsList.push(redisCluster)
+        const redisCluster = new RedisCluster(this.operatorsList)
+        this.addonsList.push(redisCluster)
 
-            const redis = new Redis(operators)
-            this.addonsList.push(redis)
+        const redis = new Redis(this.operatorsList)
+        this.addonsList.push(redis)
 
-            const mongoDB = new MongoDB(operators)
-            this.addonsList.push(mongoDB)
+        const mongoDB = new MongoDB(this.operatorsList)
+        this.addonsList.push(mongoDB)
 
-            const minio = new Minio(operators)
-            this.addonsList.push(minio)
-        })
-        .catch(err => {
-            console.error(err)
-        })
+        const minio = new Minio(this.operatorsList)
+        this.addonsList.push(minio)
     }
 
     public async getAddonsList(): Promise<IPlugin[]> {

src/modules/auth.test.ts

@@ -0,0 +1,19 @@
+import {Auth} from './auth';
+
+describe('Auth', () => {
+    it('requires no authentication', () => {
+        process.env.KUBERO_USERS = "";
+        const auth = new Auth();
+        auth.init();
+        expect(auth.getAuthMiddleware().name).toBe('noAuthMiddleware');
+        expect(auth.getBearerMiddleware().name).toBe('authenticate');
+    });
+
+    it('requires authentication', () => {
+        process.env.KUBERO_USERS = 'WwogIHsKICAgICJpZCI6IDEsCiAgICAibWV0aG9kIjogImxvY2FsIiwKICAgICJ1c2VybmFtZSI6ICJhc2RmIiwKICAgICJwYXNzd29yZCI6ICI4YTg0MjNiYTc4YzhmM2RhNjBhNjAyNDkzNjYzYzFjZGMyNDhhODk1NDFiMTI5ODBlMjkyMzk5YzBmMGNhZDIxIiwKICAgICJpbnNlY3VyZSI6IGZhbHNlCiAgfSwKICB7CiAgICAiaWQiOiAyLAogICAgIm1ldGhvZCI6ICJsb2NhbCIsCiAgICAidXNlcm5hbWUiOiAicXdlciIsCiAgICAicGFzc3dvcmQiOiAicXdlciIsCiAgICAiaW5zZWN1cmUiOiB0cnVlCiAgfQpd';
+        const auth = new Auth();
+        auth.init();
+        expect(auth.getAuthMiddleware().name).toBe('authMiddleware');
+        expect(auth.getBearerMiddleware().name).toBe('authenticate');
+    });
+});

src/modules/kubectl.test.ts

@@ -0,0 +1,21 @@
+import { Kubectl } from './kubectl';
+import YAML from 'yaml';
+import * as fs from 'fs';
+import { IKuberoConfig} from '../types';
+
+describe('Kubectl', () => {
+    it('should load config', () => {
+
+        const path = process.env.KUBERO_CONFIG_PATH as string || './config.yaml';
+        const config = YAML.parse(fs.readFileSync(path, 'utf8')) as IKuberoConfig;
+        const kubectl = new Kubectl(config);
+
+        expect(kubectl).toBeTruthy();
+        expect(kubectl.config).toBeTruthy();
+        expect(kubectl.log).toBeTruthy();
+
+        expect(kubectl.getPipelinesList()).resolves.toBeDefined();
+
+        expect(kubectl.getKubeVersion()).resolves.toBeDefined();
+    });
+});

src/routes/addons.test.ts

@@ -0,0 +1,17 @@
+
+import {RouterAddons, authMiddleware} from './addons';
+
+describe('Addons API', () => {
+    it('addons should respond', () => {
+        expect(RouterAddons.get('/api/addons')).toBeTruthy();
+        expect(RouterAddons.get('/api/cli/addons')).toBeTruthy();
+        expect(RouterAddons.get('/api/addons/operators')).toBeTruthy();
+    });
+});
+
+describe('Auth API', () => {
+    process.env.KUBERO_USERS = "";
+    it('auth should respond', () => {
+        expect(authMiddleware.name).toBe('noAuthMiddleware');
+    });
+});

tsconfig.json

@@ -26,7 +26,7 @@
 
     /* Modules */
     "module": "commonjs",                                /* Specify what module code is generated. */
-    //"rootDir": "./src/",                                  /* Specify the root folder within your source files. */
+    "rootDir": "./src/",                                  /* Specify the root folder within your source files. */
     // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */