test: Add description to e2e tests

Author: astefanutti

test/e2e/mnist_pytorch_mcad_job_test.go

@@ -30,6 +30,7 @@ import (
 	mcadv1beta1 "github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/apis/controller/v1beta1"
 )
 
+// Trains the MNIST dataset as a batch Job managed by MCAD, and asserts successful completion of the training job.
 func TestMNISTPyTorchMCAD(t *testing.T) {
 	test := With(t)
 	test.T().Parallel()

test/e2e/mnist_raycluster_sdk_test.go

@@ -32,6 +32,12 @@ import (
 	mcadv1beta1 "github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/apis/controller/v1beta1"
 )
 
+// Creates a Ray cluster, and trains the MNIST dataset using the CodeFlare SDK.
+// Asserts successful completion of the training job.
+//
+// This covers the installation of the CodeFlare SDK, as well as the RBAC required
+// for the SDK to successfully perform requests to the cluster, on behalf of the
+// impersonated user.
 func TestMNISTRayClusterSDK(t *testing.T) {
 	test := With(t)
 	test.T().Parallel()

test/e2e/mnist_rayjob_mcad_raycluster_test.go

@@ -31,6 +31,8 @@ import (
 	rayv1alpha1 "github.com/ray-project/kuberay/ray-operator/apis/ray/v1alpha1"
 )
 
+// Trains the MNIST dataset as a RayJob, executed by a Ray cluster managed by MCAD,
+// and asserts successful completion of the training job.
 func TestMNISTRayJobMCADRayCluster(t *testing.T) {
 	test := With(t)
 	test.T().Parallel()