primer3 0.1.0

Safe Rust bindings to the primer3 primer design library
Documentation
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
//! Integration tests for primer3 crate.
//!
//! These test values were verified against primer3-py and/or the primer3
//! command-line tool to ensure our FFI wiring produces correct results.

use primer3::{
    SolutionConditions, ThermoArgs, TmParams, calc_end_stability, calc_end_stability_with,
    calc_hairpin, calc_hairpin_with, calc_heterodimer, calc_heterodimer_with, calc_homodimer,
    calc_homodimer_with, calc_tm, calc_tm_with, reverse_complement,
};

// ── Tm tests ──────────────────────────────────────────────────────────

#[test]
fn test_calc_tm_m13_forward() {
    // M13 forward primer: GTAAAACGACGGCCAGT
    let tm = calc_tm("GTAAAACGACGGCCAGT").unwrap();
    // primer3-py: ~53.0 (SantaLucia with default conditions)
    assert!((48.0..=58.0).contains(&tm), "M13 forward Tm = {tm:.2}, expected roughly 53");
}

#[test]
fn test_calc_tm_poly_a() {
    let tm = calc_tm("AAAAAAAAAAAAAAAAAAA").unwrap();
    // poly-A has very low Tm
    assert!(tm < 40.0, "poly-A Tm = {tm:.2}, expected < 40");
}

#[test]
fn test_calc_tm_gc_rich() {
    let tm = calc_tm("GCGCGCGCGCGCGCGCGCGC").unwrap();
    // GC-rich sequence has high Tm
    assert!(tm > 65.0, "GC-rich Tm = {tm:.2}, expected > 65");
}

#[test]
fn test_calc_tm_empty_seq() {
    let result = calc_tm("");
    assert!(result.is_err());
}

#[test]
fn test_calc_tm_custom_conditions() {
    // Higher salt should increase Tm
    let default_tm = calc_tm("GTAAAACGACGGCCAGT").unwrap();
    let high_salt_params = TmParams {
        conditions: SolutionConditions::default().with_mv_conc(200.0),
        ..Default::default()
    };
    let high_salt_tm = calc_tm_with("GTAAAACGACGGCCAGT", &high_salt_params).unwrap();
    assert!(
        high_salt_tm > default_tm,
        "Higher salt Tm ({high_salt_tm:.2}) should be > default ({default_tm:.2})"
    );
}

// ── Hairpin tests ─────────────────────────────────────────────────────

#[test]
fn test_calc_hairpin_palindrome() {
    // Sequence with strong hairpin potential
    let result = calc_hairpin("CCCCCATCCGATCAGGGGG").unwrap();
    // Should find a structure with significant stability
    assert!(
        result.tm() > 0.0 || result.dg() < 0.0,
        "Hairpin result: tm={:.2}, dg={:.0}",
        result.tm(),
        result.dg(),
    );
}

#[test]
fn test_calc_hairpin_no_structure() {
    // Short, non-palindromic sequence
    let result = calc_hairpin("ATCGATCG").unwrap();
    // May or may not find a structure, but shouldn't error
    let _ = result.tm();
    let _ = result.dg();
}

#[test]
fn test_calc_hairpin_empty() {
    assert!(calc_hairpin("").is_err());
}

#[test]
fn test_calc_hairpin_too_long() {
    let long_seq = "A".repeat(61);
    assert!(calc_hairpin(&long_seq).is_err());
}

#[test]
fn test_calc_hairpin_with_structure() {
    let args = ThermoArgs { output_structure: true, ..Default::default() };
    let result = calc_hairpin_with("CCCCCATCCGATCAGGGGG", &args).unwrap();
    // When output_structure is true, we should get an ASCII structure
    // (but only if the C library finds a significant structure)
    if result.structure_found() {
        assert!(
            result.ascii_structure().is_some(),
            "Expected ASCII structure when structure_found=true and output_structure=true"
        );
    }
}

// ── Homodimer tests ───────────────────────────────────────────────────

#[test]
fn test_calc_homodimer() {
    let result = calc_homodimer("AGTCTAGTCTATCGATCG").unwrap();
    // Should return valid thermodynamic values
    let _ = result.tm();
    let _ = result.dg();
    let _ = result.dh();
    let _ = result.ds();
}

#[test]
fn test_calc_homodimer_empty() {
    assert!(calc_homodimer("").is_err());
}

