Add params to nb-tester

[emilkovacev]

Migrating from #2344

Effectively allows the nb-tester script to be run against any backend. Also allows you to pass authentication and configuration directly to QiskitRuntimeService (if preferred).

Here's an example of how you can use the new changes to run a set of notebooks against test_eagle using qiskit_ibm_runtime:

test-docs-notebooks --config-path scripts/config/notebook-testing.toml --provider "qiskit_ibm_runtime" --backend "test_eagle2"

By default, --provider is set to qiskit_fake_provider, which runs the same provider code that was present in nb_tester before. By changing the provider, you can also specify "runtime_fake_provider" to use the fake_providers in qiskit_ibm_runtime.fake_provider, or "qiskit_ibm_runtime" to rely on real backends, and the credentials provided.

This shouldn't require changes in CI yet - it seems like notebook testing CI is able to complete the same number of tests as in main, although it does carry over some errors that I ran into on main too.

[qiskit-bot]

Thanks for contributing to Qiskit documentation!

Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌

[Eric-Arellano]

Thanks for working on this!

[Eric-Arellano]

This looks great! Please wait for @frankharkins to approve before merging

[frankharkins]

Looks great! Just one last thing

[Eric-Arellano]

This is a bug that you're using generic_backend_args rather than runtime_service_args. Generally, I recommend deduplicating this code and simplifying it by having the caller pass in the args, so the caller is responsible for doing things like adding "". That will be easier for them to do because they know the type of each argument. This means that this function would take in runtime_service_args = list[str] | None = None (the None is only because [] is not a safe default arg in Python)

Then the caller would do something like:

runtime_service_args = [
                f'channel="{config.args.channel}"'            ],

[emilkovacev]

The only issue with this example (which I ran into while trying this out) is if the args aren't given, then config.args.channel is "None", which is invalid - which either means we write the following for each option:

f'channel="{config.args.channel}"' if config.args.channel else "channel=None"

Or, I could instead make that initial long join statement into a generic function since we would use it multiple times (and are likely to make use of it again):

def render_kwarg(arg, val):
    if isinstance(val, str):
        return f"{arg}=\"{val}\""
    return f"{arg}={val}"

and if there are any more use cases we can expand the usage of the function.

[Eric-Arellano]

render_kwarg

Sounds good to me.

[Eric-Arellano]

Looks great! Feel free to merge after those last suggestions. Thanks for iterating on this!