Implement acceptance test framework (#99)

.github/workflows/ci-cd.yaml

@@ -64,10 +64,12 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: PEP 8 check
-        run: python setup.py pep8
+      - name: Install dependencies
+        run: pip3 install -r requirements.txt
       - name: Check import orders
-        run: python setup.py isort
+        run: isort --check .
+      - name: pep8
+        run: pycodestyle .
 
   unit-tests:
     name: Unit Tests
@@ -79,11 +81,13 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
+      - name: Install dependencies
+        run: pip3 install -r requirements.txt
       - name: Run tests
-        run: python setup.py test
+        run: python -m unittest
 
   sync-to-huggingface-space:
-    needs: [yaml-lint, linkChecker, code-style]
+    needs: unit-tests
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -95,7 +99,7 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install dependencies
-        run: pip3 install -e .
+        run: pip3 install -r requirements.txt
       - name: Generate Hugging Face Datasets
         run: |
           cd huggingface
@@ -116,8 +120,8 @@ jobs:
           HF_TOKEN: ${{ secrets.HF_TOKEN }}
 
   docker:
-    name: Test Docker Build and Publish Data Image to DockerHub
-    needs: [sync-to-huggingface-space]
+    name: Test Docker Build, Runs Acceptance Tests, and Publish Data Image to DockerHub
+    needs: unit-tests
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -134,6 +138,7 @@ jobs:
               --publish=7687:7687 \
               --env=NEO4J_AUTH=none \
               --env=NEO4J_ACCEPT_LICENSE_AGREEMENT=yes \
+              -e NEO4JLABS_PLUGINS=\[\"apoc\"\] \
               --name data-loader \
               neo4j:${{ env.NEO4J_ENTERPRISE_VERSION }} &
       - name: Wait for database to be ready
@@ -152,6 +157,10 @@ jobs:
           NEO4J_DATABASE: ${{ env.NEO4J_DATABASE }}
           NEO4J_USERNAME: ${{ env.NEO4J_USERNAME }}
           NEO4J_PASSWORD: ${{ env.NEO4J_PASSWORD }}
+      - name: Install dependencies
+        run: pip3 install -r requirements.txt
+      - name: Run acceptance tests
+        run: behave
       - name: Copy over data onto host
         run: docker cp data-loader:/data .
       - name: Test image build
@@ -183,7 +192,7 @@ jobs:
 
   triggering:
     name: Triggering data model acceptance tests CI/CD
-    needs: [sync-to-huggingface-space]
+    needs: [sync-to-huggingface-space, docker]
     if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     steps:

README.md

@@ -146,7 +146,7 @@ We have offered some queries that can be used to quickly explore the vocabulary
 - How German, Latin, and Ancient greek expresses the conjunction "but":
 
   ```cypher
-  MATCH (node{label:'δέ'})
+  MATCH (node{label:"δέ"})
   CALL apoc.path.expand(node, "LINK", null, 1, 4)
   YIELD path
   RETURN path, length(path) AS hops

ancient-greek.yaml

@@ -691,7 +691,7 @@ vocabulary:
     definition:
       - (part. & conj.) and
       - (part. & conj.) but
-  - term: δ’
+  - term: δ᾽
     definition: (Apocopic form of) δέ
   - term: μέν ... δέ
     definition: on the one hand ... on the other hand (often untranslated)

behave.ini

@@ -0,0 +1,4 @@
+[behave]
+stdout_capture = no
+stderr_capture = no
+log_capture = no

features/graphs.feature

@@ -0,0 +1,18 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+Feature: Neo4J in Docker shows expected graphs
+
+  Scenario: "but" linking
+      When we expand 'δέ' by 3 hops at most
+      Then we get 13 nodes and 13 links, all distinct

features/steps/graphs.py

@@ -0,0 +1,65 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from behave import *
+from neo4j import GraphDatabase
+
+
+@when("we expand 'δέ' by 3 hops at most")
+def step_impl(context):
+    assert True is not False
+
+
+@then('we get 13 nodes and 13 links, all distinct')
+def step_impl(context):
+    driver = GraphDatabase.driver("neo4j://localhost:7687", auth=("not used", "not used"))
+
+    with driver.session() as session:
+        result = parse_apoc_path_expand_result(session.run(
+            """
+            MATCH (node{label:"δέ"})
+            CALL apoc.path.expand(node, "LINK", null, 1, 3)
+            YIELD path
+            RETURN path;
+            """
+        ))
+
+        assert set(result["nodes"]) == {"aber lieber", "aber", "but", "sed", "ἀλλά", "δέ", "and", "τε", "et", "καί",
+                                        "also", "even", "δ’"}
+
+
+def parse_apoc_path_expand_result(result):
+    nodes = set()
+    links = []
+
+    nodeMap = dict()
+    duplicateLinks = set()
+    for record in result:
+        path = record["path"]
+
+        for node in path.nodes:
+            label = dict(node)["label"]
+            nodes.add(label)
+            nodeMap[node.id] = label
+
+        for link in path.relationships:
+            if link.id not in duplicateLinks:
+                duplicateLinks.add(link.id)
+
+                links.append({
+                    "source": nodeMap[link.start_node.id],
+                    "target": nodeMap[link.end_node.id],
+                    "label": dict(link)["label"],
+                })
+
+    return {"nodes": list(nodes), "links": links}

huggingface/vocabulary_parser.py

@@ -133,7 +133,7 @@ def get_attributes(
         word: object,
         language: str,
         node_label_attribute_key: str,
-        inflection_supplier: Callable[[object], dict]=lambda word: {}
+        inflection_supplier: Callable[[object], dict] = lambda word: {}
 ) -> dict[str, str]:
     """
     Returns a flat map as the Term node properties stored in Neo4J.
@@ -170,7 +170,7 @@ def get_audio(word: object) -> dict:
 def get_inferred_links(
         vocabulary: list[dict],
         label_key: str,
-        inflection_supplier: Callable[[object], dict[str, str]]=lambda word: {}
+        inflection_supplier: Callable[[object], dict[str, str]] = lambda word: {}
 ) -> list[dict]:
     """
     Return a list of inferred links between related vocabularies.
@@ -217,7 +217,7 @@ def get_term_tokens(word: dict) -> set[str]:
 
 def get_inflection_tokens(
         word: dict,
-        inflection_supplier: Callable[[object], dict[str, str]]=lambda word: {}
+        inflection_supplier: Callable[[object], dict[str, str]] = lambda word: {}
 ) -> set[str]:
     tokens = set()
 
@@ -230,14 +230,14 @@ def get_inflection_tokens(
     return tokens
 
 
-def get_tokens_of(word: dict, inflection_supplier: Callable[[object], dict[str, str]]=lambda word: {}) -> set[str]:
+def get_tokens_of(word: dict, inflection_supplier: Callable[[object], dict[str, str]] = lambda word: {}) -> set[str]:
     return get_inflection_tokens(word, inflection_supplier) | get_term_tokens(word) | get_definition_tokens(word)
 
 
 def get_inferred_tokenization_links(
         vocabulary: list[dict],
         label_key: str,
-        inflection_supplier: Callable[[object], dict[str, str]]=lambda word: {}
+        inflection_supplier: Callable[[object], dict[str, str]] = lambda word: {}
 ) -> list[dict]:
     """
     Return a list of inferred links between related vocabulary terms which are related to one another.

requirements.txt

@@ -0,0 +1,9 @@
+pyyaml
+nltk
+wilhelm_data_loader
+
+pycodestyle
+isort
+
+behave
+neo4j

setup.cfg

@@ -1,3 +1,3 @@
 [pep8]
 max-line-length = 120
-exclude = ./.eggs
+exclude = ./.eggs,./build

setup.py

@@ -1,19 +0,0 @@
-from setuptools import find_packages
-from setuptools import setup
-
-setup(
-    name="wilhelm_vocabulary",
-    version="0.0.1",
-    description="A vocabulary processor specifically designed for QubitPi",
-    url="https://github.com/QubitPi/wilhelm-vocabulary",
-    author="Jiaqi Liu",
-    author_email="[email protected]",
-    license="Apache-2.0",
-    packages=find_packages(),
-    python_requires='>=3.10',
-    install_requires=["pyyaml", "nltk", "wilhelm_data_loader"],
-    zip_safe=False,
-    include_package_data=True,
-    setup_requires=["setuptools-pep8", "isort"],
-    test_suite='tests',
-)