Merge branch 'dev' of https://github.com/oslabs-beta/ksqljs into mx/jestTestsBranch

Author: matthewxing1

.gitignore

@@ -104,4 +104,11 @@ dist
 .tern-port
 
 # Local
-./ksqljsTest.js
+ksqljsTest.js
+package-lock.json
+local_ignore/
+.gitignore
+
+# KSQLDB docker server settings
+ksqldb_server_config/
+

__tests__/integrationtests.js

@@ -1,6 +1,10 @@
 const ksqljs = require('../ksqljs/ksqlJS.js');
 
 // Pre-requisite: start a docker container
+/* To add to README: Prior to running test with 'npm test', please start the ksqlDB
+server using the command 'docker compose-up'. This will spin up a ksqlDB server on
+'http://localhost:8088'
+*/
 
 describe('--Integration Tests--', () => {
 
@@ -61,7 +65,8 @@ describe('--Integration Tests--', () => {
 
     it('.pull receives the correct data from a pull query', async () => {
       const pullData = await client.pull("SELECT * FROM TESTJESTSTREAM;");
-      expect(pullData[1]).toEqual(['stab-rabbit', '123@mail.com', 100]);
+      console.log(pullData[1]);
+      expect(pullData[1]).toEqual(["stab-rabbit", "123@mail.com", 100]);
     })
 
     it('.pullFromTo receives all the data', async () => {
@@ -182,4 +187,4 @@ describe('--Integration Tests--', () => {
     //   }));
     // })
   })
-})
+})

__tests__/builderTest.js renamed to __tests__/queryBuilderTests.js

@@ -1,4 +1,6 @@
 const queryBuilder = require('../ksqljs/queryBuilder.js');
+const { QueryBuilderError, EmptyQueryError, NumParamsError, InappropriateStringParamError } = require('../ksqljs/customErrors.js');
+
 
 describe('Unit tests for query builder class', () => {
   let builder;
@@ -18,33 +20,34 @@ describe('Unit tests for query builder class', () => {
   });
 
   describe('Error testing', () => {
-    it('returns an error if number of params is different from number of question marks', () => {
-      const finishedQuery = builder.build(query, 123, "middle", "extra");
-      expect(finishedQuery).toBeInstanceOf(Error);
+    it('throws an error if number of params is different from number of question marks', () => {
+      expect(() => { builder.build(query, 123, "middle", "extra") }).toThrow(NumParamsError);
     });
 
-    it('returns an error if the query is empty', () => {
+    it('throws an error if the query is empty', () => {
       const query = '';
-      const finishedQuery = builder.build(query, 123);
-      expect(finishedQuery).toBeInstanceOf(Error);
+      expect(() => { builder.build(query, 123) }).toThrow(EmptyQueryError);
     });
 
-    it('returns an error if an object is passed in as a param', () => {
-      const finishedQuery = builder.build(query, 123, { "middle": "size" });
-      expect(finishedQuery).toBeInstanceOf(Error);
+    it('throws an error if an object is passed in as a param', () => {
+      expect(() => { builder.build(query, 123, { "middle": "size" }) }).toThrow(QueryBuilderError);
     });
   });
 
   describe('SQL injection', () => {
     it("prevents 'OR 1=1' SQL injection by escaping single quotations ", () => {
       // https://stackoverflow.com/questions/5139770/escape-character-in-sql-server
-      const finishedQuery = builder.build(query, 123, "middle' OR 1=1",);
+      const finishedQuery = builder.build(query, 123, "middle' OR 1=1");
       expect(finishedQuery).toEqual("SELECT * FROM table WHERE id = 123 AND size = 'middle'' OR 1=1'");
     });
 
     it("prevents (middle' OR 'a'=a') SQL injection by escaping single quotations ", () => {
       const finishedQuery = builder.build(query, 123, "middle' OR 'a'='a",);
       expect(finishedQuery).toEqual("SELECT * FROM table WHERE id = 123 AND size = 'middle'' OR ''a''=''a'");
     });
+
+    it("throws an error if user tries to add a semicolon into a string param not wrapped in quotes", () => {
+      expect(() => { builder.build(query, ['123; DROP tables WHERE size = '], 'middle') }).toThrow(InappropriateStringParamError);
+    });
   });
 });

docker-compose.yml

@@ -34,6 +34,10 @@ services:
     image: confluentinc/ksqldb-server:0.25.1
     hostname: ksqldb-server
     container_name: ksqldb-server
+    volumes:
+      - type: bind
+        source: ./
+        target: /home/appuser
     depends_on:
       - broker
     ports:
@@ -43,6 +47,16 @@ services:
       KSQL_BOOTSTRAP_SERVERS: broker:9092
       KSQL_KSQL_LOGGING_PROCESSING_STREAM_AUTO_CREATE: "true"
       KSQL_KSQL_LOGGING_PROCESSING_TOPIC_AUTO_CREATE: "true"
+      # KSQL_KSQL_OPTS: "-Djava.security.auth.login.config=/jaas_config.file"
+      # KSQL_AUTHENTICATION_METHOD: BASIC
+      # KSQL_AUTHENTICATION_REALM: KsqlServer-Props
+      # KSQL_AUTHENTICATION_ROLES: admin,developer,user
+      # KSQL_SSL_CLIENT_AUTHENTICATION: NONE
+      # KSQL_SSL_TRUSTSTORE_LOCATION: ksqldb_server_config/kafka.server.truststore.jks
+      # KSQL_SSL_TRUSTSTORE_PASSWORD: ${SSL_PASSWORD}
+      # KSQL_SSL_KEYSTORE_LOCATION: ksqldb_server_config/kafka.server.keystore.jks
+      # KSQL_SSL_KEYSTORE_PASSWORD: ${SSL_PASSWORD}
+      # KSQL_SSL_KEY_PASSWORD: ${SSL_PASSWORD}
       KSQL_KSQL_HEARTBEAT_ENABLE: "true"
       KSQL_KSQL_LAG_REPORTING_ENABLE: "true"
 

ksqljs/customErrors.js

@@ -0,0 +1,55 @@
+/** This file contains custom Node.js errors that extends the built-in Error class
+ * REF: https://rclayton.silvrback.com/custom-errors-in-node-js
+ * REF: https://futurestud.io/tutorials/node-js-create-your-custom-error
+ */
+
+// used to wrap error received from ksqlDB server
+class ksqlDBError extends Error {
+  constructor(error) {
+    super(error.message)
+
+    // Ensure the name of this error is the same as the class name
+    this.name = this.constructor.name
+
+    // capturing the stack trace keeps the reference to your error class
+    Error.captureStackTrace(this, this.constructor);
+
+    // you may also assign additional properties to your error
+    //this.status = 404
+  }
+}
+
+// for returning error related to use of queryBuilder class
+class QueryBuilderError extends Error {
+  constructor(message) {
+    super(message)
+    this.name = this.constructor.name
+    Error.captureStackTrace(this, this.constructor);
+  }
+}
+
+class EmptyQueryError extends QueryBuilderError {
+  constructor() {
+    super('Query should not be empty, undefined, or null');
+  }
+}
+
+class NumParamsError extends QueryBuilderError {
+  constructor(message) {
+    super(message);
+  }
+}
+
+class InappropriateStringParamError extends QueryBuilderError {
+  constructor(message) {
+    super(message);
+  }
+}
+
+module.exports = {
+  ksqlDBError,
+  QueryBuilderError,
+  EmptyQueryError,
+  NumParamsError,
+  InappropriateStringParamError
+};