Merge pull request #423 from hashicorp/aw/add-test-info

Add comment about the tst- prefix for future us.
hashicorp · Jun 9, 2022 · 44a6190 · 44a6190
2 parents 0280928 + 10d74ee
commit 44a6190
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/helper_test.go b/helper_test.go
@@ -414,6 +414,9 @@ func createOAuthToken(t *testing.T, client *Client, org *Organization) (*OAuthTo
 	return ocTest.OAuthTokens[0], ocTestCleanup
 }
 
+// createOrganization creates an organization for tests using the special prefix
+// "tst-" that the API uses especially to grant access to orgs for testing.
+// Don't change this prefix unless we refactor the code!
 func createOrganization(t *testing.T, client *Client) (*Organization, func()) {
 	return createOrganizationWithOptions(t, client, OrganizationCreateOptions{
 		Name:  String("tst-" + randomString(t)),