Merge branch '3-implement-bdd-tests-in-cucumber' into...

Merge branch '3-implement-bdd-tests-in-cucumber' into '1-import-prototype-adapter-code-from-example-web-client'

Resolve "Implement bdd tests in cucumber"

See merge request !2

README.md

@@ -10,11 +10,39 @@ Implements:
 - validation of messages against a specified OpenAPI schema 
 - decode/encode stubs
 
-## Install
+## Setup 
+
+```
+yarn install
+```
+
+## Test 
+
+The tests are written in [cucumber](https://cucumber.io/docs/installation/javascript/)
+
+This means we can have a common suite of [gherkin](https://github.com/cucumber/gherkin)
+tests across adapter ports written in multiple languages. 
+
+```
+yarn test
+```
+
+## Installing in your project 
+
+We may publish this to a public registry but for now you need to install the package 
+from git. 
+
+### Requirements 
+
+An `axios` library. Axios is included as a dev dependency to run the tests. 
+I've not installed it as a runtime dependency because in nuxt you need to 
+use `@nuxtjs/axios` instead. 
+
+**TODO fix this in rollup config**
 
 ### Yarn
 
-#### Once public 
+#### Once public
 
 ```yarn
 yarn add git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-javascript.git
@@ -50,6 +78,7 @@ This will be provided by the backbone operator or requested via the API.
 
 ```json
 {
+  "api": "[backbone api root url]",
   "client_id": "unique-client-id",
   "client_name": "UniqueClientName",
   "subscription": "dot.delimited.topic.subscription.#",

cucumber.js

+module.exports = {
+  default: {
+    formatOptions: {
+      snippetInterface: "synchronous"
+    },
+    paths: [ 'features/**/*.feature' ],
+    require: [ 'test/cucumber/**/*.steps.js' ],
+  },
+};

dist/adapter.esm.js

-import Validator from 'swagger-model-validator';
 import axios from 'axios';
 
 /**
@@ -9,8 +8,6 @@ class Adapter {
     this.protocol = protocol;
     this.config = config;
     this.axios = axios;
-    this.validator = new Validator(protocol.schema);
-    this.auth();
   }
 
   /**
@@ -26,10 +23,7 @@ class Adapter {
    * @returns {object}
    */
   validate(message) {
-    return this.validator.validate(
-      message,
-      this.protocol.schema.definitions.Message
-    );
+    return this.protocol.validate(message);
   }
 
   /**
@@ -79,6 +73,9 @@ class Adapter {
       .then((response) => {
         this.credentials = response.data;
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -106,6 +103,9 @@ class Adapter {
           } 
         });
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -134,6 +134,9 @@ class Adapter {
       })
       .then((response) => {
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -164,6 +167,9 @@ class Adapter {
       })
       .then((response) => {
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 }

dist/adapter.js

 'use strict';
 
-var Validator = require('swagger-model-validator');
 var axios = require('axios');
 
 /**
@@ -11,8 +10,6 @@ class Adapter {
     this.protocol = protocol;
     this.config = config;
     this.axios = axios;
-    this.validator = new Validator(protocol.schema);
-    this.auth();
   }
 
   /**
@@ -28,10 +25,7 @@ class Adapter {
    * @returns {object}
    */
   validate(message) {
-    return this.validator.validate(
-      message,
-      this.protocol.schema.definitions.Message
-    );
+    return this.protocol.validate(message);
   }
 
   /**
@@ -81,6 +75,9 @@ class Adapter {
       .then((response) => {
         this.credentials = response.data;
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -108,6 +105,9 @@ class Adapter {
           } 
         });
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -136,6 +136,9 @@ class Adapter {
       })
       .then((response) => {
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -166,6 +169,9 @@ class Adapter {
       })
       .then((response) => {
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 }

dist/protocol.esm.js

@@ -35,7 +35,13 @@ class GenericProtocol {
    * @returns {object}
    */
   validate(message) {
-    return this.validator.validate(message, this.schema.definitions.Message);
+    return this.validator.validate(
+      message,
+      this.schema.components.schemas.Message,
+      this.schema.components.schemas,
+      false,
+      true
+    );
   }
 
   /**
@@ -44,7 +50,11 @@ class GenericProtocol {
    * @returns {string}
    */
   getType(message) {
-    return message.message_type;
+    try {
+      return message.payload.message_type;
+    } catch(error) {
+      return null;
+    }
   }
 
   /**

dist/protocol.js

@@ -37,7 +37,13 @@ class GenericProtocol {
    * @returns {object}
    */
   validate(message) {
-    return this.validator.validate(message, this.schema.definitions.Message);
+    return this.validator.validate(
+      message,
+      this.schema.components.schemas.Message,
+      this.schema.components.schemas,
+      false,
+      true
+    );
   }
 
   /**
@@ -46,7 +52,11 @@ class GenericProtocol {
    * @returns {string}
    */
   getType(message) {
-    return message.message_type;
+    try {
+      return message.payload.message_type;
+    } catch(error) {
+      return null;
+    }
   }
 
   /**

features/adapter_auth.feature

+Feature: Does the adapter authenticate?
+  When an adapter instance is created it authenticates and receives a token
+
+  Scenario: A token is granted with valid config
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    Then the adapter credentials are populated
+
+  Scenario: Auth fails with invalid config
+    Given invalid config
+    When the adapter instance is created
+    Then the adapter auth fails
\ No newline at end of file

features/adapter_broadcast.feature

+Feature: Can the adapter broadcast messages?
+  The adapter publish method works as expected
+
+  Scenario: A message can be published successfully
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock notify API response is configured to return success
+    When the broadcast method is called
+    Then a successful response is returned with status 200
+
+  Scenario: A failed publish returns a 403
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock notify API response is configured to return an error
+    When the broadcast method is called
+    Then an error response is returned with status 403
\ No newline at end of file

features/adapter_get-authorization-header.feature

+Feature: Can the adapter create an authorization header?
+  The adapter getAuthorizationHeader method works as expected
+
+  Scenario: getAuthorizationHeader returns a bearer token
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When the getAuthorizationHeader method is called
+    Then a headers object is returned containing a bearer token authorization header
+
+  Scenario: getAuthorizationHeader implicitly calls auth if required
+    Given valid config
+    When the adapter instance is created
+    When the getAuthorizationHeader method is called
+    Then a headers object is returned containing a bearer token authorization header
+
+  Scenario: getAuthorizationHeader implicitly calls auth if required
+    Given invalid config
+    When the adapter instance is created
+    When the getAuthorizationHeader method is called
+    Then an error response is returned with status 403
\ No newline at end of file

features/adapter_poll.feature

+# When the queue contains x messages 
+# only mocks the API response 
+# Testing how the API behaves with a full queue are defined in the API 
+
+Feature: Can the adapter receive messages?
+  The adapter poll method works as expected
+
+  Scenario: No messages are received succecssfully if the queue is empty
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock receive API response is configured to return 0 messages
+    When the poll method is called
+    Then a successful response is returned with 0 messages  
+
+  Scenario: 2 messages are received succecssfully if the queue contains 2 messages
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock receive API response is configured to return 2 messages 
+    When the poll method is called
+    Then a successful response is returned with 2 messages
+    Then the protocol "validate" method is called 2 times
+    Then the protocol "decode" method is called 2 times
+
+  Scenario: 10 messages are received succecssfully if the queue contains 10 messages
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock receive API response is configured to return 10 messages 
+    When the poll method is called
+    Then a successful response is returned with 10 messages
+    Then the protocol "validate" method is called 10 times
+    Then the protocol "decode" method is called 10 times
+
+  Scenario: An invalid token returns a forbidden response 
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock receive API response is configured to return an error
+    When the poll method is called 
+    Then an error response is returned with status 403

features/adapter_publish.feature

+Feature: Can the adapter publish messages?
+  The adapter publish method works as expected
+
+  Scenario: A message can be published successfully
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock send API response is configured to return success
+    When the publish method is called
+    Then a successful response is returned with status 200
+
+  Scenario: A failed publish returns a 403
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock send API response is configured to return an error
+    When the publish method is called
+    Then an error response is returned with status 403

features/adapter_token-valid.feature

+Feature: Is the token valid?
+  The adapter tokenValid method works as expected
+
+  Scenario: If adapter has not authed token is invalid
+    Given valid config
+    When the adapter instance is created
+    Then tokenValid returns false  
+
+  Scenario: If credentials.expiry is in the future token is valid
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When the token expiry is in the future
+    Then tokenValid returns true  
+
+  Scenario: If credentials.expiry is in the past token is invalid
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When the token expiry is in the past
+    Then tokenValid returns false 

features/adapter_validate.feature

+Feature: Can the adapter validate messages?
+  The adapter validate method works as expected
+
+  Scenario: A valid message is successfully validated against the protocol schema
+    Given valid config
+    Given a valid message
+    When the adapter instance is created
+    When the validate method is called
+    Then the message is validated successfully  
+  
+  Scenario: An invalid message fails to validate against the protocol schema
+    Given valid config
+    Given an invalid message
+    When the adapter instance is created
+    When the validate method is called
+    Then the message fails to validate  
\ No newline at end of file

features/protocol_decode.feature

+# Decode and encode are provided as stubs which are intended to be overridden 
+# These can be used to translate the message or to invoke other functions 
+# to take action based on the type and content of messages
+
+Feature: Decode stubs passthru message unchanged
+  The protocol decode method works as expected
+
+  Scenario: Decode passes the message through unaltered
+    Given a valid message
+    When the protocol.decode method is called
+    Then the message is returned unaltered

features/protocol_encode.feature

+# Decode and encode are provided as stubs which are intended to be overridden 
+# These can be used to translate the message or to invoke other functions 
+# to take action based on the type and content of messages
+
+Feature: Encode stubs passthru message unchanged
+  The protocol encode method works as expected
+
+  Scenario: Encode passes the message through unaltered
+    Given a valid message
+    When the protocol.encode method is called
+    Then the message is returned unaltered
\ No newline at end of file

features/protocol_get-type.feature

+Feature: Can the protocol determine message type
+  The protocol getType method works as expected
+
+  Scenario: A valid message is successfully typed
+    Given a valid message
+    When protocol getType is called
+    Then getType returns message.payload.message_type if present
+
+  Scenario: An invalid message returns type:null
+    Given an invalid message
+    When protocol getType is called
+    Then getType returns null if message.payload.message_type is not present

features/protocol_validate.feature

+Feature: Can the protocol validate messages?
+  The adapter validate method works as expected
+
+  Scenario: A valid message is successfully validated against the protocol schema
+    Given a valid message
+    When the protocol.validate method is called
+    Then the message is validated successfully  
+  
+  Scenario: An invalid message fails to validate against the protocol schema
+    Given an invalid message
+    When the protocol.validate method is called
+    Then the message fails to validate
\ No newline at end of file

features/schema_validate.feature

+# If the mock schema fixture fails to validate 
+# it can cause invalid messages to show as valid
+
+Feature: Is the mock schema valid?
+  The mock schema must validate in order for the adapter test to work
+
+  Scenario: The schema matches the OpenAPI specification
+    Given the test schema
+    When it is validated
+    Then it matches the OpenAPI specification  
\ No newline at end of file

package.json

@@ -23,7 +23,8 @@
     "lint": "yarn lint:js && yarn lint:prettier",
     "lintfix": "prettier --write --list-different . && yarn lint:js --fix",
     "prepare": "husky install",
-    "test": "jest",
+    "test": "yarn build && yarn cucumber",
+    "cucumber": "cucumber-js",
     "build": "cross-env NODE_ENV=production rollup -c"
   },
   "lint-staged": {
@@ -31,7 +32,6 @@
     "*.**": "prettier --check --ignore-unknown"
   },
   "dependencies": {
-    "axios": "^1.2.2",
     "faye-websocket": "^0.11.4",
     "swagger-model-validator": "^3.0.21"
   },
@@ -40,16 +40,19 @@
     "@babel/eslint-parser": "^7.0.0",
     "@commitlint/cli": "^15.0.0",
     "@commitlint/config-conventional": "^15.0.0",
+    "@cucumber/cucumber": "^8.10.0",
     "@rollup/plugin-babel": "^6.0.3",
+    "axios": "^1.2.3",
+    "axios-mock-adapter": "^1.21.2",
     "babel-jest": "^27.4.4",
     "cross-env": "^7.0.3",
-    "cucumber": "^6.0.7",
     "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^7.0.4",
     "jest": "^27.4.4",
     "lint-staged": "^12.1.2",
+    "openapi-schema-validator": "^12.1.0",
     "prettier": "^2.5.1",
     "rollup": "^3.9.1"
   }

src/adapter/index.js

-import Validator from 'swagger-model-validator';
 import axios from 'axios';
 
 /**
@@ -9,8 +8,6 @@ export class Adapter {
     this.protocol = protocol;
     this.config = config;
     this.axios = axios;
-    this.validator = new Validator(protocol.schema);
-    this.auth();
   }
 
   /**
@@ -26,10 +23,7 @@ export class Adapter {
    * @returns {object}
    */
   validate(message) {
-    return this.validator.validate(
-      message,
-      this.protocol.schema.definitions.Message
-    );
+    return this.protocol.validate(message);
   }
 
   /**
@@ -79,6 +73,9 @@ export class Adapter {
       .then((response) => {
         this.credentials = response.data;
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -106,6 +103,9 @@ export class Adapter {
           } 
         });
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -134,6 +134,9 @@ export class Adapter {
       })
       .then((response) => {
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 
@@ -164,6 +167,9 @@ export class Adapter {
       })
       .then((response) => {
         return response;
+      })
+      .catch((error) => {
+        return Promise.reject(error);
       });
   }
 }