chore(build): Add examples of how to run test cases in README
This commit is contained in:
parent
d60212787b
commit
8bb5dc5e66
5
Makefile
5
Makefile
|
@ -22,6 +22,11 @@ ensure-rebar3:
|
||||||
|
|
||||||
$(REBAR): ensure-rebar3
|
$(REBAR): ensure-rebar3
|
||||||
|
|
||||||
|
.PHONY: eunit
|
||||||
|
eunit: $(REBAR)
|
||||||
|
$(REBAR) eunit
|
||||||
|
|
||||||
|
.PHONY: ct
|
||||||
ct: $(REBAR)
|
ct: $(REBAR)
|
||||||
$(REBAR) ct
|
$(REBAR) ct
|
||||||
|
|
||||||
|
|
25
README.md
25
README.md
|
@ -55,12 +55,15 @@ For earlier versions, release has to be built from another repo.
|
||||||
git clone https://github.com/emqx/emqx-rel.git
|
git clone https://github.com/emqx/emqx-rel.git
|
||||||
cd emqx-rel
|
cd emqx-rel
|
||||||
make
|
make
|
||||||
_build/emqx/rel/emqx/bin console
|
_build/emqx/rel/emqx/bin/emqx console
|
||||||
```
|
```
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
```
|
If emqx is built from source, `cd _buid/emqx/rel/emqx`.
|
||||||
|
Or change to the installation root directory if emqx is installed from a release package.
|
||||||
|
|
||||||
|
```bash
|
||||||
# Start emqx
|
# Start emqx
|
||||||
./bin/emqx start
|
./bin/emqx start
|
||||||
|
|
||||||
|
@ -73,6 +76,24 @@ _build/emqx/rel/emqx/bin console
|
||||||
|
|
||||||
To view the dashboard after running, use your browser to open: http://localhost:18083
|
To view the dashboard after running, use your browser to open: http://localhost:18083
|
||||||
|
|
||||||
|
## Test
|
||||||
|
|
||||||
|
### To test everything in one go
|
||||||
|
|
||||||
|
```
|
||||||
|
make eunit ct
|
||||||
|
```
|
||||||
|
|
||||||
|
### To run subset of the common tests
|
||||||
|
|
||||||
|
examples
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./rebar3 ct --dir test,apps/emqx_sn,apps/emqx_coap
|
||||||
|
./rebar3 ct --suite test/emqx_SUITE.erl,apps/emqx_auth_http/test/emqx_auth_http_SUITE.erl
|
||||||
|
./rebar3 ct --suite test/emqx_SUITE.erl --testcase t_restart
|
||||||
|
```
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
Visiting [EMQ X FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html) to get help of common problems.
|
Visiting [EMQ X FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html) to get help of common problems.
|
||||||
|
|
Loading…
Reference in New Issue