Merge branch '4-move-bdd-features-into-a-separate-repository' into 'dev'

Resolve "Move bdd features into a separate repository"

Closes #4

See merge request !3

.gitignore

@@ -55,3 +55,8 @@ node_modules/
 
 # Vim swap files
 *.swp
+
+# backbone-adapter-testsuite
+
+test/features/*.feature
+test/fixtures/*.json
\ No newline at end of file

README.md

@@ -14,6 +14,8 @@ Implements:
 
 ```
 yarn install
+# move testsuite files into view
+yarn copytests
 ```
 
 ## Test 

cucumber.js

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

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

@@ -18,6 +18,9 @@
   ],
   "license": "MIT",
   "scripts": {
+    "copytest:features": "npx recursive-copy -w node_modules/backbone-adapter-testsuite/features test/features",
+    "copytest:fixtures": "npx recursive-copy -w node_modules/backbone-adapter-testsuite/fixtures test/fixtures",
+    "copytests": "npm run copytest:features && npm run copytest:fixtures",
     "lint:js": "eslint --ext \".js\" --ignore-path .gitignore .",
     "lint:prettier": "prettier --check .",
     "lint": "yarn lint:js && yarn lint:prettier",
@@ -33,6 +36,7 @@
   },
   "dependencies": {
     "faye-websocket": "^0.11.4",
+    "json-schema-remote": "^1.6.2",
     "swagger-model-validator": "^3.0.21"
   },
   "devDependencies": {
@@ -45,6 +49,7 @@
     "axios": "^1.2.3",
     "axios-mock-adapter": "^1.21.2",
     "babel-jest": "^27.4.4",
+    "backbone-adapter-testsuite": "git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-testsuite.git#packages",
     "cross-env": "^7.0.3",
     "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.3.0",
@@ -54,6 +59,7 @@
     "lint-staged": "^12.1.2",
     "openapi-schema-validator": "^12.1.0",
     "prettier": "^2.5.1",
+    "recursive-copy-cli": "^1.0.20",
     "rollup": "^3.9.1"
   }
 }

test/cucumber/adapter/before.steps.js

@@ -11,8 +11,8 @@ const { fixtures } = require('../../fixtures/server');
 
 const mockValidConfig = fixtures.get('config-valid');
 const mockInvalidConfig = fixtures.get('config-invalid');
+const mockSchema = fixtures.get('schema-swagger');
 
-const mockSchema = require('../../mock/swagger.json');
 const { GenericProtocol } = require('../../../dist/protocol');
 
 /**

test/fixtures/config-invalid.json

-{
-  "api": "https://example.backbone.com/api",
-  "client_id": "invalid-client-id",
-  "client_name": "InvalidClientName",
-  "subscription": "dot.delimited.topic.subscription.#",
-  "secret": "TheCollaredDoveCoosInTheChimneyPot"
-}
\ No newline at end of file

test/fixtures/config-valid.json

-{
-  "api": "https://example.backbone.com/api",
-  "client_id": "unique-client-id",
-  "client_name": "UniqueClientName",
-  "subscription": "dot.delimited.topic.subscription.#",
-  "secret": "TheGeeseFlySouthInWinter"
-}
\ No newline at end of file

test/fixtures/message-vehicle-status-invalid.json

-{
-  "metadata": {
-    "source": "ae",
-    "destination": "soar.po.ecosub.eco1",
-    "delivery_type": "publish",
-    "message_id": "test"
-  },
-  "payload": {
-    "messagetype": "VehicleStatus",
-    "operatorID": 1,
-    "vehicleID": 12,
-    "coordinates": {
-      "latitude": "monkeys",
-      "longitude": "janvier",
-      "depth": "twenty five metres please",
-      "projection": 4326
-    },
-    "battery_percentage": "plenty"
-  }
-}
\ No newline at end of file