🌱 Refactor tests to plain go in util/collections

[mboersma]

What this PR does / why we need it:

Refactors the tests in util/collections/machine_collection_test.go to use plain Go testing instead of ginkgo. The other tests in this package were already there.

Which issue(s) this PR fixes:
Refs #4588

[enxebre]

/lgtm

[JoelSpeed]

The only nit I have on this would be that we are losing some of the context on the test names with this change, for example we lost the SortedByAge context on the first test which I think is important to keep. Could you double check and maybe adjust the test names as appropriate?

[mboersma]

we are losing some of the context on the test names with this change

Indeed, I'll try to preserve that logging context as well.

[mboersma]

Since Describe and friends aren't available to us without ginkgo, the test reporting context looks much different by default.

With ginkgo:

• Failure [0.000 seconds]
Machine Collection
/Users/matt/Projects/src/sigs.k8s.io/cluster-api/util/collections/machine_collection_test.go:36
  Machines
  /Users/matt/Projects/src/sigs.k8s.io/cluster-api/util/collections/machine_collection_test.go:37
    SortedByAge
    /Users/matt/Projects/src/sigs.k8s.io/cluster-api/util/collections/machine_collection_test.go:48
      should return the same number of machines as are in the collection [It]
      /Users/matt/Projects/src/sigs.k8s.io/cluster-api/util/collections/machine_collection_test.go:49

      Expected
          <int>: 1
      to equal
          <int>: 2

      /Users/matt/Projects/src/sigs.k8s.io/cluster-api/util/collections/machine_collection_test.go:53
------------------------------
••

Summarizing 1 Failure:

[Fail] Machine Collection Machines SortedByAge [It] should return the same number of machines as are in the collection 
/Users/matt/Projects/src/sigs.k8s.io/cluster-api/util/collections/machine_collection_test.go:53

Without ginkgo:

--- FAIL: TestMachineCollection (0.00s)
    --- FAIL: TestMachineCollection/should_return_the_same_number_of_machines_as_are_in_the_collection (0.00s)
        machine_collection_test.go:35: 
            Expected
                <int>: 1
            to equal
                <int>: 2
FAIL
FAIL	sigs.k8s.io/cluster-api/util/collections	0.476s

I could annotate the first argument to t.Run() to include this context:

    --- FAIL: TestMachineCollection/Machine_Collection/Machines/SortedByAge/should_return_the_same_number_of_machines_as_are_in_the_collection (0.00s)

or maybe just:

    --- FAIL: TestMachineCollection/SortedByAge/should_return_the_same_number_of_machines_as_are_in_the_collection (0.00s)

[mboersma]

BTW, I verified that go test ./util/collections -count 2 fails in master but succeeds on this branch. That supports our assumption in #4183.

[mboersma]

@JoelSpeed I nested the t.Run() statements so it looks and acts more like the ginkgo spec it replaces:

--- FAIL: TestMachineCollection (0.00s)
    --- FAIL: TestMachineCollection/SortedByAge (0.00s)
        --- FAIL: TestMachineCollection/SortedByAge/should_return_the_same_number_of_machines_as_are_in_the_collection (0.00s)
            machine_collection_test.go:36: 
                Expected
                    <int>: 1
                to equal
                    <int>: 2
FAIL
FAIL	sigs.k8s.io/cluster-api/util/collections	0.374s

[JoelSpeed]

That works for me, thanks!

/lgtm

[vincepri]

/approve
/lgtm

[vincepri]

/milestone v0.4

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [vincepri]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[vincepri]

Thank you @mboersma !