Generate resources for Central tests

[vilit1]

Automate resource generation for central tests. If the resource values are provided in the configuration file, they will be used. Otherwise, new resources will be created to run the tests. Within a given testing resource group,

• a storage account will be created to be used for all the central tests
• a separate central app will be created for each test and retrieving all possible central app values
• the resources will be deleted once the tests are done.

Specifically, these configuration variables can be safely removed:

• azext_iot_central_app_id
• azext_iot_central_primarykey
• azext_iot_central_scope_id
• azext_iot_central_token
• azext_iot_central_dns_suffix
• azext_iot_central_storage_cstring
• azext_iot_central_storage_container

Generated variables

If the central app id is not provided, the resource group to create the central app must be provided with:

• azext_iot_testrg

If a central app is provided, the resource group value will be retrieved in case it is needed for storage account creation.
Then, the following variables will be populated:

• azext_iot_central_app_id during central app creation
• azext_iot_central_scope_id by creating a throwaway device (in get_app_scope_id)
• azext_iot_central_storage_cstring and azext_iot_central_storage_container during storage account creation.

Limitations and non-generated variables

Note that with the current commands, two parameters will still be needed to run all tests:

• azext_iot_central_primarykey
• azext_iot_central_app_id

If one of these parameters is not provided, then this test will be skipped:

• test_device_connect

If only azext_iot_central_primarykey is provided, then the primary key value will be nulled out because the newly created central app would not have the same primary key as the one that is defined in the configuration file.

For internal testing, these parameters will only be populated (and used) if present in the pytest.ini configuration file:

• azext_iot_central_dns_suffix
• azext_iot_central_token

Other fixes

Delete device templates

Changed the _delete_device_template code to invoke the correct command each time. There was an issue in which the list command defined after was invoked instead of the delete command.

sys.excepthook error

In addition, fixing sys.excepthook error by specifying which loop is to be closed.

The issue is here: #475

---

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Thank you for contributing to the IoT extension!

This checklist is used to make sure that common guidelines for a pull request are followed.

General Guidelines

Intent for Production

• It is expected that pull requests made to default or core branches such as dev or main are of production grade. Corollary to this, any merged contributions to these branches may be deployed in a public release at any given time. By checking this box, you agree and commit to the expected production quality of code.

Basic expectations

• If introducing new functionality or modified behavior, are they backed by unit and/or integration tests?
• In the same context as above are command names and their parameter definitions accurate? Do help docs have sufficient content?
• Have all the relevant unit and integration tests pass? i.e. pytest <project root> -vv. Please provide evidence in the form of a screenshot showing a succesful run of tests locally OR a link to a test pipeline that has been run against the change-set.
• Have linter checks passed using the .pylintrc and .flake8 rules? Look at the CI scripts for example usage.
• Have extraneous print or debug statements, commented out code-blocks or code-statements (if any) been removed from the surface area of changes?
  - [x] Have you made an entry in HISTORY.rst which concisely explains your user-facing feature or change?

Azure IoT CLI maintainers reserve the right to enforce any of the outlined expectations.

A PR is considered ready for review when all basic expectations have been met (or do not apply).

[vilit1]

Test run with app id and primary key defined (only storage account generated for test suite):

Durations:

Test run with no variables (central application generated for each test and storage account generated for test suite):

Durations:

[yang-hai-feng]

Looks good to me, put some comments on creating new app flow, btw have you run the integration tests successfully with auto created apps?

[lucadruda]

Looks good to me

We discussed some changes offline.

[vilit1]

I removed the functionality in the integration tests that would run the tests twice (once with a token and once without). This meant that tests took twice as long.

Instead, the integration tests will rely on the configuration to determine if they are going to be run with a token or not; if there is a token defined then the integration tests will use that token and if there is no token, the integration tests will run without a token.

In a future pr, I will add unit tests to ensure that the tokens are generated properly. Specifically the unit tests will cover the functions in the central utility.

[vilit1]

https://dev.azure.com/azureiotdevxp/aziotcli/_build/results?buildId=5098&view=results