sync: Add integration tests

[ErikSchierboom]

I'd prefer them to be integration tests, as in the tests should preferrably run the actual application

[ee7]

Let's say that this issue is closed by #176.

We currently have this test:

configlet/tests/test_binary.nim

Lines 35 to 280 in b3ee377

	proc testsForSync(binaryPath: string) =
	suite "sync":
	const psDir = ".test_binary_problem_specifications"
	const trackDir = ".test_binary_nim_track_repo"
	removeDir(psDir)
	removeDir(trackDir)
	# Setup: clone the problem-specifications repo
	block:
	execAndCheck(0):
	cloneExercismRepo("problem-specifications", psDir)
	# Setup: clone a track repo
	block:
	execAndCheck(0):
	cloneExercismRepo("nim", trackDir)
	# Setup: set the problem-specifications repo to a known state
	block:
	execAndCheck(0):
	execCmdEx(&"git -C {psDir} checkout ef9e1e17c84721ee6e9d5a65c8dd3ba2122eac91")
	# Setup: set the track repo to a known state
	block:
	execAndCheck(0):
	execCmdEx(&"git -C {trackDir} checkout 6e909c9e5338cd567c20224069df00e031fb2efa")
	test "`sync --check` exits with 1 and prints the expected output":
	execAndCheck(1):
	execCmdEx(&"{binaryPath} -t {trackDir} sync -co -p {psDir}")
	check outp == """
	Checking exercises...
	[warn] diffie-hellman: missing 1 test cases
	- can calculate public key when given a different private key (0d25f8d7-4897-4338-a033-2d3d7a9af688)
	[warn] grade-school: missing 1 test cases
	- A student can't be in two different grades (c125dab7-2a53-492f-a99a-56ad511940d8)
	[warn] hamming: missing 2 test cases
	- disallow left empty strand (db92e77e-7c72-499d-8fe6-9354d2bfd504)
	- disallow right empty strand (920cd6e3-18f4-4143-b6b8-74270bb8f8a3)
	[warn] high-scores: missing 2 test cases
	- Latest score after personal top scores (2df075f9-fec9-4756-8f40-98c52a11504f)
	- Scores after personal top scores (809c4058-7eb1-4206-b01e-79238b9b71bc)
	[warn] kindergarten-garden: missing 8 test cases
	- for Charlie (566b621b-f18e-4c5f-873e-be30544b838c)
	- for David (3ad3df57-dd98-46fc-9269-1877abf612aa)
	- for Eve (0f0a55d1-9710-46ed-a0eb-399ba8c72db2)
	- for Fred (a7e80c90-b140-4ea1-aee3-f4625365c9a4)
	- for Ginny (9d94b273-2933-471b-86e8-dba68694c615)
	- for Harriet (f55bc6c2-ade8-4844-87c4-87196f1b7258)
	- for Ileana (759070a3-1bb1-4dd4-be2c-7cce1d7679ae)
	- for Joseph (78578123-2755-4d4a-9c7d-e985b8dda1c6)
	[warn] prime-factors: missing 5 test cases
	- another prime number (238d57c8-4c12-42ef-af34-ae4929f94789)
	- product of first prime (756949d3-3158-4e3d-91f2-c4f9f043ee70)
	- product of second prime (7d6a3300-a4cb-4065-bd33-0ced1de6cb44)
	- product of third prime (073ac0b2-c915-4362-929d-fc45f7b9a9e4)
	- product of first and second prime (6e0e4912-7fb6-47f3-a9ad-dbcd79340c75)
	[warn] react: missing 14 test cases
	- input cells have a value (c51ee736-d001-4f30-88d1-0c8e8b43cd07)
	- an input cell's value can be set (dedf0fe0-da0c-4d5d-a582-ffaf5f4d0851)
	- compute cells calculate initial value (5854b975-f545-4f93-8968-cc324cde746e)
	- compute cells take inputs in the right order (25795a3d-b86c-4e91-abe7-1c340e71560c)
	- compute cells update value when dependencies are changed (c62689bf-7be5-41bb-b9f8-65178ef3e8ba)
	- compute cells can depend on other compute cells (5ff36b09-0a88-48d4-b7f8-69dcf3feea40)
	- compute cells fire callbacks (abe33eaf-68ad-42a5-b728-05519ca88d2d)
	- callback cells only fire on change (9e5cb3a4-78e5-4290-80f8-a78612c52db2)
	- callbacks do not report already reported values (ada17cb6-7332-448a-b934-e3d7495c13d3)
	- callbacks can fire from multiple cells (ac271900-ea5c-461c-9add-eeebcb8c03e5)
	- callbacks can be added and removed (95a82dcc-8280-4de3-a4cd-4f19a84e3d6f)
	- removing a callback multiple times doesn't interfere with other callbacks (f2a7b445-f783-4e0e-8393-469ab4915f2a)
	- callbacks should only be called once even if multiple dependencies change (daf6feca-09e0-4ce5-801d-770ddfe1c268)
	- callbacks should not be called if dependencies change but output value doesn't change (9a5b159f-b7aa-4729-807e-f1c38a46d377)
	[warn] some exercises are missing test cases
	"""
	test "`sync --mode=include` exits with 0 and includes the expected test cases":
	execAndCheck(0):
	execCmdEx(&"{binaryPath} -t {trackDir} sync -mi -o -p {psDir}")
	check outp == """
	Syncing exercises...
	[info] diffie-hellman: included 1 missing test cases
	[info] grade-school: included 1 missing test cases
	[info] hamming: included 2 missing test cases
	[info] high-scores: included 2 missing test cases
	[info] kindergarten-garden: included 8 missing test cases
	[info] prime-factors: included 5 missing test cases
	[info] react: included 14 missing test cases
	All exercises are synced!
	"""
	const expectedDiffOutput = """
	--- exercises/practice/diffie-hellman/.meta/tests.toml
	+++ exercises/practice/diffie-hellman/.meta/tests.toml
	+[0d25f8d7-4897-4338-a033-2d3d7a9af688]
	+description = "can calculate public key when given a different private key"
	+
	--- exercises/practice/grade-school/.meta/tests.toml
	+++ exercises/practice/grade-school/.meta/tests.toml
	+[c125dab7-2a53-492f-a99a-56ad511940d8]
	+description = "A student can't be in two different grades"
	+
	--- exercises/practice/hamming/.meta/tests.toml
	+++ exercises/practice/hamming/.meta/tests.toml
	+[db92e77e-7c72-499d-8fe6-9354d2bfd504]
	+description = "disallow left empty strand"
	+
	+
	+[920cd6e3-18f4-4143-b6b8-74270bb8f8a3]
	+description = "disallow right empty strand"
	--- exercises/practice/high-scores/.meta/tests.toml
	+++ exercises/practice/high-scores/.meta/tests.toml
	+
	+[2df075f9-fec9-4756-8f40-98c52a11504f]
	+description = "Latest score after personal top scores"
	+
	+[809c4058-7eb1-4206-b01e-79238b9b71bc]
	+description = "Scores after personal top scores"
	--- exercises/practice/kindergarten-garden/.meta/tests.toml
	+++ exercises/practice/kindergarten-garden/.meta/tests.toml
	-description = "first student's garden"
	+description = "for Alice, first student's garden"
	-description = "second student's garden"
	+description = "for Bob, second student's garden"
	+
	+[566b621b-f18e-4c5f-873e-be30544b838c]
	+description = "for Charlie"
	+
	+[3ad3df57-dd98-46fc-9269-1877abf612aa]
	+description = "for David"
	+
	+[0f0a55d1-9710-46ed-a0eb-399ba8c72db2]
	+description = "for Eve"
	+
	+[a7e80c90-b140-4ea1-aee3-f4625365c9a4]
	+description = "for Fred"
	+
	+[9d94b273-2933-471b-86e8-dba68694c615]
	+description = "for Ginny"
	+
	+[f55bc6c2-ade8-4844-87c4-87196f1b7258]
	+description = "for Harriet"
	+
	+[759070a3-1bb1-4dd4-be2c-7cce1d7679ae]
	+description = "for Ileana"
	+
	+[78578123-2755-4d4a-9c7d-e985b8dda1c6]
	+description = "for Joseph"
	-description = "second to last student's garden"
	+description = "for Kincaid, second to last student's garden"
	-description = "last student's garden"
	+description = "for Larry, last student's garden"
	--- exercises/practice/prime-factors/.meta/tests.toml
	+++ exercises/practice/prime-factors/.meta/tests.toml
	+[238d57c8-4c12-42ef-af34-ae4929f94789]
	+description = "another prime number"
	+
	+[756949d3-3158-4e3d-91f2-c4f9f043ee70]
	+description = "product of first prime"
	+
	+[7d6a3300-a4cb-4065-bd33-0ced1de6cb44]
	+description = "product of second prime"
	+
	+[073ac0b2-c915-4362-929d-fc45f7b9a9e4]
	+description = "product of third prime"
	+
	+[6e0e4912-7fb6-47f3-a9ad-dbcd79340c75]
	+description = "product of first and second prime"
	+
	--- exercises/practice/react/.meta/tests.toml
	+++ exercises/practice/react/.meta/tests.toml
	+
	+[c51ee736-d001-4f30-88d1-0c8e8b43cd07]
	+description = "input cells have a value"
	+
	+[dedf0fe0-da0c-4d5d-a582-ffaf5f4d0851]
	+description = "an input cell's value can be set"
	+
	+[5854b975-f545-4f93-8968-cc324cde746e]
	+description = "compute cells calculate initial value"
	+
	+[25795a3d-b86c-4e91-abe7-1c340e71560c]
	+description = "compute cells take inputs in the right order"
	+
	+[c62689bf-7be5-41bb-b9f8-65178ef3e8ba]
	+description = "compute cells update value when dependencies are changed"
	+
	+[5ff36b09-0a88-48d4-b7f8-69dcf3feea40]
	+description = "compute cells can depend on other compute cells"
	+
	+[abe33eaf-68ad-42a5-b728-05519ca88d2d]
	+description = "compute cells fire callbacks"
	+
	+[9e5cb3a4-78e5-4290-80f8-a78612c52db2]
	+description = "callback cells only fire on change"
	+
	+[ada17cb6-7332-448a-b934-e3d7495c13d3]
	+description = "callbacks do not report already reported values"
	+
	+[ac271900-ea5c-461c-9add-eeebcb8c03e5]
	+description = "callbacks can fire from multiple cells"
	+
	+[95a82dcc-8280-4de3-a4cd-4f19a84e3d6f]
	+description = "callbacks can be added and removed"
	+
	+[f2a7b445-f783-4e0e-8393-469ab4915f2a]
	+description = "removing a callback multiple times doesn't interfere with other callbacks"
	+
	+[daf6feca-09e0-4ce5-801d-770ddfe1c268]
	+description = "callbacks should only be called once even if multiple dependencies change"
	+
	+[9a5b159f-b7aa-4729-807e-f1c38a46d377]
	+description = "callbacks should not be called if dependencies change but output value doesn't change"
	"""
	const diffOpts = "--no-ext-diff --text --unified=0 --no-prefix --color=never"
	const diffCmd = &"""git --no-pager -C {trackDir} diff {diffOpts}"""
	test "`git diff` shows the expected diff":
	execAndCheck(0):
	execCmdEx(diffCmd)
	check outp.conciseDiff() == expectedDiffOutput
	test "after syncing, another `sync --mode=include` performs no changes":
	execAndCheck(0):
	execCmdEx(&"{binaryPath} -t {trackDir} sync -mi -o -p {psDir}")
	check outp == """
	Syncing exercises...
	All exercises are synced!
	"""
	test "after syncing, `sync --check` shows that exercises are up to date":
	execAndCheck(0):
	execCmdEx(&"{binaryPath} -t {trackDir} sync -c -o -p {psDir}")
	check outp == """
	Checking exercises...
	All exercises are up-to-date!
	"""
	test "the `git diff` output is still the same":
	execAndCheck(0):
	execCmdEx(diffCmd)
	check outp.conciseDiff() == expectedDiffOutput

Of course, we'll want to add more tests as sync is overhauled, but we can track that elsewhere.