#[test]
fn test_calc_homodimer_custom_conditions() {
    let args = ThermoArgs {
        conditions: SolutionConditions::default().with_mv_conc(100.0),
        ..Default::default()
    };
    let result = calc_homodimer_with("AGTCTAGTCTATCGATCG", &args).unwrap();
    let _ = result.tm();
}

// ── Heterodimer tests ─────────────────────────────────────────────────

#[test]
fn test_calc_heterodimer_complementary() {
    // Perfectly complementary sequences
    let result = calc_heterodimer("AAAAAAAAAA", "TTTTTTTTTT").unwrap();
    // Should find a stable dimer
    assert!(result.dg() < 0.0, "Complementary heterodimer dG = {:.0}, expected < 0", result.dg());
}

#[test]
fn test_calc_heterodimer_non_complementary() {
    let result = calc_heterodimer("AAAAAAAAAA", "AAAAAAAAAA").unwrap();
    // Non-complementary: should have less favorable dG
    // (may still find some alignment)
    let _ = result.dg();
}

#[test]
fn test_calc_heterodimer_empty() {
    assert!(calc_heterodimer("", "ATCG").is_err());
    assert!(calc_heterodimer("ATCG", "").is_err());
}

#[test]
fn test_calc_heterodimer_both_too_long() {
    let long1 = "A".repeat(61);
    let long2 = "T".repeat(61);
    assert!(calc_heterodimer(&long1, &long2).is_err());
}

#[test]
fn test_calc_heterodimer_one_long_ok() {
    // One short (<=60) and one long should be fine
    let short = "ATCGATCGATCG";
    let long = "T".repeat(100);
    let result = calc_heterodimer(short, &long);
    assert!(result.is_ok(), "One short + one long should work");
}

#[test]
fn test_calc_heterodimer_with_structure() {
    let args = ThermoArgs { output_structure: true, ..Default::default() };
    let result = calc_heterodimer_with("AAAAAAAAAA", "TTTTTTTTTT", &args).unwrap();
    if result.structure_found() {
        assert!(result.ascii_structure().is_some());
    }
}

// ── End stability tests ───────────────────────────────────────────────

#[test]
fn test_calc_end_stability() {
    let result = calc_end_stability("AGCTATTTTTTTTTTT", "CATGATTTTTTTTTTTTTT").unwrap();
    // Should return valid thermodynamic values
    let _ = result.tm();
    let _ = result.dg();
}

#[test]
fn test_calc_end_stability_custom() {
    let args = ThermoArgs {
        conditions: SolutionConditions::default().with_mv_conc(100.0),
        ..Default::default()
    };
    let result = calc_end_stability_with("AGCTATTTTTTTTTTT", "CATGATTTTTTTTTTTTTT", &args).unwrap();
    let _ = result.tm();
}

// ── ThermoResult tests ────────────────────────────────────────────────

#[test]
fn test_thermo_result_display() {
    let result = calc_hairpin("CCCCCATCCGATCAGGGGG").unwrap();
    let display = format!("{result}");
    assert!(display.contains("ThermoResult"));
    assert!(display.contains("tm="));
}

#[test]
fn test_thermo_result_approx_eq() {
    let r1 = calc_hairpin("CCCCCATCCGATCAGGGGG").unwrap();
    let r2 = calc_hairpin("CCCCCATCCGATCAGGGGG").unwrap();
    assert!(r1.approx_eq(&r2, 0.01), "Same input should give same result");
}

// ── Reverse complement tests ─────────────────────────────────────────

#[test]
fn test_reverse_complement() {
    assert_eq!(reverse_complement("ATCG"), "CGAT");
    assert_eq!(reverse_complement(""), "");
    assert_eq!(reverse_complement("A"), "T");
    assert_eq!(reverse_complement("AAAA"), "TTTT");
    assert_eq!(reverse_complement("aAtTgGcC"), "GgCcAaTt");
}

// ── Design primers tests ──────────────────────────────────────────────

