Fix typos (#9783)

NathanBaulch · eddumelendez · web-flow · commit 99981f84cbb9 · 2025-02-18T09:12:18.000-06:00
Co-authored-by: Eddú Meléndez Gonzales &lt;eddu.melendez@gmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -281,7 +281,7 @@
 ## [1.1.8] - 2017-01-22
 ### Fixed
 - Compatibility fixes for Docker for Mac v1.13.0 ([\#272](https://github.com/testcontainers/testcontainers-java/issues/272))
-- Relax docker environment disk space check to accomodate unusual empty `df` output observed on Docker for Mac with OverlayFS ([\#273](https://github.com/testcontainers/testcontainers-java/issues/273), [\#278](https://github.com/testcontainers/testcontainers-java/issues/278))
+- Relax docker environment disk space check to accommodate unusual empty `df` output observed on Docker for Mac with OverlayFS ([\#273](https://github.com/testcontainers/testcontainers-java/issues/273), [\#278](https://github.com/testcontainers/testcontainers-java/issues/278))
 - Fix inadvertent private-scoping of startup checks' `StartupStatus`, which made implementation of custom startup checks impossible ([\#266](https://github.com/testcontainers/testcontainers-java/issues/266))
 - Fix potential resource lead/deadlock when errors are encountered building images from a Dockerfile ([\#274](https://github.com/testcontainers/testcontainers-java/issues/274))
 
diff --git a/core/src/main/java/org/testcontainers/utility/ResourceReaper.java b/core/src/main/java/org/testcontainers/utility/ResourceReaper.java
@@ -368,7 +368,7 @@ static class FilterRegistry {
          * Registers the given filters with Ryuk
          *
          * @param filters the filter to register
-         * @return true if the filters have been registered successfuly, false otherwise
+         * @return true if the filters have been registered successfully, false otherwise
          * @throws IOException if communication with Ryuk fails
          */
         protected boolean register(List<Map.Entry<String, String>> filters) throws IOException {
diff --git a/core/src/test/java/org/testcontainers/junit/DependenciesTest.java b/core/src/test/java/org/testcontainers/junit/DependenciesTest.java
@@ -37,7 +37,7 @@ public void shouldWorkWithSimpleDependency() {
     }
 
     @Test
-    public void shouldWorkWithMutlipleDependencies() {
+    public void shouldWorkWithMultipleDependencies() {
         InvocationCountingStartable startable1 = new InvocationCountingStartable();
         InvocationCountingStartable startable2 = new InvocationCountingStartable();
 
diff --git a/core/src/test/java/org/testcontainers/utility/LazyFutureTest.java b/core/src/test/java/org/testcontainers/utility/LazyFutureTest.java
@@ -21,7 +21,7 @@
 public class LazyFutureTest {
 
     @Test
-    public void testLazyness() throws Exception {
+    public void testLaziness() throws Exception {
         AtomicInteger counter = new AtomicInteger();
 
         Future<Integer> lazyFuture = new LazyFuture<Integer>() {
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,6 +1,6 @@
 # Contributing
 
-* Star the project on [Github](https://github.com/testcontainers/testcontainers-java) and help spread the word :)
+* Star the project on [GitHub](https://github.com/testcontainers/testcontainers-java) and help spread the word :)
 * Join our [Slack workspace](http://slack.testcontainers.org)
 * [Start a discussion](https://github.com/testcontainers/testcontainers-java/discussions) if you have an idea, find a possible bug or have a general question.
 * Contribute improvements or fixes using a [Pull Request](https://github.com/testcontainers/testcontainers-java/pulls). If you're going to contribute, thank you! Please just be sure to:
@@ -97,7 +97,7 @@ We will evaluate incubating modules periodically, and remove the label when appr
 Since we generally get a lot of Dependabot PRs, we regularly combine them into single commits.
 For this, we are using the [gh-combine-prs](https://github.com/rnorth/gh-combine-prs) extension for [GitHub CLI](https://cli.github.com/).
 
-The whole process is as follow:
+The whole process is as follows:
 
 1. Check that all open Dependabot PRs did succeed their build. If they did not succeed, trigger a rerun if the cause were external factors or else document the reason if obvious.
 2. Run the extension from an up-to-date local `main` branch: `gh combine-prs --query "author:app/dependabot"`
diff --git a/docs/contributing_docs.md b/docs/contributing_docs.md
@@ -84,7 +84,7 @@ foo.doSomething();
 
 Note that:
 
-* Any code included will be have its indentation reduced
+* Any code included will have its indentation reduced
 * Every line in the source file will be searched for an instance of the token (e.g. `doFoo`). If more than one line
   includes that token, then potentially more than one block could be targeted for inclusion. It is advisable to use a
   specific, unique token to avoid unexpected behaviour.
diff --git a/docs/modules/azure.md b/docs/modules/azure.md
@@ -22,7 +22,7 @@ CosmosDBEmulatorContainer | [mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emula
 Start Azurite Emulator during a test:
 
 <!--codeinclude-->
-[Starting a Azurite container](../../modules/azure/src/test/java/org/testcontainers/azure/AzuriteContainerTest.java) inside_block:emulatorContainer
+[Starting an Azurite container](../../modules/azure/src/test/java/org/testcontainers/azure/AzuriteContainerTest.java) inside_block:emulatorContainer
 <!--/codeinclude-->
 
 !!! note
@@ -32,11 +32,11 @@ If the tested application needs to use more than one set of credentials, the con
 Please see some examples below.
 
 <!--codeinclude-->
-[Starting a Azurite Blob container with one account and two keys](../../modules/azure/src/test/java/org/testcontainers/azure/AzuriteContainerTest.java) inside_block:withTwoAccountKeys
+[Starting an Azurite Blob container with one account and two keys](../../modules/azure/src/test/java/org/testcontainers/azure/AzuriteContainerTest.java) inside_block:withTwoAccountKeys
 <!--/codeinclude-->
 
 <!--codeinclude-->
-[Starting a Azurite Blob container with more accounts and keys](../../modules/azure/src/test/java/org/testcontainers/azure/AzuriteContainerTest.java) inside_block:withMoreAccounts
+[Starting an Azurite Blob container with more accounts and keys](../../modules/azure/src/test/java/org/testcontainers/azure/AzuriteContainerTest.java) inside_block:withMoreAccounts
 <!--/codeinclude-->
 
 #### Using with Blob
@@ -140,7 +140,7 @@ Configure the sender and the processor clients:
 Start Azure CosmosDB Emulator during a test:
 
 <!--codeinclude-->
-[Starting a Azure CosmosDB Emulator container](../../modules/azure/src/test/java/org/testcontainers/containers/CosmosDBEmulatorContainerTest.java) inside_block:emulatorContainer
+[Starting an Azure CosmosDB Emulator container](../../modules/azure/src/test/java/org/testcontainers/containers/CosmosDBEmulatorContainerTest.java) inside_block:emulatorContainer
 <!--/codeinclude-->
 
 Prepare KeyStore to use for SSL.
diff --git a/docs/modules/databases/jdbc.md b/docs/modules/databases/jdbc.md
@@ -135,7 +135,7 @@ By default database container is being stopped as soon as last connection is clo
 
  `jdbc:tc:mysql:8.0.36:///databasename?TC_DAEMON=true`
 
-With this parameter database container will keep running even when there're no open connections.
+With this parameter database container will keep running even when there's no open connections.
 
 
 ### Running container with tmpfs options
diff --git a/docs/modules/kafka.md b/docs/modules/kafka.md
@@ -43,7 +43,7 @@ Now your tests or any other process running on your machine can get access to ru
 Create a `ConfluentKafkaContainer` to use it in your tests:
 
 <!--codeinclude-->
-[Creating a ConlfuentKafkaContainer](../../modules/kafka/src/test/java/org/testcontainers/kafka/ConfluentKafkaContainerTest.java) inside_block:constructorWithVersion
+[Creating a ConfluentKafkaContainer](../../modules/kafka/src/test/java/org/testcontainers/kafka/ConfluentKafkaContainerTest.java) inside_block:constructorWithVersion
 <!--/codeinclude-->
 
 ### Using org.testcontainers.kafka.KafkaContainer
diff --git a/docs/modules/typesense.md b/docs/modules/typesense.md
@@ -4,7 +4,7 @@ Testcontainers module for [Typesense](https://hub.docker.com/r/typesense/typesen
 
 ## TypesenseContainer's usage examples
 
-You can start an Typesense container instance from any Java application by using:
+You can start a Typesense container instance from any Java application by using:
 
 <!--codeinclude-->
 [Typesense container](../../modules/typesense/src/test/java/org/testcontainers/typesense/TypesenseContainerTest.java) inside_block:container
diff --git a/docs/test_framework_integration/junit_5.md b/docs/test_framework_integration/junit_5.md
@@ -62,7 +62,7 @@ Since this module has a dependency onto JUnit Jupiter and on Testcontainers core
 has a dependency onto JUnit 4.x, projects using this module will end up with both, JUnit Jupiter
 and JUnit 4.x in the test classpath.
 
-This extension has only be tested with sequential test execution. Using it with parallel test execution is unsupported and may have unintended side effects.
+This extension has only been tested with sequential test execution. Using it with parallel test execution is unsupported and may have unintended side effects.
 
 ## Adding Testcontainers JUnit 5 support to your project dependencies
 
diff --git a/modules/cassandra/src/test/resources/cassandra-auth-required-configuration/cassandra.yaml b/modules/cassandra/src/test/resources/cassandra-auth-required-configuration/cassandra.yaml
@@ -250,7 +250,7 @@ commit_failure_policy: stop
 #
 # Valid values are either "auto" (omitting the value) or a value greater 0.
 #
-# Note that specifying a too large value will result in long running GCs and possbily
+# Note that specifying a too large value will result in long running GCs and possibly
 # out-of-memory errors. Keep the value at a small fraction of the heap.
 #
 # If you constantly see "prepared statements discarded in the last minute because
@@ -259,7 +259,7 @@ commit_failure_policy: stop
 # i.e. use bind markers for variable parts.
 #
 # Do only change the default value, if you really have more prepared statements than
-# fit in the cache. In most cases it is not neccessary to change this value.
+# fit in the cache. In most cases it is not necessary to change this value.
 # Constantly re-preparing statements is a performance penalty.
 #
 # Default value ("auto") is 1/256th of the heap or 10MB, whichever is greater
@@ -309,7 +309,7 @@ key_cache_save_period: 14400
 #   Fully off-heap row cache implementation (default).
 #
 # org.apache.cassandra.cache.SerializingCacheProvider
-#   This is the row cache implementation availabile
+#   This is the row cache implementation available
 #   in previous releases of Cassandra.
 # row_cache_class_name: org.apache.cassandra.cache.OHCProvider
 
@@ -444,7 +444,7 @@ concurrent_counter_writes: 32
 concurrent_materialized_view_writes: 32
 
 # Maximum memory to use for sstable chunk cache and buffer pooling.
-# 32MB of this are reserved for pooling buffers, the rest is used as an
+# 32MB of this are reserved for pooling buffers, the rest is used as a
 # cache that holds uncompressed sstable chunks.
 # Defaults to the smaller of 1/4 of heap or 512MB. This pool is allocated off-heap,
 # so is in addition to the memory allocated for heap. The cache also has on-heap
@@ -553,7 +553,7 @@ memtable_allocation_type: heap_buffers
 # new space for cdc-tracked tables has been made available. Default to 250ms
 # cdc_free_space_check_interval_ms: 250
 
-# A fixed memory pool size in MB for for SSTable index summaries. If left
+# A fixed memory pool size in MB for SSTable index summaries. If left
 # empty, this will default to 5% of the heap size. If the memory usage of
 # all index summaries exceeds this limit, SSTables with low read rates will
 # shrink their index summaries in order to meet this limit.  However, this
@@ -778,7 +778,7 @@ auto_snapshot: true
 # number of rows per partition.  The competing goals are these:
 #
 # - a smaller granularity means more index entries are generated
-#   and looking up rows withing the partition by collation column
+#   and looking up rows within the partition by collation column
 #   is faster
 # - but, Cassandra will keep the collation index in memory for hot
 #   rows (as part of the key cache), so a larger granularity means
@@ -1109,7 +1109,7 @@ windows_timer_interval: 1
 
 # Enables encrypting data at-rest (on disk). Different key providers can be plugged in, but the default reads from
 # a JCE-style keystore. A single keystore can hold multiple keys, but the one referenced by
-# the "key_alias" is the only key that will be used for encrypt opertaions; previously used keys
+# the "key_alias" is the only key that will be used for encrypt operations; previously used keys
 # can still (and should!) be in the keystore and will be used on decrypt operations
 # (to handle the case of key rotation).
 #
@@ -1143,7 +1143,7 @@ transparent_data_encryption_options:
 # tombstones seen in memory so we can return them to the coordinator, which
 # will use them to make sure other replicas also know about the deleted rows.
 # With workloads that generate a lot of tombstones, this can cause performance
-# problems and even exaust the server heap.
+# problems and even exhaust the server heap.
 # (http://www.datastax.com/dev/blog/cassandra-anti-patterns-queues-and-queue-like-datasets)
 # Adjust the thresholds here if you understand the dangers and want to
 # scan more tombstones anyway.  These thresholds may also be adjusted at runtime
diff --git a/modules/cassandra/src/test/resources/cassandra-test-configuration-example/cassandra.yaml b/modules/cassandra/src/test/resources/cassandra-test-configuration-example/cassandra.yaml
@@ -250,7 +250,7 @@ commit_failure_policy: stop
 #
 # Valid values are either "auto" (omitting the value) or a value greater 0.
 #
-# Note that specifying a too large value will result in long running GCs and possbily
+# Note that specifying a too large value will result in long running GCs and possibly
 # out-of-memory errors. Keep the value at a small fraction of the heap.
 #
 # If you constantly see "prepared statements discarded in the last minute because
@@ -259,7 +259,7 @@ commit_failure_policy: stop
 # i.e. use bind markers for variable parts.
 #
 # Do only change the default value, if you really have more prepared statements than
-# fit in the cache. In most cases it is not neccessary to change this value.
+# fit in the cache. In most cases it is not necessary to change this value.
 # Constantly re-preparing statements is a performance penalty.
 #
 # Default value ("auto") is 1/256th of the heap or 10MB, whichever is greater
@@ -309,7 +309,7 @@ key_cache_save_period: 14400
 #   Fully off-heap row cache implementation (default).
 #
 # org.apache.cassandra.cache.SerializingCacheProvider
-#   This is the row cache implementation availabile
+#   This is the row cache implementation available
 #   in previous releases of Cassandra.
 # row_cache_class_name: org.apache.cassandra.cache.OHCProvider
 
@@ -444,7 +444,7 @@ concurrent_counter_writes: 32
 concurrent_materialized_view_writes: 32
 
 # Maximum memory to use for sstable chunk cache and buffer pooling.
-# 32MB of this are reserved for pooling buffers, the rest is used as an
+# 32MB of this are reserved for pooling buffers, the rest is used as a
 # cache that holds uncompressed sstable chunks.
 # Defaults to the smaller of 1/4 of heap or 512MB. This pool is allocated off-heap,
 # so is in addition to the memory allocated for heap. The cache also has on-heap
@@ -553,7 +553,7 @@ memtable_allocation_type: heap_buffers
 # new space for cdc-tracked tables has been made available. Default to 250ms
 # cdc_free_space_check_interval_ms: 250
 
-# A fixed memory pool size in MB for for SSTable index summaries. If left
+# A fixed memory pool size in MB for SSTable index summaries. If left
 # empty, this will default to 5% of the heap size. If the memory usage of
 # all index summaries exceeds this limit, SSTables with low read rates will
 # shrink their index summaries in order to meet this limit.  However, this
@@ -778,7 +778,7 @@ auto_snapshot: true
 # number of rows per partition.  The competing goals are these:
 #
 # - a smaller granularity means more index entries are generated
-#   and looking up rows withing the partition by collation column
+#   and looking up rows within the partition by collation column
 #   is faster
 # - but, Cassandra will keep the collation index in memory for hot
 #   rows (as part of the key cache), so a larger granularity means
@@ -1109,7 +1109,7 @@ windows_timer_interval: 1
 
 # Enables encrypting data at-rest (on disk). Different key providers can be plugged in, but the default reads from
 # a JCE-style keystore. A single keystore can hold multiple keys, but the one referenced by
-# the "key_alias" is the only key that will be used for encrypt opertaions; previously used keys
+# the "key_alias" is the only key that will be used for encrypt operations; previously used keys
 # can still (and should!) be in the keystore and will be used on decrypt operations
 # (to handle the case of key rotation).
 #
@@ -1143,7 +1143,7 @@ transparent_data_encryption_options:
 # tombstones seen in memory so we can return them to the coordinator, which
 # will use them to make sure other replicas also know about the deleted rows.
 # With workloads that generate a lot of tombstones, this can cause performance
-# problems and even exaust the server heap.
+# problems and even exhaust the server heap.
 # (http://www.datastax.com/dev/blog/cassandra-anti-patterns-queues-and-queue-like-datasets)
 # Adjust the thresholds here if you understand the dangers and want to
 # scan more tombstones anyway.  These thresholds may also be adjusted at runtime
diff --git a/modules/consul/src/main/java/org/testcontainers/consul/ConsulContainer.java b/modules/consul/src/main/java/org/testcontainers/consul/ConsulContainer.java
@@ -91,7 +91,7 @@ private void runConsulCommands() {
     /**
      * Run consul commands using the consul cli.
      *
-     * Useful for enableing more secret engines like:
+     * Useful for enabling more secret engines like:
      * <pre>
      *     .withConsulCommand("secrets enable pki")
      *     .withConsulCommand("secrets enable transit")
diff --git a/modules/cratedb/src/test/java/org/testcontainers/junit/cratedb/SimpleCrateDBTest.java b/modules/cratedb/src/test/java/org/testcontainers/junit/cratedb/SimpleCrateDBTest.java
@@ -40,7 +40,7 @@ public void testCommandOverride() throws SQLException {
 
             ResultSet resultSet = performQuery(cratedb, "select name from sys.cluster");
             String result = resultSet.getString(1);
-            assertThat(result).as("cluster name should be overriden").isEqualTo("testcontainers");
+            assertThat(result).as("cluster name should be overridden").isEqualTo("testcontainers");
         }
     }
 
diff --git a/modules/db2/src/main/java/org/testcontainers/containers/Db2Container.java b/modules/db2/src/main/java/org/testcontainers/containers/Db2Container.java
@@ -79,7 +79,7 @@ protected Set<Integer> getLivenessCheckPorts() {
 
     @Override
     protected void configure() {
-        // If license was not accepted programatically, check if it was accepted via resource file
+        // If license was not accepted programmatically, check if it was accepted via resource file
         if (!getEnvMap().containsKey("LICENSE")) {
             LicenseAcceptance.assertLicenseAccepted(this.getDockerImageName());
             acceptLicense();
diff --git a/modules/mariadb/src/test/java/org/testcontainers/junit/mariadb/SimpleMariaDBTest.java b/modules/mariadb/src/test/java/org/testcontainers/junit/mariadb/SimpleMariaDBTest.java
@@ -79,7 +79,7 @@ public void testMariaDBWithCommandOverride() throws SQLException {
             ResultSet resultSet = performQuery(mariadbCustomConfig, "show variables like 'auto_increment_increment'");
             String result = resultSet.getString("Value");
 
-            assertThat(result).as("Auto increment increment should be overriden by command line").isEqualTo("10");
+            assertThat(result).as("Auto increment increment should be overridden by command line").isEqualTo("10");
         }
     }
 
diff --git a/modules/mssqlserver/src/main/java/org/testcontainers/containers/MSSQLServerContainer.java b/modules/mssqlserver/src/main/java/org/testcontainers/containers/MSSQLServerContainer.java
@@ -72,7 +72,7 @@ public Set<Integer> getLivenessCheckPortNumbers() {
 
     @Override
     protected void configure() {
-        // If license was not accepted programatically, check if it was accepted via resource file
+        // If license was not accepted programmatically, check if it was accepted via resource file
         if (!getEnvMap().containsKey("ACCEPT_EULA")) {
             LicenseAcceptance.assertLicenseAccepted(this.getDockerImageName());
             acceptLicense();
diff --git a/modules/mysql/src/test/java/org/testcontainers/junit/mysql/SimpleMySQLTest.java b/modules/mysql/src/test/java/org/testcontainers/junit/mysql/SimpleMySQLTest.java
@@ -91,7 +91,7 @@ public void testCommandOverride() throws SQLException {
             ResultSet resultSet = performQuery(mysqlCustomConfig, "show variables like 'auto_increment_increment'");
             String result = resultSet.getString("Value");
 
-            assertThat(result).as("Auto increment increment should be overriden by command line").isEqualTo("42");
+            assertThat(result).as("Auto increment increment should be overridden by command line").isEqualTo("42");
         }
     }
 
diff --git a/modules/postgresql/src/test/java/org/testcontainers/containers/TimescaleDBContainerTest.java b/modules/postgresql/src/test/java/org/testcontainers/containers/TimescaleDBContainerTest.java
@@ -35,7 +35,7 @@ public void testCommandOverride() throws SQLException {
                 "SELECT current_setting('max_connections')"
             );
             String result = resultSet.getString(1);
-            assertThat(result).as("max_connections should be overriden").isEqualTo("42");
+            assertThat(result).as("max_connections should be overridden").isEqualTo("42");
         }
     }
 
@@ -54,7 +54,7 @@ public void testUnsetCommand() throws SQLException {
                 "SELECT current_setting('max_connections')"
             );
             String result = resultSet.getString(1);
-            assertThat(result).as("max_connections should not be overriden").isNotEqualTo("42");
+            assertThat(result).as("max_connections should not be overridden").isNotEqualTo("42");
         }
     }
 
diff --git a/modules/postgresql/src/test/java/org/testcontainers/junit/postgresql/SimplePostgreSQLTest.java b/modules/postgresql/src/test/java/org/testcontainers/junit/postgresql/SimplePostgreSQLTest.java
diff --git a/modules/redpanda/src/main/resources/testcontainers/bootstrap.yaml.ftl b/modules/redpanda/src/main/resources/testcontainers/bootstrap.yaml.ftl
diff --git a/modules/solace/src/main/java/org/testcontainers/solace/SolaceContainer.java b/modules/solace/src/main/java/org/testcontainers/solace/SolaceContainer.java
diff --git a/modules/vault/src/main/java/org/testcontainers/vault/VaultContainer.java b/modules/vault/src/main/java/org/testcontainers/vault/VaultContainer.java
diff --git a/modules/yugabytedb/src/main/java/org/testcontainers/containers/YugabyteDBYCQLContainer.java b/modules/yugabytedb/src/main/java/org/testcontainers/containers/YugabyteDBYCQLContainer.java
diff --git a/modules/yugabytedb/src/main/java/org/testcontainers/containers/YugabyteDBYSQLContainer.java b/modules/yugabytedb/src/main/java/org/testcontainers/containers/YugabyteDBYSQLContainer.java

Original file line number	Diff line number	Diff line change
`@@ -368,7 +368,7 @@ static class FilterRegistry {`
`368`	`368`	`* Registers the given filters with Ryuk`
`369`	`369`	`*`
`370`	`370`	`* @param filters the filter to register`
`371`		`- * @return true if the filters have been registered successfuly, false otherwise`
	`371`	`+ * @return true if the filters have been registered successfully, false otherwise`
`372`	`372`	`* @throws IOException if communication with Ryuk fails`
`373`	`373`	`*/`
`374`	`374`	`protected boolean register(List<Map.Entry<String, String>> filters) throws IOException {`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public void shouldWorkWithSimpleDependency() {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`@Test`
`40`		`- public void shouldWorkWithMutlipleDependencies() {`
	`40`	`+ public void shouldWorkWithMultipleDependencies() {`
`41`	`41`	`InvocationCountingStartable startable1 = new InvocationCountingStartable();`
`42`	`42`	`InvocationCountingStartable startable2 = new InvocationCountingStartable();`
`43`	`43`