Tenant ports were deleted while cleaning resources

[Min Li]

After tempest started running, I created a new instance. After tempest finished running, I found that the port of the instance was deleted.
All tenant ports are listed, and all are deleted when resources are cleaned up.

please check： https://opendev.org/openstack/tempest/src/branch/master/tempest/cmd/cleanup_service.py#L627
self.tenant_filter is {}
This will affect the normal use of tenants during running tempest.

[Min Li (limin0801)]

The same problem also occurs when cleaning up network resources.

[Martin Kopec (mkopec)]

'tempest cleanup' deletes everything it founds and is not in the saved_state.json state at the same time - see its documentation:

https://docs.openstack.org/tempest/latest/cleanup.html

The 'tempest cleanup' is not very smart, the only way how to control what's gonna be deleted is the saved_state.json file. If you wanna test what resources would be deleted, try --dry-run arg - see the doc I linked above.

As I'm thinking about it, maybe we could improve the cleanup utility so that it deletes only resources which are prefixed by "tempest" - as ~all resources created by tempest tests should be named like "tempest-<some name>-<hash>" or very similar to it.

[Martin Kopec (mkopec)]

https://review.opendev.org/c/openstack/tempest/+/826536

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/tempest/+/879923

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/tempest/+/897231

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tempest/+/897231
Committed: https://opendev.org/openstack/tempest/commit/17053d69e57d0131e795ba6f35c6ed7d77ba8bcf
Submitter: "Zuul (22348)"
Branch: master

commit 17053d69e57d0131e795ba6f35c6ed7d77ba8bcf
Author: Luigi Dino Tamagnone <email address hidden>
Date: Tue Oct 3 14:05:25 2023 +0000

    Adding tempest prefix option in tempest.conf

    Adding a new config option in tempest.conf as the prefix for the random
    name resources with this new option all the resources created by
    tempest will have the prefix defined by resource_name_prefix option
    in tempest.conf. If not defined the default is tempest.

    Tempest cleanup CLI will then use this config option to cleanup only the
    resources that match the prefix. Make sure this prefix does not match with
    the resource name you do not want Tempest cleanup CLI to delete.

    This is a patch created after the conversation on
    https://review.opendev.org/c/openstack/tempest/+/879923?tab=comments

    Related-Bug: #1945082
    Change-Id: I663a6307a5aa63299d20a304188efe6d29aea9d3

[Samuel Allan (samuelallan)]

Note that the help info for the resource_name_prefix config option is currently misleading, as the option exists but it's not implemented yet - the prefix does not affect how tempest cleanup runs ( https://review.opendev.org/c/openstack/tempest/+/897231 ). Could I suggest a quick follow up to note that it's not implemented yet in the help text?

[Martin Kopec (mkopec)]

you're right, it's still being developed: https://review.opendev.org/c/openstack/tempest/+/879923

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tempest/+/879923
Committed: https://opendev.org/openstack/tempest/commit/9052dfcc851097c9c75782bf7b70310d5a559e49
Submitter: "Zuul (22348)"
Branch: master

commit 9052dfcc851097c9c75782bf7b70310d5a559e49
Author: Luigi Dino Tamagnone <email address hidden>
Date: Sun Apr 9 15:24:45 2023 +0000

    Allow tempest cleanup delete resources based on prefix

    A warning in command description of run cleanup first with dry-run
    is added. The cleanup behavior is extended to allow users to delete
    only resources if their name starts with a certain prefix.

    Closes-Bug: #1945082
    Change-Id: I65dfe051c891b3679538acec713e8616746c47f6