#[test]
fn test_design_primers_basic() {
    use primer3::{PrimerSettings, SequenceArgs, design_primers};

    // A reasonable template sequence (~500bp)
    let template = "GCTTGCATGCCTGCAGGTCGACTCTAGAGGATCCCCGGGTACCGAGCTCGA\
        ATTCGTAATCATGGTCATAGCTGTTTCCTGTGTGAAATTGTTATCCGCTCA\
        CAATTCCACACAACATACGAGCCGGAAGCATAAAGTGTAAAGCCTGGGGTGC\
        CTAATGAGTGAGCTAACTCACATTAATTGCGTTGCGCTCACTGCCCGCTTT\
        CCAGTCGGGAAACCTGTCGTGCCAGCTGCATTAATGAATCGGCCAACGCGC\
        GGGGAGAGGCGGTTTGCGTATTGGGCGCTCTTCCGCTTCCTCGCTCACTGA\
        CTCGCTGCGCTCGGTCGTTCGGCTGCGGCGAGCGGTATCAGCTCACTCAAA\
        GGCGGTAATACGGTTATCCACAGAATCAGGGGATAACGCAGGAAAGAACATG\
        TGAGCAAAAGGCCAGCAAAAGGCCAGGAACCGTAAAAAGGCCGCGTTGCTGG\
        CGTTTTTCCATAGGCTCCGCCCCCCTGACGAGCATCACAAAAATCGACGCTC";

    let seq_args = SequenceArgs::builder().sequence(template).target(200, 50).build().unwrap();

    let settings = PrimerSettings::builder()
        .primer_opt_tm(60.0)
        .primer_min_tm(57.0)
        .primer_max_tm(63.0)
        .product_size_range(75, 300)
        .num_return(5)
        .build()
        .unwrap();

    let result = design_primers(&seq_args, &settings, None, None).unwrap();

    // Should find at least one primer pair
    assert!(
        result.num_pairs() > 0,
        "Expected at least one primer pair, got {}. Left stats: {:?}",
        result.num_pairs(),
        result.left_stats(),
    );

    // Check that the first pair has reasonable properties
    let pair = &result.pairs()[0];
    assert!(!pair.left().sequence().is_empty());
    assert!(!pair.right().sequence().is_empty());
    assert!(pair.left().tm() > 50.0 && pair.left().tm() < 70.0);
    assert!(pair.right().tm() > 50.0 && pair.right().tm() < 70.0);
    assert!(pair.product_size() > 0);
    assert!(pair.product_size() <= 300);
}

#[test]
fn test_design_primers_no_target() {
    use primer3::{PrimerSettings, SequenceArgs, design_primers};

    // Very short sequence where no primers can be found
    let seq_args = SequenceArgs::builder().sequence("ATCGATCG").build().unwrap();

    let settings = PrimerSettings::default();
    let result = design_primers(&seq_args, &settings, None, None);
    // Should either return an error or an empty result (no pairs found)
    if let Ok(r) = result {
        assert_eq!(r.num_pairs(), 0, "No pairs expected for tiny sequence");
    }
}

#[test]
fn test_design_primers_check_mode() {
    use primer3::{PrimerSettings, PrimerTask, SequenceArgs, design_primers};

    let template = "GCTTGCATGCCTGCAGGTCGACTCTAGAGGATCCCCGGGTACCGAGCTCGA\
        ATTCGTAATCATGGTCATAGCTGTTTCCTGTGTGAAATTGTTATCCGCTCA\
        CAATTCCACACAACATACGAGCCGGAAGCATAAAGTGTAAAGCCTGGGGTGC\
        CTAATGAGTGAGCTAACTCACATTAATTGCGTTGCGCTCACTGCCCGCTTT\
        CCAGTCGGGAAACCTGTCGTGCCAGCTGCATTAATGAATCGGCCAACGCGC";

    let seq_args = SequenceArgs::builder()
        .sequence(template)
        .left_primer("GCTTGCATGCCTGCAGGTCG")
        .right_primer("GCGCGTTGGCCGATTCATTA")
        .build()
        .unwrap();

    let settings = PrimerSettings::builder()
        .task(PrimerTask::CheckPrimers)
        .primer_opt_tm(60.0)
        .primer_min_tm(50.0)
        .primer_max_tm(70.0)
        .product_size_range(100, 300)
        .build()
        .unwrap();

    let result = design_primers(&seq_args, &settings, None, None).unwrap();
    // Check mode should return exactly 1 pair (or 0 if the primers fail constraints)
    assert!(
        result.num_pairs() <= 1,
        "Check mode should return at most 1 pair, got {}",
        result.num_pairs()
    );
}

// ── Sequence library tests ───────────────────────────────────────────

