/
__init__.py
923 lines (748 loc) · 32.2 KB
/
__init__.py
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
from __future__ import annotations
import io
import json
import logging
from dataclasses import dataclass, field, replace
from enum import Enum
from pathlib import Path
from typing import Dict, List, Optional, Set
import typer
SUPPORTED_MANIFEST_SCHEMA_VERSIONS = [
"https://schemas.getdbt.com/dbt/manifest/v4.json",
"https://schemas.getdbt.com/dbt/manifest/v5.json",
"https://schemas.getdbt.com/dbt/manifest/v6.json",
"https://schemas.getdbt.com/dbt/manifest/v7.json",
"https://schemas.getdbt.com/dbt/manifest/v8.json",
"https://schemas.getdbt.com/dbt/manifest/v9.json",
"https://schemas.getdbt.com/dbt/manifest/v10.json",
"https://schemas.getdbt.com/dbt/manifest/v11.json",
]
app = typer.Typer(help="Compute coverage of dbt-managed data warehouses.")
class CoverageType(Enum):
DOC = "doc"
TEST = "test"
class CoverageFormat(str, Enum):
STRING_TABLE = "string"
MARKDOWN_TABLE = "markdown"
@dataclass
class Column:
"""Dataclass containing the information about the docs and tests of a database column."""
name: str
doc: bool = None
test: bool = None
@staticmethod
def from_node(node) -> Column:
return Column(node["name"].lower())
@staticmethod
def is_valid_doc(doc):
return doc is not None and doc != ""
@staticmethod
def is_valid_test(tests):
return tests is not None and tests
@dataclass
class Table:
"""Dataclass containing the information about a database table and its columns."""
unique_id: str
name: str
original_file_path: str
columns: Dict[str, Column]
@staticmethod
def from_node(node, manifest: Manifest) -> Table:
unique_id = node["unique_id"]
manifest_table = manifest.get_table(unique_id)
if manifest_table is None:
raise ValueError(f"Unique ID {unique_id} not found in manifest.json")
columns = [Column.from_node(col) for col in node["columns"].values()]
original_file_path = manifest_table["original_file_path"]
if original_file_path is None:
logging.warning("original_file_path value not found in manifest for %s", unique_id)
return Table(
unique_id,
# Take table name from manifest.json instead of catalog.json since in catalog.json the
# name is actually an alias in case it is defined.
manifest_table["name"].lower(),
original_file_path,
{col.name: col for col in columns},
)
def get_column(self, column_name):
return self.columns.get(column_name)
@dataclass
class Catalog:
"""Dataclass containing the information about a database catalog, its tables and columns."""
tables: Dict[str, Table]
def filter_tables(self, model_path_filter: List[str]) -> Catalog:
"""
Filters ``Catalog``'s ``tables`` attribute to ``Tables`` that have the
``model_path_filter`` value at the start of their ``original_file_path``.
Args:
model_path_filter: the model_path string(s) to filter tables on, (matches using
the ``startswith`` operator)
Returns:
New ``Catalog`` instance containing only ``Table``s that passed the filter
"""
model_path_filter = tuple(model_path_filter)
tables = {
t_id: t
for t_id, t in self.tables.items()
if t.original_file_path.startswith(model_path_filter)
}
logging.info(
"Successfully filtered tables. Total tables post-filtering: %d tables", len(tables)
)
return Catalog(tables=tables)
@staticmethod
def from_nodes(nodes, manifest: Manifest):
tables = [Table.from_node(table, manifest) for table in nodes]
return Catalog({table.unique_id: table for table in tables})
def get_table(self, table_id):
return self.tables.get(table_id)
@dataclass
class Manifest:
sources: Dict[str, Dict[str, Dict[str, Dict]]]
models: Dict[str, Dict[str, Dict[str, Dict]]]
seeds: Dict[str, Dict[str, Dict[str, Dict]]]
snapshots: Dict[str, Dict[str, Dict[str, Dict]]]
tests: Dict[str, Dict[str, List[Dict]]]
@classmethod
def from_nodes(cls, manifest_nodes: Dict[str, Dict]) -> Manifest:
"""Constructs a ``Manifest`` by parsing from manifest.json nodes."""
sources = [
table for table in manifest_nodes.values() if table["resource_type"] == "source"
]
sources = {
table["unique_id"]: {
"columns": cls._normalize_column_names(table["columns"]),
"original_file_path": cls._normalize_path(table["original_file_path"]),
"name": cls._full_table_name(table),
}
for table in sources
}
models = [table for table in manifest_nodes.values() if table["resource_type"] == "model"]
models = {
table["unique_id"]: {
"columns": cls._normalize_column_names(table["columns"]),
"original_file_path": cls._normalize_path(table["original_file_path"]),
"name": cls._full_table_name(table),
}
for table in models
}
seeds = [table for table in manifest_nodes.values() if table["resource_type"] == "seed"]
seeds = {
table["unique_id"]: {
"columns": cls._normalize_column_names(table["columns"]),
"original_file_path": cls._normalize_path(table["original_file_path"]),
"name": cls._full_table_name(table),
}
for table in seeds
}
snapshots = [
table for table in manifest_nodes.values() if table["resource_type"] == "snapshot"
]
snapshots = {
table["unique_id"]: {
"columns": cls._normalize_column_names(table["columns"]),
"original_file_path": cls._normalize_path(table["original_file_path"]),
"name": cls._full_table_name(table),
}
for table in snapshots
}
tests = cls._parse_tests(manifest_nodes)
return Manifest(sources, models, seeds, snapshots, tests)
def get_table(self, table_id):
source_candidate = self.sources.get(table_id)
models_candidate = self.models.get(table_id)
seeds_candidate = self.seeds.get(table_id)
snapshots_candidate = self.snapshots.get(table_id)
all_candidates = [
source_candidate,
models_candidate,
seeds_candidate,
snapshots_candidate,
]
non_empty_candidates = [c for c in all_candidates if c]
if len(non_empty_candidates) > 1:
raise ValueError(
f"Duplicate unique_id: {table_id}, duplicate entries: {non_empty_candidates}"
)
return non_empty_candidates[0] if non_empty_candidates else None
@classmethod
def _parse_tests(cls, manifest_nodes: Dict[str, Dict]) -> Dict[str, Dict[str, List[Dict]]]:
"""Parses tests from manifest.json nodes.
The logic is taken from the dbt-docs official source code:
https://github.com/dbt-labs/dbt-docs/blob/02731092389b18d69649fdc322d969b5d5b61b20/src/app/services/project_service.js#L155-L221
"""
tests = {}
for node in manifest_nodes.values():
if node["resource_type"] != "test" or "test_metadata" not in node:
continue
depends_on = node["depends_on"]["nodes"]
if not depends_on:
continue
if node["test_metadata"]["name"] == "relationships":
table_id = depends_on[-1]
else:
table_id = depends_on[0]
column_name = (
node.get("column_name")
or node["test_metadata"]["kwargs"].get("column_name")
or node["test_metadata"]["kwargs"].get("arg")
)
if not column_name:
continue
column_name = column_name.lower()
table_tests = tests.setdefault(table_id, {})
column_tests = table_tests.setdefault(column_name, [])
column_tests.append(node)
return tests
@staticmethod
def _full_table_name(table):
return f"{table['schema']}.{table['name']}".lower()
@staticmethod
def _normalize_column_names(columns):
for col in columns.values():
col["name"] = col["name"].lower()
return {col["name"]: col for col in columns.values()}
@staticmethod
def _normalize_path(path: str) -> str:
return str(Path(path).as_posix())
@dataclass
class CoverageReport:
"""
Dataclass containing the information about the coverage of an entity, along with its nested
subentities.
Attributes:
report_type: ``Type`` of the entity that the report represents, either CATALOG, TABLE or
COLUMN.
entity_name: In case of TABLE and COLUMN reports, the name of the respective entity.
covered: Collection of names of columns in the entity that are documented.
total: Collection of names of all columns in the entity.
misses: Collection of names of all columns in the entity that are not documented.
coverage: Percentage of documented columns.
subentities: ``CoverageReport``s for each subentity of the entity, i.e. for ``Table``s of
``Catalog`` and for ``Column``s of ``Table``s.
"""
class EntityType(Enum):
CATALOG = "catalog"
TABLE = "table"
COLUMN = "column"
@dataclass(frozen=True)
class ColumnRef:
table_name: str
column_name: str
entity_type: EntityType
cov_type: CoverageType
entity_name: Optional[str]
covered: Set[ColumnRef]
total: Set[ColumnRef]
misses: Set[ColumnRef] = field(init=False)
coverage: float = field(init=False)
subentities: Dict[str, CoverageReport]
def __post_init__(self):
if self.covered is not None and self.total is not None and self.total != 0:
self.misses = self.total - self.covered
self.coverage = len(self.covered) / len(self.total)
else:
self.misses = None
self.coverage = None
@classmethod
def from_catalog(cls, catalog: Catalog, cov_type: CoverageType):
subentities = {
table.name: CoverageReport.from_table(table, cov_type)
for table in catalog.tables.values()
}
covered = set(col for table_report in subentities.values() for col in table_report.covered)
total = set(col for table_report in subentities.values() for col in table_report.total)
return CoverageReport(cls.EntityType.CATALOG, cov_type, None, covered, total, subentities)
@classmethod
def from_table(cls, table: Table, cov_type: CoverageType):
subentities = {
col.name: CoverageReport.from_column(col, cov_type) for col in table.columns.values()
}
covered = set(
replace(col, table_name=table.name)
for col_report in subentities.values()
for col in col_report.covered
)
total = set(
replace(col, table_name=table.name)
for col_report in subentities.values()
for col in col_report.total
)
return CoverageReport(
cls.EntityType.TABLE, cov_type, table.name, covered, total, subentities
)
@classmethod
def from_column(cls, column: Column, cov_type: CoverageType):
if cov_type == CoverageType.DOC:
covered = column.doc
elif cov_type == CoverageType.TEST:
covered = column.test
else:
raise ValueError(f"Unsupported cov_type {cov_type}")
covered = {CoverageReport.ColumnRef(None, column.name)} if covered else set()
total = {CoverageReport.ColumnRef(None, column.name)}
return CoverageReport(cls.EntityType.COLUMN, cov_type, column.name, covered, total, {})
def to_markdown_table(self):
if self.entity_type == CoverageReport.EntityType.TABLE:
return (
f"| {self.entity_name:70} | {len(self.covered):5}/{len(self.total):<5} | "
f"{self.coverage * 100:5.1f}% |"
)
elif self.entity_type == CoverageReport.EntityType.CATALOG:
buf = io.StringIO()
buf.write(f"# Coverage report ({self.cov_type.value})\n")
buf.write("| Model | Columns Covered | % |\n")
buf.write("|:------|----------------:|:-:|\n")
for _, table_cov in sorted(self.subentities.items()):
buf.write(table_cov.to_markdown_table() + "\n")
buf.write(
f"| {'Total':70} | {len(self.covered):5}/{len(self.total):<5} | "
f"{self.coverage * 100:5.1f}% |\n"
)
return buf.getvalue()
else:
raise TypeError(
f"Unsupported report_type for to_markdown_table method: "
f"{type(self.entity_type)}"
)
def to_formatted_string(self):
if self.entity_type == CoverageReport.EntityType.TABLE:
return (
f"{self.entity_name:50} {len(self.covered):5}/{len(self.total):<5} "
f"{self.coverage * 100:5.1f}%"
)
elif self.entity_type == CoverageReport.EntityType.CATALOG:
buf = io.StringIO()
buf.write(f"Coverage report ({self.cov_type.value})\n")
buf.write("=" * 69 + "\n")
for _, table_cov in sorted(self.subentities.items()):
buf.write(table_cov.to_formatted_string() + "\n")
buf.write("=" * 69 + "\n")
buf.write(
f"{'Total':50} {len(self.covered):5}/{len(self.total):<5} "
f"{self.coverage * 100:5.1f}%\n"
)
return buf.getvalue()
else:
raise TypeError(
f"Unsupported report_type for to_formatted_string method: "
f"{type(self.entity_type)}"
)
def to_dict(self):
if self.entity_type == CoverageReport.EntityType.COLUMN:
return {
"name": self.entity_name,
"covered": len(self.covered),
"total": len(self.total),
"coverage": self.coverage,
}
elif self.entity_type == CoverageReport.EntityType.TABLE:
return {
"name": self.entity_name,
"covered": len(self.covered),
"total": len(self.total),
"coverage": self.coverage,
"columns": [col_report.to_dict() for col_report in self.subentities.values()],
}
elif self.entity_type == CoverageReport.EntityType.CATALOG:
return {
"cov_type": self.cov_type.value,
"covered": len(self.covered),
"total": len(self.total),
"coverage": self.coverage,
"tables": [table_report.to_dict() for table_report in self.subentities.values()],
}
else:
raise TypeError(
f"Unsupported report_type for to_dict method: " f"{type(self.entity_type)}"
)
@staticmethod
def from_dict(report, cov_type: CoverageType):
if "tables" in report:
subentities = {
table_report["name"]: CoverageReport.from_dict(table_report, cov_type)
for table_report in report["tables"]
}
return CoverageReport(
CoverageReport.EntityType.CATALOG,
cov_type,
None,
set(col for tbl in subentities.values() for col in tbl.covered),
set(col for tbl in subentities.values() for col in tbl.total),
subentities,
)
elif "columns" in report:
table_name = report["name"]
subentities = {
col_report["name"]: CoverageReport.from_dict(col_report, cov_type)
for col_report in report["columns"]
}
return CoverageReport(
CoverageReport.EntityType.TABLE,
cov_type,
table_name,
set(
replace(col, table_name=table_name)
for col_report in subentities.values()
for col in col_report.covered
),
set(
replace(col, table_name=table_name)
for col_report in subentities.values()
for col in col_report.total
),
subentities,
)
else:
column_name = report["name"]
return CoverageReport(
CoverageReport.EntityType.COLUMN,
cov_type,
column_name,
{CoverageReport.ColumnRef(None, column_name)} if report["covered"] > 0 else set(),
{CoverageReport.ColumnRef(None, column_name)},
{},
)
def to_json(self):
return json.dumps(self.to_dict(), indent=2)
@dataclass
class CoverageDiff:
"""Dataclass summarizing the difference of two coverage reports, mainly its decrease."""
before: Optional[CoverageReport]
after: CoverageReport
new_misses: Dict[str, CoverageDiff] = field(init=False)
def __post_init__(self):
assert self.before is None or self.before.cov_type == self.after.cov_type, (
f"Cannot compare reports with different cov_types: {self.before.cov_type} and "
f"{self.after.cov_type}"
)
assert self.before is None or self.before.entity_type == self.after.entity_type, (
f"Cannot compare reports with different report_types: {self.before.report_type} and "
f"{self.after.entity_type}"
)
self.new_misses = self.find_new_misses()
def find_new_misses(self):
if self.after.entity_type == CoverageReport.EntityType.COLUMN:
return None
new_misses = self.after.misses - (self.before.misses if self.before is not None else set())
res: Dict[str, CoverageDiff] = {}
for new_miss in new_misses:
new_misses_entity_name = (
new_miss.table_name
if self.after.entity_type == CoverageReport.EntityType.CATALOG
else new_miss.column_name
)
before_entity = (
self.before.subentities.get(new_misses_entity_name)
if self.before is not None
else None
)
after_entity = self.after.subentities[new_misses_entity_name]
res[new_misses_entity_name] = CoverageDiff(before_entity, after_entity)
return res
def summary(self):
buf = io.StringIO()
if self.after.entity_type != CoverageReport.EntityType.CATALOG:
raise TypeError(
f"Unsupported report_type for summary method: " f"{self.after.entity_type}"
)
buf.write(f"{'':10}{'before':>10}{'after':>10}{'+/-':>15}\n")
buf.write("=" * 45 + "\n")
buf.write(
f"{'Coverage':10}{self.before.coverage:10.2%}{self.after.coverage:10.2%}"
f"{(self.after.coverage - self.before.coverage):+15.2%}\n"
)
buf.write("=" * 45 + "\n")
add_del = (
f"{len(set(self.after.subentities) - set(self.before.subentities)):+d}/"
f"{-len(set(self.before.subentities) - set(self.after.subentities)):+d}"
)
buf.write(
f"{'Tables':10}{len(self.before.subentities):10d}"
f"{len(self.after.subentities):10d}"
f"{add_del:>15}\n"
)
add_del = (
f"{len(self.after.total - self.before.total):+d}/"
f"{-len(self.before.total - self.after.total):+d}"
)
buf.write(
f"{'Columns':10}{len(self.before.total):10d}{len(self.after.total):10d}"
f"{add_del:>15}\n"
)
buf.write("=" * 45 + "\n")
add_del = (
f"{len(self.after.covered - self.before.covered):+d}/"
f"{-len(self.before.covered - self.after.covered):+d}"
)
buf.write(
f"{'Hits':10}{len(self.before.covered):10d}{len(self.after.covered):10d}"
f"{add_del:>15}\n"
)
add_del = (
f"{len(self.after.misses - self.before.misses):+d}/"
f"{-len(self.before.misses - self.after.misses):+d}"
)
buf.write(
f"{'Misses':10}{len(self.before.misses):10d}{len(self.after.misses):10d}"
f"{add_del:>15}\n"
)
buf.write("=" * 45 + "\n")
return buf.getvalue()
def new_misses_summary(self):
if self.after.entity_type == CoverageReport.EntityType.COLUMN:
return self._new_miss_summary_row()
elif self.after.entity_type == CoverageReport.EntityType.TABLE:
buf = io.StringIO()
buf.write(self._new_miss_summary_row())
for col in self.new_misses.values():
buf.write(col.new_misses_summary())
return buf.getvalue()
elif self.after.entity_type == CoverageReport.EntityType.CATALOG:
buf = io.StringIO()
buf.write("=" * 94 + "\n")
buf.write(self._new_miss_summary_row())
buf.write("=" * 94 + "\n")
for table in self.new_misses.values():
buf.write(table.new_misses_summary())
buf.write("=" * 94 + "\n")
return buf.getvalue()
else:
raise TypeError(
f"Unsupported report_type for new_misses_summary method: "
f"{self.after.entity_type}"
)
def _new_miss_summary_row(self):
if self.after.entity_type == CoverageReport.EntityType.CATALOG:
title_prefix = ""
elif self.after.entity_type == CoverageReport.EntityType.TABLE:
title_prefix = "- "
elif self.after.entity_type == CoverageReport.EntityType.COLUMN:
title_prefix = "-- "
else:
raise TypeError(
f"Unsupported report_type for _new_miss_summary_row method: "
f"{type(self.after.entity_type)}"
)
title = (
"Catalog"
if self.after.entity_type == CoverageReport.EntityType.CATALOG
else self.after.entity_name
)
title = title_prefix + title
before_covered = len(self.before.covered) if self.before is not None else "-"
before_total = len(self.before.total) if self.before is not None else "-"
before_coverage = f"({self.before.coverage:.2%})" if self.before is not None else "(-)"
after_covered = len(self.after.covered)
after_total = len(self.after.total)
after_coverage = f"({self.after.coverage:.2%})"
buf = io.StringIO()
buf.write(f"{title:50}")
buf.write(f"{before_covered:>5}/{before_total:<5}{before_coverage:^9}")
buf.write(" -> ")
buf.write(f"{after_covered:>5}/{after_total:<5}{after_coverage:^9}\n")
return buf.getvalue()
def check_manifest_version(manifest_json):
manifest_version = manifest_json["metadata"]["dbt_schema_version"]
if manifest_version not in SUPPORTED_MANIFEST_SCHEMA_VERSIONS:
logging.warning(
"Unsupported manifest.json version %s, unexpected behavior can occur. Supported "
"versions: %s. See "
"https://github.com/slidoapp/dbt-coverage/tree/main#supported-dbt-versions for more "
"details.",
manifest_version,
SUPPORTED_MANIFEST_SCHEMA_VERSIONS,
)
def load_catalog(project_dir: Path, run_artifacts_dir: Path, manifest: Manifest) -> Catalog:
if run_artifacts_dir is None:
catalog_path = project_dir / "target/catalog.json"
else:
catalog_path = run_artifacts_dir / "catalog.json"
if not catalog_path.exists():
raise FileNotFoundError(
"catalog.json not found in target/ or in custom path - "
"before using dbt-coverage, run: dbt docs generate"
)
with open(catalog_path) as f:
catalog_json = json.load(f)
catalog_nodes = {**catalog_json["sources"], **catalog_json["nodes"]}
# Filter out tables storing test failures: https://github.com/slidoapp/dbt-coverage/issues/62
catalog_nodes = {n_id: n for n_id, n in catalog_nodes.items() if not n_id.startswith("test.")}
catalog = Catalog.from_nodes(catalog_nodes.values(), manifest)
logging.info("Successfully loaded %d tables from catalog", len(catalog.tables))
return catalog
def load_manifest(project_dir: Path, run_artifacts_dir: Path) -> Manifest:
if run_artifacts_dir is None:
manifest_path = project_dir / "target/manifest.json"
else:
manifest_path = run_artifacts_dir / "manifest.json"
if not manifest_path.exists():
raise FileNotFoundError(
f"manifest.json not found in target or in custom path - "
"before using dbt-coverage, run a dbt command that creates manifest artifact "
"(see: https://docs.getdbt.com/reference/artifacts/manifest-json)"
)
with open(manifest_path) as f:
manifest_json = json.load(f)
check_manifest_version(manifest_json)
manifest_nodes = {**manifest_json["sources"], **manifest_json["nodes"]}
manifest = Manifest.from_nodes(manifest_nodes)
return manifest
def load_files(project_dir: Path, run_artifacts_dir: Path) -> Catalog:
if run_artifacts_dir is None:
logging.info("Loading catalog and manifest files from project dir: %s", project_dir)
else:
logging.info("Loading catalog and manifest files from custom dir: %s", run_artifacts_dir)
manifest = load_manifest(project_dir, run_artifacts_dir)
catalog = load_catalog(project_dir, run_artifacts_dir, manifest)
for table_id in catalog.tables:
catalog_table = catalog.get_table(table_id)
manifest_source_table = manifest.sources.get(table_id, {"columns": {}})
manifest_model_table = manifest.models.get(table_id, {"columns": {}})
manifest_seed_table = manifest.seeds.get(table_id, {"columns": {}})
manifest_snapshot_table = manifest.snapshots.get(table_id, {"columns": {}})
manifest_table_tests = manifest.tests.get(table_id, {})
for catalog_column in catalog_table.columns.values():
manifest_source_column = manifest_source_table["columns"].get(catalog_column.name)
manifest_model_column = manifest_model_table["columns"].get(catalog_column.name)
manifest_seed_column = manifest_seed_table["columns"].get(catalog_column.name)
manifest_snapshot_column = manifest_snapshot_table["columns"].get(catalog_column.name)
manifest_column_tests = manifest_table_tests.get(catalog_column.name)
manifest_column = (
manifest_source_column
or manifest_model_column
or manifest_seed_column
or manifest_snapshot_column
or {}
)
doc = manifest_column.get("description")
catalog_column.doc = Column.is_valid_doc(doc)
catalog_column.test = Column.is_valid_test(manifest_column_tests)
return catalog
def compute_coverage(catalog: Catalog, cov_type: CoverageType):
logging.info("Computing coverage for %d tables", len(catalog.tables))
coverage_report = CoverageReport.from_catalog(catalog, cov_type)
logging.info("Coverage computed successfully")
return coverage_report
def compare_reports(report, compare_report):
diff = CoverageDiff(compare_report, report)
print(diff.summary())
print(diff.new_misses_summary())
return diff
def read_coverage_report(path: Path):
with open(path) as f:
report = json.load(f)
report = CoverageReport.from_dict(report, CoverageType(report["cov_type"]))
return report
def write_coverage_report(coverage_report: CoverageReport, path: Path):
logging.info("Writing coverage report to %s", path)
with open(path, "w") as f:
f.write(coverage_report.to_json())
logging.info("Report successfully written to %s", path)
def fail_under(coverage_report: CoverageReport, min_coverage: float):
if coverage_report.coverage < min_coverage:
raise RuntimeError(
f"Measured coverage {coverage_report.coverage:.3f} "
f"lower than min required coverage {min_coverage}"
)
def fail_compare(coverage_report: CoverageReport, compare_path: Path):
compare_report = read_coverage_report(compare_path)
diff = compare_reports(coverage_report, compare_report)
if diff.after.coverage < diff.before.coverage:
raise RuntimeError(
f"Coverage decreased from {diff.before.coverage:.2%} to " f"{diff.after.coverage:.2%}"
)
def do_compute(
project_dir: Path = Path("."),
run_artifacts_dir: Path = None,
cov_report: Path = Path("coverage.json"),
cov_type: CoverageType = CoverageType.DOC,
cov_fail_under: float = None,
cov_fail_compare: Path = None,
model_path_filter: Optional[List[str]] = None,
cov_format: CoverageFormat = CoverageFormat.STRING_TABLE,
):
"""
Computes coverage for a dbt project.
Use this method in your Python code to bypass typer.
"""
catalog = load_files(project_dir, run_artifacts_dir)
if model_path_filter:
catalog = catalog.filter_tables(model_path_filter)
if not catalog.tables:
raise ValueError(
"After filtering, the Catalog contains no tables. Ensure your model_path_filter "
"is correct."
)
coverage_report = compute_coverage(catalog, cov_type)
if cov_format == CoverageFormat.MARKDOWN_TABLE:
print(coverage_report.to_markdown_table())
else:
print(coverage_report.to_formatted_string())
write_coverage_report(coverage_report, cov_report)
if cov_fail_under is not None:
fail_under(coverage_report, cov_fail_under)
if cov_fail_compare is not None:
fail_compare(coverage_report, cov_fail_compare)
return coverage_report
def do_compare(report: Path, compare_report: Path):
"""
Compares two coverage reports generated by the ``compute`` command.
Use this method in your Python code to bypass typer.
"""
report = read_coverage_report(report)
compare_report = read_coverage_report(compare_report)
diff = compare_reports(report, compare_report)
return diff
@app.command()
def compute(
project_dir: Path = typer.Option(".", help="dbt project directory path."),
run_artifacts_dir: Path = typer.Option(
None, help="Custom directory path for catalog and manifest files"
),
cov_report: Path = typer.Option("coverage.json", help="Output coverage report path."),
cov_type: CoverageType = typer.Argument(..., help="Type of coverage to compute."),
cov_fail_under: float = typer.Option(
None, help="Fail if coverage is lower than provided threshold."
),
cov_fail_compare: Path = typer.Option(
None,
help="Path to coverage report to compare with and fail if current coverage is lower. "
"Normally used to prevent coverage drop between subsequent tests.",
),
model_path_filter: Optional[List[str]] = typer.Option(
None, help="The model_path string(s) to filter tables on."
),
cov_format: CoverageFormat = typer.Option(
CoverageFormat.STRING_TABLE,
help="The output format to print, either `string` or `markdown`",
),
):
"""Compute coverage for project in PROJECT_DIR from catalog.json and manifest.json."""
return do_compute(
project_dir,
run_artifacts_dir,
cov_report,
cov_type,
cov_fail_under,
cov_fail_compare,
model_path_filter,
cov_format,
)
@app.command()
def compare(
report: Path = typer.Argument(..., help="Path to coverage report."),
compare_report: Path = typer.Argument(
..., help="Path to another coverage report to " "compare with."
),
):
"""Compare two coverage reports generated by the compute command."""
return do_compare(report, compare_report)
@app.callback()
def main(verbose: bool = typer.Option(False, help="Turn verbose logging messages on or off.")):
if verbose:
logging.basicConfig(level=logging.INFO)
else:
logging.basicConfig(level=logging.WARNING)
if __name__ == "__main__":
app()