diff --git a/README.md b/README.md index 79a0e5b4..acd9d0df 100644 --- a/README.md +++ b/README.md @@ -28,17 +28,36 @@ npm install -g yahoo-arrow * **--page** path to the mock or production html page, for example: http://www.yahoo.com or mock.html * **--driver** selenium|phantomjs|browser. (default: phantomjs) * **--browser** firefox|chrome|opera|reuse. Specify browser version with a hypen, ex.: firefox-4.0 or opera-11.0 (default: firefox) -* **--controller** a custom controller javascript file -* **--reuseSession** true/false. Specifies whether to run tests in existing sessions managed by selenium. Visit http://selenuim_host/wd/hub to setup sessions (default: false) * **--report** true/false. Creates report files in junit and json format, and also prints a consolidated test report summary on console +* **--reportFolder** : (optional) folderPath. creates report files in that folder. (default: descriptor folder path) * **--testName** comma separated list of test names defined in test descriptor. all other tests will be ignored * **--group** comma separated list of groups defined in test descriptor, all other groups will be ignored * **--logLevel** DEBUG|INFO|WARN|ERROR|FATAL (default: INFO) * **--dimension** a custom dimension file for defining ycb contexts * **--context** name of ycb context - - - +* **--seleniumHost** : (optional) override selenium host url (example: --seleniumHost=http://host.com:port/wd/hub)" + "\n\n" + +* **--capabilities** : (optional) the name of a json file containing webdriver capabilities required by your project" + +* **--startProxyServer** : (optional) true/false. Starts a proxy server for all intercepting all selenium browser calls" + +* **--routerProxyConfig** : (optional) filePath. Expects a Json file, allows users to modify host and headers for all calls being made by browser. Also supports recording of select url calls. + + + Example Json : + { + "": { + "newHost": "", + "headers": + { + "param": "", + "value": "" + } + ], + "record": true + } + } + +* **--exitCode** : (optional) true/false. Causes the exit code to be non-zero if any tests fail (default: false) +* **--coverage** : (optional) true/false. creates code-coverage report for all js files included/loaded by arrow (default: false) + ##Examples Below are some examples to help you get started. diff --git a/index.js b/index.js index 36cd604e..46cc6f7f 100755 --- a/index.js +++ b/index.js @@ -79,7 +79,6 @@ function showHelp() { " --page : (optional) path to the mock or production html page" + "\n" + " example: http://www.yahoo.com or mock.html" + "\n\n" + " --driver : (optional) one of selenium|nodejs. (default: selenium)" + "\n\n" + - " --descriptor : (optional) glob/path for descriptor(s). (example: **/*descriptor.json)" + "\n\n" + " --browser : (optional) a comma seperated list of browser names, optionally with a hypenated version number.\n" + " Example : 'firefox-12.0,chrome-10.0' or 'firefox,chrome' or 'firefox'. (default: firefox)" + "\n\n" + " --parallel : (optional) test thread count. Determines how many tests to run in parallel for current session. (default: 1)\n" + @@ -97,7 +96,7 @@ function showHelp() { " --seleniumHost : (optional) override selenium host url (example: --seleniumHost=http://host.com:port/wd/hub)" + "\n\n" + " --capabilities : (optional) the name of a json file containing webdriver capabilities required by your project" + " --startProxyServer : (optional) true/false. Starts a proxy server for all intercepting all selenium browser calls" + - " --routerProxyConfig : (optional) filePath. Expects a Json file containing key-value pair, where key = original host, and value = new routed host." + + "\n" + + " --routerProxyConfig : (optional) filePath. Expects a Json file, allows users to modify host and headers for all calls being made by browser. Also supports recording of select url calls." + "\n" + " Example Json :" + "\n" + " {" + "\n" + " \"\": {" + "\n" +