sam_oneal/dial-reference
1
0
Fork 0
mirror of https://github.com/Netflix/dial-reference.git synced 2026-06-08 10:59:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding code tags in README

Browse Source
This commit is contained in:
Chintan Parikh
2017-10-04 06:50:41 -07:00
parent c1ed839cfb
commit 7ba715a54e
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -18,10 +18,10 @@
2) Run make, passing in your TARGET value. 2) Run make, passing in your TARGET value.
```
For example: For example:
TARGET=/usr/local/i686-DIAL-EXAMPLE/bin/i686-DIAL-EXAMPLE make TARGET=/usr/local/i686-DIAL-EXAMPLE/bin/i686-DIAL-EXAMPLE make
```
### Running the DIAL server ### Running the DIAL server
The DIAL server should be started as a service, after the platform's networking The DIAL server should be started as a service, after the platform's networking
has been initialized, and it should remain running at all times (a daemon has been initialized, and it should remain running at all times (a daemon
@@ -67,6 +67,7 @@ to the runtime linker.
## DIAL client Usage ## DIAL client Usage
When running the DIAL client, you have the following options When running the DIAL client, you have the following options
```
usage: dialclient <option> usage: dialclient <option>
Option Parameter Description Option Parameter Description
@@ -75,7 +76,7 @@ Option Parameter Description
-o filename Reporter output file (./report.html) -o filename Reporter output file (./report.html)
-i filename Input File (./dialclient_input.txt) -i filename Input File (./dialclient_input.txt)
-a ip_address IP addr of DIAL server (used for conformance testing) -a ip_address IP addr of DIAL server (used for conformance testing)
```
If you do not provide an ip_address and multiple servers are discovered, the If you do not provide an ip_address and multiple servers are discovered, the
client will prompt you to select a server. client will prompt you to select a server.
@@ -91,7 +92,7 @@ server/tests/js_tests. To run these tests againsts a DIAL server:
The tests themselves are located inside the server/tests/js_tests/tests folder. The tests themselves are located inside the server/tests/js_tests/tests folder.
The file tests.js is a batch runner and will run all the tests serially. It The file tests.js is a batch runner and will run all the tests serially. It
takes the following arguments: takes the following arguments:
```
server/tests/js_tests/tests$ node tests.js server/tests/js_tests/tests$ node tests.js
Usage: node tests.js[options] Usage: node tests.js[options]
@@ -104,11 +105,11 @@ Options:
before querying application status before querying application status
[string] [default: 5000] [string] [default: 5000]
--help, -h Show help [boolean] --help, -h Show help [boolean]
```
To run each test independantly and not through tests.js, just call the To run each test independantly and not through tests.js, just call the
appropriate test file name. appropriate test file name.
```
Example: Example:
server/tests/js_tests/tests$ node discoverServerUnderTest.js server/tests/js_tests/tests$ node discoverServerUnderTest.js
@@ -119,6 +120,6 @@ Options:
running [string] [required] running [string] [required]
--application, --app Application to test [string] [required] --application, --app Application to test [string] [required]
--help, -h Show help [boolean] --help, -h Show help [boolean]
```
Log file of test run is written in js_tests_log.txt in the Log file of test run is written in js_tests_log.txt in the
server/tests/js_tests/tests folder. server/tests/js_tests/tests folder.