Improve tests format and add prepare option (#16)

Co-authored-by: Luc <[email protected]> Co-authored-by: Luc <[email protected]>
v3xlabs · Jan 1, 2022 · 5e3d27c · 5e3d27c
1 parent f1da4f2
commit 5e3d27c
Show file tree

Hide file tree

Showing 15 changed files with 94 additions and 25 deletions.
diff --git a/__tests__/__GLOBAL_SETUP__.ts b/__tests__/__GLOBAL_SETUP__.ts
@@ -0,0 +1,27 @@
+import { ScylloClient } from '../lib';
+
+type User = {
+    username: string,
+    uid: number
+}
+
+export default async () => {
+    console.log('Preparing Database for Tests');
+
+    const DB = new ScylloClient<{ 'users': User }>({
+        client: {
+            contactPoints: [
+                'localhost:9042'
+            ],
+            localDataCenter: 'datacenter1',
+            keyspace: 'system'
+        }
+    });
+    await DB.awaitConnection();
+    await DB.useKeyspace('scyllojestsuite', true);
+    await DB.createTable('users', true, {
+        username: { type: 'text' },
+        uid: { type: 'bigint' },
+    }, 'uid');
+    await DB.shutdown();
+};
diff --git a/__tests__/__GLOBAL_TEARDOWN__.ts b/__tests__/__GLOBAL_TEARDOWN__.ts
@@ -0,0 +1,24 @@
+import { ScylloClient } from '../lib';
+
+type User = {
+    username: string,
+    uid: number
+}
+
+export default async () => {
+    console.log('Cleaning Database after Tests');
+
+    const DB = new ScylloClient<{ 'users': User }>({
+        client: {
+            contactPoints: [
+                'localhost:9042'
+            ],
+            localDataCenter: 'datacenter1',
+            keyspace: 'system'
+        },
+        prepare: false
+    });
+    await DB.awaitConnection();
+    await DB.raw('DROP KEYSPACE IF EXISTS scyllojestsuite');
+    await DB.shutdown();
+};
diff --git a/__tests__/insertInto.spec.ts → __tests__/live/insertInto.spec.ts b/__tests__/insertInto.spec.ts → __tests__/live/insertInto.spec.ts
@@ -1,4 +1,4 @@
-import { ScylloClient } from "../lib";
+import { ScylloClient } from "../../lib";
 
 type User = {
     username: string,
@@ -14,7 +14,7 @@ beforeAll(async () => {
                 'localhost:9042'
             ],
             localDataCenter: 'datacenter1',
-            keyspace: 'scyllo'
+            keyspace: 'scyllojestsuite'
         }
     });
     await DB.awaitConnection();

diff --git a/__tests__/selectFrom.spec.ts → __tests__/live/selectFrom.spec.ts b/__tests__/selectFrom.spec.ts → __tests__/live/selectFrom.spec.ts
@@ -1,4 +1,4 @@
-import { ScylloClient } from "../lib";
+import { ScylloClient } from "../../lib";
 
 type User = {
     username: string,
@@ -14,7 +14,7 @@ beforeAll(async () => {
                 'localhost:9042'
             ],
             localDataCenter: 'datacenter1',
-            keyspace: 'scyllo'
+            keyspace: 'scyllojestsuite'
         }
     });
     await DB.awaitConnection();

diff --git a/__tests__/selectOneFrom.spec.ts → __tests__/live/selectOneFrom.spec.ts b/__tests__/selectOneFrom.spec.ts → __tests__/live/selectOneFrom.spec.ts
@@ -1,5 +1,5 @@
 import Long from "long";
-import { ScylloClient, selectOneFromRaw } from "../lib";
+import { ScylloClient, selectOneFromRaw } from "../../lib";
 
 type User = {
     username: string,
@@ -15,7 +15,7 @@ beforeAll(async () => {
                 'localhost:9042'
             ],
             localDataCenter: 'datacenter1',
-            keyspace: 'scyllo'
+            keyspace: 'scyllojestsuite'
         }
     });
     await DB.awaitConnection();

diff --git a/__tests__/update.spec.ts → __tests__/live/update.spec.ts b/__tests__/update.spec.ts → __tests__/live/update.spec.ts
@@ -1,5 +1,5 @@
 import Long from "long";
-import { ScylloClient } from "../lib";
+import { ScylloClient } from "../../lib";
 
 type User = {
     username: string,
@@ -15,7 +15,7 @@ beforeAll(async () => {
                 'localhost:9042'
             ],
             localDataCenter: 'datacenter1',
-            keyspace: 'scyllo'
+            keyspace: 'scyllojestsuite'
         }
     });
     await DB.awaitConnection();

