[Cloud Security][FTR]Refactor API FTR to use .to.eql instead of .to.be

[animehart]

Summary

This PR is for refactoring current API FTR to use .to.eql instead of .to.be for more understandable error message when an error occurs. Currently when test fail due to unmatched value, the error message can be quite confusing as we don't know which one is the expected and actual value from current error message.

With this change from this PR it's easier to see which is the expected value and which is the actual value

[elasticmachine]

Pinging @elastic/kibana-cloud-security-posture (Team:Cloud Security)

[kfirpeled]

Hi I added comments I'd like you to apply across all the assertions

Really useful refactoring! thanks ricky

[kfirpeled]

Suggested another refactoring and to add index name into the assertion message

[kfirpeled]

I suggest adding the checked index to the message

Suggested change

	expect(
	res.indicesDetails.find((idx) => idx.index === LATEST_VULNERABILITIES_INDEX_DEFAULT_NS)
	?.status
	).to.eql(
	'empty',
	`expected empty but got ${
	res.indicesDetails.find((idx) => idx.index === LATEST_VULNERABILITIES_INDEX_DEFAULT_NS)
	?.status
	} instead`
	);
	expect(
	res.indicesDetails.find((idx) => idx.index === LATEST_VULNERABILITIES_INDEX_DEFAULT_NS)
	?.status
	).to.eql(
	'empty',
	`expected ${LATEST_VULNERABILITIES_INDEX_DEFAULT_NS} empty but got ${
	res.indicesDetails.find((idx) => idx.index === LATEST_VULNERABILITIES_INDEX_DEFAULT_NS)
	?.status
	} instead`
	);

[kfirpeled]

And to clean up the code you can create the following assertion func:

const assertIndexStatus(indicesDetails, indexName, expectedStatus) => {
  const actualStatus = indicesDetails.find(idx => idx.name === indexName)?.status);
  expect(actualStatus).to.eql(expectedStatus, `expected ${indexName} to be ${expectedStatus} but got  ${actualStatus} instead`);
}

[kfirpeled]

And use it

assertIndexStatus(res.indicesDetails, LATEST_VULNERABILITIES_INDEX_DEFAULT_NS, 'empty');

[kfirpeled]

LGTM,
suggested a fix to assertIndexStatus message

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 147f6f6

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
enterpriseSearch	14	16	+2
securitySolution	410	414	+4
total			+6

Total ESLint disabled count

id	before	after	diff
enterpriseSearch	15	17	+2
securitySolution	489	493	+4
total			+6

History

• 💚 Build #139217 succeeded 6acff75
• 💚 Build #138910 succeeded 45567c4
• 💚 Build #138706 succeeded f87edb9

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream