API-factory: Method to Associate needed entities, then Register the Host

[damoore044]

Problem Statement

Many hosts for Errata-UI, use a fixture registered_contenthost (@L223), which registers a rhel_contenthost fixture.
In parameterized sessions, the registered_contenthost can fail if preexisting content is present, so decent cleanup was needed.

• Current Errata-UI reg. hosts are setup as a fixture of a fixture,
• intermittent setup failures in the fixture, or mismatched/persisted content in CI runs.
• We do not seem to have a 6.15+ setup method like the older repos_collection.setup_virtual_machine() or ContentHost.contenthost_setup().

Solution

Create an API Factory method (could also exist in the ContentHost class?), that will accept desired entities to host content, associate them, then register the desired client (ie a passed fixture rhel_contenthost) to the now attached entities, using ak.

Note: For api-factory method, you can pass id (int), name (string), or instance for entities (except for client, must be the entity's instance, and except for boolean args)

Very minimal setup is needed, create the needed custom entities or import fixtures, add repos to CV prior if desired, then call the method. Prior to calling, you can also do varying amounts of custom setup to lce, CV etc. For CV, latest version (if any) will be used, can handle entities partially associated or fully.

• To enable repos for host, we can add them to the contentview like I did to setup test_end_to_end, then call the new function. Once registered, I enable them within the method by flag, and the repos (custom or redhat) will be visible to the host, from CV associated to AK. Can also skip enable_repos for method (default), and do it yourself after.
• Alternatively, using the method you can register to an empty CV, then add & sync repos in the CV, publish/promote, enable repos, content is now available to the registered client.
• You can also call other setup methods, like setup_org_for_a_custom_repo or setup_rh_repo_and_return_id etc,
  then simply add the repos to CV, before calling this new method. The content from repo(s) is associated and visible as expected.
• The method makes use of unittest MagicMock(), to mock a request to add finalizer (cleanup method to unregister host during teardown).
• You can register the host to entities using names: org, ak, env, cv
  ie: can accept str "Library" for environment, and can accept "Default Organization View" for content-view.
  Do not pass the Library env as an id or instance, this will fail (building a check for this). Done (ref ~@ln845)

Related Issues

• CI Intermittent UI failures of registered_contenthost, fails setup, or mismatched content, between parameters of a combined session.
• Difficulty creating/fixing tests, as many useful fixtures need varying levels of setup before they can be used to host content.

Demonstration-PRT Case

• UI::Errata::test_end_to_end : Implemented to replace existing registered_contenthost local fixture, which relies on convoluted setup to achieve a useable host ready for content/with content.

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[damoore044]

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[Satellite-QE]

PRT Result

Build Number: 6801
Build Status: UNSTABLE
PRT Comment: pytest tests/foreman/ui/test_errata.py::test_end_to_end --external-logging
Test Result : ============ 2 failed, 1 passed, 313 warnings in 2223.06s (0:37:03) ============

[damoore044]

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[damoore044]

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[Satellite-QE]

PRT Result

Build Number: 6809
Build Status: SUCCESS
PRT Comment: pytest tests/foreman/ui/test_errata.py::test_end_to_end --external-logging
Test Result : ================= 3 passed, 341 warnings in 2343.18s (0:39:03) =================

[damoore044]

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[Satellite-QE]

PRT Result

Build Number: 6828
Build Status: UNSTABLE
PRT Comment: pytest tests/foreman/ui/test_errata.py::test_end_to_end --external-logging
Test Result : ================= 3 failed, 233 warnings in 1776.62s (0:29:36) =================

[damoore044]

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[Satellite-QE]

PRT Result

Build Number: 6872
Build Status: SUCCESS
PRT Comment: pytest tests/foreman/ui/test_errata.py::test_end_to_end --external-logging
Test Result : ================= 3 passed, 325 warnings in 2280.56s (0:38:00) =================

[damoore044]

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[Satellite-QE]

PRT Result

Build Number: 6905
Build Status: SUCCESS
PRT Comment: pytest tests/foreman/ui/test_errata.py::test_end_to_end --external-logging
Test Result : ================= 3 passed, 328 warnings in 2452.15s (0:40:52) =================

[vsedmik]

Nice work in good direction I think! I've just put a few suggestions/questions to consider.

[vsedmik]

Suggested change

param satellite: sat instance where needed entities exist.

[vsedmik]

As far as I know the force=True option in registration basically performs the same under the hood - unregisters the host first and then registers it again. Do we really need this client.unregister() prior to L912 (forceful) registration for some reason I don't see right now? (Like for some setup between this line and L912?)
If not, we could be fine with the force option only.

Suggested change

	if not force and client.subscribed:
	if unregister:
	client.unregister()
	else:
	method_error['message'] = (
	'Passed client is already registered.'
	' Unregister the host prior to calling this method.'
	' Or, pass unregister=True, to unregister within this method first,'
	' Or, pass force=True, to bypass during registration.'
	)
	return method_error
	if not force and client.subscribed:
	method_error['message'] = (
	'Passed client is already registered.'
	' Unregister the host prior to calling this method.'
	' Or, pass force=True, to bypass during registration.'
	)
	return method_error

[damoore044]

This has been removed in favor of unregistering the host, if subscribed, in any actual test or fixture that calls this method.
In parameterized sessions, the rhel ContentHost(s) can get reused and then will not re-register unless force=True.

[vsedmik]

This is interesting use of the feature.

[vsedmik]

Hmm, do we need to read/update all the entities? Wouldn't be update of entities['ContentView'] enough?
Nice syntax anyway.

[vsedmik]

Maybe we could pass the loc as parameter too (for future uses).

[vsedmik]

I know we use this at several places already. I just wonder if it wouldn't be better to do content-override at the AK entity (based on the enable_repos param) prior to the client registration, so the repos would get enabled through the AK already.

[damoore044]

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[Satellite-QE]

PRT Result

Build Number: 6920
Build Status: SUCCESS
PRT Comment: pytest tests/foreman/ui/test_errata.py::test_end_to_end --external-logging
Test Result : ================= 3 passed, 325 warnings in 2262.87s (0:37:42) =================

[damoore044]

trigger: test-robottelo
pytest: tests/foreman/ui/test_errata.py::test_end_to_end

[Satellite-QE]

PRT Result

Build Number: 6993
Build Status: SUCCESS
PRT Comment: pytest tests/foreman/ui/test_errata.py::test_end_to_end --external-logging
Test Result : ================= 3 passed, 323 warnings in 2384.87s (0:39:44) =================

[damoore044]

Work has been brought into #15085