#[test]
fn test_design_primers_with_misprime_lib() {
    use primer3::{PrimerSettings, SequenceArgs, SequenceLibrary, design_primers};

    let template = "GCTTGCATGCCTGCAGGTCGACTCTAGAGGATCCCCGGGTACCGAGCTCGA\
        ATTCGTAATCATGGTCATAGCTGTTTCCTGTGTGAAATTGTTATCCGCTCA\
        CAATTCCACACAACATACGAGCCGGAAGCATAAAGTGTAAAGCCTGGGGTGC\
        CTAATGAGTGAGCTAACTCACATTAATTGCGTTGCGCTCACTGCCCGCTTT\
        CCAGTCGGGAAACCTGTCGTGCCAGCTGCATTAATGAATCGGCCAACGCGC\
        GGGGAGAGGCGGTTTGCGTATTGGGCGCTCTTCCGCTTCCTCGCTCACTGA\
        CTCGCTGCGCTCGGTCGTTCGGCTGCGGCGAGCGGTATCAGCTCACTCAAA\
        GGCGGTAATACGGTTATCCACAGAATCAGGGGATAACGCAGGAAAGAACATG\
        TGAGCAAAAGGCCAGCAAAAGGCCAGGAACCGTAAAAAGGCCGCGTTGCTGG\
        CGTTTTTCCATAGGCTCCGCCCCCCTGACGAGCATCACAAAAATCGACGCTC";

    let seq_args = SequenceArgs::builder().sequence(template).target(200, 50).build().unwrap();

    let settings = PrimerSettings::builder()
        .primer_opt_tm(60.0)
        .primer_min_tm(57.0)
        .primer_max_tm(63.0)
        .product_size_range(75, 300)
        .num_return(5)
        .build()
        .unwrap();

    // Create a library with a simple repeat sequence
    let mut lib = SequenceLibrary::new();
    lib.add("SIMPLE_REPEAT", "ATATATATATATATATATATATAT");
    lib.add_weighted("ALU_FRAG", "GGCCGGGCGCGGTGGCTCACGCCTGTAAT", 2.0);

    let result = design_primers(&seq_args, &settings, Some(&lib), None).unwrap();
    // Should still find primers (the library sequences don't match much)
    assert!(
        result.num_pairs() > 0,
        "Expected primer pairs with mispriming library, got {}",
        result.num_pairs()
    );
}

#[test]
fn test_design_primers_with_empty_lib() {
    use primer3::{PrimerSettings, SequenceArgs, SequenceLibrary, design_primers};

    let template = "GCTTGCATGCCTGCAGGTCGACTCTAGAGGATCCCCGGGTACCGAGCTCGA\
        ATTCGTAATCATGGTCATAGCTGTTTCCTGTGTGAAATTGTTATCCGCTCA\
        CAATTCCACACAACATACGAGCCGGAAGCATAAAGTGTAAAGCCTGGGGTGC\
        CTAATGAGTGAGCTAACTCACATTAATTGCGTTGCGCTCACTGCCCGCTTT\
        CCAGTCGGGAAACCTGTCGTGCCAGCTGCATTAATGAATCGGCCAACGCGC";

    let seq_args = SequenceArgs::builder().sequence(template).target(100, 50).build().unwrap();
    let settings = PrimerSettings::builder().product_size_range(75, 300).build().unwrap();

    // Empty library should behave like None
    let lib = SequenceLibrary::new();
    let result = design_primers(&seq_args, &settings, Some(&lib), None);
    assert!(result.is_ok());
}

// ── Thread safety test ────────────────────────────────────────────────

#[test]
fn test_thread_safety_tm() {
    use std::thread;

    let handles: Vec<_> = (0..4)
        .map(|_| {
            thread::spawn(|| {
                for _ in 0..10 {
                    let tm = calc_tm("GTAAAACGACGGCCAGT").unwrap();
                    assert!(tm > 40.0 && tm < 70.0);
                }
            })
        })
        .collect();

    for h in handles {
        h.join().unwrap();
    }
}

#[test]
fn test_thread_safety_hairpin() {
    use std::thread;

    let handles: Vec<_> = (0..4)
        .map(|_| {
            thread::spawn(|| {
                for _ in 0..10 {
                    let result = calc_hairpin("CCCCCATCCGATCAGGGGG").unwrap();
                    let _ = result.tm();
                }
            })
        })
        .collect();

    for h in handles {
        h.join().unwrap();
    }
}