add insert_barrier argument to UnitaryOverlap

[kevinsung]

Summary

Fixes #12319

Details and comments

[qiskit-bot]

One or more of the the following people are requested to review this:

• @Cryoris
• @Qiskit/terra-core
• @ajavadia

[kevinsung]

Strange, I can't reproduce the CI test failures locally...

==============================
Failed 1 tests - output below:
==============================

test.python.circuit.library.test_overlap.TestUnitaryOverlap.test_insert_barrier
-------------------------------------------------------------------------------

Captured traceback:
~~~~~~~~~~~~~~~~~~~
    Traceback (most recent call last):

      File "/tmp/terra-tests/test/python/circuit/library/test_overlap.py", line 140, in test_insert_barrier
    self.assertEqual(

      File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/unittest/case.py", line 912, in assertEqual
    assertion_func(first, second, msg=msg)

      File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/unittest/case.py", line 1292, in assertMultiLineEqual
    self.fail(self._formatMessage(msg, standardMsg))

      File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/unittest/case.py", line 753, in fail
    raise self.failureException(msg)

    AssertionError: '┌───[35 chars]─┐ ░ »\nq: ┤ EfficientSU2(p1[0],p1[1],p1[2],p1[206 chars]───┘' != '┌───[35 chars]─┐ ░ ┌────────────────────────────────────────[185 chars]───┘'
+ ┌───────────────────────────────────────┐ ░ ┌──────────────────────────────────────────┐
+ q: ┤ EfficientSU2(p1[0],p1[1],p1[2],p1[3]) ├─░─┤ EfficientSU2_dg(p2[0],p2[1],p2[2],p2[3]) ├
+    └───────────────────────────────────────┘ ░ └──────────────────────────────────────────┘- ┌───────────────────────────────────────┐ ░ »
- q: ┤ EfficientSU2(p1[0],p1[1],p1[2],p1[3]) ├─░─»
-    └───────────────────────────────────────┘ ░ »
- «   ┌──────────────────────────────────────────┐
- «q: ┤ EfficientSU2_dg(p2[0],p2[1],p2[2],p2[3]) ├
- «   └──────────────────────────────────────────┘

[raynelfss]

Thank you for working on this. This looks good, however, I believe your assertion issue is due to the way the instance of Overlap is being drawn. There is an easy way to fix this though. Check my comment below.

[coveralls]

Pull Request Test Coverage Report for Build 9133373485

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
• 979 unchanged lines in 56 files lost coverage.
• Overall coverage increased (+0.07%) to 89.612%

---

Files with Coverage Reduction	New Missed Lines	%
qiskit/circuit/classical/expr/constructors.py	1	91.82%
qiskit/primitives/backend_estimator_v2.py	1	98.29%
qiskit/transpiler/passes/layout/apply_layout.py	1	98.25%
qiskit/primitives/statevector_sampler.py	1	99.08%
qiskit/circuit/store.py	1	94.44%
qiskit/passmanager/passmanager.py	1	92.63%
qiskit/circuit/library/data_preparation/initializer.py	1	93.75%
crates/accelerate/src/sabre/mod.rs	1	75.0%
qiskit/circuit/classical/expr/expr.py	1	93.51%
qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py	1	99.11%

Totals
Change from base Build 8912008593:	0.07%
Covered Lines:	62302
Relevant Lines:	69524

---

💛 - Coveralls

[raynelfss]

LGTM! Thank you for the quick updates