2121350: Implement "force" register option in rhsm dbus python binding

[DuckBoss]

• Card ID: ENT-5350
• BZ: https://bugzilla.redhat.com/show_bug.cgi?id=2121350
• Implemented missing behavior of the "force" option in Dbus API by unregistering the system if already registered and re-registering the system.

Testing

This implementation can be tested in either Python or CLI by sending a register command with the "force" option enabled to the rhsm dbus python binding as seen below:

Testing with a shell script

• Use this script: https://github.com/jirihnidek/rhsm-dbus-examples/blob/main/register-org-username-password-force.sh

Testing with a python script

• Modified script from original BZ reproduction steps:

import dbus

REGISTER_OPTS_DICT = dbus.Dictionary({"force": True}, signature="ss")
system_bus = dbus.SystemBus()
register_server = system_bus.get_object("com.redhat.RHSM1", "/com/redhat/RHSM1/RegisterServer")
address = register_server.Start("C", dbus_interface="com.redhat.RHSM1.RegisterServer")
private_bus = dbus.connection.Connection(address)
register_object = private_bus.get_object("com.redhat.RHSM1", "/com/redhat/RHSM1/Register")
connection_opts = {
    "host": "<stage_server_address>"
}
connection_opts = dbus.Dictionary(connection_opts, signature="ss")

# Register w/ username and password
register_object.Register(
    "<org_id>",
    "<username>",
    "<password>",
    REGISTER_OPTS_DICT,
    connection_opts,
    "C",
    dbus_interface="com.redhat.RHSM1.Register",
)

# Register w/ activation keys
register_object.RegisterWithActivationKeys(
    "<org_id>",
    [<list_of_activation_keys>],
    REGISTER_OPTS_DICT,
    connection_opts,
    "C",
    dbus_interface="com.redhat.RHSM1.Register",
)

[DuckBoss]

Side note for anyone reviewing: I added unit tests for the related dbus binding changes, however I'm not too sure if this is the proper implementation. Please let me know!

[jirihnidek]

Overall it LGTM 👍 . I have only small requests.

BTW: it is good to add some instruction how to test this case. Something like: Use this script for testing: https://github.com/jirihnidek/rhsm-dbus-examples/blob/main/register-org-username-password-force.sh

[ptoscano]

This seems good now at a quick glance; also RegisterWithActivationKeys needs the same changes, as that API has the same issue.

[jirihnidek]

BTW: When I try to run unit tests: py.test ./test/rhsmlib/dbus/test_register.py, then there is many failed unit test even for main branch. There is PR fixing this issue: #3156. We should wait until this is merged to main.

[DuckBoss]

BTW: When I try to run unit tests: py.test ./test/rhsmlib/dbus/test_register.py, then there is many failed unit test even for main branch. There is PR fixing this issue: #3156. We should wait until this is merged to main.

Thanks for letting me know, but I'm not able to reproduce the unit test errors for the main branch PR. I'm getting the dbus-related unit test errors only in the 1.28 backport PR.

---

Edit: I've added the additional unit test for checking registration with activation keys if the system is already registered.

[jirihnidek]

LGTM, Thanks for updates.