[e988c2]: / tests / unit / backends / test_base.py

Download this file

199 lines (155 with data), 5.9 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
import datetime
import pytest
import sqlalchemy
from ehrql.backends.base import (
DefaultSQLBackend,
MappedTable,
QueryTable,
SQLBackend,
ValidationError,
)
from ehrql.query_engines.base_sql import BaseSQLQueryEngine
from ehrql.query_model.nodes import Column, TableSchema
from ehrql.tables import PatientFrame, Series, table
class BackendFixture(SQLBackend):
display_name = "Backend Fixture"
query_engine_class = BaseSQLQueryEngine
patient_join_column = "PatientId"
patients = MappedTable(
source="Patient",
columns=dict(
patient_id="PatID",
date_of_birth="DateOfBirth",
),
)
events = MappedTable(
source="events",
columns=dict(
date="date",
),
)
practice_registrations = QueryTable(
"SELECT patient_id, date_start, date_end FROM some_table"
)
@QueryTable.from_function
def positive_tests(self):
table_name = self.config.get("table_name", "some_table")
return f"SELECT patient_id, date FROM {table_name}"
def test_backend_registers_tables():
"""Test that a backend registers its table names"""
assert set(BackendFixture.tables) == {
"patients",
"events",
"practice_registrations",
"positive_tests",
}
def test_mapped_table_sql_with_modified_names():
table = BackendFixture().get_table_expression(
"patients",
TableSchema(
date_of_birth=Column(datetime.date),
),
)
sql = str(sqlalchemy.select(table.c.patient_id, table.c.date_of_birth))
assert sql == 'SELECT "Patient"."PatID", "Patient"."DateOfBirth" \nFROM "Patient"'
def test_mapped_table_sql_with_matching_names():
table = BackendFixture().get_table_expression(
"events",
TableSchema(
date=Column(datetime.date),
),
)
sql = str(sqlalchemy.select(table.c.patient_id, table.c.date))
assert sql == 'SELECT events."PatientId", events.date \nFROM events'
def test_query_table_sql():
table = BackendFixture().get_table_expression(
"practice_registrations",
TableSchema(
date_start=Column(datetime.date),
date_end=Column(datetime.date),
),
)
sql = str(sqlalchemy.select(table.c.patient_id, table.c.date_start))
assert sql == (
"SELECT practice_registrations.patient_id, practice_registrations.date_start \n"
"FROM (SELECT patient_id, date_start, date_end FROM some_table) AS "
"practice_registrations"
)
def test_query_table_from_function_sql():
backend = BackendFixture(config={"table_name": "other_table"})
table = backend.get_table_expression(
"positive_tests",
TableSchema(date=Column(datetime.date)),
)
assert str(table) == "SELECT patient_id, date FROM other_table"
def test_default_backend_sql():
backend = DefaultSQLBackend(query_engine_class=BaseSQLQueryEngine)
table = backend.get_table_expression(
"some_table", TableSchema(i=Column(int), b=Column(bool))
)
sql = str(sqlalchemy.select(table.c.patient_id, table.c.i, table.c.b))
assert sql == (
"SELECT some_table.patient_id, some_table.i, some_table.b \nFROM some_table"
)
# Use a class as a convenient namespace (`types.SimpleNamespace` would also work)
class Schema:
@table
class patients(PatientFrame):
date_of_birth = Series(datetime.date)
def test_backend_definition_is_allowed_extra_tables_and_columns():
class BackendFixture(SQLBackend):
display_name = "Backend Fixture"
query_engine_class = BaseSQLQueryEngine
patient_join_column = "patient_id"
implements = [Schema]
patients = MappedTable(
source="patient",
columns=dict(date_of_birth="DoB", sex="sex"),
)
events = MappedTable(
source="patient",
columns=dict(date="date", code="code"),
)
assert BackendFixture
def test_backend_definition_accepts_query_table():
class BackendFixture(SQLBackend):
display_name = "Backend Fixture"
query_engine_class = BaseSQLQueryEngine
patient_join_column = "patient_id"
implements = [Schema]
patients = QueryTable(
"SELECT patient_id, CAST(DoB AS date) AS date_of_birth FROM patients",
)
assert BackendFixture
def test_backend_definition_fails_if_missing_tables():
with pytest.raises(ValidationError, match="does not implement table"):
class BackendFixture(SQLBackend):
display_name = "Backend Fixture"
query_engine_class = BaseSQLQueryEngine
patient_join_column = "patient_id"
implements = [Schema]
events = MappedTable(
source="patient",
columns=dict(date="date", code="code"),
)
def test_backend_definition_fails_if_missing_column():
with pytest.raises(ValidationError, match="missing columns"):
class BackendFixture(SQLBackend):
display_name = "Backend Fixture"
query_engine_class = BaseSQLQueryEngine
patient_join_column = "patient_id"
implements = [Schema]
patients = MappedTable(
source="patient",
columns=dict(sex="sex"),
)
def test_backend_definition_fails_if_query_table_missing_columns():
with pytest.raises(ValidationError, match="SQL does not reference columns"):
class BackendFixture(SQLBackend):
display_name = "Backend Fixture"
query_engine_class = BaseSQLQueryEngine
patient_join_column = "patient_id"
implements = [Schema]
patients = QueryTable(
"SELECT patient_id, not_date_of_birth FROM patients",
)