Signed-off-by: Jie Ma <jienius@outlook.com>
Jie Ma authored on 2020/06/27 08:30:59... | ... |
@@ -28,7 +28,7 @@ Most code changes will fall into one of the following categories. |
28 | 28 |
### Writing tests for new features |
29 | 29 |
|
30 | 30 |
New code should be covered by unit tests. If the code is difficult to test with |
31 |
-a unit tests then that is a good sign that it should be refactored to make it |
|
31 |
+unit tests, then that is a good sign that it should be refactored to make it |
|
32 | 32 |
easier to reuse and maintain. Consider accepting unexported interfaces instead |
33 | 33 |
of structs so that fakes can be provided for dependencies. |
34 | 34 |
|
... | ... |
@@ -44,12 +44,12 @@ case. Error cases should be handled by unit tests. |
44 | 44 |
|
45 | 45 |
Bugs fixes should include a unit test case which exercises the bug. |
46 | 46 |
|
47 |
-A bug fix may also include new assertions in an existing integration tests for the |
|
47 |
+A bug fix may also include new assertions in existing integration tests for the |
|
48 | 48 |
API endpoint. |
49 | 49 |
|
50 | 50 |
### Integration tests environment considerations |
51 | 51 |
|
52 |
-When adding new tests or modifying existing test under `integration/`, testing |
|
52 |
+When adding new tests or modifying existing tests under `integration/`, testing |
|
53 | 53 |
environment should be properly considered. `skip.If` from |
54 | 54 |
[gotest.tools/skip](https://godoc.org/gotest.tools/skip) can be used to make the |
55 | 55 |
test run conditionally. Full testing environment conditions can be found at |
... | ... |
@@ -104,9 +104,9 @@ TEST_SKIP_INTEGRATION and/or TEST_SKIP_INTEGRATION_CLI environment variables. |
104 | 104 |
Flags specific to each suite can be set in the TESTFLAGS_INTEGRATION and |
105 | 105 |
TESTFLAGS_INTEGRATION_CLI environment variables. |
106 | 106 |
|
107 |
-If all you want is to specity a test filter to run, you can set the |
|
107 |
+If all you want is to specify a test filter to run, you can set the |
|
108 | 108 |
`TEST_FILTER` environment variable. This ends up getting passed directly to `go |
109 |
-test -run` (or `go test -check-f`, dpenending on the test suite). It will also |
|
109 |
+test -run` (or `go test -check-f`, depending on the test suite). It will also |
|
110 | 110 |
automatically set the other above mentioned environment variables accordingly. |
111 | 111 |
|
112 | 112 |
### Go Version |
... | ... |
@@ -83,7 +83,7 @@ hour. To run the test suite, do the following: |
83 | 83 |
* cross-compiles all the binaries for the various operating systems |
84 | 84 |
* runs all the tests in the system |
85 | 85 |
|
86 |
- It can take approximate one hour to run all the tests. The time depends |
|
86 |
+ It can take approximately one hour to run all the tests. The time depends |
|
87 | 87 |
on your host performance. The default timeout is 60 minutes, which is |
88 | 88 |
defined in `hack/make.sh` (`${TIMEOUT:=60m}`). You can modify the timeout |
89 | 89 |
value on the basis of your host performance. When they complete |
... | ... |
@@ -208,7 +208,7 @@ run a Bash terminal on Windows. |
208 | 208 |
``` |
209 | 209 |
|
210 | 210 |
4. Set `DOCKER_TEST_HOST` to the `tcp://IP_ADDRESS:2376` value; substitute your |
211 |
- Linux machines actual IP address. For example: |
|
211 |
+ Linux machine's actual IP address. For example: |
|
212 | 212 |
|
213 | 213 |
```bash |
214 | 214 |
$ export DOCKER_TEST_HOST=tcp://213.124.23.200:2376 |