quantrs2-anneal 0.1.3

Quantum annealing support for the QuantRS2 framework
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
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
//! Test scenarios and test case definitions

use std::collections::HashMap;
use std::time::{Duration, SystemTime};

/// Test case registry
pub struct TestRegistry {
    /// Registered test cases
    pub test_cases: HashMap<String, IntegrationTestCase>,
    /// Test suites
    pub test_suites: HashMap<String, TestSuite>,
    /// Test dependencies
    pub dependencies: HashMap<String, Vec<String>>,
    /// Test categories
    pub categories: HashMap<TestCategory, Vec<String>>,
}

impl TestRegistry {
    #[must_use]
    pub fn new() -> Self {
        Self {
            test_cases: HashMap::new(),
            test_suites: HashMap::new(),
            dependencies: HashMap::new(),
            categories: HashMap::new(),
        }
    }

    pub fn register_test_case(&mut self, test_case: IntegrationTestCase) -> Result<(), String> {
        let id = test_case.id.clone();
        let category = test_case.category.clone();

        self.test_cases.insert(id.clone(), test_case);

        // Add to category index
        self.categories
            .entry(category)
            .or_insert_with(Vec::new)
            .push(id);

        Ok(())
    }

    /// Register a test suite
    pub fn register_test_suite(&mut self, test_suite: TestSuite) -> Result<(), String> {
        let id = test_suite.id.clone();
        self.test_suites.insert(id, test_suite);
        Ok(())
    }

    /// Unregister a test case
    pub fn unregister_test_case(&mut self, test_case_id: &str) -> Result<(), String> {
        self.test_cases
            .remove(test_case_id)
            .ok_or_else(|| format!("Test case {test_case_id} not found"))?;

        // Remove from dependencies
        self.dependencies.remove(test_case_id);

        Ok(())
    }

    /// Get a test case by ID
    #[must_use]
    pub fn get_test_case(&self, test_case_id: &str) -> Option<&IntegrationTestCase> {
        self.test_cases.get(test_case_id)
    }

    /// Get a test suite by ID
    #[must_use]
    pub fn get_test_suite(&self, test_suite_id: &str) -> Option<&TestSuite> {
        self.test_suites.get(test_suite_id)
    }

    /// Get all test cases in a category
    #[must_use]
    pub fn get_test_cases_by_category(&self, category: &TestCategory) -> Vec<&IntegrationTestCase> {
        if let Some(ids) = self.categories.get(category) {
            ids.iter()
                .filter_map(|id| self.test_cases.get(id))
                .collect()
        } else {
            Vec::new()
        }
    }

    /// Add a dependency between test cases
    pub fn add_dependency(&mut self, test_case_id: String, dependency_id: String) {
        self.dependencies
            .entry(test_case_id)
            .or_insert_with(Vec::new)
            .push(dependency_id);
    }

    /// Get dependencies for a test case
    #[must_use]
    pub fn get_dependencies(&self, test_case_id: &str) -> Vec<&str> {
        self.dependencies
            .get(test_case_id)
            .map(|deps| deps.iter().map(std::string::String::as_str).collect())
            .unwrap_or_default()
    }

    /// List all test cases
    #[must_use]
    pub fn list_test_cases(&self) -> Vec<&IntegrationTestCase> {
        self.test_cases.values().collect()
    }

    /// List all test suites
    #[must_use]
    pub fn list_test_suites(&self) -> Vec<&TestSuite> {
        self.test_suites.values().collect()
    }

    /// Get test case count
    #[must_use]
    pub fn test_case_count(&self) -> usize {
        self.test_cases.len()
    }

    /// Get test suite count
    #[must_use]
    pub fn test_suite_count(&self) -> usize {
        self.test_suites.len()
    }

    /// Clear all test cases and suites
    pub fn clear_all(&mut self) {
        self.test_cases.clear();
        self.test_suites.clear();
        self.dependencies.clear();
        self.categories.clear();
    }

    /// Find test cases by name pattern
    #[must_use]
    pub fn find_test_cases(&self, pattern: &str) -> Vec<&IntegrationTestCase> {
        self.test_cases
            .values()
            .filter(|tc| tc.name.contains(pattern) || tc.description.contains(pattern))
            .collect()
    }
}

/// Integration test case definition
#[derive(Debug, Clone)]
pub struct IntegrationTestCase {
    /// Test case identifier
    pub id: String,
    /// Test case name
    pub name: String,
    /// Test description
    pub description: String,
    /// Test category
    pub category: TestCategory,
    /// Test priority
    pub priority: TestPriority,
    /// Test timeout
    pub timeout: Duration,
    /// Test prerequisites
    pub prerequisites: Vec<String>,
    /// Test parameters
    pub parameters: HashMap<String, TestParameter>,
    /// Expected results
    pub expected_results: ExpectedResults,
    /// Test steps
    pub test_steps: Vec<TestStep>,
    /// Test metadata
    pub metadata: TestMetadata,
}

/// Test suite definition
#[derive(Debug, Clone)]
pub struct TestSuite {
    /// Suite identifier
    pub id: String,
    /// Suite name
    pub name: String,
    /// Suite description
    pub description: String,
    /// Test cases in the suite
    pub test_cases: Vec<String>,
    /// Suite configuration
    pub configuration: TestSuiteConfig,
    /// Suite metadata
    pub metadata: TestMetadata,
}

/// Test categories
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum TestCategory {
    /// Unit integration tests
    Unit,
    /// Component integration tests
    Component,
    /// System integration tests
    System,
    /// End-to-end tests
    EndToEnd,
    /// Performance tests
    Performance,
    /// Stress tests
    Stress,
    /// Security tests
    Security,
    /// Compatibility tests
    Compatibility,
    /// Custom category
    Custom(String),
}

/// Test priorities
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd)]
pub enum TestPriority {
    Low = 1,
    Normal = 2,
    High = 3,
    Critical = 4,
}

/// Test parameter definition
#[derive(Debug, Clone)]
pub struct TestParameter {
    /// Parameter name
    pub name: String,
    /// Parameter type
    pub parameter_type: ParameterType,
    /// Default value
    pub default_value: Option<ParameterValue>,
    /// Parameter description
    pub description: String,
    /// Validation rules
    pub validation: ParameterValidation,
}

/// Parameter types
#[derive(Debug, Clone, PartialEq)]
pub enum ParameterType {
    /// Boolean parameter
    Boolean,
    /// Integer parameter
    Integer,
    /// Float parameter
    Float,
    /// String parameter
    String,
    /// Array parameter
    Array(Box<Self>),
    /// Object parameter
    Object(HashMap<String, Self>),
}

/// Parameter values
#[derive(Debug, Clone)]
pub enum ParameterValue {
    /// Boolean value
    Boolean(bool),
    /// Integer value
    Integer(i64),
    /// Float value
    Float(f64),
    /// String value
    String(String),
    /// Array value
    Array(Vec<Self>),
    /// Object value
    Object(HashMap<String, Self>),
}

/// Parameter validation rules
#[derive(Debug, Clone)]
pub struct ParameterValidation {
    /// Required parameter
    pub required: bool,
    /// Minimum value
    pub min_value: Option<f64>,
    /// Maximum value
    pub max_value: Option<f64>,
    /// Allowed values
    pub allowed_values: Option<Vec<ParameterValue>>,
    /// Custom validation function
    pub custom_validator: Option<String>,
}

/// Expected test results
#[derive(Debug, Clone)]
pub struct ExpectedResults {
    /// Expected outcome
    pub outcome: ExpectedOutcome,
    /// Result validation
    pub validation: ResultValidation,
    /// Expected performance metrics
    pub performance_metrics: Option<ExpectedPerformanceMetrics>,
    /// Expected side effects
    pub side_effects: Vec<ExpectedSideEffect>,
}

/// Expected test outcomes
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ExpectedOutcome {
    /// Test should pass
    Pass,
    /// Test should fail
    Fail,
    /// Test should be skipped
    Skip,
    /// Custom outcome
    Custom(String),
}

/// Result validation specification
#[derive(Debug, Clone)]
pub struct ResultValidation {
    /// Validation method
    pub method: ValidationMethod,
    /// Tolerance for numeric results
    pub tolerance: Option<f64>,
    /// Confidence level required
    pub confidence_level: f64,
}

/// Validation methods for results
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ValidationMethod {
    /// Exact match
    Exact,
    /// Approximate match
    Approximate,
    /// Range check
    Range,
    /// Statistical validation
    Statistical,
    /// Custom validation
    Custom(String),
}

/// Expected performance metrics
#[derive(Debug, Clone)]
pub struct ExpectedPerformanceMetrics {
    /// Expected execution time
    pub execution_time: Option<Duration>,
    /// Expected memory usage
    pub memory_usage: Option<usize>,
    /// Expected throughput
    pub throughput: Option<f64>,
    /// Expected error rate
    pub error_rate: Option<f64>,
    /// Custom metrics
    pub custom_metrics: HashMap<String, f64>,
}

