1.0.27

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiglobal/test-sdk",
-  "version": "1.0.3",
+  "version": "1.0.27",
   "private": false,
   "description": "an sdk for testing ag handlers",
   "main": "dist_ts/index.js",
@@ -9,18 +9,24 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^3.2.9",
+    "@types/node": "^14.14.0",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "dependencies": {
+    "@apiglobal/sdk": "^1.0.18",
+    "@apiglobal/typedrequest": "^1.0.54",
+    "@apiglobal/typedrequest-interfaces": "^1.0.15",
+    "@pushrocks/qenv": "^4.0.10",
+    "@pushrocks/smartexpress": "^3.0.81",
+    "@pushrocks/smartobject": "^1.0.4"
   },
-  "dependencies": {},
   "files": [
     "ts/**/*",
     "ts_web/**/*",
@@ -32,5 +38,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

test/test.ts

@@ -1,8 +1,10 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as testSdk from '../ts/index';
 
+let testServer: testSdk.AgTestServer;
+
 tap.test('first test', async () => {
-  console.log(testSdk.standardExport);
+  console.log('TODO');
 });
 
 tap.start();

ts/index.ts

@@ -1,3 +1,88 @@
 import * as plugins from './test-sdk.plugins';
+import { AgTestServer } from './test-sdk.classes.testserver';
+import { AAgHandler } from '@apiglobal/sdk';
 
-export let standardExport = 'Hi there! :) This is an exported string';
+export { AgTestServer };
+
+let testServer: AgTestServer;
+let handler: AAgHandler<any>;
+export const createTestServer = async (handlerArg: {
+  new (envManagerArg: plugins.agSdk.AgEnvironment): plugins.agSdk.AAgHandler<any>;
+}) => {
+  class AgEnvironement extends plugins.agSdk.AgEnvironment {
+    public qenv = new plugins.qenv.Qenv('./', './.nogit');
+    public async getEnvVar(nameArg: string) {
+      return this.qenv.getEnvVarOnDemand(nameArg);
+    }
+  }
+  handler = new handlerArg(new AgEnvironement());
+  console.log(`now checking requirements for handler with slug ${handler.slug}...`);
+  await handler.checkRequirements();
+  testServer = new AgTestServer(handler);
+  await testServer.start();
+  return testServer;
+};
+
+export const testFire = <
+  A extends plugins.agSdk.AAgHandler<any>,
+  T extends plugins.typedrequestInterfaces.ITypedRequest
+>(
+  slugArg: A['slug'],
+  methodArg: T['method'],
+  requestArg: T['request']
+) => {
+  if (!testServer) {
+    throw new Error('you need to create and start a testServer first!');
+  }
+  if (testServer.server.serverStatus !== 'running') {
+    throw new Error('you need to start the testServer first!');
+  }
+  const typedRequest = new plugins.typedrequest.TypedRequest<T>(
+    `http://localhost:${testServer.server.options.port}/${slugArg}`,
+    methodArg
+  );
+  const responsePromise = typedRequest.fire(requestArg);
+  const expect = async (expectedResponseArg: T['response']) => {
+    const actualResponse = await responsePromise;
+    const comparisonResult = plugins.smartobject.compareObjects(
+      expectedResponseArg,
+      actualResponse
+    );
+    let throwErrorBool = false;
+    if (comparisonResult.divergingProperties.length > 0) {
+      console.log(`The following properties diverged:`);
+      console.log(comparisonResult.divergingProperties);
+      for (const divProperty of comparisonResult.divergingProperties) {
+        if (expectedResponseArg[divProperty] !== 'maydiverge') {
+          throwErrorBool = true;
+        } else {
+          console.log(`${divProperty} may diverge, not throwing for this one`);
+        }
+      }
+    }
+    if (comparisonResult.missingProperties.length > 0) {
+      console.log(`The following properties diverged:`);
+      console.log(comparisonResult.divergingProperties);
+      throwErrorBool = true;
+    }
+    if (throwErrorBool) {
+      console.log('Result: response did not comply');
+      console.log('-> expected:');
+      console.log(expectedResponseArg);
+      console.log('-> but actually received:');
+      console.log(actualResponse);
+      throw new Error('response did not comply');
+    }
+    return actualResponse;
+  };
+  return {
+    expect,
+  };
+};
+
+export const stopTestServer = async () => {
+  if (testServer) {
+    await testServer.stop();
+    await handler.stop();
+  }
+};

ts/test-sdk.classes.testserver.ts

@@ -0,0 +1,52 @@
+import * as plugins from './test-sdk.plugins';
+
+export class AgTestServer {
+  public handlers: Array<plugins.agSdk.AAgHandler<any>> = [];
+  public server: plugins.smartexpress.Server;
+
+  constructor(handlerArg?: plugins.agSdk.AAgHandler<any>) {
+    if (handlerArg) {
+      this.addAgHandler(handlerArg);
+    }
+  }
+
+  public async addAgHandler(handlerArg: plugins.agSdk.AAgHandler<any>) {
+    this.handlers.push(handlerArg);
+    console.log(`added handler with slug ${handlerArg.slug}`);
+    if (this.server && this.server.serverStatus === 'running') {
+      await this.stop();
+      await this.start();
+    }
+  }
+
+  public async start() {
+    this.server = new plugins.smartexpress.Server({
+      cors: true,
+      forceSsl: false,
+      defaultAnswer: async () => 'apiglobal testserver',
+      domain: 'localhost',
+      port: 3000,
+    });
+    for (const handlerArg of this.handlers) {
+      console.log(`found handler with slug ${handlerArg.slug}`);
+      await handlerArg.start();
+      console.log(`started handler with slug ${handlerArg.slug}`);
+      const slugroute = `/${handlerArg.slug}`;
+      this.server.addRoute(
+        slugroute,
+        new plugins.smartexpress.HandlerTypedRouter(handlerArg.typedrouter)
+      );
+      console.log(`added slugroute ${slugroute}`);
+    }
+    await this.server.start();
+  }
+
+  public async stop() {
+    if (this.server) {
+      const previousServer = this.server;
+      this.server = null;
+      await previousServer.startedPromise;
+      await previousServer.stop();
+    }
+  }
+}

ts/test-sdk.plugins.ts

@@ -1,2 +1,13 @@
-const removeme = {};
-export { removeme };
+// apiglobal scope
+import * as agSdk from '@apiglobal/sdk';
+import * as typedrequest from '@apiglobal/typedrequest';
+import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
+
+export { agSdk, typedrequest, typedrequestInterfaces };
+
+// pushrocks scope
+import * as qenv from '@pushrocks/qenv';
+import * as smartexpress from '@pushrocks/smartexpress';
+import * as smartobject from '@pushrocks/smartobject';
+
+export { qenv, smartexpress, smartobject };