GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

microsoft/qdk

Public

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

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
v1.2.0

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

225lines · 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::{RuntimeCapabilityFlags, SourceMap};
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 RuntimeCapabilityFlags::all(),
135 Encoding::Utf8,
136 LanguageFeatures::default(),
137 )?;
138 debugger.set_entry()?;
139 let ids = get_breakpoint_ids(&debugger, "test");
140 let expected_id = ids[0];
141 expect_bp(&mut debugger, &ids, expected_id);
142 expect_in(&mut debugger);
143 expect_next(&mut debugger);
144 expect_next(&mut debugger);
145 expect_next(&mut debugger);
146 expect_next(&mut debugger);
147 expect_next(&mut debugger);
148 let expected = "42";
149 expect_return(debugger, expected);
150 Ok(())
151 }
152
153 #[test]
154 fn next_crosses_operation_works() -> Result<(), Vec<crate::interpret::Error>> {
155 let sources = SourceMap::new([("test".into(), STEPPING_SOURCE.into())], None);
156 let mut debugger = Debugger::new(
157 sources,
158 RuntimeCapabilityFlags::all(),
159 Encoding::Utf8,
160 LanguageFeatures::default(),
161 )?;
162 debugger.set_entry()?;
163 let ids = get_breakpoint_ids(&debugger, "test");
164 let expected_id = ids[0];
165 expect_bp(&mut debugger, &ids, expected_id);
166 expect_next(&mut debugger);
167 expect_next(&mut debugger);
168 let expected = "42";
169 expect_return(debugger, expected);
170 Ok(())
171 }
172
173 #[test]
174 fn in_multiple_operations_works() -> Result<(), Vec<crate::interpret::Error>> {
175 let sources = SourceMap::new([("test".into(), STEPPING_SOURCE.into())], None);
176 let mut debugger = Debugger::new(
177 sources,
178 RuntimeCapabilityFlags::all(),
179 Encoding::Utf8,
180 LanguageFeatures::default(),
181 )?;
182 debugger.set_entry()?;
183 let ids = get_breakpoint_ids(&debugger, "test");
184 let expected_id = ids[0];
185 expect_bp(&mut debugger, &ids, expected_id);
186 expect_in(&mut debugger);
187 expect_next(&mut debugger);
188 expect_next(&mut debugger);
189 expect_in(&mut debugger);
190 expect_next(&mut debugger);
191 expect_next(&mut debugger);
192 expect_next(&mut debugger);
193 expect_next(&mut debugger);
194 expect_next(&mut debugger);
195 let expected = "42";
196 expect_return(debugger, expected);
197 Ok(())
198 }
199
200 #[test]
201 fn out_multiple_operations_works() -> Result<(), Vec<crate::interpret::Error>> {
202 let sources = SourceMap::new([("test".into(), STEPPING_SOURCE.into())], None);
203 let mut debugger = Debugger::new(
204 sources,
205 RuntimeCapabilityFlags::all(),
206 Encoding::Utf8,
207 LanguageFeatures::default(),
208 )?;
209 debugger.set_entry()?;
210 let ids = get_breakpoint_ids(&debugger, "test");
211 let expected_id = ids[0];
212 expect_bp(&mut debugger, &ids, expected_id);
213 expect_in(&mut debugger);
214 expect_next(&mut debugger);
215 expect_next(&mut debugger);
216 expect_in(&mut debugger);
217 expect_out(&mut debugger);
218 expect_out(&mut debugger);
219 expect_next(&mut debugger);
220 let expected = "42";
221 expect_return(debugger, expected);
222 Ok(())
223 }
224 }
225}
226