From 1780539810b341ef4c067f42cbb8b5b94d7d3bfc Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Wed, 18 Jan 2023 16:01:32 +0000
Subject: [PATCH 01/18] feat: features and fixtures from js adapter
---
LICENCE.md | 7 +
README.md | 20 +-
features/adapter_auth.feature | 13 +
features/adapter_broadcast.feature | 18 ++
.../adapter_get-authorization-header.feature | 21 ++
features/adapter_poll.feature | 42 +++
features/adapter_publish.feature | 18 ++
features/adapter_token-valid.feature | 21 ++
features/adapter_validate.feature | 16 ++
features/protocol_decode.feature | 11 +
features/protocol_encode.feature | 11 +
features/protocol_get-type.feature | 12 +
features/protocol_validate.feature | 12 +
features/schema_validate.feature | 10 +
fixtures/config-invalid.json | 7 +
fixtures/config-valid.json | 7 +
fixtures/message-vehicle-status-invalid.json | 20 ++
fixtures/message-vehicle-status.json | 20 ++
fixtures/response-denied-token.json | 3 +
fixtures/response-valid-token.json | 4 +
fixtures/schema-swagger.json | 252 ++++++++++++++++++
21 files changed, 544 insertions(+), 1 deletion(-)
create mode 100644 LICENCE.md
create mode 100644 features/adapter_auth.feature
create mode 100644 features/adapter_broadcast.feature
create mode 100644 features/adapter_get-authorization-header.feature
create mode 100644 features/adapter_poll.feature
create mode 100644 features/adapter_publish.feature
create mode 100644 features/adapter_token-valid.feature
create mode 100644 features/adapter_validate.feature
create mode 100644 features/protocol_decode.feature
create mode 100644 features/protocol_encode.feature
create mode 100644 features/protocol_get-type.feature
create mode 100644 features/protocol_validate.feature
create mode 100644 features/schema_validate.feature
create mode 100644 fixtures/config-invalid.json
create mode 100644 fixtures/config-valid.json
create mode 100644 fixtures/message-vehicle-status-invalid.json
create mode 100644 fixtures/message-vehicle-status.json
create mode 100644 fixtures/response-denied-token.json
create mode 100644 fixtures/response-valid-token.json
create mode 100644 fixtures/schema-swagger.json
diff --git a/LICENCE.md b/LICENCE.md
new file mode 100644
index 0000000..10bb2c1
--- /dev/null
+++ b/LICENCE.md
@@ -0,0 +1,7 @@
+Copyright 2023 [NOC](https://noc.ac.uk)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
index 82d8c17..88d1c4e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
# backbone-adapter-testsuite
-Gherkin feature definitions and fixtures to run against all language ports of the adapter.
\ No newline at end of file
+Gherkin feature definitions and fixtures to run against all language ports of the backbone-adapter.
+
+## Contents
+
+### /features
+
+Gherkin `.feature` files describing a suite of tests which
+should be run against all language ports of the adapter
+
+### /fixtures
+
+A set of fixtures to be used to configure the tests.
+
+### Implementations
+
+You can see existing implementations of the test suite here
+
+- [JS-Cucumber](https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-javascript)
+Step definitions are in `test/cucumber`
\ No newline at end of file
diff --git a/features/adapter_auth.feature b/features/adapter_auth.feature
new file mode 100644
index 0000000..c55e271
--- /dev/null
+++ b/features/adapter_auth.feature
@@ -0,0 +1,13 @@
+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
diff --git a/features/adapter_broadcast.feature b/features/adapter_broadcast.feature
new file mode 100644
index 0000000..e37344a
--- /dev/null
+++ b/features/adapter_broadcast.feature
@@ -0,0 +1,18 @@
+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
diff --git a/features/adapter_get-authorization-header.feature b/features/adapter_get-authorization-header.feature
new file mode 100644
index 0000000..59de9a4
--- /dev/null
+++ b/features/adapter_get-authorization-header.feature
@@ -0,0 +1,21 @@
+Feature: Does the adapter authenticate?
+ When an adapter instance is created it authenticates and receives a token
+
+ 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
diff --git a/features/adapter_poll.feature b/features/adapter_poll.feature
new file mode 100644
index 0000000..9ecc9e9
--- /dev/null
+++ b/features/adapter_poll.feature
@@ -0,0 +1,42 @@
+# 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
diff --git a/features/adapter_publish.feature b/features/adapter_publish.feature
new file mode 100644
index 0000000..7e7e7de
--- /dev/null
+++ b/features/adapter_publish.feature
@@ -0,0 +1,18 @@
+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
diff --git a/features/adapter_token-valid.feature b/features/adapter_token-valid.feature
new file mode 100644
index 0000000..53fe89d
--- /dev/null
+++ b/features/adapter_token-valid.feature
@@ -0,0 +1,21 @@
+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
diff --git a/features/adapter_validate.feature b/features/adapter_validate.feature
new file mode 100644
index 0000000..c2af9f1
--- /dev/null
+++ b/features/adapter_validate.feature
@@ -0,0 +1,16 @@
+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
diff --git a/features/protocol_decode.feature b/features/protocol_decode.feature
new file mode 100644
index 0000000..ab2a50f
--- /dev/null
+++ b/features/protocol_decode.feature
@@ -0,0 +1,11 @@
+# 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
diff --git a/features/protocol_encode.feature b/features/protocol_encode.feature
new file mode 100644
index 0000000..41bb57c
--- /dev/null
+++ b/features/protocol_encode.feature
@@ -0,0 +1,11 @@
+# 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
diff --git a/features/protocol_get-type.feature b/features/protocol_get-type.feature
new file mode 100644
index 0000000..829ae6d
--- /dev/null
+++ b/features/protocol_get-type.feature
@@ -0,0 +1,12 @@
+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
diff --git a/features/protocol_validate.feature b/features/protocol_validate.feature
new file mode 100644
index 0000000..a5293c4
--- /dev/null
+++ b/features/protocol_validate.feature
@@ -0,0 +1,12 @@
+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
diff --git a/features/schema_validate.feature b/features/schema_validate.feature
new file mode 100644
index 0000000..34f457a
--- /dev/null
+++ b/features/schema_validate.feature
@@ -0,0 +1,10 @@
+# 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
diff --git a/fixtures/config-invalid.json b/fixtures/config-invalid.json
new file mode 100644
index 0000000..82625f6
--- /dev/null
+++ b/fixtures/config-invalid.json
@@ -0,0 +1,7 @@
+{
+ "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
diff --git a/fixtures/config-valid.json b/fixtures/config-valid.json
new file mode 100644
index 0000000..8b765ec
--- /dev/null
+++ b/fixtures/config-valid.json
@@ -0,0 +1,7 @@
+{
+ "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
diff --git a/fixtures/message-vehicle-status-invalid.json b/fixtures/message-vehicle-status-invalid.json
new file mode 100644
index 0000000..c59f56d
--- /dev/null
+++ b/fixtures/message-vehicle-status-invalid.json
@@ -0,0 +1,20 @@
+{
+ "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
diff --git a/fixtures/message-vehicle-status.json b/fixtures/message-vehicle-status.json
new file mode 100644
index 0000000..55cdd81
--- /dev/null
+++ b/fixtures/message-vehicle-status.json
@@ -0,0 +1,20 @@
+{
+ "metadata": {
+ "source": "ae",
+ "destination": "soar.po.ecosub.eco1",
+ "delivery_type": "publish",
+ "message_id": "test"
+ },
+ "payload": {
+ "message_type": "VehicleStatus",
+ "operator_id": "po",
+ "vehicle_id": "eco1",
+ "coordinates": {
+ "latitude": 57.234,
+ "longitude": -8.432,
+ "depth": 50,
+ "projection": 4326
+ },
+ "battery_percentage": 64
+ }
+}
\ No newline at end of file
diff --git a/fixtures/response-denied-token.json b/fixtures/response-denied-token.json
new file mode 100644
index 0000000..d5fb311
--- /dev/null
+++ b/fixtures/response-denied-token.json
@@ -0,0 +1,3 @@
+{
+ "message": "Invalid client credentials"
+}
\ No newline at end of file
diff --git a/fixtures/response-valid-token.json b/fixtures/response-valid-token.json
new file mode 100644
index 0000000..87306ff
--- /dev/null
+++ b/fixtures/response-valid-token.json
@@ -0,0 +1,4 @@
+{
+ "token": "gAAAAABjwB-vxtER44M2en6xYyt7G1WXp8QwfsiHw-ijCqNBZpQPwxxrBHzUU1fQ9lfPPo4QHj50p-yh203dV6zLLoTzuiReqGzE2InqAxOwv4gddlQWNFJKyrmg4mVVMX2VZe2cCAljmHxEo66BHgt_T24AieedMnI4VR2kw4SFiooFv5nr2W8=",
+ "expiry": "2030-12-31T23:59:59.000000"
+}
\ No newline at end of file
diff --git a/fixtures/schema-swagger.json b/fixtures/schema-swagger.json
new file mode 100644
index 0000000..35999bc
--- /dev/null
+++ b/fixtures/schema-swagger.json
@@ -0,0 +1,252 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "title": "soar",
+ "version": "1.0",
+ "description": "SoAR message schemas"
+ },
+ "paths": {},
+ "components": {
+ "schemas": {
+ "Message": {
+ "properties": {
+ "metadata": {
+ "$ref": "#/components/schemas/Metadata"
+ },
+ "payload": {
+ "$ref": "#/components/schemas/Payload"
+ }
+ },
+ "required": ["metadata", "payload"]
+ },
+ "Payload": {
+ "discriminator": {
+ "propertyName": "message_type",
+ "mapping": {
+ "VehicleStatus": "#/components/schemas/VehicleStatus",
+ "VehicleMission": "#/components/schemas/VehicleMission",
+ "AreaOfInterest": "#/components/schemas/AreaOfInterest"
+ }
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/VehicleStatus"
+ },
+ {
+ "$ref": "#/components/schemas/VehicleMission"
+ },
+ {
+ "$ref": "#/components/schemas/AreaOfInterest"
+ }
+ ]
+ },
+ "Metadata": {
+ "properties": {
+ "source": {
+ "type": "string",
+ "description": "The sender.",
+ "example": "autonomy-engine"
+ },
+ "destination": {
+ "type": "string",
+ "description": "Publisher topic.",
+ "example": "soar.noc.autosub.ah1.status"
+ },
+ "delivery_type": {
+ "type": "string",
+ "description": "Published or broadcast",
+ "enum": ["broadcast", "publish"],
+ "example": "2.0.0"
+ },
+ "message_id": {
+ "type": "string",
+ "description": "An identifier for the type of message received.",
+ "example": "VehicleStatus"
+ }
+ },
+ "required": ["source","destination","message_id"],
+ "type": "object"
+ },
+ "Coordinates": {
+ "properties": {
+ "latitude": {
+ "type": "number",
+ "description": "Latitude in decimal degrees.",
+ "example": 54.234
+ },
+ "longitude": {
+ "type": "number",
+ "description": "Longitude in decimal degrees.",
+ "example": -1.432
+ },
+ "depth": {
+ "type": "number",
+ "description": "Target depth",
+ "default": 0,
+ "example": 50
+ },
+ "altitude": {
+ "type": "number",
+ "description": "Target altitude above bottom",
+ "default": 0,
+ "example": 50
+ },
+ "projection": {
+ "type": "integer",
+ "description": "EPSG Projection Code",
+ "example": 4326,
+ "default": 4326
+ }
+ },
+ "required": ["latitude", "longitude"],
+ "type": "object"
+ },
+ "VehicleStatus": {
+ "properties": {
+ "message_type": {
+ "type": "string",
+ "description": "An identifier for the payload type.",
+ "example": "VehicleStatus",
+ "enum": ["VehicleStatus"]
+ },
+ "operator_id": {
+ "type": "string",
+ "description": "An identifier for the operator.",
+ "example": "noc"
+ },
+ "vehicle_id": {
+ "type": "string",
+ "description": "An identifier for the vehicle.",
+ "example": "noc_ah1"
+ },
+ "coordinates": {
+ "$ref": "#/components/schemas/Coordinates"
+ },
+ "battery_percentage": {
+ "type": "number",
+ "description": "The remaining battery capacity.",
+ "example": 64
+ }
+ },
+ "required": ["message_type", "operator_id", "vehicle_id", "coordinates", "battery_percentage"],
+ "type": "object"
+ },
+ "VehicleMission": {
+ "properties": {
+ "message_type": {
+ "type": "string",
+ "description": "An identifier for the payload type.",
+ "example": "VehicleMission",
+ "enum": ["VehicleMission"]
+ },
+ "operator_id": {
+ "type": "string",
+ "description": "An identifier for the operator.",
+ "example": "noc"
+ },
+ "vehicle_id": {
+ "type": "string",
+ "description": "An identifier for the vehicle.",
+ "example": "noc_ah1"
+ },
+ "coordinates": {
+ "$ref": "#/components/schemas/Coordinates"
+ },
+ "actions": {
+ "type": "array",
+ "items": {
+ "discriminator": {
+ "propertyName": "action_type",
+ "mapping": {
+ "GoToWaypoint": "#/components/schemas/GoToWaypoint",
+ "DescendToAltitude": "#/components/schemas/DescendToAltitude",
+ "AscendToSurface": "#/components/schemas/AscendToSurface"
+ }
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/VehicleStatus"
+ },
+ {
+ "$ref": "#/components/schemas/VehicleMission"
+ },
+ {
+ "$ref": "#/components/schemas/AreaOfInterest"
+ }
+ ]
+ }
+ }
+ },
+ "required": ["message_type", "operator_id", "vehicle_id", "coordinates", "actions"],
+ "type": "object"
+ },
+ "AreaOfInterest": {
+ "properties": {
+ "message_type": {
+ "type": "string",
+ "description": "An identifier for the payload type.",
+ "example": "AreaOfInterest",
+ "enum": ["AreaOfInterest"]
+ },
+ "operator_id": {
+ "type": "string",
+ "description": "An identifier for the operator.",
+ "example": "noc"
+ },
+ "vehicle_id": {
+ "type": "string",
+ "description": "An identifier for the vehicle.",
+ "example": "noc_ah1"
+ },
+ "coordinates": {
+ "$ref": "#/components/schemas/Coordinates"
+ }
+ },
+ "required": ["message_type", "operator_id", "vehicle_id", "coordinates"],
+ "type": "object"
+ },
+ "GoToWaypoint": {
+ "properties": {
+ "action_type": {
+ "type": "string",
+ "description": "An identifier for the payload type.",
+ "example": "GoToWaypoint",
+ "enum": ["GoToWaypoint"]
+ },
+ "coordinates": {
+ "$ref": "#/components/schemas/Coordinates"
+ }
+ },
+ "type": "object"
+ },
+ "DescendToAltitude": {
+ "properties": {
+ "action_type": {
+ "type": "string",
+ "description": "An identifier for the payload type.",
+ "example": "DescendToAltitude",
+ "enum": ["DescendToAltitude"]
+ },
+ "coordinates": {
+ "$ref": "#/components/schemas/Coordinates"
+ }
+ },
+ "type": "object"
+ },
+ "AscendToSurface": {
+ "properties": {
+ "action_type": {
+ "type": "string",
+ "description": "An identifier for the payload type.",
+ "example": "AscendToSurface",
+ "enum": ["AscendToSurface"]
+ },
+ "coordinates": {
+ "$ref": "#/components/schemas/Coordinates"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+}
--
GitLab
From ddd182c92ba717786c72d9e55deefca91baf69fe Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 09:09:31 +0000
Subject: [PATCH 02/18] fix: correct feature description for auth header
---
features/adapter_get-authorization-header.feature | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/features/adapter_get-authorization-header.feature b/features/adapter_get-authorization-header.feature
index 59de9a4..554acdf 100644
--- a/features/adapter_get-authorization-header.feature
+++ b/features/adapter_get-authorization-header.feature
@@ -1,5 +1,5 @@
-Feature: Does the adapter authenticate?
- When an adapter instance is created it authenticates and receives a token
+Feature: Can the adapter create an authorization header?
+ The adapter getAuthorizationHeader method works as expected
Scenario: getAuthorizationHeader returns a bearer token
Given valid config
--
GitLab
From 40b9fe63ed9cbdd7130904f8c69d6a07dfdf1641 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 14:52:49 +0000
Subject: [PATCH 03/18] test: experiment with installing with npm and pip
---
package.json | 23 +++++++++++++++++++++++
setup.py | 9 +++++++++
2 files changed, 32 insertions(+)
create mode 100644 package.json
create mode 100644 setup.py
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..3dab9b5
--- /dev/null
+++ b/package.json
@@ -0,0 +1,23 @@
+{
+ "name": "backbone-adapter-testsuite",
+ "description": "Common test suite to run on all adapter language ports",
+ "repository": {
+ "type": "git",
+ "url": "git@git.noc.ac.uk:communications-backbone-system/backbone-adapter-testsuite.git"
+ },
+ "contributors": [
+ {
+ "name": "James Kirk",
+ "email": "james.kirk@noc.ac.uk"
+ },
+ {
+ "name": "Dan Jones",
+ "email": "dan.jones@noc.ac.uk"
+ },
+ {
+ "name": "Trishna Saeharaseelan",
+ "email": "trishna.saeharaseelan@noc.ac.uk"
+ }
+ ],
+ "license": "MIT"
+}
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..5e932fa
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,9 @@
+setup(
+ name='backbone-adapter-testsuite',
+ packages=find_packages(),
+ package_data={
+ 'myapp': ['features/*.feature', 'fixtures/*.json'],
+ },
+ include_package_data=True,
+ zip_safe=False
+)
\ No newline at end of file
--
GitLab
From 97b7f98c81ab77d8900a26e627f5040ff7240634 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 15:07:10 +0000
Subject: [PATCH 04/18] fix: import setup
---
setup.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/setup.py b/setup.py
index 5e932fa..1f90bd8 100644
--- a/setup.py
+++ b/setup.py
@@ -1,3 +1,5 @@
+from setuptools import setup
+
setup(
name='backbone-adapter-testsuite',
packages=find_packages(),
--
GitLab
From a82e040fb87489ead13408733c8a2962392f11a4 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 15:08:38 +0000
Subject: [PATCH 05/18] fix: import find_packages
---
setup.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/setup.py b/setup.py
index 1f90bd8..4aff18b 100644
--- a/setup.py
+++ b/setup.py
@@ -1,4 +1,4 @@
-from setuptools import setup
+from setuptools import setup, find_packages
setup(
name='backbone-adapter-testsuite',
@@ -8,4 +8,4 @@ setup(
},
include_package_data=True,
zip_safe=False
-)
\ No newline at end of file
+)
--
GitLab
From ddfef10d09507d55110eff4b077cd508537fb171 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 15:19:01 +0000
Subject: [PATCH 06/18] fix: change package data name
---
setup.py | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/setup.py b/setup.py
index 4aff18b..f05a85b 100644
--- a/setup.py
+++ b/setup.py
@@ -1,10 +1,11 @@
from setuptools import setup, find_packages
+
setup(
name='backbone-adapter-testsuite',
packages=find_packages(),
package_data={
- 'myapp': ['features/*.feature', 'fixtures/*.json'],
+ 'backbone-adapter-testsuite': ['features/*.feature', 'fixtures/*.json'],
},
include_package_data=True,
zip_safe=False
--
GitLab
From be9e95cc68c60f8fb032e9c5b9d12283d164fc28 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 15:23:24 +0000
Subject: [PATCH 07/18] fix: change package_data config
---
setup.py | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/setup.py b/setup.py
index f05a85b..4bfd512 100644
--- a/setup.py
+++ b/setup.py
@@ -5,7 +5,8 @@ setup(
name='backbone-adapter-testsuite',
packages=find_packages(),
package_data={
- 'backbone-adapter-testsuite': ['features/*.feature', 'fixtures/*.json'],
+ 'features': ['features/*.feature'],
+ 'fixtures': ['*.json'],
},
include_package_data=True,
zip_safe=False
--
GitLab
From a06070b8caa47508d800541240d5bc2918dd37da Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 15:26:36 +0000
Subject: [PATCH 08/18] fix declare package_data from root
---
setup.py | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/setup.py b/setup.py
index 4bfd512..5e8d14f 100644
--- a/setup.py
+++ b/setup.py
@@ -5,8 +5,7 @@ setup(
name='backbone-adapter-testsuite',
packages=find_packages(),
package_data={
- 'features': ['features/*.feature'],
- 'fixtures': ['*.json'],
+ '': ['features/*.feature', 'fixtures/*.json'],
},
include_package_data=True,
zip_safe=False
--
GitLab
From 3581c145d04279ef232f611a42e501dd6452d43a Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 15:31:09 +0000
Subject: [PATCH 09/18] fix: add package data to MANIFEST.in
---
MANIFEST.in | 2 ++
1 file changed, 2 insertions(+)
create mode 100644 MANIFEST.in
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..4f01146
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,2 @@
+include features/*.feature
+include fixtures/*.json
--
GitLab
From 778abaff656b01820e3aeecfc8e555c6ea35f5e4 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Thu, 19 Jan 2023 15:44:39 +0000
Subject: [PATCH 10/18] fix: identify location of package
---
setup.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/setup.py b/setup.py
index 5e8d14f..5f409e4 100644
--- a/setup.py
+++ b/setup.py
@@ -1,12 +1,14 @@
-from setuptools import setup, find_packages
+from setuptools import setup
setup(
name='backbone-adapter-testsuite',
- packages=find_packages(),
+ packages=['testsuite'],
+ package_dir: {
+ 'testsuite': '.',
+ },
package_data={
- '': ['features/*.feature', 'fixtures/*.json'],
+ 'testsuite': ['features/*.feature', 'fixtures/*.json'],
},
include_package_data=True,
- zip_safe=False
)
--
GitLab
From 07f7f064bd544bed47b7115c1665bf48e3cf0cc4 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Fri, 20 Jan 2023 09:29:39 +0000
Subject: [PATCH 11/18] fix: correct indentation
---
setup.py | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/setup.py b/setup.py
index 5f409e4..6e8bc2e 100644
--- a/setup.py
+++ b/setup.py
@@ -2,13 +2,13 @@ from setuptools import setup
setup(
- name='backbone-adapter-testsuite',
- packages=['testsuite'],
- package_dir: {
- 'testsuite': '.',
- },
- package_data={
- 'testsuite': ['features/*.feature', 'fixtures/*.json'],
- },
- include_package_data=True,
+ name='backbone-adapter-testsuite',
+ packages=['testsuite'],
+ package_dir={
+ 'testsuite': '.',
+ },
+ package_data={
+ 'testsuite': ['features/*.feature', 'fixtures/*.json'],
+ },
+ include_package_data=True,
)
--
GitLab
From 7bcad5e26dfea49a37ffed718a9ce27107228e86 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Fri, 20 Jan 2023 15:35:52 +0000
Subject: [PATCH 12/18] feat: add post install setup for python
---
README.md | 31 +++++++++++++++++++++++++++++--
copy_tests.py | 25 +++++++++++++++++++++++++
setup.cfg | 3 +++
setup.py | 2 +-
4 files changed, 58 insertions(+), 3 deletions(-)
create mode 100644 copy_tests.py
create mode 100644 setup.cfg
diff --git a/README.md b/README.md
index 88d1c4e..ddb70bc 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,36 @@ should be run against all language ports of the adapter
A set of fixtures to be used to configure the tests.
-### Implementations
+## Implementations
You can see existing implementations of the test suite here
- [JS-Cucumber](https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-javascript)
-Step definitions are in `test/cucumber`
\ No newline at end of file
+Step definitions are in `test/cucumber`
+
+## Installing
+
+The intention is to install a tagged version of the testsuite into each adapter so that if we develop
+the testsuite existing adapter implementations won't break.
+
+### NPM
+
+```bash
+npm install --saveDev git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-testsuite.git#[tag|branch|commit]
+```
+
+### Yarn
+
+```bash
+yarn add --dev git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-testsuite.git#[tag|branch|commit]
+```
+
+### PIP
+
+```bash
+echo
+"git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-testsuite.git@[tag|branch|commit]#egg=backbone-adapter-testsuite" >> requirements.txt
+pip install -r reqiurements.txt
+# copy features and fixtures into test directory
+copy_tests
+```
diff --git a/copy_tests.py b/copy_tests.py
new file mode 100644
index 0000000..631c831
--- /dev/null
+++ b/copy_tests.py
@@ -0,0 +1,25 @@
+import os
+from shutil import copytree
+import site
+
+
+def copy_directory(src, dest, directory):
+ copytree(os.path.join(src, directory), os.path.join(dest, directory))
+
+
+def copy():
+ here = os.getcwd();
+ package_locations = site.getsitepackages()
+
+ for root_path in package_locations:
+ dirs = [x[0] for x in os.walk(root_path)]
+ for dirx in dirs:
+ if dirx.endswith('testsuite'):
+ src = dirx
+ dest = os.path.join(here, 'test')
+ copy_directory(src, dest, 'features')
+ copy_directory(src, dest, 'fixtures')
+
+
+if __name__ == '__main__':
+ copy()
\ No newline at end of file
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..a8aeb66
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,3 @@
+[options.entry_points]
+console_scripts=
+ copy_tests = testsuite.copy_tests:copy
\ No newline at end of file
diff --git a/setup.py b/setup.py
index 6e8bc2e..b025934 100644
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,7 @@ from setuptools import setup
setup(
- name='backbone-adapter-testsuite',
+ name='backbone_adapter_testsuite',
packages=['testsuite'],
package_dir={
'testsuite': '.',
--
GitLab
From 95692094de5498d55ab3b7cb05787424069c4882 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Fri, 20 Jan 2023 15:40:39 +0000
Subject: [PATCH 13/18] fix: add version to package.json
---
package.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/package.json b/package.json
index 3dab9b5..6cc5121 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,6 @@
{
"name": "backbone-adapter-testsuite",
+ "version": "0.0.1",
"description": "Common test suite to run on all adapter language ports",
"repository": {
"type": "git",
--
GitLab
From 66f7e6f115bc08ced8bd3edba5dd9baba8f7dd13 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Fri, 20 Jan 2023 16:08:20 +0000
Subject: [PATCH 14/18] docs: draw attention to the git url versioning
---
README.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/README.md b/README.md
index ddb70bc..0bc3abc 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,8 @@ Step definitions are in `test/cucumber`
The intention is to install a tagged version of the testsuite into each adapter so that if we develop
the testsuite existing adapter implementations won't break.
+In JS the target tag/branch/commit is specified with # after the git url
+
### NPM
```bash
@@ -39,6 +41,8 @@ yarn add --dev git+https://git.noc.ac.uk/communications-backbone-system/backbone
### PIP
+In pip the target tag/branch/commit is specified with @ after the git url
+
```bash
echo
"git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-testsuite.git@[tag|branch|commit]#egg=backbone-adapter-testsuite" >> requirements.txt
--
GitLab
From 06cefe4e050901fe4ca880f976dd9750f37550eb Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Mon, 23 Jan 2023 15:27:52 +0000
Subject: [PATCH 15/18] fix: correct typos in scenario names
---
features/adapter_poll.feature | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/features/adapter_poll.feature b/features/adapter_poll.feature
index 9ecc9e9..ff05566 100644
--- a/features/adapter_poll.feature
+++ b/features/adapter_poll.feature
@@ -5,7 +5,7 @@
Feature: Can the adapter receive messages?
The adapter poll method works as expected
- Scenario: No messages are received succecssfully if the queue is empty
+ Scenario: No messages are received successfully if the queue is empty
Given valid config
When the adapter instance is created
When the auth method is called
@@ -13,7 +13,7 @@ Feature: Can the adapter receive 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
+ Scenario: 2 messages are received successfully if the queue contains 2 messages
Given valid config
When the adapter instance is created
When the auth method is called
@@ -23,7 +23,7 @@ Feature: Can the adapter receive 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
+ Scenario: 10 messages are received successfully if the queue contains 10 messages
Given valid config
When the adapter instance is created
When the auth method is called
--
GitLab
From 89f4449612b1ec80c69283e95c18032448407669 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Mon, 23 Jan 2023 15:42:04 +0000
Subject: [PATCH 16/18] fix: clearer grammar for token scenarios
---
features/adapter_token-valid.feature | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/features/adapter_token-valid.feature b/features/adapter_token-valid.feature
index 53fe89d..e0e105b 100644
--- a/features/adapter_token-valid.feature
+++ b/features/adapter_token-valid.feature
@@ -1,19 +1,19 @@
Feature: Is the token valid?
The adapter tokenValid method works as expected
- Scenario: If adapter has not authed token is invalid
+ Scenario: If adapter has not authed then the tokenValid returns false
Given valid config
When the adapter instance is created
Then tokenValid returns false
- Scenario: If credentials.expiry is in the future token is valid
+ Scenario: If credentials.expiry is in the future then the 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
+ Scenario: If credentials.expiry is in the past then the token is invalid
Given valid config
When the adapter instance is created
When the auth method is called
--
GitLab
From 797ebbcb35e49b48b9eaf38e613d4e9ec9792019 Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Mon, 23 Jan 2023 16:28:31 +0000
Subject: [PATCH 17/18] docs: explain expected behaviour of tokenValid
---
features/adapter_token-valid.feature | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/features/adapter_token-valid.feature b/features/adapter_token-valid.feature
index e0e105b..c7290a7 100644
--- a/features/adapter_token-valid.feature
+++ b/features/adapter_token-valid.feature
@@ -1,3 +1,9 @@
+# tokenValid returns true if there is a token and the expiry is in the future
+# tokenValid returns false if the token expiry is in the past
+# or if there is no token
+# In the case where invalid credentials are supplied
+# the auth will fail so there will be no token available
+
Feature: Is the token valid?
The adapter tokenValid method works as expected
--
GitLab
From ec09b26945415b1d75edccdcc7ddf7945e6fcd2b Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Wed, 25 Jan 2023 08:14:32 +0000
Subject: [PATCH 18/18] fix: correct action schema references
---
fixtures/schema-swagger.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/fixtures/schema-swagger.json b/fixtures/schema-swagger.json
index 35999bc..c0638af 100644
--- a/fixtures/schema-swagger.json
+++ b/fixtures/schema-swagger.json
@@ -165,13 +165,13 @@
},
"oneOf": [
{
- "$ref": "#/components/schemas/VehicleStatus"
+ "$ref": "#/components/schemas/GoToWaypoint"
},
{
- "$ref": "#/components/schemas/VehicleMission"
+ "$ref": "#/components/schemas/DescendToAltitude"
},
{
- "$ref": "#/components/schemas/AreaOfInterest"
+ "$ref": "#/components/schemas/AscendToSurface"
}
]
}
--
GitLab