Add test descriptions (#30)

* add descriptions to TestOutput
* add better description for TestRobinhoodExample
* bump golangci-lint version. remove golint

.github/workflows/go.yml

@@ -30,5 +30,5 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
-          version: v1.33.0 # elh: my current version
+          version: v1.53.3 # elh: my current version
           args: --timeout 5m

Makefile

@@ -20,9 +20,7 @@ test-check-output:
 	git diff --exit-code
 
 # lint
-# run golint because I like the exported comment warnings. It does not fail the run.
 lint:
-	golint ./...
 	golangci-lint run
 
 ######################################################### wasm #########################################################

dbtest/test.go

@@ -311,7 +311,7 @@ func TestGet(t *testing.T, oldValue, newValue Value, dbFn func(kvs []*VersionedK
 			t.Run(fmt.Sprintf("%v: %v", s.fixtures.name, tC.desc), func(t *testing.T) {
 				db, closeFn, err := dbFn(s.fixtures.vKVs())
 				defer closeFn()
-				defer WriteOutputHistory(t, db, []string{"A"}, t.Name())
+				defer WriteOutputHistory(t, db, []string{"A"}, t.Name(), "")
 				require.Nil(t, err)
 				ret, err := db.Get(tC.key, tC.readOpts...)
 				if tC.expectErrNotFound {
@@ -449,7 +449,7 @@ func TestList(t *testing.T, oldValue, newValue Value, dbFn func(kvs []*Versioned
 			t.Run(fmt.Sprintf("%v: %v", s.fixtures.name, tC.desc), func(t *testing.T) {
 				db, closeFn, err := dbFn(s.fixtures.vKVs())
 				defer closeFn()
-				defer WriteOutputHistory(t, db, []string{"A"}, t.Name())
+				defer WriteOutputHistory(t, db, []string{"A"}, t.Name(), "")
 				require.Nil(t, err)
 				ret, err := db.List(tC.readOpts...)
 				if tC.expectErr {
@@ -921,7 +921,7 @@ func TestSet(t *testing.T, dbFn func(kvs []*VersionedKV, clock Clock) (DB, error
 			t.Run(fmt.Sprintf("%v: %v", s.fixtures.name, tC.desc), func(t *testing.T) {
 				clock := &TestClock{}
 				db, err := dbFn(s.fixtures.vKVs(), clock)
-				defer WriteOutputHistory(t, db, []string{"A"}, t.Name())
+				defer WriteOutputHistory(t, db, []string{"A"}, t.Name(), "")
 				require.Nil(t, err)
 				if tC.now != nil {
 					require.Nil(t, clock.SetNow(*tC.now))
@@ -1261,7 +1261,7 @@ func TestDelete(t *testing.T, oldValue, newValue Value, dbFn func(kvs []*Version
 				clock := &TestClock{}
 				db, closeFn, err := dbFn(s.fixtures.vKVs(), clock)
 				defer closeFn()
-				defer WriteOutputHistory(t, db, []string{"A"}, t.Name())
+				defer WriteOutputHistory(t, db, []string{"A"}, t.Name(), "")
 				require.Nil(t, err)
 				if tC.now != nil {
 					require.Nil(t, clock.SetNow(*tC.now))
@@ -1617,7 +1617,7 @@ func TestHistory(t *testing.T, oldValue, newValue Value, dbFn func(kvs []*Versio
 			t.Run(fmt.Sprintf("%v: %v", s.fixtures.name, tC.desc), func(t *testing.T) {
 				db, closeFn, err := dbFn(s.fixtures.vKVs())
 				defer closeFn()
-				defer WriteOutputHistory(t, db, []string{"A"}, t.Name())
+				defer WriteOutputHistory(t, db, []string{"A"}, t.Name(), "")
 				require.Nil(t, err)
 				ret, err := db.History(tC.key)
 				if tC.expectErrNotFound {
@@ -1652,14 +1652,15 @@ func toJSON(v interface{}) string {
 
 // TestOutput is the format for saving test data for debugging and visualization.
 type TestOutput struct {
-	TestName  string
-	Passed    bool                      // true is test passed
-	Histories map[string][]*VersionedKV // key -> history
+	TestName    string
+	Passed      bool                      // true is test passed
+	Histories   map[string][]*VersionedKV // key -> history
+	Description string                    // optional description. Markdown is supported.
 }
 
 // WriteOutputHistory writes to a file the final "history" for specified keys at the end of a test. This is used for
 // debugging and visualization.
-func WriteOutputHistory(t *testing.T, db DB, keys []string, testName string) {
+func WriteOutputHistory(t *testing.T, db DB, keys []string, testName, description string) {
 	if !outputHistory {
 		return
 	}
@@ -1676,9 +1677,10 @@ func WriteOutputHistory(t *testing.T, db DB, keys []string, testName string) {
 		histories[key] = kvs
 	}
 	o := TestOutput{
-		TestName:  testName,
-		Passed:    !t.Failed(),
-		Histories: histories,
+		TestName:    testName,
+		Passed:      !t.Failed(),
+		Histories:   histories,
+		Description: description,
 	}
 	kvsJSON := toJSON(o)
 

memory/_testoutput/TestDelete_empty_db_delete_with_no_match_is_nop.json

@@ -3,5 +3,6 @@
   "Passed": true,
   "Histories": {
     "A": []
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestDelete_existing_entries_multiple_valid_time_ranges_active_set_overlaps_multiple_versions.json

@@ -44,5 +44,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestDelete_existing_entry_no_valid_end_basic_delete.json

@@ -20,5 +20,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestDelete_existing_entry_no_valid_end_error_if_end_valid_time_before_valid_time.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestDelete_existing_entry_no_valid_end_error_if_end_valid_time_before_valid_time_default_valid_time_.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestDelete_existing_entry_no_valid_end_error_if_end_valid_time_equal_to_valid_time.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestDelete_existing_entry_no_valid_end_set_w_valid_time_end_no_overhang.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestDelete_existing_entry_no_valid_end_set_w_valid_time_end_original_record_overhands_on_both_sides.json

@@ -28,5 +28,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_empty_db_not_found.json

@@ -3,5 +3,6 @@
   "Passed": true,
   "Histories": {
     "A": []
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_initial_set_and_then_deletion_with_later_valid_time_as_of_tx_time_before_update_as_of_valid_time_before_update.json

@@ -20,5 +20,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_initial_set_and_then_deletion_with_later_valid_time_as_of_tx_time_before_update_as_of_valid_time_now.json

@@ -20,5 +20,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_initial_set_and_then_deletion_with_later_valid_time_as_of_tx_time_now_as_of_valid_time_before_update.json

@@ -20,5 +20,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_initial_set_and_then_deletion_with_later_valid_time_not_found_default_as_of_times.json

@@ -20,5 +20,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_initial_set_and_then_set_with_later_valid_time_as_of_tx_time_before_update_as_of_valid_time_before_update.json

@@ -28,5 +28,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_initial_set_and_then_set_with_later_valid_time_as_of_tx_time_before_update_as_of_valid_time_now.json

@@ -28,5 +28,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_initial_set_and_then_set_with_later_valid_time_as_of_tx_time_now_as_of_valid_time_before_update.json

@@ -28,5 +28,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_initial_set_and_then_set_with_later_valid_time_found_default_as_of_times.json

@@ -28,5 +28,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_no_end_found_as_of_tx_time_T_in_range.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_no_end_found_as_of_tx_time_T_in_range_inclusive_.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_no_end_found_as_of_valid_time_T_in_range.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_no_end_found_as_of_valid_time_T_in_range_inclusive_.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_no_end_found_default_as_of_times.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_no_end_not_found_as_of_tx_time_T_before_tx_time_start.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_no_end_not_found_as_of_valid_time_T_before_valid_time_start.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_with_end_found_as_of_valid_and_tx_time_T_in_range.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": "2022-01-03T00:00:00Z"
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_with_end_not_found_as_of_valid_time_T_after_valid_time_end.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": "2022-01-03T00:00:00Z"
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_with_end_not_found_as_of_valid_time_T_equal_to_valid_time_end_exclusive_.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": "2022-01-03T00:00:00Z"
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestGet_single_set_with_end_not_found_default_as_of_times.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": "2022-01-03T00:00:00Z"
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestHistory_empty_db_not_found.json

@@ -3,5 +3,6 @@
   "Passed": true,
   "Histories": {
     "A": []
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestHistory_initial_set_and_then_deletion_with_later_valid_time_returns_deleted_versions.json

@@ -20,5 +20,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestHistory_initial_set_and_then_set_with_later_valid_time_return_versions_by_descending_end_transaction_time_descending_end_valid_time.json

@@ -28,5 +28,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestHistory_multiple_versions_have_nil_end_transaction_time_return_versions_by_descending_end_transaction_time_descending_end_valid_time.json

@@ -20,5 +20,6 @@
         "ValidTimeEnd": "2022-01-02T00:00:00Z"
       }
     ]
-  }
+  },
+  "Description": ""
 }

memory/_testoutput/TestHistory_single_set_no_end_basic_return_1_version.json

@@ -12,5 +12,6 @@
         "ValidTimeEnd": null
       }
     ]
-  }
+  },
+  "Description": ""
 }