Migrate catch2 v2 to v3

[AndreRicardo-Zoetis]

Hello, would you consider upgrading Catch to version 3?

We would like to use newer functionality in Catch2 such as SKIP.
https://catch2-temp.readthedocs.io/en/latest/skipping-passing-failing.html

Also noticed that in Catch2 version 3 there is no need to define all those empty main.cpp.

Changes

Followed the guidelines from:
https://catch2-temp.readthedocs.io/en/latest/migrate-v2-to-v3.html

1. Change Catch2 to Catch2WithMain where main.cpp was used

2. [!hide] tag has been removed
   https://github.com/catchorg/Catch2/blob/914aeecfe23b1e16af6ea675a4fb5dbd5a5b8d0a/docs/release-notes.md?plain=1#L505

3. "The Contains string matcher was renamed to ContainsSubstring."
   https://github.com/catchorg/Catch2/blob/devel/docs/migrate-v2-to-v3.md#things-that-can-break-during-porting

I can tidy up the PR further and remove all the no longer needed main.cpp files, but before doing so would like to have your guidance.

PS: I do have other changes to be able to run the tests as GitHub Action but was able to run the tests successfully in
https://github.com/AndreRicardo-Zoetis/iot-hub-device-update/actions/runs/12689720900/job/35369056358

[AndreRicardo-Zoetis]

@microsoft-github-policy-service agree company="Zoetis"

[jw-msft]

@AndreRicardo-Zoetis Yes. That's something on the backlog for too long, so thank you for doing this. It would be nice of you to remove the rest of the main.cpp in the tests (except where there are multiple CU).

I built and ran the tests from your fork's branch and they all pass on my end (after running ./scripts/install-deps.sh --install-catch2) and it looks good so far.

For github actions changes, could you open a discussion and at-mention me on it? Then, after discussion we can possibly move towards a PR (let us not include it in this PR).

[jw-msft]

looking good so far.

[AndreRicardo-Zoetis]

@jw-msft could you please re-review? I'm not pointing at the latest develop branch commit as I'm having an error building mentioned in #685 (comment)

Once that is solved, I can rebase my branch to the latest develop commit.

[AndreRicardo-Zoetis]

Tested in

https://github.com/AndreRicardo-Zoetis/iot-hub-device-update/actions/runs/12870328126/job/35881103267#step:4:2634