/// Expected side effects
#[derive(Debug, Clone)]
pub struct ExpectedSideEffect {
    /// Side effect name
    pub name: String,
    /// Side effect type
    pub effect_type: SideEffectType,
    /// Effect description
    pub description: String,
    /// Acceptance criteria
    pub acceptance_criteria: AcceptanceCriteria,
}

/// Types of side effects
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SideEffectType {
    /// State change
    StateChange,
    /// Resource consumption
    ResourceConsumption,
    /// Performance impact
    PerformanceImpact,
    /// Data modification
    DataModification,
    /// Custom side effect
    Custom(String),
}

/// Acceptance criteria for side effects
#[derive(Debug, Clone)]
pub struct AcceptanceCriteria {
    /// Acceptable impact level
    pub acceptable_impact: ImpactLevel,
    /// Maximum duration
    pub max_duration: Option<Duration>,
    /// Recovery requirements
    pub recovery_requirements: Vec<String>,
}

/// Impact levels for side effects
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd)]
pub enum ImpactLevel {
    None = 0,
    Minimal = 1,
    Low = 2,
    Medium = 3,
    High = 4,
    Critical = 5,
}

/// Individual test step
#[derive(Debug, Clone)]
pub struct TestStep {
    /// Step identifier
    pub id: String,
    /// Step name
    pub name: String,
    /// Step description
    pub description: String,
    /// Step type
    pub step_type: StepType,
    /// Step parameters
    pub parameters: HashMap<String, ParameterValue>,
    /// Step timeout
    pub timeout: Option<Duration>,
    /// Retry configuration
    pub retry_config: Option<RetryConfig>,
}

/// Test step types
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum StepType {
    /// Setup step
    Setup,
    /// Execution step
    Execution,
    /// Validation step
    Validation,
    /// Cleanup step
    Cleanup,
    /// Custom step
    Custom(String),
}

/// Retry configuration for test steps
#[derive(Debug, Clone)]
pub struct RetryConfig {
    /// Maximum retry attempts
    pub max_attempts: usize,
    /// Retry delay
    pub retry_delay: Duration,
    /// Exponential backoff
    pub exponential_backoff: bool,
    /// Retry conditions
    pub retry_conditions: Vec<String>,
}

/// Test suite configuration
#[derive(Debug, Clone)]
pub struct TestSuiteConfig {
    /// Execution order
    pub execution_order: ExecutionOrder,
    /// Parallel execution settings
    pub parallel_execution: ParallelExecutionConfig,
    /// Suite timeout
    pub timeout: Duration,
    /// Failure handling
    pub failure_handling: FailureHandling,
}

/// Test execution order
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ExecutionOrder {
    /// Sequential execution
    Sequential,
    /// Parallel execution
    Parallel,
    /// Dependency-based order
    DependencyBased,
    /// Priority-based order
    PriorityBased,
    /// Custom order
    Custom(Vec<String>),
}

/// Parallel execution configuration
#[derive(Debug, Clone)]
pub struct ParallelExecutionConfig {
    /// Enable parallel execution
    pub enable_parallel: bool,
    /// Maximum parallel threads
    pub max_threads: usize,
    /// Thread pool configuration
    pub thread_pool_config: ThreadPoolConfig,
}

/// Thread pool configuration
#[derive(Debug, Clone)]
pub struct ThreadPoolConfig {
    /// Core pool size
    pub core_size: usize,
    /// Maximum pool size
    pub max_size: usize,
    /// Thread keepalive time
    pub keepalive_time: Duration,
    /// Queue capacity
    pub queue_capacity: usize,
}

/// Failure handling strategies
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum FailureHandling {
    /// Stop on first failure
    StopOnFirstFailure,
    /// Continue on failure
    ContinueOnFailure,
    /// Retry failed tests
    RetryFailedTests,
    /// Custom handling
    Custom(String),
}

/// Test metadata
#[derive(Debug, Clone)]
pub struct TestMetadata {
    /// Test author
    pub author: String,
    /// Creation timestamp
    pub created: SystemTime,
    /// Last modified timestamp
    pub modified: SystemTime,
    /// Test version
    pub version: String,
    /// Tags
    pub tags: Vec<String>,
    /// Custom metadata
    pub custom: HashMap<String, String>,
}