Tooling and CI set up + 1st four exercises

bin/run-test.sh

@@ -34,9 +34,19 @@ function run_test() {
         # "exercises/practice/.meta/hello_world_example.odin"
         example_file="${exercise_path}/${meta}/${exercise_safe_name}_example.odin"
 
-        # Copy the example and test files into the temporary directory
+        # Copy the example file into the temporary directory
         cp ${example_file} ${tmp_path}/${exercise_safe_name}.odin
-        cp ${test_file} ${tmp_path}
+
+        # Unskip all tests and write the processed test file to the temporary directory.
+        # The test file for the exercise often has several of the tests skippped initially, so that
+        # students can do test-driven development by enabling the next test, possibly see it fail,
+        # and then refining their solution. However, the test runner used by contributors and the CI
+        # pipeline always needs to run all tests.
+        #
+        # In Odin, a test can be skipped by commenting out the `@(test)` annotation preceding the
+        # test procedure. Here we unskip the test by searching for `\\ @(test)` lines and replacing
+        # them with `@test`.
+        sed s/"\/\/ @(test)"/"@(test)"/ ${test_file} > ${tmp_path}/${exercise_safe_name}_test.odin
 
         # Run the tests using the example file to verify that it is a valid solution.
         odin test ${tmp_path}

exercises/practice/difference-of-squares/difference_of_squares_test.odin

@@ -1,3 +1,8 @@
+/* These are the unit tests for the exercise. Only the first one is enabled to start with. You can
+ * enable the other tests by uncommenting the `@(test)` attribute of the test procedure. Your
+ * solution should pass all tests before it is ready for submission.
+ */
+
 package difference_of_squares
 
 import "core:testing"
@@ -7,42 +12,42 @@ test_square_of_sum_1 :: proc(t: ^testing.T) {
 	testing.expect_value(t, square_of_sum(1), 1)
 }
 
-@(test)
+// @(test)
 test_square_of_sum_5 :: proc(t: ^testing.T) {
 	testing.expect_value(t, square_of_sum(5), 225)
 }
 
-@(test)
+// @(test)
 test_square_of_sum_100 :: proc(t: ^testing.T) {
 	testing.expect_value(t, square_of_sum(100), 25_502_500)
 }
 
-@(test)
+// @(test)
 sum_of_squares_1_test :: proc(t: ^testing.T) {
 	testing.expect_value(t, sum_of_squares(1), 1)
 }
 
-@(test)
+// @(test)
 sum_of_squares_5_test :: proc(t: ^testing.T) {
 	testing.expect_value(t, sum_of_squares(5), 55)
 }
 
-@(test)
+// @(test)
 sum_of_squares_100_test :: proc(t: ^testing.T) {
 	testing.expect_value(t, sum_of_squares(100), 338_350)
 }
 
-@(test)
+// @(test)
 difference_of_squares_1_test :: proc(t: ^testing.T) {
 	testing.expect_value(t, difference(1), 0)
 }
 
-@(test)
+// @(test)
 difference_of_squares_5_test :: proc(t: ^testing.T) {
 	testing.expect_value(t, difference(5), 170)
 }
 
-@(test)
+// @(test)
 difference_of_squares_100_test :: proc(t: ^testing.T) {
 	testing.expect_value(t, difference(100), 25_164_150)
 }

exercises/practice/grains/grains_test.odin

@@ -1,3 +1,8 @@
+/* These are the unit tests for the exercise. Only the first one is enabled to start with. You can
+ * enable the other tests by uncommenting the `@(test)` attribute of the test procedure. Your
+ * solution should pass all tests before it is ready for submission.
+ */
+
 package grains
 
 import "core:testing"
@@ -11,7 +16,7 @@ test_returns_the_number_of_grains_on_the_square_grains_on_square_1 :: proc(
 	testing.expect_value(t, e, Error.None)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_grains_on_square_2 :: proc(
 	t: ^testing.T,
 ) {
@@ -20,7 +25,7 @@ test_returns_the_number_of_grains_on_the_square_grains_on_square_2 :: proc(
 	testing.expect_value(t, e, Error.None)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_grains_on_square_3 :: proc(
 	t: ^testing.T,
 ) {
@@ -29,7 +34,7 @@ test_returns_the_number_of_grains_on_the_square_grains_on_square_3 :: proc(
 	testing.expect_value(t, e, Error.None)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_grains_on_square_4 :: proc(
 	t: ^testing.T,
 ) {
@@ -38,7 +43,7 @@ test_returns_the_number_of_grains_on_the_square_grains_on_square_4 :: proc(
 	testing.expect_value(t, e, Error.None)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_grains_on_square_16 :: proc(
 	t: ^testing.T,
 ) {
@@ -47,7 +52,7 @@ test_returns_the_number_of_grains_on_the_square_grains_on_square_16 :: proc(
 	testing.expect_value(t, e, Error.None)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_grains_on_square_32 :: proc(
 	t: ^testing.T,
 ) {
@@ -56,7 +61,7 @@ test_returns_the_number_of_grains_on_the_square_grains_on_square_32 :: proc(
 	testing.expect_value(t, e, Error.None)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_grains_on_square_64 :: proc(
 	t: ^testing.T,
 ) {
@@ -65,7 +70,7 @@ test_returns_the_number_of_grains_on_the_square_grains_on_square_64 :: proc(
 	testing.expect_value(t, e, Error.None)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_square_0_raises_an_exception :: proc(
 	t: ^testing.T,
 ) {
@@ -74,7 +79,7 @@ test_returns_the_number_of_grains_on_the_square_square_0_raises_an_exception ::
 	testing.expect_value(t, e, Error.InvalidSquare)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_negative_square_raises_an_exception :: proc(
 	t: ^testing.T,
 ) {
@@ -83,7 +88,7 @@ test_returns_the_number_of_grains_on_the_square_negative_square_raises_an_except
 	testing.expect_value(t, e, Error.InvalidSquare)
 }
 
-@(test)
+// @(test)
 test_returns_the_number_of_grains_on_the_square_square_greater_than_64_raises_an_exception :: proc(
 	t: ^testing.T,
 ) {
@@ -92,7 +97,7 @@ test_returns_the_number_of_grains_on_the_square_square_greater_than_64_raises_an
 	testing.expect_value(t, e, Error.InvalidSquare)
 }
 
-@(test)
+// @(test)
 test_returns_the_total_number_of_grains_on_the_board :: proc(t: ^testing.T) {
 	c, e := total()
 	testing.expect_value(t, c, 18_446_744_073_709_551_615)

exercises/practice/leap/leap_test.odin

@@ -1,3 +1,8 @@
+/* These are the unit tests for the exercise. Only the first one is enabled to start with. You can
+ * enable the other tests by uncommenting the `@(test)` attribute of the test procedure. Your
+ * solution should pass all tests before it is ready for submission.
+ */
+
 package leap
 
 import "core:testing"
@@ -7,48 +12,48 @@ test_not_divisible_by_4_in_common_year :: proc(t: ^testing.T) {
 	testing.expect(t, !is_leap_year(2015))
 }
 
-@(test)
+// @(test)
 test_divisible_by_2_not_divisible_by_4_in_common_year :: proc(t: ^testing.T) {
 	testing.expect(t, !is_leap_year(1970))
 }
 
-@(test)
+// @(test)
 test_divisible_by_4_not_divisible_by_100_in_leap_year :: proc(t: ^testing.T) {
 	testing.expect(t, is_leap_year(1996))
 }
 
-@(test)
+// @(test)
 test_divisible_by_4_and_5_is_still_a_leap_year :: proc(t: ^testing.T) {
 	testing.expect(t, is_leap_year(1960))
 }
 
-@(test)
+// @(test)
 test_divisible_by_100_not_divisible_by_400_in_common_year :: proc(
 	t: ^testing.T,
 ) {
 	testing.expect(t, !is_leap_year(2100))
 }
 
-@(test)
+// @(test)
 test_divisible_by_100_but_not_by_3_is_still_not_a_leap_year :: proc(
 	t: ^testing.T,
 ) {
 	testing.expect(t, !is_leap_year(1900))
 }
 
-@(test)
+// @(test)
 test_divisible_by_400 :: proc(t: ^testing.T) {
 	testing.expect(t, is_leap_year(2000))
 }
 
-@(test)
+// @(test)
 test_divisible_by_400_but_not_by_125_is_still_a_leap_year :: proc(
 	t: ^testing.T,
 ) {
 	testing.expect(t, is_leap_year(2400))
 }
 
-@(test)
+// @(test)
 test_divisible_by_200_not_divisible_by_400_in_common_year :: proc(
 	t: ^testing.T,
 ) {

exercises/practice/resistor-color/resistor_color_test.odin

@@ -1,3 +1,9 @@
+/* These are the unit tests for the exercise. Only the tests for the `code()`
+ * procedure are enabled to start with. You can enable the final test by
+ * uncommenting the`@(test)` attribute of the `all_colors` test procedure. Your
+ * solution should pass all tests before it is ready for submission.
+ */
+
 package resistor_color
 
 import "core:testing"
@@ -52,7 +58,7 @@ white :: proc(t: ^testing.T) {
 	testing.expect_value(t, code(.White), 9)
 }
 
-@(test)
+// @(test)
 all_colors :: proc(t: ^testing.T) {
 	testing.expect_value(
 		t,