Make TestTcp retry TCP initialization

[andy31415]

Problem

TestTCP is flaky, seemingly because of a "Address already in use" error. See https://github.com/project-chip/connectedhomeip/runs/5407037210?check_suite_focus=true or
https://github.com/project-chip/connectedhomeip/runs/5408995357?check_suite_focus=true

Change overview

Retry init a few times (5 seconds max) with a lengthy comment of what I think is happening and what a "followup fix" should contain.

Testing

Ran this 100s of times on a mac mini. Without the fix reproduced the crash, with the fix observed a 'retrying' message and test passed.

[github-actions]

PR #15824: Size comparison from 3b83461 to 7686f0c

Full report (31 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)

platform	target	config	section	3b83461	7686f0c	change	% change
cyw30739	light	cyw930739m2evb_01	(read/write)	600234	600234	0	0.0
			.app_xip_area	505256	505256	0	0.0
			.bss	77660	77660	0	0.0
			.data	660	660	0	0.0
			.rodata	0	0	0	0.0
			.text	0	0	0	0.0
	lock	cyw930739m2evb_01	(read/write)	558230	558230	0	0.0
			.app_xip_area	464788	464788	0	0.0
			.bss	76164	76164	0	0.0
			.data	624	624	0	0.0
			.rodata	0	0	0	0.0
			.text	0	0	0	0.0
	ota-requestor	cyw930739m2evb_01	(read/write)	578858	578858	0	0.0
			.app_xip_area	475720	475720	0	0.0
			.bss	85532	85532	0	0.0
			.data	568	568	0	0.0
			.rodata	0	0	0	0.0
			.text	112	112	0	0.0
efr32	lighting-app	BRD4161A	(read only)	918280	918280	0	0.0
			(read/write)	128816	128816	0	0.0
			.bss	126760	126760	0	0.0
			.data	2056	2056	0	0.0
			.text	918272	918272	0	0.0
		BRD4161A+rpc	(read only)	948364	948364	0	0.0
			(read/write)	145756	145756	0	0.0
			.bss	143536	143536	0	0.0
			.data	2220	2220	0	0.0
			.text	948356	948356	0	0.0
	lock-app	BRD4161A+wf200	(read only)	988084	988084	0	0.0
			(read/write)	120312	120312	0	0.0
			.bss	118380	118380	0	0.0
			.data	1932	1932	0	0.0
			.text	988076	988076	0	0.0
	window-app	BRD4161A	(read only)	853064	853064	0	0.0
			(read/write)	126784	126784	0	0.0
			.bss	124856	124856	0	0.0
			.data	1924	1924	0	0.0
			.text	853056	853056	0	0.0
esp32	all-clusters-app	c3devkit	(read only)	953072	953072	0	0.0
			(read/write)	1392562	1392562	0	0.0
			.dram0.bss	62536	62536	0	0.0
			.dram0.data	14236	14236	0	0.0
			.flash.rodata	196872	196872	0	0.0
			.flash.text	953072	953072	0	0.0
			.iram0.text	62016	62016	0	0.0
		m5stack	(read only)	1008339	1008339	0	0.0
			(read/write)	459684	459684	0	0.0
			.dram0.bss	68056	68056	0	0.0
			.dram0.data	34080	34080	0	0.0
			.flash.rodata	225712	225712	0	0.0
			.flash.text	1002955	1002955	0	0.0
			.iram0.text	123107	123107	0	0.0
k32w	light	k32w061+release	(read/write)	692556	692556	0	0.0
			.bss	77688	77688	0	0.0
			.data	1932	1932	0	0.0
			.text	607136	607136	0	0.0
	lock	k32w061+release	(read/write)	695708	695708	0	0.0
			.bss	77616	77616	0	0.0
			.data	1972	1972	0	0.0
			.text	610320	610320	0	0.0
