-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_core.py
More file actions
1938 lines (1394 loc) · 65.8 KB
/
Copy pathtest_core.py
File metadata and controls
1938 lines (1394 loc) · 65.8 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
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
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Tests for the cli_generator Python extension.
Covers:
- Unit tests — verify the `version()` function returns a well-formed string.
- Property tests — invariants that must hold for any version string.
- Smoke tests — `build_url` and `QueryBuilder` round-trip.
"""
import json
import pathlib
import re
from cli_generator import QueryBuilder, build_url, version
# ── Unit tests ────────────────────────────────────────────────────────────────
def test_version_returns_a_string() -> None:
assert isinstance(version(), str)
def test_version_is_non_empty() -> None:
assert len(version()) > 0
def test_version_matches_semver_pattern() -> None:
# Accepts "MAJOR.MINOR.PATCH" with an optional pre-release suffix.
pattern = re.compile(r"^\d+\.\d+\.\d+")
assert pattern.match(version()), f"Unexpected version string: {version()!r}"
def test_version_is_stable_across_calls() -> None:
assert version() == version()
# ── build_url smoke tests ─────────────────────────────────────────────────────
def test_build_url_returns_string() -> None:
url = build_url(
"index: taxon\ntaxa: [Mammalia]\n",
"size: 10\npage: 1\n",
"https://goat.genomehubs.org/api",
"v2",
"search",
)
assert isinstance(url, str)
def test_build_url_contains_api_base() -> None:
url = build_url(
"index: taxon\ntaxa: [Mammalia]\n",
"size: 10\npage: 1\n",
"https://goat.genomehubs.org/api",
"v2",
"search",
)
assert url.startswith("https://goat.genomehubs.org/api/v2/search")
def test_build_url_raises_on_bad_yaml() -> None:
import pytest
with pytest.raises(ValueError):
build_url("index: [invalid: yaml: {", "", "https://example.com", "v2", "search")
# ── QueryBuilder smoke tests ─────────────────────────────────────────────────
def test_query_builder_produces_valid_yaml() -> None:
import yaml
q = QueryBuilder("taxon")
q.set_taxa(["Mammalia"], filter_type="tree").set_rank("species")
doc = yaml.safe_load(q.to_query_yaml())
assert doc["index"] == "taxon"
assert "Mammalia" in doc["taxa"]
assert doc["rank"] == "species"
def test_query_builder_chaining_returns_self() -> None:
q = QueryBuilder("assembly")
result = q.set_taxa(["Homo sapiens"]).set_size(50).set_page(2)
assert result is q
def test_query_builder_build_url_integration() -> None:
q = (
QueryBuilder("taxon")
.set_taxa(["Insecta"], filter_type="tree")
.add_attribute("genome_size", operator="lt", value="1000000000")
.add_field("genome_size")
.set_names(["scientific_name"])
)
url = build_url(
q.to_query_yaml(),
q.to_params_yaml(),
"https://goat.genomehubs.org/api",
"v2",
"search",
)
assert "result=taxon" in url
assert "tax_tree" in url
assert "genome_size" in url
assert "scientific_name" in url
def test_query_builder_reset_clears_taxa() -> None:
q = QueryBuilder("taxon")
q.set_taxa(["Mammalia"])
q.reset()
import yaml
doc = yaml.safe_load(q.to_query_yaml())
assert "taxa" not in doc
# ── QueryBuilder.merge / combine tests ───────────────────────────────────────
def test_merge_combines_parallel_builders() -> None:
"""Identifiers and attributes built in parallel can be merged."""
import yaml
id_builder = QueryBuilder("taxon").set_taxa(["Mammalia"], filter_type="tree").set_rank("species")
attr_builder = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator="lt", value="3000000000")
.add_field("genome_size")
.set_names(["scientific_name"])
)
q = QueryBuilder.combine(id_builder, attr_builder)
doc = yaml.safe_load(q.to_query_yaml())
assert doc["taxa"] == ["Mammalia"]
assert doc["rank"] == "species"
assert doc["attributes"][0]["name"] == "genome_size"
assert doc["fields"][0]["name"] == "genome_size"
assert doc["names"] == ["scientific_name"]
def test_merge_raises_on_index_mismatch() -> None:
import pytest
a = QueryBuilder("taxon").set_taxa(["Mammalia"])
b = QueryBuilder("assembly").add_field("contig_n50")
with pytest.raises(ValueError, match="different indexes"):
a.merge(b)
def test_combine_requires_at_least_one_builder() -> None:
import pytest
with pytest.raises(ValueError):
QueryBuilder.combine()
def test_merge_scalar_default_not_overwritten() -> None:
"""A builder with default size=10 should not overwrite a custom size."""
base = QueryBuilder("taxon").set_size(50)
other = QueryBuilder("taxon") # default size=10
base.merge(other)
import yaml
params = yaml.safe_load(base.to_params_yaml())
assert params["size"] == 50
# ── Additional method tests ───────────────────────────────────────────────────
def test_query_builder_set_assemblies() -> None:
import yaml
q = QueryBuilder("assembly").set_assemblies(["GCA_000001405.40", "GCA_000001405.29"])
doc = yaml.safe_load(q.to_query_yaml())
assert "GCA_000001405.40" in doc["assemblies"]
def test_query_builder_set_samples() -> None:
import yaml
q = QueryBuilder("sample").set_samples(["SAMN00000001", "SAMN00000002"])
doc = yaml.safe_load(q.to_query_yaml())
assert "SAMN00000001" in doc["samples"]
def test_query_builder_set_ranks() -> None:
import yaml
q = QueryBuilder("taxon").set_ranks(["species", "genus"])
doc = yaml.safe_load(q.to_query_yaml())
assert doc["ranks"] == ["species", "genus"]
def test_query_builder_set_sort() -> None:
import yaml
q = QueryBuilder("taxon").set_sort("genome_size", "desc")
params = yaml.safe_load(q.to_params_yaml())
assert params["sort_by"] == "genome_size"
assert params["sort_order"] == "desc"
def test_query_builder_set_include_estimates() -> None:
import yaml
q = QueryBuilder("taxon").set_include_estimates(False)
params = yaml.safe_load(q.to_params_yaml())
assert params["include_estimates"] is False
def test_query_builder_set_taxonomy() -> None:
import yaml
q = QueryBuilder("taxon").set_taxonomy("ott")
params = yaml.safe_load(q.to_params_yaml())
assert params["taxonomy"] == "ott"
def test_query_builder_sample_index() -> None:
q = QueryBuilder("sample")
q.set_samples(["SAMN123"]).add_field("collection_date")
import yaml
doc = yaml.safe_load(q.to_query_yaml())
assert doc["index"] == "sample"
# ── Property-based tests with Hypothesis ──────────────────────────────────────
from hypothesis import given
from hypothesis import strategies as st
@given(
taxa=st.lists(
st.text(min_size=1, max_size=20, alphabet=st.characters(blacklist_categories=("Cc",))), min_size=0, max_size=5
)
)
def test_querybuilder_taxa_handles_varied_lists(taxa: list) -> None:
"""Property: QueryBuilder should handle taxa lists of any length without errors."""
q = QueryBuilder("taxon").set_taxa(taxa)
# Should always produce valid YAML
yaml_output = q.to_query_yaml()
assert isinstance(yaml_output, str)
@given(assemblies=st.lists(st.just("GCA_000001405.40"), min_size=0, max_size=3))
def test_querybuilder_assemblies_always_serializable(assemblies: list) -> None:
"""Property: QueryBuilder with assemblies should always serialize to YAML."""
q = QueryBuilder("assembly").set_assemblies(assemblies)
yaml_output = q.to_query_yaml()
assert "assembly" in yaml_output.lower() or not assemblies
@given(samples=st.lists(st.just("SRS123456"), min_size=0, max_size=3))
def test_querybuilder_samples_idempotence(samples: list) -> None:
"""Property: Multiple calls to set_samples should be idempotent (last one wins)."""
q1 = QueryBuilder("sample").set_samples(samples)
q2 = QueryBuilder("sample").set_samples(samples).set_samples(samples)
assert q1.to_query_yaml() == q2.to_query_yaml()
@given(st.booleans())
def test_querybuilder_include_estimates_roundtrip(include_estimates: bool) -> None:
"""Property: include_estimates setting should roundtrip through YAML."""
import yaml
q = QueryBuilder("taxon").set_include_estimates(include_estimates)
params = yaml.safe_load(q.to_params_yaml())
assert params["include_estimates"] is include_estimates
@given(rank=st.just("species"))
def test_querybuilder_rank_preserved_in_yaml(rank: str) -> None:
"""Property: Rank should be preserved when round-tripping to YAML."""
import yaml
q = QueryBuilder("taxon").set_ranks([rank])
doc = yaml.safe_load(q.to_query_yaml())
if "ranks" in doc:
assert rank in doc["ranks"]
assert rank in doc["ranks"]
# ── Operator alias tests ──────────────────────────────────────────────────────
def test_operator_alias_symbol_greater_than() -> None:
"""Operator alias: > should work as gt."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator=">", value="1000000000").add_field("genome_size")
yaml_output = q.to_query_yaml()
assert "genome_size" in yaml_output
assert "operator:" in yaml_output
def test_operator_alias_symbol_greater_equal() -> None:
"""Operator alias: >= should work as ge."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator=">=", value="1000000000").add_field("genome_size")
yaml_output = q.to_query_yaml()
assert "genome_size" in yaml_output
def test_operator_alias_word_gte() -> None:
"""Operator alias: gte should work as ge."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="gte", value="1000000000").add_field("genome_size")
yaml_output = q.to_query_yaml()
assert "genome_size" in yaml_output
def test_operator_alias_symbol_less_than() -> None:
"""Operator alias: < should work as lt."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="<", value="1000000000").add_field("genome_size")
yaml_output = q.to_query_yaml()
assert "genome_size" in yaml_output
def test_operator_alias_symbol_less_equal() -> None:
"""Operator alias: <= should work as le."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="<=", value="1000000000").add_field("genome_size")
yaml_output = q.to_query_yaml()
assert "genome_size" in yaml_output
def test_operator_alias_word_lte() -> None:
"""Operator alias: lte should work as le."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="lte", value="1000000000").add_field("genome_size")
yaml_output = q.to_query_yaml()
assert "genome_size" in yaml_output
def test_operator_alias_symbol_equals() -> None:
"""Operator alias: = should work as eq."""
q = (
QueryBuilder("taxon")
.add_attribute("assembly_level", operator="=", value="chromosome")
.add_field("assembly_level")
)
yaml_output = q.to_query_yaml()
assert "assembly_level" in yaml_output
def test_operator_alias_symbol_double_equals() -> None:
"""Operator alias: == should work as eq."""
q = (
QueryBuilder("taxon")
.add_attribute("assembly_level", operator="==", value="chromosome")
.add_field("assembly_level")
)
yaml_output = q.to_query_yaml()
assert "assembly_level" in yaml_output
def test_operator_alias_symbol_not_equal() -> None:
"""Operator alias: != should work as ne."""
q = (
QueryBuilder("taxon")
.add_attribute("assembly_level", operator="!=", value="scaffold")
.add_field("assembly_level")
)
yaml_output = q.to_query_yaml()
assert "assembly_level" in yaml_output
def test_operator_alias_canonical_forms_still_work() -> None:
"""Canonical snake_case forms should still work."""
q = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator="lt", value="3000000000")
.add_attribute("assembly_level", operator="eq", value="chromosome")
.add_field("genome_size")
.add_field("assembly_level")
)
yaml_output = q.to_query_yaml()
assert "genome_size" in yaml_output
assert "assembly_level" in yaml_output
def test_operator_aliases_build_valid_url() -> None:
"""URL building should work with operator aliases."""
q = QueryBuilder("taxon").set_taxa(["Mammalia"]).add_attribute("genome_size", operator=">", value="1000000000")
url = build_url(
q.to_query_yaml(),
q.to_params_yaml(),
"https://goat.genomehubs.org/api",
"v2",
"search",
)
assert isinstance(url, str)
assert "Mammalia" in url
# ── QueryBuilder.describe tests ───────────────────────────────────────────────
def test_query_builder_describe_returns_string() -> None:
"""QueryBuilder.describe() should return a string."""
q = QueryBuilder("taxon").set_taxa(["Mammalia"])
desc = q.describe()
assert isinstance(desc, str)
assert len(desc) > 0
def test_query_builder_describe_concise_includes_taxa() -> None:
"""Concise description should mention the taxa."""
q = QueryBuilder("taxon").set_taxa(["Mammalia"], filter_type="tree")
desc = q.describe(mode="concise")
assert "Mammalia" in desc or "taxa" in desc.lower()
def test_query_builder_describe_concise_includes_filter() -> None:
"""Concise description should mention filters."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator=">=", value="1000000000")
desc = q.describe(mode="concise")
assert "genome_size" in desc or ">=" in desc
def test_query_builder_describe_verbose_formats_better() -> None:
"""Verbose description should include more details than concise."""
q = (
QueryBuilder("taxon")
.set_taxa(["Mammalia"], filter_type="tree")
.add_attribute("genome_size", operator=">=", value="1000000000")
)
concise = q.describe(mode="concise")
verbose = q.describe(mode="verbose")
# Verbose version should contain more content or structured formatting
assert len(verbose) >= len(concise)
def test_query_builder_describe_with_field_metadata() -> None:
"""Describe should accept optional field metadata."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator=">=", value="1000000000")
field_meta = {"genome_size": {"display_name": "Genome Size (BP)"}}
desc = q.describe(field_metadata=field_meta, mode="concise")
assert isinstance(desc, str)
assert len(desc) > 0
def test_query_builder_describe_handles_multiple_filters() -> None:
"""Describe should handle multiple filters."""
q = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator=">=", value="1000000000")
.add_attribute("assembly_level", operator="eq", value="chromosome")
)
desc = q.describe()
assert isinstance(desc, str)
# Should mention at least one of the filters
assert "genome_size" in desc or "assembly" in desc or "filter" in desc.lower()
def test_query_builder_describe_handles_empty_query() -> None:
"""Describe should handle minimal queries gracefully."""
q = QueryBuilder("taxon")
desc = q.describe()
assert isinstance(desc, str)
assert "taxa" in desc.lower() or "search" in desc.lower()
# ── QueryBuilder.snippet tests ────────────────────────────────────────────────
def test_snippet_returns_dict() -> None:
"""snippet() returns a dict mapping language name to code string."""
q = QueryBuilder("taxon")
result = q.snippet()
assert isinstance(result, dict)
assert "python" in result
assert isinstance(result["python"], str)
def test_snippet_default_language_is_python() -> None:
"""Calling snippet() with no arguments produces exactly one Python entry."""
q = QueryBuilder("taxon")
result = q.snippet()
assert list(result.keys()) == ["python"]
def test_snippet_empty_query_renders_without_filters() -> None:
"""Empty query produces a snippet with no add_attribute calls."""
q = QueryBuilder("taxon")
code = q.snippet()["python"]
assert "QueryBuilder" in code
assert "add_attribute" not in code
def test_snippet_includes_filter() -> None:
"""Snippet contains the attribute filter when one is set."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator=">=", value="1000000000")
code = q.snippet()["python"]
assert "genome_size" in code
assert "1000000000" in code
assert ">=" in code
def test_snippet_includes_multiple_filters() -> None:
"""Snippet contains all attribute filters when multiple are set."""
q = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator=">=", value="1000000000")
.add_attribute("assembly_level", operator="eq", value="chromosome")
)
code = q.snippet()["python"]
assert "genome_size" in code
assert "assembly_level" in code
def test_snippet_includes_sort() -> None:
"""Snippet contains sort call when sort is set."""
q = QueryBuilder("taxon").set_sort("genome_size", "desc")
code = q.snippet()["python"]
assert "genome_size" in code
assert "sort" in code.lower() or "desc" in code
def test_snippet_includes_field_selections() -> None:
"""Snippet contains set_fields call when fields are selected."""
q = QueryBuilder("taxon").add_field("organism_name").add_field("genome_size")
code = q.snippet()["python"]
assert "organism_name" in code
assert "genome_size" in code
def test_snippet_site_params_appear_in_code() -> None:
"""Site name and sdk_name appear in the generated snippet."""
q = QueryBuilder("taxon")
code = q.snippet(site_name="goat", sdk_name="goat_sdk")["python"]
assert "goat_sdk" in code
assert "goat" in code
def test_snippet_is_valid_python_syntax() -> None:
"""Generated Python snippet is syntactically valid Python."""
import ast
q = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator=">=", value="1000000000")
.add_field("organism_name")
.set_sort("genome_size", "desc")
)
code = q.snippet(site_name="goat", sdk_name="goat_sdk")["python"]
# Raises SyntaxError if the generated code is invalid Python.
ast.parse(code)
# ============================================================================
# R snippet tests
# ============================================================================
def test_r_snippet_is_in_result() -> None:
"""snippet() includes R code when 'r' is requested."""
q = QueryBuilder("taxon")
result = q.snippet(languages=["r"])
assert "r" in result
assert isinstance(result["r"], str)
def test_r_snippet_uses_r6_syntax() -> None:
"""R snippet uses R6 class notation (QueryBuilder$new, $add_attribute, etc.)."""
q = QueryBuilder("taxon")
code = q.snippet(languages=["r"])["r"]
assert "QueryBuilder$new" in code
assert "$new(" in code
def test_r_snippet_includes_filters() -> None:
"""R snippet contains attribute filters."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator=">=", value="1000000000")
code = q.snippet(languages=["r"])["r"]
assert "genome_size" in code
assert "1000000000" in code
def test_r_snippet_includes_multiple_filters() -> None:
"""R snippet contains multiple attribute filters."""
q = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator=">=", value="1000000000")
.add_attribute("assembly_level", operator="eq", value="chromosome")
)
code = q.snippet(languages=["r"])["r"]
assert "genome_size" in code
assert "assembly_level" in code
def test_r_snippet_includes_sort() -> None:
"""R snippet contains sort directive."""
q = QueryBuilder("taxon").set_sort("genome_size", "desc")
code = q.snippet(languages=["r"])["r"]
assert "genome_size" in code
assert "sort" in code.lower() or "desc" in code
def test_r_snippet_includes_field_selections() -> None:
"""R snippet contains set_fields call when present."""
q = QueryBuilder("taxon").add_field("organism_name").add_field("genome_size")
code = q.snippet(languages=["r"])["r"]
assert "organism_name" in code
assert "genome_size" in code
def test_r_snippet_site_params_appear() -> None:
"""R snippet includes site_name and sdk_name parameters."""
q = QueryBuilder("taxon")
code = q.snippet(languages=["r"], site_name="goat", sdk_name="goat_sdk")["r"]
assert "goat" in code
def test_r_snippet_is_valid_r_code() -> None:
"""Generated R snippet is valid R code (basic syntax check)."""
q = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator=">=", value="1000000000")
.add_field("organism_name")
.set_sort("genome_size", "desc")
)
code = q.snippet(languages=["r"], site_name="goat", sdk_name="goat_sdk")["r"]
# Basic R syntax checks
assert "library(" in code
assert "QueryBuilder$new(" in code
assert "$add_" in code or "genome_size" in code
assert "<-" in code # R assignment operator
# Check for at least one method call with $
assert code.count("$") >= 2
# ── JavaScript snippet tests ──────────────────────────────────────────────────
def test_js_snippet_is_in_result() -> None:
"""Requesting 'javascript' returns a snippet keyed as 'javascript'."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="ge", value="1000000000")
result = q.snippet(languages=["javascript"], site_name="goat", sdk_name="goat_sdk")
assert "javascript" in result
assert len(result["javascript"]) > 0
def test_js_snippet_uses_class_syntax() -> None:
"""Generated JS snippet uses QueryBuilder class instantiation."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="ge", value="1000000000")
code = q.snippet(languages=["javascript"], site_name="goat", sdk_name="goat_sdk")["javascript"]
assert "new QueryBuilder(" in code
assert "require(" in code
def test_js_snippet_includes_filters() -> None:
"""A single attribute filter appears in the JS snippet."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="ge", value="1000000000")
code = q.snippet(languages=["javascript"], site_name="goat", sdk_name="goat_sdk")["javascript"]
assert "genome_size" in code
assert "ge" in code
assert "1000000000" in code
def test_js_snippet_includes_multiple_filters() -> None:
"""Multiple attribute filters all appear in the JS snippet."""
q = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator="ge", value="1000000000")
.add_attribute("assembly_span", operator="lt", value="5000000000")
)
code = q.snippet(languages=["javascript"], site_name="goat", sdk_name="goat_sdk")["javascript"]
assert "genome_size" in code
assert "assembly_span" in code
def test_js_snippet_includes_sort() -> None:
"""Sort directive appears in the JS snippet."""
q = QueryBuilder("taxon").set_sort("genome_size", "desc")
code = q.snippet(languages=["javascript"], site_name="goat", sdk_name="goat_sdk")["javascript"]
assert "genome_size" in code
assert "desc" in code
assert "setSort(" in code
def test_js_snippet_includes_field_selections() -> None:
"""Selected fields appear in the JS snippet."""
q = QueryBuilder("taxon").add_field("assembly_span").add_field("genome_size")
code = q.snippet(languages=["javascript"], site_name="goat", sdk_name="goat_sdk")["javascript"]
assert "assembly_span" in code
assert "genome_size" in code
assert "addField(" in code
def test_js_snippet_site_params_appear() -> None:
"""Site name appears as a comment in the JS snippet."""
q = QueryBuilder("taxon")
code = q.snippet(languages=["javascript"], site_name="mysite", sdk_name="mysite_sdk")["javascript"]
assert "mysite" in code
def test_js_snippet_is_valid_js() -> None:
"""Generated JS snippet passes basic syntax checks."""
q = (
QueryBuilder("taxon")
.add_attribute("genome_size", operator="ge", value="1000000000")
.add_field("organism_name")
.set_sort("genome_size", "desc")
)
code = q.snippet(languages=["javascript"], site_name="goat", sdk_name="goat_sdk")["javascript"]
# Basic JS syntax checks
assert "require(" in code
assert "new QueryBuilder(" in code
assert "toV2Url()" in code
assert "const " in code
# Should not contain Python or R syntax
assert "import " not in code or code.index("import ") > code.index("require(")
assert "library(" not in code
assert "<-" not in code
# ── CLI snippet tests ─────────────────────────────────────────────────────────
def test_cli_snippet_is_in_result() -> None:
"""snippet() returns a 'cli' key when requested."""
q = QueryBuilder("taxon")
result = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")
assert "cli" in result
assert isinstance(result["cli"], str)
def test_cli_snippet_contains_binary_and_index() -> None:
"""CLI snippet has the binary name, index, and 'search' subcommand."""
q = QueryBuilder("taxon")
code = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")["cli"]
assert "goat-cli" in code
assert "taxon" in code
assert "search" in code
def test_cli_snippet_respects_index() -> None:
"""CLI snippet uses the builder's index, not a hardcoded fallback."""
q = QueryBuilder("assembly")
code = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")["cli"]
assert "assembly" in code
assert "taxon" not in code
def test_cli_snippet_includes_filter() -> None:
"""Attribute filter appears as --filter FIELD OP VALUE."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="ge", value="1000000000")
code = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")["cli"]
assert "--filter" in code
assert "genome_size" in code
assert "ge" in code
assert "1000000000" in code
def test_cli_snippet_includes_sort() -> None:
"""Sort appears as --sort FIELD:DIRECTION."""
q = QueryBuilder("taxon").set_sort("genome_size", "desc")
code = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")["cli"]
assert "--sort" in code
assert "genome_size" in code
assert "desc" in code
def test_cli_snippet_includes_fields() -> None:
"""Selected fields appear as --fields."""
q = QueryBuilder("taxon").add_field("organism_name").add_field("genome_size")
code = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")["cli"]
assert "--fields" in code
assert "organism_name" in code
assert "genome_size" in code
def test_cli_snippet_includes_taxa() -> None:
"""Taxa appear as --taxon and --taxon-filter."""
q = QueryBuilder("taxon").set_taxa(["Mammalia"], "tree")
code = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")["cli"]
assert "--taxon" in code
assert "Mammalia" in code
assert "--taxon-filter" in code
assert "tree" in code
def test_cli_snippet_includes_rank() -> None:
"""Rank restriction appears as --rank."""
q = QueryBuilder("taxon").set_rank("species")
code = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")["cli"]
assert "--rank" in code
assert "species" in code
def test_cli_snippet_no_trailing_backslash() -> None:
"""Last non-empty line of the CLI snippet does not end with a continuation backslash."""
q = (
QueryBuilder("taxon")
.set_taxa(["Mammalia"], "tree")
.add_attribute("genome_size", operator="ge", value="1000000000")
.add_field("organism_name")
.set_sort("genome_size", "desc")
)
code = q.snippet(languages=["cli"], site_name="goat", sdk_name="goat-cli")["cli"]
non_empty_lines = [ln for ln in code.splitlines() if ln.strip()]
assert non_empty_lines, "snippet produced no output"
assert not non_empty_lines[-1].rstrip().endswith("\\")
def test_cli_snippet_all_languages_together() -> None:
"""Requesting python, r, javascript, and cli returns all four keys."""
q = QueryBuilder("taxon").add_attribute("genome_size", operator="ge", value="1000000000")
result = q.snippet(
languages=["python", "r", "javascript", "cli"],
site_name="goat",
sdk_name="goat_sdk",
)
assert set(result.keys()) == {"python", "r", "javascript", "cli"}
# ── parse_search_json / values_only / annotated_values smoke tests ────────────
_TAXON_RESPONSE = json.dumps(
{
"status": {"hits": 1, "success": True},
"results": [
{
"index": "taxon--ncbi--goat--2026.04.16",
"id": "9606",
"score": 1.0,
"result": {
"taxon_id": "9606",
"scientific_name": "Homo sapiens",
"taxon_rank": "species",
"fields": {
"genome_size": {
"value": 3_100_000_000,
"count": 1,
"min": 3_100_000_000,
"max": 3_200_000_000,
"aggregation_source": "direct",
"sp_count": 0,
}
},
},
}
],
}
)
def test_parse_search_json_returns_flat_record() -> None:
from cli_generator import parse_search_json
rows = json.loads(parse_search_json(_TAXON_RESPONSE))
assert len(rows) == 1
row = rows[0]
assert row["taxon_id"] == "9606"
assert row["scientific_name"] == "Homo sapiens"
assert row["genome_size"] == 3_100_000_000
assert row["genome_size__source"] == "direct"
assert row["genome_size__min"] == 3_100_000_000
assert row["genome_size__max"] == 3_200_000_000
def test_values_only_strips_subkey_columns() -> None:
from cli_generator import parse_search_json, values_only
flat = parse_search_json(_TAXON_RESPONSE)
rows = json.loads(values_only(flat))
assert len(rows) == 1
row = rows[0]
assert row["taxon_id"] == "9606"
assert row["genome_size"] == 3_100_000_000
# Sub-key columns must be absent.
assert "genome_size__source" not in row
assert "genome_size__min" not in row
assert "genome_size__max" not in row
def test_values_only_preserves_keep_column() -> None:
from cli_generator import parse_search_json, values_only
flat = parse_search_json(_TAXON_RESPONSE)
keep = json.dumps(["genome_size__min"])
rows = json.loads(values_only(flat, keep))
row = rows[0]
# Explicitly requested stat preserved.
assert row["genome_size__min"] == 3_100_000_000
# Other sub-key columns still stripped.
assert "genome_size__source" not in row
assert "genome_size__max" not in row
def test_add_field_colon_syntax_builds_correct_url() -> None:
"""add_field(\"assembly_span:min\") should produce bare field before :min in URL."""
from cli_generator import QueryBuilder, build_url
q = QueryBuilder("assembly").add_field("assembly_span:min")
url = build_url(q.to_query_yaml(), q.to_params_yaml(), "https://goat.genomehubs.org/api", "v2", "search")
assert "assembly_span" in url
assert "assembly_span%3Amin" in url
# Bare field must appear before the modifier.
idx_bare = url.index("assembly_span")
idx_mod = url.index("assembly_span%3Amin")
assert idx_bare < idx_mod
def test_field_modifiers_returns_stat_columns() -> None:
q = QueryBuilder("assembly")
q.add_field("assembly_span:min")
q.add_field("genome_size", modifiers=["max"])
q.add_field("contig_n50")
q.add_field("assembly_span:direct") # status modifier — also produces __direct column
assert set(q.field_modifiers()) == {"assembly_span__min", "genome_size__max", "assembly_span__direct"}
def test_annotated_values_direct_stays_numeric_in_non_direct_mode() -> None:
from cli_generator import annotated_values, parse_search_json
flat = parse_search_json(_TAXON_RESPONSE)
rows = json.loads(annotated_values(flat, "non_direct"))
assert len(rows) == 1
row = rows[0]
# Direct source in non_direct mode: value stays numeric, no __* columns.
assert row["genome_size"] == 3_100_000_000
assert "genome_size__source" not in row
assert "genome_size__label" not in row
_ANCESTOR_RESPONSE = json.dumps(
{
"status": {"hits": 1, "success": True},
"results": [
{
"index": "taxon--ncbi--goat--2026.04.16",
"id": "9347",
"score": 1.0,
"result": {
"taxon_id": "9347",
"scientific_name": "Eutheria",
"taxon_rank": "clade",
"fields": {
"genome_size": {
"value": 8_215_200_000,
"aggregation_source": ["ancestor"],
}
},
},
}
],
}
)
def test_annotated_values_ancestor_becomes_labelled_string() -> None:
from cli_generator import annotated_values, parse_search_json
flat = parse_search_json(_ANCESTOR_RESPONSE)
rows = json.loads(annotated_values(flat, "non_direct"))
row = rows[0]
assert row["genome_size"] == "8215200000 (Ancestral)"
assert "genome_size__source" not in row
assert "genome_size__label" not in row
# ── to_tidy_records ──────────────────────────────────────────────────────────
_FLAT_RESPONSE = json.dumps(
[
{
"taxon_id": "9606",
"scientific_name": "Homo sapiens",
"taxon_rank": "species",
"genome_size": 3_100_000_000,
"genome_size__source": "direct",
"assembly_span": 2_747_877_777,
"assembly_span__source": "ancestor",
}
]
)
def test_to_tidy_records_returns_one_row_per_field() -> None:
from cli_generator import to_tidy_records
rows = json.loads(to_tidy_records(_FLAT_RESPONSE))
assert len(rows) == 2
field_names = {r["field"] for r in rows}
assert field_names == {"genome_size", "assembly_span"}
def test_to_tidy_records_identity_columns_present() -> None:
from cli_generator import to_tidy_records
rows = json.loads(to_tidy_records(_FLAT_RESPONSE))
for row in rows:
assert row["taxon_id"] == "9606"
assert row["scientific_name"] == "Homo sapiens"
assert row["taxon_rank"] == "species"