GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

microsoft/qdk

Public

mirrored from https://github.com/microsoft/qdkAvailable

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
e874bfb8e1dbfc3eec7aebe87f45fc0cb4c547b6

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

qdk/compiler/qsc/src/interpret

compiler/qsc/src/interpret/debugger_tests.rs

221lines · modecode

RawDownload
Latest commit unavailable.
1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4#![allow(clippy::needless_raw_string_hashes)]
5
6use crate::interpret::Debugger;
7use crate::line_column::Encoding;
8use qsc_data_structures::language_features::LanguageFeatures;
9use qsc_eval::{output::CursorReceiver, StepAction, StepResult};
10use qsc_fir::fir::StmtId;
11use qsc_frontend::compile::{SourceMap, TargetCapabilityFlags};
12use std::io::Cursor;
13
14fn get_breakpoint_ids(debugger: &Debugger, path: &str) -> Vec<StmtId> {
15 let mut bps = debugger.get_breakpoints(path);
16 bps.sort_by_key(|f| f.id);
17 let ids = bps.iter().map(|f| f.id.into()).collect::<Vec<_>>();
18 ids
19}
20
21fn expect_return(mut debugger: Debugger, expected: &str) {
22 let r = step_next(&mut debugger, &[]);
23 match r.0 {
24 Ok(StepResult::Return(value)) => assert_eq!(value.to_string(), expected),
25 Ok(v) => panic!("Expected Return, got {v:?}"),
26 Err(e) => panic!("Expected Return, got {e:?}"),
27 }
28}
29
30fn expect_bp(debugger: &mut Debugger, ids: &[StmtId], expected_id: StmtId) {
31 let r = step_next(debugger, ids);
32 match r.0 {
33 Ok(StepResult::BreakpointHit(actual_id)) => assert!(actual_id == expected_id),
34 Ok(v) => panic!("Expected BP, got {v:?}"),
35 Err(e) => panic!("Expected BP, got {e:?}"),
36 }
37}
38
39fn step_in(
40 debugger: &mut Debugger,
41 breakpoints: &[StmtId],
42) -> (Result<StepResult, Vec<crate::interpret::Error>>, String) {
43 step(debugger, breakpoints, qsc_eval::StepAction::In)
44}
45
46fn step_next(
47 debugger: &mut Debugger,
48 breakpoints: &[StmtId],
49) -> (Result<StepResult, Vec<crate::interpret::Error>>, String) {
50 step(debugger, breakpoints, qsc_eval::StepAction::Next)
51}
52
53fn step_out(
54 debugger: &mut Debugger,
55 breakpoints: &[StmtId],
56) -> (Result<StepResult, Vec<crate::interpret::Error>>, String) {
57 step(debugger, breakpoints, qsc_eval::StepAction::Out)
58}
59
60fn step(
61 debugger: &mut Debugger,
62 breakpoints: &[StmtId],
63 step: StepAction,
64) -> (Result<StepResult, Vec<crate::interpret::Error>>, String) {
65 let mut cursor = Cursor::new(Vec::<u8>::new());
66 let mut receiver = CursorReceiver::new(&mut cursor);
67 (
68 debugger.eval_step(&mut receiver, breakpoints, step),
69 receiver.dump(),
70 )
71}
72
73fn expect_next(debugger: &mut Debugger) {
74 let result = step_next(debugger, &[]);
75 match result.0 {
76 Ok(StepResult::Next) => (),
77 Ok(v) => panic!("Expected Next, got {v:?}"),
78 Err(e) => panic!("Expected Next, got {e:?}"),
79 }
80}
81
82fn expect_in(debugger: &mut Debugger) {
83 let result = step_in(debugger, &[]);
84 match result.0 {
85 Ok(StepResult::StepIn) => (),
86 Ok(v) => panic!("Expected StepIn, got {v:?}"),
87 Err(e) => panic!("Expected StepIn, got {e:?}"),
88 }
89}
90
91fn expect_out(debugger: &mut Debugger) {
92 let result = step_out(debugger, &[]);
93 match result.0 {
94 Ok(StepResult::StepOut) => (),
95 Ok(v) => panic!("Expected StepOut, got {v:?}"),
96 Err(e) => panic!("Expected StepOut, got {e:?}"),
97 }
98}
99
100#[cfg(test)]
101mod given_debugger {
102 use super::*;
103
104 static STEPPING_SOURCE: &str = r#"
105 namespace Test {
106 @EntryPoint()
107 operation A() : Int {
108 let d = B();
109 let e = d / 1;
110 e
111 }
112 operation B() : Int {
113 let g = 10;
114 let h = 20;
115 let l = C(g, h);
116 42
117 }
118 operation C(m: Int, n: Int) : Int {
119 let o = 42 - (m + n);
120 let p = (m + n) + o;
121 p
122 }
123 }"#;
124 #[cfg(test)]
125 mod step {
126 use super::*;
127
128 #[test]
129 fn in_one_level_operation_works() -> Result<(), Vec<crate::interpret::Error>> {
130 use qsc_data_structures::language_features::LanguageFeatures;
131 let sources = SourceMap::new([("test".into(), STEPPING_SOURCE.into())], None);
132 let mut debugger = Debugger::new(
133 sources,
134 TargetCapabilityFlags::all(),
135 Encoding::Utf8,
136 LanguageFeatures::default(),
137 )?;
138 let ids = get_breakpoint_ids(&debugger, "test");
139 let expected_id = ids[0];
140 expect_bp(&mut debugger, &ids, expected_id);
141 expect_in(&mut debugger);
142 expect_next(&mut debugger);
143 expect_next(&mut debugger);
144 expect_next(&mut debugger);
145 expect_next(&mut debugger);
146 expect_next(&mut debugger);
147 let expected = "42";
148 expect_return(debugger, expected);
149 Ok(())
150 }
151
152 #[test]
153 fn next_crosses_operation_works() -> Result<(), Vec<crate::interpret::Error>> {
154 let sources = SourceMap::new([("test".into(), STEPPING_SOURCE.into())], None);
155 let mut debugger = Debugger::new(
156 sources,
157 TargetCapabilityFlags::all(),
158 Encoding::Utf8,
159 LanguageFeatures::default(),
160 )?;
161 let ids = get_breakpoint_ids(&debugger, "test");
162 let expected_id = ids[0];
163 expect_bp(&mut debugger, &ids, expected_id);
164 expect_next(&mut debugger);
165 expect_next(&mut debugger);
166 let expected = "42";
167 expect_return(debugger, expected);
168 Ok(())
169 }
170
171 #[test]
172 fn in_multiple_operations_works() -> Result<(), Vec<crate::interpret::Error>> {
173 let sources = SourceMap::new([("test".into(), STEPPING_SOURCE.into())], None);
174 let mut debugger = Debugger::new(
175 sources,
176 TargetCapabilityFlags::all(),
177 Encoding::Utf8,
178 LanguageFeatures::default(),
179 )?;
180 let ids = get_breakpoint_ids(&debugger, "test");
181 let expected_id = ids[0];
182 expect_bp(&mut debugger, &ids, expected_id);
183 expect_in(&mut debugger);
184 expect_next(&mut debugger);
185 expect_next(&mut debugger);
186 expect_in(&mut debugger);
187 expect_next(&mut debugger);
188 expect_next(&mut debugger);
189 expect_next(&mut debugger);
190 expect_next(&mut debugger);
191 expect_next(&mut debugger);
192 let expected = "42";
193 expect_return(debugger, expected);
194 Ok(())
195 }
196
197 #[test]
198 fn out_multiple_operations_works() -> Result<(), Vec<crate::interpret::Error>> {
199 let sources = SourceMap::new([("test".into(), STEPPING_SOURCE.into())], None);
200 let mut debugger = Debugger::new(
201 sources,
202 TargetCapabilityFlags::all(),
203 Encoding::Utf8,
204 LanguageFeatures::default(),
205 )?;
206 let ids = get_breakpoint_ids(&debugger, "test");
207 let expected_id = ids[0];
208 expect_bp(&mut debugger, &ids, expected_id);
209 expect_in(&mut debugger);
210 expect_next(&mut debugger);
211 expect_next(&mut debugger);
212 expect_in(&mut debugger);
213 expect_out(&mut debugger);
214 expect_out(&mut debugger);
215 expect_next(&mut debugger);
216 let expected = "42";
217 expect_return(debugger, expected);
218 Ok(())
219 }
220 }
221}