forked from StackExchange/StackExchange.Redis
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
48a0a99
commit 10e95fe
Showing
4 changed files
with
44 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
StackExchange.Redis | ||
=================== | ||
|
||
For all documentation, [see here](http://stackexchange.github.io/StackExchange.Redis/) | ||
For all documentation, [see here](https://stackexchange.github.io/StackExchange.Redis/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,3 @@ | ||
## Test Suite | ||
|
||
Welcome to the `StackExchange.Redis` test suite! | ||
|
||
Supported platforms: | ||
- Windows | ||
|
||
...that's it. For now. I'll add Docker files for the instances soon, unless someone's willing to get to it first. The tests (for `netcoreapp`) can run multi-platform | ||
|
||
The unit and integration tests here are fairly straightforward. There are 2 primary steps: | ||
1. Start the servers | ||
2. Run the tests | ||
|
||
Tests default to `127.0.0.1` as their server, however you can override any of the test IPs/Hostnames and ports by placing a `TestConfig.json` in the `StackExchange.Redis.Tests\` folder. This file is intentionally in `.gitignore` already, as it's for *your* personal overrides. This is useful for testing local or remote servers, different versions, various ports, etc. | ||
|
||
You can find all the JSON properties at [TestConfig.cs](#TODO Link). An example override (everything not specified being a default) would look like this: | ||
```json | ||
{ | ||
"RunLongRunning": true, | ||
"MasterServer": "192.168.0.42", | ||
"MasterPort": 12345 | ||
} | ||
``` | ||
<sub>Note: if a server isn't specified, the related tests should be skipped as inconclusive.</sub> | ||
|
||
### Instructions for Windows | ||
The tests are run (by default) as part of the build. You can simply run this in the repository root: | ||
```cmd | ||
.\build.cmd -BuildNumber local | ||
``` | ||
|
||
To specifically run the tests with far more options, from the repository root: | ||
```cmd | ||
dotnet build | ||
.\RedisConfigs\start-for-tests.cmd | ||
cd StackExchange.Redis.Tests | ||
dotnet xunit | ||
``` | ||
To test `StackExchange.Redis`, [see the documentation](https://stackexchange.github.io/StackExchange.Redis/Testing). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
Testing | ||
=== | ||
|
||
Welcome to documentation for the `StackExchange.Redis` test suite! | ||
|
||
Supported platforms: | ||
- Windows | ||
|
||
...that's it. For now. I'll add Docker files for the instances soon, unless someone's willing to get to it first. The tests (for `netcoreapp`) can run multi-platform. | ||
|
||
**Note: some tests are not yet green, about 20 are failing (~31 in CI)**. A large set of .NET Core, testing, and CI changes just slammed us, we're getting back in action. | ||
|
||
The unit and integration tests here are fairly straightforward. There are 2 primary steps: | ||
1. Start the servers | ||
2. Run the tests | ||
|
||
Tests default to `127.0.0.1` as their server, however you can override any of the test IPs/Hostnames and ports by placing a `TestConfig.json` in the `StackExchange.Redis.Tests\` folder. This file is intentionally in `.gitignore` already, as it's for *your* personal overrides. This is useful for testing local or remote servers, different versions, various ports, etc. | ||
|
||
You can find all the JSON properties at [TestConfig.cs](Helpers/TestConfig.cs). An example override (everything not specified being a default) would look like this: | ||
```json | ||
{ | ||
"RunLongRunning": true, | ||
"MasterServer": "192.168.0.42", | ||
"MasterPort": 12345 | ||
} | ||
``` | ||
<sub>Note: if a server isn't specified, the related tests should be skipped as inconclusive.</sub> | ||
|
||
### Instructions for Windows | ||
The tests are run (by default) as part of the build. You can simply run this in the repository root: | ||
```cmd | ||
.\build.cmd -BuildNumber local | ||
``` | ||
|
||
To specifically run the tests with far more options, from the repository root: | ||
```cmd | ||
dotnet build | ||
.\RedisConfigs\start-for-tests.cmd | ||
cd StackExchange.Redis.Tests | ||
dotnet xunit | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters