chore: apply some feedback from @lidel

ipfs · Sep 25, 2023 · 08f2f1e · 08f2f1e
1 parent 63df4e1
commit 08f2f1e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/tests/path_gateway_dag_test.go b/tests/path_gateway_dag_test.go
@@ -236,7 +236,7 @@ func TestPlainCodec(t *testing.T) {
 
 		tests := &SugarTests{}
 		tests.Append(
-			helpers.BaseWithRangeTestTransform(t,
+			helpers.IncludeRangeTests(t,
 				SugarTest{
 					Name: Fmt(`GET {{name}} without Accept or format= has expected "{{format}}" Content-Type and body as-is`, row.Name, row.Format),
 					Hint: `
@@ -255,7 +255,7 @@ func TestPlainCodec(t *testing.T) {
 				Fmt("application/{{format}}", row.Format),
 			)...).
 			Append(
-				helpers.BaseWithRangeTestTransform(t,
+				helpers.IncludeRangeTests(t,
 					SugarTest{
 						Name: Fmt("GET {{name}} with ?format= has expected {{format}} Content-Type and body as-is", row.Name, row.Format),
 						Hint: `
@@ -275,7 +275,7 @@ func TestPlainCodec(t *testing.T) {
 					Fmt("application/{{format}}", row.Format),
 				)...).
 			Append(
-				helpers.BaseWithRangeTestTransform(t,
+				helpers.IncludeRangeTests(t,
 					SugarTest{
 						Name: Fmt("GET {{name}} with Accept has expected {{format}} Content-Type and body as-is, with single range request", row.Name, row.Format),
 						Hint: `

diff --git a/tooling/helpers/range.go b/tooling/helpers/range.go
@@ -177,20 +177,20 @@ func MultiRangeTestTransform(t *testing.T, baseTest test.SugarTest, branges Byte
 	return rangeTest
 }
 
-// BaseWithRangeTestTransform takes a test where there is no "Range" header set in the request, or checks on the
+// IncludeRangeTests takes a test where there is no "Range" header set in the request, or checks on the
 // StatusCode, Body, or Content-Range headers and verifies whether a valid response is given for the requested ranges.
 // Will test the full request, a single range request for the first passed range as well as a multi-range request for
 // all the requested ranges.
 //
 // If contentType is empty it is ignored.
 //
 // If no ranges are passed then some non-overlapping ranges are automatically generated for data >= 10 bytes. Smaller
-// data will result in undefined behavior.
+// data will produce a panic to avoid undefined behavior.
 //
 // Note: HTTP Range requests can be validly responded with either the full data, or the requested partial data
 // Note: HTTP Multi Range requests can be validly responded with one of the full data, the partial data from the first
 // range, or the partial data from all the requested ranges
-func BaseWithRangeTestTransform(t *testing.T, baseTest test.SugarTest, branges ByteRanges, fullData []byte, contentType string) test.SugarTests {
+func IncludeRangeTests(t *testing.T, baseTest test.SugarTest, branges ByteRanges, fullData []byte, contentType string) test.SugarTests {
 	standardBaseRequest := baseTest.Request.Clone()
 	if contentType != "" {
 		standardBaseRequest = standardBaseRequest.Header("Content-Type", contentType)
@@ -218,7 +218,7 @@ func BaseWithRangeTestTransform(t *testing.T, baseTest test.SugarTest, branges B
 // If contentType is empty it is ignored.
 //
 // If no ranges are passed then some non-overlapping ranges are automatically generated for data >= 10 bytes. Smaller
-// data will result in undefined behavior.
+// data will produce a panic to avoid undefined behavior.
 //
 // Note: HTTP Range requests can be validly responded with either the full data, or the requested partial data
 // Note: HTTP Multi Range requests can be validly responded with one of the full data, the partial data from the first