Skip to content

Commit cae5198

Browse files
author
Sam Harrison
committed
docs: update the Docker test integration docs
A top-level Dockerfile is now present which can be used to test this repo with prism.
1 parent 8285451 commit cae5198

File tree

4 files changed

+15
-120
lines changed

4 files changed

+15
-120
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Before you decide to create a new issue, please try the following:
4242

4343
### Please use our Bug Report Template
4444

45-
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/sendgrid-csharp/.github/ISSUE_TEMPLATE) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
45+
In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).
4646

4747
<a name="improvements-to-the-codebase"></a>
4848
## Improvements to the Codebase
@@ -58,7 +58,7 @@ Please note that we utilize the [Gitflow Workflow](https://www.atlassian.com/git
5858
##### Prerequisites #####
5959

6060
- .NET 4.5.2+
61-
- [Visual Studio Community 2017](https://www.visualstudio.com/downloads/)+
61+
- [Visual Studio Community 2017](https://www.visualstudio.com/downloads/)
6262

6363
##### Initial setup: #####
6464

@@ -83,36 +83,25 @@ Next, update your Environment with your [SENDGRID_APIKEY](https://app.sendgrid.c
8383
<a name="understanding-the-codebase"></a>
8484
## Understanding the Code Base
8585

86-
**[/examples](https://github.com/sendgrid/sendgrid-csharp/blob/master/examples)**
87-
88-
Examples that demonstrate usage.
89-
90-
**[/ExampleCoreProject/Example.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/ExampleCoreProject/Example.cs)**
91-
92-
A working .NET Core example project for testing.
93-
94-
**[/ExampleNet45Project/Example.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/ExampleNet45Project/Example.cs)**
95-
96-
A working .NET 4.5.2 example project for testing.
97-
98-
**[/src/SendGrid/SendGridClient.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/SendGridClient.cs)**
99-
100-
The main interface to the Twilio SendGrid API is the class `SendGridClient`.
101-
102-
**[/tests/SendGrid.Tests/Integration.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs)**
103-
104-
Integration tests
86+
- **[/examples](https://github.com/sendgrid/sendgrid-csharp/blob/master/examples)**
87+
- Examples that demonstrate usage.
88+
- **[/ExampleCoreProject/Example.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/ExampleCoreProject/Example.cs)**
89+
- A working .NET Core example project for testing.
90+
- **[/ExampleNet45Project/Example.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/ExampleNet45Project/Example.cs)**
91+
- A working .NET 4.5.2 example project for testing.
92+
- **[/src/SendGrid/SendGridClient.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/SendGridClient.cs)**
93+
- The main interface to the Twilio SendGrid API is the class `SendGridClient`.
94+
- **[/tests/SendGrid.Tests/Integration.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs)**
95+
- Integration tests
10596

10697
<a name="testing"></a>
10798
## Testing
10899

109-
All PRs require passing tests before the PR will be reviewed.
110-
111-
All test files are in the [`SendGrid.Tests`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests) directory.
100+
All PRs require passing tests before the PR will be reviewed. All test files are in the [`SendGrid.Tests`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests) directory. For the purposes of contributing to this repo, please update the [`Integration.cs`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs) file with unit tests as you modify the code.
112101

113-
For the purposes of contributing to this repo, please update the [`Integration.cs`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs) file with unit tests as you modify the code.
102+
The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`.
114103

115-
The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`. Once these are available, simply run the Docker test target to run all tests: `make test-docker`
104+
Once these are available, simply execute the Docker test target to run all tests: `make test-docker`. This command can also be used to open an interactive shell into the container where this library is installed. To start a *bash* shell for example, use this command: `command=bash make test-docker`.
116105

117106
<a name="style-guidelines-and-naming-conventions"></a>
118107
## Style Guidelines & Naming Conventions

docker/Dockerfile

Lines changed: 0 additions & 34 deletions
This file was deleted.

docker/README.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docker/entrypoint.sh

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)