Resolve "import-features-and-fixtures-from-js-adapter"

Closes #1 (closed)

features/adapter_get-authorization-header.feature

+Feature: Does the adapter authenticate?

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

features/adapter_get-authorization-header.feature

-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

MANIFEST.in

+include features/*.feature
+include fixtures/*.json

README.md

 
 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. 
+
+In JS the target tag/branch/commit is specified with # after the git url
+
+### 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 
+
+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 
+pip install -r reqiurements.txt
+# copy features and fixtures into test directory
+copy_tests
+```

copy_tests.py

+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

package.json

+{
+  "name": "backbone-adapter-testsuite",
+  "version": "0.0.1",
+  "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"
+}

setup.cfg

+[options.entry_points]
+console_scripts=
+    copy_tests = testsuite.copy_tests:copy
\ No newline at end of file

setup.py

+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,
+)

[Trishna Saeharaseelan]

Could the filename follow snake case or kebab-case?

[Dan Jones]

Could do - the reason for the difference is adapter is the class get-authorization-feature is the method. I did that deliberately to delineate between those 2 concepts.

[Trishna Saeharaseelan]

Hmm. I understand, but I still think it would be good to choose one naming convention.

[Trishna Saeharaseelan]

Does this need a validation before publishing? (or are we just validating incoming messages from client's side?)

Then the protocol "validate" method is called