chore(gcloud): deprecate old gcp containers, creating subpackages for them

docs/modules/gcloud-shared.md

@@ -0,0 +1,7 @@
+{% include "../features/common_functional_options.md" %}
+
+#### WithProjectID
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+The `WithProjectID` function sets the project ID for the Google Cloud container.

docs/modules/gcloud.md

@@ -16,99 +16,221 @@ go get github.com/testcontainers/testcontainers-go/modules/gcloud
 
 ## Usage example
 
+The Google Cloud module exposes the following Go packages:
+
+- [BigQuery](#bigquery): `github.com/testcontainers/testcontainers-go/modules/gcloud/bigquery`.
+- [BigTable](#bigtable): `github.com/testcontainers/testcontainers-go/modules/gcloud/bigtable`.
+- [Datastore](#datastore): `github.com/testcontainers/testcontainers-go/modules/gcloud/datastore`.
+- [Firestore](#firestore): `github.com/testcontainers/testcontainers-go/modules/gcloud/firestore`.
+- [Pubsub](#pubsub): `github.com/testcontainers/testcontainers-go/modules/gcloud/pubsub`.
+- [Spanner](#spanner): `github.com/testcontainers/testcontainers-go/modules/gcloud/spanner`.
 !!!info
     By default, the all the emulators use `gcr.io/google.com/cloudsdktool/cloud-sdk:367.0.0-emulators` as the default Docker image, except for the BigQuery emulator, which uses `ghcr.io/goccy/bigquery-emulator:0.6.1`, and Spanner, which uses `gcr.io/cloud-spanner-emulator/emulator:1.4.0`.
 
-### BigQuery
+## BigQuery
 
-<!--codeinclude-->
-[Creating a BigQuery container](../../modules/gcloud/bigquery_test.go) inside_block:runBigQueryContainer
-[Obtaining a BigQuery client](../../modules/gcloud/bigquery_test.go) inside_block:bigQueryClient
-<!--/codeinclude-->
+### Run function
 
-It's important to set the `option.WithEndpoint()` option using the container's URI, as shown in the client example above.
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+The BigQuery module exposes one entrypoint function to create the BigQuery container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)
+```
+
+- `context.Context`, the Go context.
+- `string`, the Docker image to use.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the BigQuery container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+Use the second argument in the `Run` function to set a valid Docker image.
+In example: `Run(context.Background(), "ghcr.io/goccy/bigquery-emulator:0.6.1")`.
+
+{% include "./gcloud-shared.md" %}
 
 #### Data YAML (Seed File)
 
-- Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.35.0"><span class="tc-version">:material-tag: v0.35.0</span></a>
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
 
 If you would like to do additional initialization in the BigQuery container, add a `data.yaml` file represented by an `io.Reader` to the container request with the `WithDataYAML` function.
 That file is copied after the container is created but before it's started. The startup command then used will look like `--project test --data-from-yaml /testcontainers-data.yaml`.
 
 An example of a `data.yaml` file that seeds the BigQuery instance with datasets and tables is shown below:
 
 <!--codeinclude-->
-[Data Yaml content](../../modules/gcloud/testdata/data.yaml)
+[Data Yaml content](../../modules/gcloud/bigquery/testdata/data.yaml)
 <!--/codeinclude-->
 
-!!!warning
-    This feature is only available for the `BigQuery` container, and if you pass multiple `WithDataYAML` options, an error is returned.
+### Examples
+
+<!--codeinclude-->
+[Creating a BigQuery container](../../modules/gcloud/bigquery/examples_test.go) inside_block:runBigQueryContainer
+[Obtaining a BigQuery client](../../modules/gcloud/bigquery/examples_test.go) inside_block:bigQueryClient
+<!--/codeinclude-->
+
+It's important to set the `option.WithEndpoint()` option using the container's URI, as shown in the client example above.
+
+## BigTable
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+The BigTable module exposes one entrypoint function to create the BigTable container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)
+```
+
+- `context.Context`, the Go context.
+- `string`, the Docker image to use.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the BigTable container, you can pass options in a variadic way to configure it.
+
+#### Image
 
-### BigTable
+Use the second argument in the `Run` function to set a valid Docker image.
+In example: `Run(context.Background(), "gcr.io/google.com/cloudsdktool/cloud-sdk:367.0.0-emulators")`.
+
+{% include "./gcloud-shared.md" %}
+
+### Examples
 
 <!--codeinclude-->
-[Creating a BigTable container](../../modules/gcloud/bigtable_test.go) inside_block:runBigTableContainer
-[Obtaining a BigTable Admin client](../../modules/gcloud/bigtable_test.go) inside_block:bigTableAdminClient
-[Obtaining a BigTable client](../../modules/gcloud/bigtable_test.go) inside_block:bigTableClient
+[Creating a BigTable container](../../modules/gcloud/bigtable/examples_test.go) inside_block:runBigTableContainer
+[Obtaining a BigTable Admin client](../../modules/gcloud/bigtable/examples_test.go) inside_block:bigTableAdminClient
+[Obtaining a BigTable client](../../modules/gcloud/bigtable/examples_test.go) inside_block:bigTableClient
 <!--/codeinclude-->
 
 It's important to set the `option.WithEndpoint()` option using the container's URI, as shown in the Admin client example above.
 
-### Datastore
+## Datastore
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+The Datastore module exposes one entrypoint function to create the Datastore container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)
+```
+
+- `context.Context`, the Go context.
+- `string`, the Docker image to use.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the Datastore container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+Use the second argument in the `Run` function to set a valid Docker image.
+In example: `Run(context.Background(), "gcr.io/google.com/cloudsdktool/cloud-sdk:367.0.0-emulators")`.
+
+{% include "./gcloud-shared.md" %}
+
+### Examples
 
 <!--codeinclude-->
-[Creating a Datastore container](../../modules/gcloud/datastore_test.go) inside_block:runDatastoreContainer
-[Obtaining a Datastore client](../../modules/gcloud/datastore_test.go) inside_block:datastoreClient
+[Creating a Datastore container](../../modules/gcloud/datastore/examples_test.go) inside_block:runDatastoreContainer
+[Obtaining a Datastore client](../../modules/gcloud/datastore/examples_test.go) inside_block:datastoreClient
 <!--/codeinclude-->
 
 It's important to set the `option.WithEndpoint()` option using the container's URI, as shown in the client example above.
 
-### Firestore
+## Firestore
 
-<!--codeinclude-->
-[Creating a Firestore container](../../modules/gcloud/firestore_test.go) inside_block:runFirestoreContainer
-[Obtaining a Firestore client](../../modules/gcloud/firestore_test.go) inside_block:firestoreClient
-<!--/codeinclude-->
+### Run function
 
-It's important to set the target string of the `grpc.NewClient` method using the container's URI, as shown in the client example above.
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+The Firestore module exposes one entrypoint function to create the Firestore container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)
+```
+
+- `context.Context`, the Go context.
+- `string`, the Docker image to use.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the Firestore container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+Use the second argument in the `Run` function to set a valid Docker image.
+In example: `Run(context.Background(), "gcr.io/google.com/cloudsdktool/cloud-sdk:367.0.0-emulators")`.
+
+{% include "./gcloud-shared.md" %}
 
-### Pubsub
+### Examples
 
 <!--codeinclude-->
-[Creating a Pubsub container](../../modules/gcloud/pubsub_test.go) inside_block:runPubsubContainer
-[Obtaining a Pubsub client](../../modules/gcloud/pubsub_test.go) inside_block:pubsubClient
+[Creating a Firestore container](../../modules/gcloud/firestore/examples_test.go) inside_block:runFirestoreContainer
+[Obtaining a Firestore client](../../modules/gcloud/firestore/examples_test.go) inside_block:firestoreClient
 <!--/codeinclude-->
 
 It's important to set the target string of the `grpc.NewClient` method using the container's URI, as shown in the client example above.
 
-### Spanner
+## Pubsub
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+The Pubsub module exposes one entrypoint function to create the Pubsub container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)
+```
+
+- `context.Context`, the Go context.
+- `string`, the Docker image to use.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the Pubsub container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+Use the second argument in the `Run` function to set a valid Docker image.
+In example: `Run(context.Background(), "gcr.io/google.com/cloudsdktool/cloud-sdk:367.0.0-emulators")`.
+
+{% include "./gcloud-shared.md" %}
+
+### Examples
 
 <!--codeinclude-->
-[Creating a Spanner container](../../modules/gcloud/spanner_test.go) inside_block:runSpannerContainer
-[Obtaining a Spanner Admin client](../../modules/gcloud/spanner_test.go) inside_block:spannerAdminClient
-[Obtaining a Spanner Database Admin client](../../modules/gcloud/spanner_test.go) inside_block:spannerDBAdminClient
+[Creating a Pubsub container](../../modules/gcloud/pubsub/examples_test.go) inside_block:runPubsubContainer
+[Obtaining a Pubsub client](../../modules/gcloud/pubsub/examples_test.go) inside_block:pubsubClient
 <!--/codeinclude-->
 
-It's important to set the `option.WithEndpoint()` option using the container's URI, as shown in the Admin client example above.
+It's important to set the target string of the `grpc.NewClient` method using the container's URI, as shown in the client example above.
 
-## Module Reference
+## Spanner
 
 ### Run function
 
-- Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.32.0"><span class="tc-version">:material-tag: v0.32.0</span></a>
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
 
-!!!info
-    The `RunXXXContainer(ctx, opts...)` functions are deprecated and will be removed in the next major release of _Testcontainers for Go_.
-
-The GCloud module exposes one entrypoint function to create the different GCloud emulators, and each function receives three parameters:
+The Spanner module exposes one entrypoint function to create the Spanner container, and this function receives three parameters:
 
 ```golang
-func RunBigQuery(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*BigQueryContainer, error)
-func RunBigTable(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*BigTableContainer, error)
-func RunDatastore(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DatastoreContainer, error)
-func RunFirestore(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*FirestoreContainer, error)
-func RunPubsub(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*PubsubContainer, error)
-func RunSpanner(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*SpannerContainer, error)
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)
 ```
 
 - `context.Context`, the Go context.
@@ -117,15 +239,21 @@ func RunSpanner(ctx context.Context, img string, opts ...testcontainers.Containe
 
 ### Container Options
 
-When starting any of the GCloud containers, you can pass options in a variadic way to configure it.
+When starting the Spanner container, you can pass options in a variadic way to configure it.
 
 #### Image
 
-Use the second argument in the `RunXXX` function (`RunBigQuery, RunDatastore`, ...) to set a valid Docker image.
-In example: `RunXXX(context.Background(), "gcr.io/google.com/cloudsdktool/cloud-sdk:367.0.0-emulators")`.
+Use the second argument in the `Run` function to set a valid Docker image.
+In example: `Run(context.Background(), "gcr.io/google.com/cloudsdktool/cloud-sdk:367.0.0-emulators")`.
+
+{% include "./gcloud-shared.md" %}
 
-{% include "../features/common_functional_options.md" %}
+### Examples
 
-### Container Methods
+<!--codeinclude-->
+[Creating a Spanner container](../../modules/gcloud/spanner/examples_test.go) inside_block:runSpannerContainer
+[Obtaining a Spanner Admin client](../../modules/gcloud/spanner/examples_test.go) inside_block:spannerAdminClient
+[Obtaining a Spanner Database Admin client](../../modules/gcloud/spanner/examples_test.go) inside_block:spannerDBAdminClient
+<!--/codeinclude-->
 
-The GCloud container exposes the following methods:
+It's important to set the `option.WithEndpoint()` option using the container's URI, as shown in the Admin client example above.

modules/gcloud/bigquery.go

@@ -8,14 +8,15 @@ import (
 	"github.com/testcontainers/testcontainers-go/wait"
 )
 
-// Deprecated: use RunBigQuery instead
+// Deprecated: use [RunBigQuery] instead
 // RunBigQueryContainer creates an instance of the GCloud container type for BigQuery.
 func RunBigQueryContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*GCloudContainer, error) {
 	return RunBigQuery(ctx, "ghcr.io/goccy/bigquery-emulator:0.6.1", opts...)
 }
 
+// Deprecated: use [bigquery.Run] instead.
 // RunBigQuery creates an instance of the GCloud container type for BigQuery.
-// The URI will always use http:// as the protocol.
+// The URI uses http:// as the protocol.
 func RunBigQuery(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*GCloudContainer, error) {
 	req := testcontainers.GenericContainerRequest{
 		ContainerRequest: testcontainers.ContainerRequest{