Skip to content

Commit 1a11580

Browse files
authored
Merge pull request #210 from scottkurz/master
Doc typos, minor fixes
2 parents 65a8f2e + 50a5907 commit 1a11580

7 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/features/ApplicationEnvironment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The envionment is called "hollow" because everything _except_ your application w
5151
.withNetworkAliases("testmongo");
5252
```
5353

54-
With the default `TestcontainersConfiguration`, both the `app` and `mongo` containers would be started each time tests are run. With "hollow" mode, only the `mongo` container would be started each time the tests run, and instead of staring the `app` container the already-running application runtime will be used.
54+
With the default `TestcontainersConfiguration`, both the `app` and `mongo` containers would be started each time tests are run. With "hollow" mode, only the `mongo` container would be started each time the tests run, and instead of starting the `app` container the already-running application runtime will be used.
5555

5656
This environment is also provided by the `microshed-testing-testcontainers` module. To enable this environment, the following system properties or env vars must be set:
5757
* **microshed_hostname**: Indicates the hostname or IP address where the application is running. For example, `localhost` or `216.3.128.12`.

docs/features/Examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Sometimes code is worth a thousand words. Here are some pointers to working exam
1010

1111
- [Basic JAX-RS application using Gradle](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-json)
1212
- [Basic JAX-RS application using Maven](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/maven-app)
13-
- [Basic JAX-RS application using REST Assured](https://github.com/MicroShed/microshed-testing/blob/master/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredTest.java)
13+
- [Basic JAX-RS application using REST Assured](https://github.com/MicroShed/microshed-testing/blob/master/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java)
1414
- [JAX-RS and JDBC application using a PostgreSQL database](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jdbc-app)
1515
- [JAX-RS application secured with Basic Auth](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-basicauth)
1616
- [JAX-RS application secured with MP JWT](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-mpjwt)
@@ -23,4 +23,4 @@ Sometimes code is worth a thousand words. Here are some pointers to working exam
2323
- [Testing an application with OpenLiberty](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/liberty-app)
2424
- [Testing an application with Payara Micro](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/payara-app)
2525
- [Testing an application with Wildfly](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/wildfly-app)
26-
- [Testing an application with Quarkus](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/quarkus-app)
26+
- [Testing an application with Quarkus](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/quarkus-app)

docs/features/MP_JWT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public class SecuredService {
3434
}
3535
```
3636

37-
As the `@RolesAllowed` annotations imply, anyone can access the `GET /data/ping` endpoint, but only client authenticated in the `users` role can access the `GET /data/users` endpoint.
37+
As the `@RolesAllowed` annotations imply, anyone can access the `GET /data/ping` endpoint, but only clients authenticated in the `users` role can access the `GET /data/users` endpoint.
3838

3939
## Testing a MP JWT secured endpoint
4040

docs/features/RestAssured.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "REST Assured"
44
order: 14
55
---
66

7-
MicroShed Testing provides auto-configuration for when [REST Assured](https://github.com/rest-assured/rest-assured) is available on the test classpath. REST Assured is a Java DSL library for easy testing of REST services. It is more verbose than using a REST client, but offers more direct control over the request and response.f
7+
MicroShed Testing provides auto-configuration for when [REST Assured](https://github.com/rest-assured/rest-assured) is available on the test classpath. REST Assured is a Java DSL library for easy testing of REST services. It is more verbose than using a REST client, but offers more direct control over the request and response.
88

99
## Enable REST Assured
1010

@@ -90,7 +90,7 @@ It is also possible to send/receive POJOs with the JSON-B based ObjectMapper:
9090
}
9191
```
9292

93-
For a complete working example, see the [RestAssuredTest class](https://github.com/MicroShed/microshed-testing/blob/master/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredTest.java)
93+
For a complete working example, see the [RestAssuredTest class](https://github.com/MicroShed/microshed-testing/blob/master/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java)
9494

9595
## Auto-configuration override
9696

docs/features/SharedContainerConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The Testcontainers API has a built-in dependency mechanism which can be used to
7878
```
7979

8080
Since the `app` container `dependsOn` the `mongo` container, when MicroShed Testing starts the containers, the Testcontainers library will
81-
ensure that the `mongo` container starts sucessfully before the `app` container start is initiatied.
81+
ensure that the `mongo` container starts sucessfully before the `app` container start is initiated.
8282

8383
### Fully custom start process
8484

docs/features/Walkthrough.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ order: 00
66

77
Have you ever toiled with creating mock objects for unit tests? How about custom setup steps for integration tests? Ever had an issue in production because of differences in behavior between testing and production environments?
88

9-
One of the great benefits of Docker is that we get a nice consistent package that contains everything down to the OS, meaning its portable to any hardware. Great, so lets use this to get consistent testing environments too!
9+
One of the great benefits of Docker is that we get a nice consistent package that contains everything down to the OS, meaning it's portable to any hardware. Great, so let's use this to get consistent testing environments too!
1010

1111
# Starting application
1212

@@ -167,7 +167,7 @@ A few questions may come up at this point, such as:
167167
### Why port 33735?
168168

169169
Although port 33735 was not configured anywhere, MicroShed Testing still waited for this port to be available. This is because the application is running inside a container, and the ports inside containers can be mapped to different ports outside of the container. Testcontainers takes advantage of this
170-
feature of containers by automatically randomizing the ports so they do not conflict. In th is case, port `9080` inside of the container was randomly exposed as `33735`, which can be obtained by calling `app.getFirstExposedPort()` or `app.getMappedPort(9080)`.
170+
feature of containers by automatically randomizing the ports so they do not conflict. In this case, port `9080` inside of the container was randomly exposed as `33735`, which can be obtained by calling `app.getFirstExposedPort()` or `app.getMappedPort(9080)`.
171171

172172
### Why wasn't the URL accessible?
173173

@@ -181,7 +181,7 @@ However, our application does not respond at this endpoint, so we need to config
181181
.withReadinessPath("/myservice/people");
182182
```
183183

184-
Alternatively, if your application runtime supports MicroProfile Health 2.0, it will have a standard readiness endpoint at `/heath/ready`, which will return `HTTP 200` when the application is available.
184+
Alternatively, if your application runtime supports MicroProfile Health 2.0, it will have a standard readiness endpoint at `/health/ready`, which will return `HTTP 200` when the application is available.
185185

186186
## Writing your first test method
187187

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,5 +166,5 @@ public class MyTest {
166166
}
167167
```
168168
169-
For a more complete introduction, see the [Walkthrough page](Walkthrough).
169+
For a more complete introduction, see the [Walkthrough page](https://microshed.org/microshed-testing/features/Walkthrough.html)
170170

0 commit comments

Comments
 (0)