Flaky assertion fix

[matejnesuta]

Describe the change

Related to #7237.

I have not found a reliable way to reproduce the failure, but I have encountered it multiple times both on upstream OCP and Kind. Occasionally, the code inside the Mocha hook was not executed at all and the test passed even though it should detect a failure. This piece of code is tied to most of the CRD validation tests in Cypress.

Steps to test the PR

Create a minimal Istio gateway in Kiali and insert this scenario in the istio_config.feature file:

  @bookinfo-app
  @selected
  Scenario: delete me later
    When user selects the "bookinfo" namespace
    Then the "foo" "Gateway" of the "bookinfo" namespace should have a "danger"

Run the yarn cypress:selected command and the test should fail.

When doing the same procedure against the master branch, there is a chance that the scenario will pass instead of failing.

Issue reference

#7237

[matejnesuta]

KIA0505 validation is a flaky test, but the other two scenarios are failing consistently on my local Kind.

[matejnesuta]

The cleanup hook was not working, so a fix of that will hopefully resolve some of the flakes. KIA1102 is probably a bug (see #7275).

[hhovsepy]

I think we need to leave the "retries 3" as this is done to make sure that newly created objects appear in cache and are listed.

[matejnesuta]

There is a gherkin step before this assertion in every scenario, which selects a namespace and waits until loading finishes. Shouldn't this be sufficient enough?

[hhovsepy]

I think that step is not enough because it checks the load not the content update with newly created objects, which loading can take some time.

[matejnesuta]

I replaced the original code with my own mechanism using recursion. The cy.wait() interval can be tweaked further.

[ScriptingShrimp]

@matejnesuta does the tests eventually stop looping if there is error?