Improve coverage

dannykopping · dannykopping · commit 3d77c6396186 · 2024-08-15T14:52:22.000+02:00
Signed-off-by: Danny Kopping &lt;danny@coder.com&gt;
diff --git a/provisioner/terraform/testdata/timings-aggregation/faster-than-light.txtar b/provisioner/terraform/testdata/timings-aggregation/faster-than-light.txtar
@@ -0,0 +1,7 @@
+A provisioning which appears to complete before it started has its start and end times aligned.
+
+-- apply --
+{"@level":"info","@message":"coder_agent.main: Creating...","@module":"terraform.ui","@timestamp":"2024-08-15T10:26:39.616546+02:00","hook":{"resource":{"addr":"coder_agent.main","module":"","resource":"coder_agent.main","implied_provider":"coder","resource_type":"coder_agent","resource_name":"main","resource_key":null},"action":"create"},"type":"apply_start"}
+{"@level":"info","@message":"coder_agent.main: Creation complete after 0s [id=a23083da-4679-4396-a306-f7b466237883]","@module":"terraform.ui","@timestamp":"2024-08-15T10:21:39.618045+02:00","hook":{"resource":{"addr":"coder_agent.main","module":"","resource":"coder_agent.main","implied_provider":"coder","resource_type":"coder_agent","resource_name":"main","resource_key":null},"action":"create","id_key":"id","id_value":"a23083da-4679-4396-a306-f7b466237883","elapsed_seconds":0},"type":"apply_complete"}
+-- timings --
+{"start":"2024-08-15T08:21:39.618045Z","end":"2024-08-15T08:21:39.618045Z","action":"create","source":"coder","resource":"coder_agent.main","stage":"apply","state":"COMPLETED"}
diff --git a/provisioner/terraform/testdata/timings-aggregation/incomplete.txtar b/provisioner/terraform/testdata/timings-aggregation/incomplete.txtar
@@ -0,0 +1,7 @@
+An apply_start without a corresponding apply_complete will not produce a timing (and vice-versa).
+
+-- plan --
+{"@level":"info","@message":"data.coder_provisioner.me: Refreshing...","@module":"terraform.ui","@timestamp":"2024-08-15T10:26:39.194726+02:00","hook":{"resource":{"addr":"data.coder_provisioner.me","module":"","resource":"data.coder_provisioner.me","implied_provider":"coder","resource_type":"coder_provisioner","resource_name":"me","resource_key":null},"action":"read"},"type":"apply_start"}
+-- apply --
+{"@level":"info","@message":"coder_agent.main: Creation complete after 0s [id=a23083da-4679-4396-a306-f7b466237883]","@module":"terraform.ui","@timestamp":"2024-08-15T10:26:39.618045+02:00","hook":{"resource":{"addr":"coder_agent.main","module":"","resource":"coder_agent.main","implied_provider":"coder","resource_type":"coder_agent","resource_name":"main","resource_key":null},"action":"create","id_key":"id","id_value":"a23083da-4679-4396-a306-f7b466237883","elapsed_seconds":0},"type":"apply_complete"}
+-- timings --
diff --git a/provisioner/terraform/timings_internal_test.go b/provisioner/terraform/timings_internal_test.go
@@ -21,6 +21,10 @@ var (
 	inputError []byte
 	//go:embed testdata/timings-aggregation/complete.txtar
 	inputComplete []byte
+	//go:embed testdata/timings-aggregation/incomplete.txtar
+	inputIncomplete []byte
+	//go:embed testdata/timings-aggregation/faster-than-light.txtar
+	inputFasterThanLight []byte
 )
 
 func TestAggregation(t *testing.T) {
@@ -46,6 +50,14 @@ func TestAggregation(t *testing.T) {
 			name:  "complete",
 			input: inputComplete,
 		},
+		{
+			name:  "incomplete",
+			input: inputIncomplete,
+		},
+		{
+			name:  "faster-than-light",
+			input: inputFasterThanLight,
+		},
 	}
 
 	// nolint:paralleltest // Not since go v1.22.
@@ -64,8 +76,11 @@ func TestAggregation(t *testing.T) {
 			t.Logf("%s: %s", t.Name(), arc.Comment)
 
 			var actualTimings []*proto.Timing
+
+			// The last "file" MUST contain the expected timings.
 			expectedTimings := arc.Files[len(arc.Files)-1]
 
+			// Iterate over the initial "files" and extract their timings according to their stage.
 			for i := 0; i < len(arc.Files)-1; i++ {
 				file := arc.Files[i]
 				stage := database.ProvisionerJobTimingStage(file.Name)
@@ -77,6 +92,7 @@ func TestAggregation(t *testing.T) {
 				actualTimings = append(actualTimings, agg.aggregate()...)
 			}
 
+			// Ensure that the expected timings were produced.
 			expected := ParseTimingLines(t, expectedTimings.Data)
 			StableSortTimings(t, actualTimings) // To reduce flakiness.
 			if !assert.True(t, TimingsAreEqual(t, expected, actualTimings)) {
