[Samples] Add samples for testing operations in Q#

samples/testing/operations/README.md

@@ -9,21 +9,21 @@ There are two primary ways to test operations in the QDK:
    - Use the `dump_operation` Python API to retrieve the operation's representation as a matrix and compare it against the expected matrix.
 
 2. **Q# `Fact` Assertions:**
-   - Use a `Fact` function in your Q# code that uses the `CheckOperationsAreEqual` operation to verify if two operations are identical. The `Fact` function asserts that the check returns `true`.
+   - Use a `Fact` function in your Q# code that uses the `CheckOperationsAreEqual` operation to verify if two operations are identical upto a global phase. The `Fact` function asserts that the check returns `true`.
 
 ## Project Structure
 This sample project is a multi-file Q# project that showcases both testing methods. The project structure is as follows:
 
 - src
     - `BellState.qs`: Q# file containing the `AllBellStates` operation to be tested
-    - `Test_SWAP.qs`: Q# file containing the `ApplySWAP1` and `ApplySWAP2` operations to be tested
-    - `OperationEquivalence.qs`: Q# file containing the `TestEquivalence` operation to be called in python wrapper
+    - `CustomOperation.qs`: Q# file containing the `ApplySWAP1` and `ApplySWAP2` operations to be tested
+    - `OperationEquivalence.qs`: Q# file containing the `TestEquivalence` operation to be called in Python wrapper
 - `qsharp.json`: Q# project manifest file, instructing compiler to include all files in `src` directory.
 - `test_dump_operation.py`: Python wrapper containing tests.
 
 ## Installation
-- Install the `qsharp` python package by following the instructions mentioned [here](https://learn.microsoft.com/azure/quantum/install-overview-qdk#add-support-for-python-and-jupyter-notebooks).
-- Install `pytest` python package.
+- Install the `qsharp` Python package by following the instructions mentioned [here](https://learn.microsoft.com/azure/quantum/install-overview-qdk#add-support-for-python-and-jupyter-notebooks).
+- Install `pytest` Python package.
 
 ## Running the sample
 Open the `samples/testing/operations` directory, and run `pytest` command.

samples/testing/operations/src/BellState.qs

@@ -1,13 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-/// # Sample
-/// Multi File Testing Project (Refer to README for Project Overview)
-///
-/// # Description
-/// This code builds upon the concepts explained in the README file,
-/// demonstrating how to organize Q# code into multiple files for testing.
-
 namespace BellState {
     /// # Summary
     /// Operation that generates all bell states for testing with `dump_operation.py`.

samples/testing/operations/src/CustomOperation.qs

@@ -1,13 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-/// # Sample
-/// Multi File Testing Project
-///
-/// # Description
-/// This code builds upon the concepts explained in the README file,
-/// demonstrating how to organize Q# code into multiple files for testing.
-
 namespace CustomOperation {
     // # Summary
     /// CNOT based operation for testing with `TestEquivalence` operation.

samples/testing/operations/src/OperationEquivalence.qs

@@ -1,20 +1,13 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-/// # Sample
-/// Multi File Testing Project (Refer to README for Project Overview)
-///
-/// # Description
-/// This code builds upon the concepts explained in the README file,
-/// demonstrating how to organize Q# code into multiple files for testing.
-
 namespace OperationEquivalence {
     open Microsoft.Quantum.Diagnostics;
     open CustomOperation;
     /// # Summary
-    /// Verifies the equivalence of quantum operations using `Fact` function
+    /// Verifies the equivalence of quantum operations upto a global phase using `Fact` function
     /// and the `CheckOperationsAreEqual` operation. You can either run this here,
-    /// by clicking `Run` in VsCode or call `TestEquivalence` operation in python.
+    /// by clicking `Run` in VsCode or call `TestEquivalence` operation in Python.
     @EntryPoint()
     operation TestEquivalence() : Unit {
         let actual = qs => CustomOperation.ApplySWAP(qs[0], qs[1]);

samples/testing/operations/test_operations.py

@@ -7,10 +7,9 @@
 
 @pytest.fixture(autouse=True)
 def setup():
-    """Fixture to execute asserts before a test is run"""
-    # You can set the target profile here if you want
-    # By default, it uses "Unrestricted" profile
-    qsharp.init(target_profile=qsharp.TargetProfile.Base)
+    """Fixture to execute before a test is run"""
+    # Setting the project root to current folder.
+    qsharp.init(project_root=".")
     yield # this is where the testing happens
 
 def test_empty_operation() -> None:
@@ -22,26 +21,20 @@
 
 
 def test_single_qubit_not_gate() -> None:
-    qsharp.init(target_profile=qsharp.TargetProfile.Unrestricted)
-
     res = dump_operation("qs => X(qs[0])", 1)
     assert res == [
         [0, 1],
         [1, 0],
     ]
 
 def test_single_qubit_hadamard_gate() -> None:
-    qsharp.init(target_profile=qsharp.TargetProfile.Unrestricted)
-
     res = dump_operation("qs => H(qs[0])", 1)
     assert res == [
         [0.707107, 0.707107],
         [0.707107, -0.707107],
     ]
 
 def test_two_qubit_cnot_gate() -> None:
-    qsharp.init(target_profile=qsharp.TargetProfile.Unrestricted)
-
     res = dump_operation("qs => CNOT(qs[0], qs[1])", 2)
     assert res == [
         [1, 0, 0, 0],
@@ -51,10 +44,8 @@
     ]
 
 def test_custom_operation() -> None:
-    qsharp.init(target_profile=qsharp.TargetProfile.Unrestricted)
-
     qsharp.eval(
         "operation ApplySWAP(qs : Qubit[]) : Unit is Ctl + Adj { SWAP(qs[0], qs[1]); }"
     )
 
     res = dump_operation("ApplySWAP", 2)
@@ -66,7 +57,6 @@
     ]
 
 def test_operation_no_args_in_qsharp_file() -> None:
-    qsharp.init(target_profile=qsharp.TargetProfile.Unrestricted)
     qsharp.init(project_root='.')
 
     res = dump_operation("qs => CustomOperation.ApplySWAP(qs[0], qs[1])", 2)
@@ -78,7 +68,6 @@
     ]
 
 def test_operation_with_args_in_qsharp_file() -> None:
-    qsharp.init(target_profile=qsharp.TargetProfile.Unrestricted)
     qsharp.init(project_root='.')
 
     res0 = dump_operation("BellState.AllBellStates(_, 0)", 2)
@@ -119,9 +108,8 @@
 
 
 def test_operation_equivalence_using_fact() -> None:
-    qsharp.init(target_profile=qsharp.TargetProfile.Unrestricted)
     qsharp.init(project_root='.')
 
     qsharp.eval(
         "OperationEquivalence.TestEquivalence()"
     )