microsoft/qdk
Publicmirrored fromhttps://github.com/microsoft/qdkAvailable
compiler/qsc_codegen/src/qsharp/test_utils.rs
95lines · modecode
| 1 | // Copyright (c) Microsoft Corporation. |
| 2 | // Licensed under the MIT License. |
| 3 | |
| 4 | #![allow(clippy::too_many_lines)] |
| 5 | #![allow(clippy::needless_raw_string_hashes)] |
| 6 | |
| 7 | use std::sync::Arc; |
| 8 | |
| 9 | use expect_test::Expect; |
| 10 | use qsc_ast::{ast::Package, mut_visit::MutVisitor}; |
| 11 | use qsc_data_structures::{ |
| 12 | language_features::LanguageFeatures, span::Span, target::TargetCapabilityFlags, |
| 13 | }; |
| 14 | use qsc_frontend::compile::{self, compile, PackageStore, SourceMap}; |
| 15 | use qsc_hir::hir::PackageId; |
| 16 | use qsc_passes::{run_core_passes, run_default_passes, PackageType}; |
| 17 | |
| 18 | use crate::qsharp::write_package_string; |
| 19 | |
| 20 | pub(crate) fn check(program: &str, expr: Option<&str>, expect: &Expect) { |
| 21 | let (qsharp, src_ast_str) = compile_program(expr, program); |
| 22 | expect.assert_eq(&qsharp); |
| 23 | // Run the output against the compiler to ensure that input |
| 24 | // and output both generate the same qsharp. |
| 25 | let (round_trip_qsharp, gen_ast_str) = compile_program(expr, &qsharp); |
| 26 | expect.assert_eq(&round_trip_qsharp); |
| 27 | // we've validated the output, now validate the ASTs |
| 28 | // We may have generated the same Q#, but may have changed semantics |
| 29 | difference::assert_diff!(&src_ast_str, &gen_ast_str, "\n", 0); |
| 30 | } |
| 31 | |
| 32 | pub(crate) fn get_compilation(sources: Option<SourceMap>) -> (PackageId, PackageStore) { |
| 33 | let mut core = compile::core(); |
| 34 | assert!(run_core_passes(&mut core).is_empty()); |
| 35 | let mut store = PackageStore::new(core); |
| 36 | let mut std = compile::std(&store, TargetCapabilityFlags::empty()); |
| 37 | assert!(run_default_passes( |
| 38 | store.core(), |
| 39 | &mut std, |
| 40 | PackageType::Lib, |
| 41 | TargetCapabilityFlags::empty() |
| 42 | ) |
| 43 | .is_empty()); |
| 44 | let std = store.insert(std); |
| 45 | |
| 46 | let mut unit = compile( |
| 47 | &store, |
| 48 | &[std], |
| 49 | sources.unwrap_or_default(), |
| 50 | TargetCapabilityFlags::all(), |
| 51 | LanguageFeatures::empty(), |
| 52 | ); |
| 53 | assert!(unit.errors.is_empty(), "{:?}", unit.errors); |
| 54 | assert!(run_default_passes( |
| 55 | store.core(), |
| 56 | &mut unit, |
| 57 | PackageType::Lib, |
| 58 | TargetCapabilityFlags::all() |
| 59 | ) |
| 60 | .is_empty()); |
| 61 | let package_id = store.insert(unit); |
| 62 | (package_id, store) |
| 63 | } |
| 64 | |
| 65 | pub(crate) fn compile_program(expr: Option<&str>, program: &str) -> (String, String) { |
| 66 | let expr_as_arc: Option<Arc<str>> = expr.map(|s| Arc::from(s.to_string())); |
| 67 | let sources = SourceMap::new([("test".into(), program.into())], expr_as_arc); |
| 68 | |
| 69 | let (package_id, store) = get_compilation(Some(sources)); |
| 70 | let package = &store.get(package_id).expect("package must exist"); |
| 71 | |
| 72 | let despanned_ast = AstDespanner.despan(&package.ast.package); |
| 73 | let qsharp = write_package_string(&despanned_ast); |
| 74 | let ast = format!("{despanned_ast}"); |
| 75 | (qsharp, ast) |
| 76 | } |
| 77 | |
| 78 | struct AstDespanner; |
| 79 | impl AstDespanner { |
| 80 | fn despan(&mut self, package: &Package) -> Package { |
| 81 | let mut p = package.clone(); |
| 82 | self.visit_package(&mut p); |
| 83 | p |
| 84 | } |
| 85 | } |
| 86 | |
| 87 | impl qsc_ast::mut_visit::MutVisitor for AstDespanner { |
| 88 | fn visit_span(&mut self, span: &mut Span) { |
| 89 | span.hi = 0; |
| 90 | span.lo = 0; |
| 91 | } |
| 92 | fn visit_visibility(&mut self, vis: &mut qsc_ast::ast::Visibility) { |
| 93 | self.visit_span(&mut vis.span); |
| 94 | } |
| 95 | } |
| 96 | |