linux	all-clusters-app	debug	(read only)	2402161	2402161	0	0.0
			(read/write)	144600	144600	0	0.0
			.bss	59104	59104	0	0.0
			.data	1392	1392	0	0.0
			.data.rel.ro	78392	78392	0	0.0
			.dynamic	592	592	0	0.0
			.got	4160	4160	0	0.0
			.init	27	27	0	0.0
			.init_array	912	912	0	0.0
			.rodata	204997	204997	0	0.0
			.text	2034418	2034418	0	0.0
	bridge-app	debug+rpc	(read only)	1728141	1728141	0	0.0
			(read/write)	92560	92560	0	0.0
			.bss	47400	47400	0	0.0
			.data	2048	2048	0	0.0
			.data.rel.ro	38040	38040	0	0.0
			.dynamic	592	592	0	0.0
			.got	3912	3912	0	0.0
			.init	27	27	0	0.0
			.init_array	544	544	0	0.0
			.rodata	141652	141652	0	0.0
			.text	1470709	1470709	0	0.0
	chip-tool	debug	(read only)	9398141	9398141	0	0.0
			(read/write)	305736	305736	0	0.0
			.bss	25440	25440	0	0.0
			.data	1136	1136	0	0.0
			.data.rel.ro	273152	273152	0	0.0
			.dynamic	608	608	0	0.0
			.got	4760	4760	0	0.0
			.init	27	27	0	0.0
			.init_array	608	608	0	0.0
			.rodata	497781	497781	0	0.0
			.text	8239317	8239317	0	0.0
	chip-tool-ipv6only	arm64	(read only)	9096660	9096660	0	0.0
			(read/write)	418497	418497	0	0.0
			.bss	43761	43761	0	0.0
			.data	1192	1192	0	0.0
			.data.rel.ro	317920	317920	0	0.0
			.dynamic	560	560	0	0.0
			.got	51848	51848	0	0.0
			.init	24	24	0	0.0
			.init_array	192	192	0	0.0
			.rodata	473580	473580	0	0.0
			.text	7705412	7705412	0	0.0
	door-lock-app	debug	(read only)	1942697	1942697	0	0.0
			(read/write)	119008	119008	0	0.0
			.bss	50400	50400	0	0.0
			.data	1056	1056	0	0.0
			.data.rel.ro	62168	62168	0	0.0
			.dynamic	592	592	0	0.0
			.got	4096	4096	0	0.0
			.init	27	27	0	0.0
			.init_array	664	664	0	0.0
			.rodata	173596	173596	0	0.0
			.text	1620642	1620642	0	0.0
	lighting-app	debug+rpc	(read only)	2078145	2078145	0	0.0
			(read/write)	124400	124400	0	0.0
			.bss	51328	51328	0	0.0
			.data	1472	1472	0	0.0
			.data.rel.ro	66136	66136	0	0.0
			.dynamic	608	608	0	0.0
			.got	4128	4128	0	0.0
			.init	27	27	0	0.0
			.init_array	712	712	0	0.0
			.rodata	165980	165980	0	0.0
			.text	1756738	1756738	0	0.0
	ota-provider-app	debug	(read only)	1875009	1875009	0	0.0
			(read/write)	114640	114640	0	0.0
			.bss	50208	50208	0	0.0
			.data	1352	1352	0	0.0
			.data.rel.ro	57448	57448	0	0.0
			.dynamic	608	608	0	0.0
			.got	4352	4352	0	0.0
			.init	27	27	0	0.0
			.init_array	616	616	0	0.0
			.rodata	158835	158835	0	0.0
			.text	1565634	1565634	0	0.0
	ota-requestor-app	debug	(read only)	1886217	1886217	0	0.0
			(read/write)	116952	116952	0	0.0
			.bss	51360	51360	0	0.0
			.data	1480	1480	0	0.0
			.data.rel.ro	58696	58696	0	0.0
			.dynamic	592	592	0	0.0
			.got	4152	4152	0	0.0
			.init	27	27	0	0.0
			.init_array	624	624	0	0.0
			.rodata	152356	152356	0	0.0
			.text	1585026	1585026	0	0.0
	shell	debug	(read only)	2371193	2371193	0	0.0
			(read/write)	146832	146832	0	0.0
			.bss	67176	67176	0	0.0
			.data	864	864	0	0.0
			.data.rel.ro	73128	73128	0	0.0
			.dynamic	592	592	0	0.0
			.got	4144	4144	0	0.0
			.init	27	27	0	0.0
			.init_array	896	896	0	0.0
			.rodata	204978	204978	0	0.0
			.text	2009682	2009682	0	0.0
	thermostat-no-ble	arm64	(read only)	2168772	2168772	0	0.0
			(read/write)	148385	148385	0	0.0
			.bss	65121	65121	0	0.0
			.data	1072	1072	0	0.0
			.data.rel.ro	75032	75032	0	0.0
			.dynamic	560	560	0	0.0
			.got	4208	4208	0	0.0
			.init	24	24	0	0.0
			.init_array	352	352	0	0.0
			.rodata	132900	132900	0	0.0
			.text	1817664	1817664	0	0.0
	tv-app	debug	(read only)	2609073	2609073	0	0.0
			(read/write)	250744	250744	0	0.0
			.bss	167904	167904	0	0.0
			.data	3200	3200	0	0.0
			.data.rel.ro	73608	73608	0	0.0
			.dynamic	592	592	0	0.0
			.got	4528	4528	0	0.0
			.init	27	27	0	0.0
			.init_array	880	880	0	0.0
			.rodata	199133	199133	0	0.0
			.text	2236034	2236034	0	0.0
mbed	lock-app	CY8CPROTO_062_4343W+release	(read only)	6224	6224	0	0.0
			(read/write)	2350708	2350708	0	0.0
			.bss	187036	187036	0	0.0
			.data	5784	5784	0	0.0
			.text	1313308	1313308	0	0.0
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	(read/write)	1076519	1076519	0	0.0
			bss	128876	128876	0	0.0
			rodata	141664	141664	0	0.0
			text	730784	730784	0	0.0
p6	all-clusters-app	default	(read/write)	2489552	2489552	0	0.0
			.bss	118608	118608	0	0.0
			.data	2696	2696	0	0.0
			.text	1447816	1447816	0	0.0
	light-app	default	(read/write)	2396688	2396688	0	0.0
			.bss	112920	112920	0	0.0
			.data	2544	2544	0	0.0
			.text	1354952	1354952	0	0.0
	lock-app	default	(read/write)	2360200	2360200	0	0.0
			.bss	112664	112664	0	0.0
			.data	2504	2504	0	0.0
			.text	1318464	1318464	0	0.0
qpg	lighting-app	qpg6105+debug	(read only)	601768	601768	0	0.0
			(read/write)	146936	146936	0	0.0
			.bss	91064	91064	0	0.0
			.data	1132	1132	0	0.0
			.text	596448	596448	0	0.0
	lock-app	qpg6105+debug	(read only)	567468	567468	0	0.0
			(read/write)	146936	146936	0	0.0
			.bss	91072	91072	0	0.0
			.data	1084	1084	0	0.0
			.text	562148	562148	0	0.0
	persistent-storage-app	qpg6105+debug	(read only)	99520	99520	0	0.0
			(read/write)	146940	146940	0	0.0
			.bss	24004	24004	0	0.0
			.data	176	176	0	0.0
			.text	94200	94200	0	0.0
telink	lighting-app	tlsr9518adk80d	(read/write)	883754	883754	0	0.0
			bss	86280	86280	0	0.0
			noinit	37160	37160	0	0.0
			text	625014	625014	0	0.0