You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-6Lines changed: 27 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,11 @@ defp deps do
19
19
end
20
20
```
21
21
22
-
Then, run `$ mix deps.get`.
22
+
Then, run:
23
+
24
+
```sh
25
+
mix deps.get
26
+
```
23
27
24
28
## Usage
25
29
@@ -106,13 +110,30 @@ Mint is a low-level client. If you need higher-level features such as connection
106
110
107
111
If you wish to contribute, check out the [issue list][issues] and let us know what you want to work on, so that we can discuss it and reduce duplicate work.
108
112
109
-
Tests are organized with tags. Integration tests that hit real websites over the internet are tagged with `:requires_internet_connection`. Proxy tests are tagged with `:proxy` and require that you run `DOCKER_USER="$UID:$GID" docker-compose up` from the Mint root directory in order to run (they are excluded by default when you run `$ mix test`). A few examples of running tests:
113
+
Tests are organized with tags. Integration tests that hit real websites over the internet are tagged with `:requires_internet_connection`. Proxy tests are tagged with `:proxy` (excluded by default) and require that you start local proxy instance through Docker Compose (or Podman Compose) from the Mint root directory in order to run.
114
+
115
+
If you encounter `{:error, %Mint.TransportError{reason: :nxdomain}}` error during the integration test, this suggests your DNS-based adblocker (self-hosted or VPN) might be blocking social media sites used in the integration test cases.
116
+
117
+
Here are a few examples of running tests:
118
+
119
+
Run all default tests which including `:requires_internet_connection` except `:proxy`:
110
120
111
-
*`$ mix test` to run the test suite without caring about Docker and `docker-compose up`.
121
+
```sh
122
+
mix test
123
+
```
124
+
125
+
Local tests, if you don't have an Internet connection available:
112
126
113
-
*`$ mix test --exclude integration` to only run local tests (for example, you don't have an internet connection available).
127
+
```sh
128
+
mix test --exclude requires_internet_connection
129
+
```
114
130
115
-
*`$ mix test --include proxy` to run all tests, including proxy tests.
131
+
Run all tests:
132
+
133
+
```sh
134
+
DOCKER_USER="$UID:$GID" docker-compose up --detach # or podman-compose up --detach
135
+
mix test --include proxy
136
+
```
116
137
117
138
## License
118
139
@@ -122,7 +143,7 @@ Copyright 2018 Eric Meadows-Jönsson and Andrea Leopardi
122
143
you may not use this file except in compliance with the License.
123
144
You may obtain a copy of the License at
124
145
125
-
http://www.apache.org/licenses/LICENSE-2.0
146
+
https://www.apache.org/licenses/LICENSE-2.0
126
147
127
148
Unless required by applicable law or agreed to in writing, software
128
149
distributed under the License is distributed on an "AS IS" BASIS,
0 commit comments