diff --git a/__tests__/createIndexRaw.spec.ts → __tests__/raw/createIndexRaw.spec.ts b/__tests__/createIndexRaw.spec.ts → __tests__/raw/createIndexRaw.spec.ts
@@ -1,4 +1,4 @@
-import { createIndexRaw, createLocalIndexRaw } from '../lib';
+import { createIndexRaw, createLocalIndexRaw } from '../../lib';
 
 it('Can create a basic table', async () => {
     expect(

diff --git a/__tests__/createTableRaw.spec.ts → __tests__/raw/createTableRaw.spec.ts b/__tests__/createTableRaw.spec.ts → __tests__/raw/createTableRaw.spec.ts
@@ -1,4 +1,4 @@
-import { createTableRaw } from "../lib";
+import { createTableRaw } from "../../lib";
 
 it('Can create a basic table', async () => {
     expect(createTableRaw<{'atable': {a:string}}, 'atable'>('scyllo', 'atable', false, {a: {type: 'bigint'}}, 'a')).toEqual({"args": [], "query": "CREATE TABLE scyllo.atable (a bigint, PRIMARY KEY (a))"});

diff --git a/__tests__/deleteFromRaw.spec.ts → __tests__/raw/deleteFromRaw.spec.ts b/__tests__/deleteFromRaw.spec.ts → __tests__/raw/deleteFromRaw.spec.ts
@@ -1,4 +1,4 @@
-import { selectOneFromRaw } from "../lib";
+import { selectOneFromRaw } from "../../lib";
 
 // fix
 it('Can insert a user into the database', async () => {

diff --git a/__tests__/insertIntoRaw.spec.ts → __tests__/raw/insertIntoRaw.spec.ts b/__tests__/insertIntoRaw.spec.ts → __tests__/raw/insertIntoRaw.spec.ts
@@ -1,4 +1,4 @@
-import { selectOneFromRaw } from "../lib";
+import { selectOneFromRaw } from "../../lib";
 
 // fix
 it('Can insert a user into the database', async () => {

diff --git a/__tests__/updateRaw.spec.ts → __tests__/raw/updateRaw.spec.ts b/__tests__/updateRaw.spec.ts → __tests__/raw/updateRaw.spec.ts
@@ -1,4 +1,4 @@
-import { updateRaw } from "../lib"
+import { updateRaw } from "../../lib"
 
 it('Can update a specific user in the database', async () => {
     expect(updateRaw<{'users': {uid: number, username: string}}, 'users', 'uid' | 'username'>('scyllo', 'users', { username: "Jest" }, { uid: 1234567890 })).toEqual({query: 'UPDATE scyllo.users SET username=? WHERE uid=?', args: ['Jest', 1234567890]});

diff --git a/jest.config.js b/jest.config.js
@@ -2,8 +2,10 @@
 module.exports = {
     preset: 'ts-jest',
     testEnvironment: 'node',
-    testPathIgnorePatterns: ['/.history/', '/node_modules/'],
+    testPathIgnorePatterns: ['/.history/', '/node_modules/', '/__tests__/__.*.ts'],
     /*reporters: [
         'jest-nyancat-reporter'
     ]*/
+    globalSetup: './__tests__/__GLOBAL_SETUP__.ts',
+    globalTeardown: './__tests__/__GLOBAL_TEARDOWN__.ts',
 };
diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
         "typescript-eslint": "^0.0.1-alpha.0"
     },
     "scripts": {
-        "test": "yarn build && jest",
+        "test": "yarn build && jest --verbose",
         "build": "tsc",
         "lint": "eslint -c .eslintrc.json --ext .ts ./src",
         "pub": "yarn build && yarn publish --access public"

diff --git a/src/ScylloClient.ts b/src/ScylloClient.ts
@@ -24,7 +24,25 @@ export type ScylloClientOptions = {
      * Cassandra-Driver config
      * Empty Object = `localhost:9042`
      */
-    client: CassandraConfig;
+    client: CassandraConfig & {
+        /**
+         * Name of the keyspace you would like to use
+         * -scyllo was here
+         */
+        keyspace: string,
+        /**
+         * Name of the datacenter you would like to use,
+         * This can be completely arbitrary and is used for routing.
+         * -scyllo was here
+         */
+        localDataCenter: string
+    };
+    /**
+     * Whether to prepare inputed args for query
+     * @default true
+     * @example false
+     */
+    prepare?: boolean;
     /**
      * Custom log method
      * @default `console.log`
@@ -45,16 +63,18 @@ const fromObjScyllo = (row: types.Row) =>
             .map((item: any) => ({ [item]: fromScyllo(row.get(item)) }))
     );
 export class ScylloClient<Tables extends TableScheme> {
-    keyspace: string = 'scyllo';
+    keyspace: string;
     client: Client;
     debug: boolean;
     log: LogMethod;
+    prepare: boolean;
 
     constructor(options: ScylloClientOptions) {
         this.client = new Client(options.client);
-        this.keyspace = options.client.keyspace ?? '';
+        this.keyspace = options.client.keyspace;
         this.debug = options.debug || false;
         this.log = options.log || console.log;
+        this.prepare = options.prepare ?? true;
     }
     /**
      * Await the connection
@@ -81,7 +101,7 @@ export class ScylloClient<Tables extends TableScheme> {
         if (this.debug)
             this.log(`[Scyllo][Debug]\t${query}\n${args.join(' ')}`);
 
-        return await this.client.execute(query, args);
+        return await this.client.execute(query, args, { prepare: this.prepare });
     }
 
     async query(query: QueryBuild): Promise<types.ResultSet> {
@@ -206,7 +226,7 @@ export class ScylloClient<Tables extends TableScheme> {
     async dropTable<Table extends keyof Tables>(
         table: Table
     ): Promise<types.ResultSet> {
-        return await this.rawWithParams('DROP TABLE ?', [table]);
+        return await this.raw('DROP TABLE ' + table);
     }
     /**
      * Create

diff --git a/src/ScylloTranslator.ts b/src/ScylloTranslator.ts
@@ -1,6 +1,6 @@
 import { types } from 'cassandra-driver';
 
-export type ScylloSafeType = string | number | types.Long | boolean;
+export type ScylloSafeType = string | number | types.Long | boolean | object;
 export type ValidDataType =
     | string
     | number
@@ -12,10 +12,6 @@ export type ValidDataType =
 export const toScyllo: (a: ValidDataType) => ScylloSafeType = (a) => {
     if (a instanceof types.Long) return a;
 
-    if (Array.isArray(a) || a instanceof Object) {
-        return JSON.stringify(a);
-    }
-
     return a;
 };