[testing] Cleaning up TemplateTests iOS simulator issues

[ivanpovazan]

Description

This PR tries to fix failures reported in: #21077

The issues seem to be caused by the following:

• we are querying xharness to find the device's UDID based on ios-simulator-64 in:
  

  maui/src/TestUtils/src/Microsoft.Maui.IntegrationTests/Apple/Simulator.cs

  Line 8 in 7639a2c

  public string XHarnessID { get; set; } = "ios-simulator-64";

• since we are only passing the device name: ios-simulator-64, xharness returns the first device that matches the pattern. However, there can be more device with the same name but different version which can lead to unwanted behaviour

Problem scenario

There are two devices:
- ios-simulator-64_17.0 (e.g., UDID: 491595A5-EBC3-4605-9069-7D2E57E826B0, State: Shutdown)
- ios-simulator-64_17.2 (eg., UDID: A3DB0329-7EE0-4C6C-A69A-2B6CF76F870E, State: Booted)

When querying for device's UDID based on ios-simulator-64 only, xharness will return: 491595A5-EBC3-4605-9069-7D2E57E826B0 which is a device already in 'Shutdown' state.

This can be a problem, as the sequence in the test SetUp code in TemplateTests:

maui/src/TestUtils/src/Microsoft.Maui.IntegrationTests/AppleTemplateTests.cs

Lines 16 to 18 in 7639a2c

	TestSimulator.Shutdown();
	Assert.IsTrue(TestSimulator.Launch(), $"Failed to boot simulator with UDID '{TestSimulator.GetUDID()}'.");
	TestSimulator.ShowWindow();

can further cause the simulator to be in a corrupted state:

   [ToolRunner] Running: xcrun simctl shutdown 491595A5-EBC3-4605-9069-7D2E57E826B0
   [ToolRunner] Process 'xcrun' exited with code: 149
   [ToolRunner] Running: xcrun simctl boot 491595A5-EBC3-4605-9069-7D2E57E826B0
   [ToolRunner] Process 'xcrun' exited with code: 0

Which finally makes the test execution fail:

error VSTEST1: Microsoft.Maui.IntegrationTests.AppleTemplateTests.AppleTemplateSetup()   Failed to boot simulator with UDID '491595A5-EBC3-4605-9069-7D2E57E826B0'

Solution

This PR tries to fix the problem by:

• utilizing the same logic for preparing and reseting iOS simulators prior to test run (like we do for device and UI tests) and
• explicitly querying the exact device name and version
  which should bring us always to a clean state, before executing TemplateTests

---

Contributes to:

• [testing] TestTemplates RuniOS fails a lot on iOS  #21077
• [Testing] Template tests xharness issues #20623