Added tests for data review tool

shaunhutch · shaunhutch · commit f6639f2cf0cc · 2023-06-22T23:03:18.000-07:00
diff --git a/tests/data_review_tool/test_article_review.py b/tests/data_review_tool/test_article_review.py
@@ -0,0 +1,72 @@
+# Author: Shaun Hutchinson,
+# Date: 2023-06-22
+from dash._callback_context import context_value
+from dash._utils import AttributeDict
+from dash import html, dash_table
+import dash_mantine_components as dmc
+from dash.testing.browser import Browser
+import pytest
+import sys
+import os
+
+# ensure that the parent directory is on the path for relative imports
+sys.path.append(os.path.join(os.path.dirname(__file__), "..", ".."))
+
+from src.data_review_tool.app import *
+from src.data_review_tool.pages.article_review import *
+
+
+def test_collapse():
+    """Test that the collapse function returns None when the no accordion is clicked."""
+    assert collapse(True) == None
+
+
+def test_cell_clicked():
+    "Test that the cell_clicked function returns the correct value when a cell is clicked."
+    assert cell_clicked(1) == "/"
+    assert cell_clicked(0) == dash.no_update
+
+
+def test_directory_structure():
+    "Test that the directory structure is as expected."
+    dir = "data/data-review-tool"
+    expected = ["processed", "raw"]
+    assert sorted(os.listdir(dir)) == expected
+
+
+def test_find_start_end_char():
+    "Test that the find_start_end_char function returns the correct values."
+    text = "This is a test"
+    entity = "test"
+    assert find_start_end_char(text, entity) == (10, 14)
+
+
+def test_update_button():
+    "Test that the update_button function returns correct children for Delete or Restore."
+    assert update_button(True)[0].children == "Delete Entity"
+    assert update_button(False)[0].children == "Restore Entity"
+
+
+def test_chips_values():
+    "Test that the chips_values function returns the correct values."
+    site = "test"
+    taxa, region, geog, alti, age, email = None, None, None, None, None, None
+    accordian = "SITE"
+    data = {"entities": {"SITE": {"test": {"corrected_name": "test"}}}}
+
+    assert chips_values(
+        site, taxa, region, geog, alti, age, email, accordian, data
+    ) == ("test", False, False, "test")
+
+
+def test_enable_correct_button():
+    "Test that the enable_correct_button function returns the correct values."
+    assert enable_correct_button("Pinus") == False
+
+
+def test_update_chips():
+    "Test that the update_chips function returns the correct values."
+    deleted = False
+    data = {"entities": {"SITE": {"test": {"corrected_name": "test"}}}}
+
+    assert update_chips(deleted, data)[0] == "test"
diff --git a/tests/data_review_tool/test_home.py b/tests/data_review_tool/test_home.py
@@ -0,0 +1,115 @@
+# Author: Shaun Hutchinson,
+# Date: 2023-06-22
+from dash._utils import AttributeDict
+from dash import html, dash_table
+import dash_mantine_components as dmc
+import pandas as pd
+import pytest
+from dash.testing.application_runners import import_app
+from dash.testing.composite import DashComposite
+import sys
+import os
+
+sys.path.append(os.path.join(os.path.dirname(__file__), "..", ".."))
+
+# Import the names of callback functions you want to test
+from src.data_review_tool.app import *
+from src.data_review_tool.pages.home import *
+from src.data_review_tool.pages.config import *
+
+
+def test_directory_structure():
+    "test that the data directory structure is correct"
+    dir = "data/data-review-tool"
+    expected = ["processed", "raw"]
+
+    assert sorted(os.listdir(dir)) == expected
+
+
+def test_current_article_clicked():
+    "test that clicking 'Review' button redirects to the correct article"
+    active_cell_current = AttributeDict({"row": 0, "column_id": "Review"})
+    current_data = [{"gddid": "1234", "Review": "Review"}]
+    active_cell_completed = None
+    completed_data = None
+    active_cell_nonrelevant = None
+    nonrelevant_data = None
+
+    # Create the expected output
+    expected = "/article/1234"
+    assert (
+        current_article_clicked(
+            active_cell_current,
+            current_data,
+            active_cell_completed,
+            completed_data,
+            active_cell_nonrelevant,
+            nonrelevant_data,
+        )
+        == expected
+    )
+
+
+def test_get_article_tab():
+    """Test that the tab is created correctly"""
+    tab_header = "Current"
+    data = pd.DataFrame({"gddid": ["1234", "5678"]})
+
+    # Create the expected output
+    expected = dmc.Tab(
+        children=dmc.Text(tab_header, style=tab_header_style),
+        value=tab_header,
+        rightSection=dmc.Badge(
+            f"{data.shape[0]}",
+            p=0,
+            variant="filled",
+            style=badge_style,
+            sx={"width": 20, "height": 20, "pointerEvents": "none"},
+        ),
+    )
+
+    assert (
+        get_article_tab(tab_header, data).rightSection.children
+        == expected.rightSection.children
+    )
+    assert get_article_tab(tab_header, data).value == expected.value
+
+
+def test_get_article_table():
+    """Test that the table is created correctly"""
+    table_id = "current-table"
+    location_id = "current-table-location"
+    tab_header = "Current Articles"
+    data = pd.DataFrame({"gddid": ["1234", "5678"]})
+
+    expected = dmc.TabsPanel(
+        html.Div(
+            [
+                dash_table.DataTable(
+                    id=table_id,
+                    filter_action="native",
+                    sort_action="native",
+                    page_action="native",
+                    page_size=10,
+                    style_data=table_data_style,
+                    filter_options={"placeholder_text": ""},
+                    columns=[{"name": i, "id": i} for i in data.columns],
+                    data=data.to_dict("records"),
+                    style_data_conditional=table_conditional_style,
+                    style_table={
+                        "overflowX": "auto",
+                        "padding-top": "20px",
+                    },
+                    style_cell=table_cell_style,
+                    style_header=table_header_style,
+                ),
+                dcc.Location(id=location_id, refresh=True),
+            ],
+            style=tab_body_style,
+        ),
+        value=tab_header,
+    )
+    assert (
+        get_article_table(table_id, location_id, tab_header, data).value
+        == expected.value
+    )
