Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DavertMik committed Dec 4, 2015
1 parent d829146 commit 01c4b1c
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 80 deletions.
45 changes: 0 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,51 +255,6 @@ Scenario('test some forms', (I, docsPage) => {
});
```
## Connect through proxy
CodeceptJS also provides flexible options when you want to execute tests to Selenium servers through proxy. You will
need to update the `helpers.WebDriverIO.proxy` key.
```js
{
"helpers": {
"WebDriverIO": {
"proxy": {
"proxyType": "manual|pac",
"proxyAutoconfigUrl": "URL TO PAC FILE",
"httpProxy": "PROXY SERVER",
"sslProxy": "PROXY SERVER",
"ftpProxy": "PROXY SERVER",
"socksProxy": "PROXY SERVER",
"socksUsername": "USERNAME",
"socksPassword": "PASSWORD",
"noProxy": "BYPASS ADDRESSES"
}
}
}
}
```
For example,
```js
{
"helpers": {
"WebDriverIO": {
"proxy": {
"proxyType": "manual",
"httpProxy": "http://corporate.proxy:8080",
"socksUsername": "codeceptjs",
"socksPassword": "secret",
"noProxy": "127.0.0.1,localhost"
}
}
}
}
```
Please refer to [Selenium - Proxy Object](https://code.google.com/p/selenium/wiki/DesiredCapabilities#Proxy_JSON_Object) for more information.
## Current State
CodeceptJS is in its early days. Any feedback, issues, and pull requests are welcome. Try it, and if you like it - help us make it better!
Expand Down
16 changes: 8 additions & 8 deletions docs/helpers/FileSystem.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FileSystem

[lib/helper/FileSystem.js:22-87](https://github.com/Codeception/CodeceptJS/blob/478d1362d9a1755b85bc94e1f57b738d905fb6e5/lib/helper/FileSystem.js#L22-L87 "Source code on GitHub")
[lib/helper/FileSystem.js:22-87](https://github.com/Codeception/CodeceptJS/blob/d8291463c033201c9ee70f96b4ef33137782c548/lib/helper/FileSystem.js#L22-L87 "Source code on GitHub")

Helper for testing filesystem.
Can be easily used to check file structures:
Expand All @@ -14,7 +14,7 @@ I.dontSeeInThisFile("WebDriverIO");

## amInPath

[lib/helper/FileSystem.js:34-37](https://github.com/Codeception/CodeceptJS/blob/478d1362d9a1755b85bc94e1f57b738d905fb6e5/lib/helper/FileSystem.js#L34-L37 "Source code on GitHub")
[lib/helper/FileSystem.js:34-37](https://github.com/Codeception/CodeceptJS/blob/d8291463c033201c9ee70f96b4ef33137782c548/lib/helper/FileSystem.js#L34-L37 "Source code on GitHub")

Enters a directory In local filesystem.
Starts from a current directory
Expand All @@ -25,7 +25,7 @@ Starts from a current directory

## dontSeeFileContentsEqual

[lib/helper/FileSystem.js:82-85](https://github.com/Codeception/CodeceptJS/blob/478d1362d9a1755b85bc94e1f57b738d905fb6e5/lib/helper/FileSystem.js#L82-L85 "Source code on GitHub")
[lib/helper/FileSystem.js:82-85](https://github.com/Codeception/CodeceptJS/blob/d8291463c033201c9ee70f96b4ef33137782c548/lib/helper/FileSystem.js#L82-L85 "Source code on GitHub")

Checks that contents of file found by `seeFile` doesn't equal to text.

Expand All @@ -36,7 +36,7 @@ Checks that contents of file found by `seeFile` doesn't equal to text.

## dontSeeInThisFile

[lib/helper/FileSystem.js:66-69](https://github.com/Codeception/CodeceptJS/blob/478d1362d9a1755b85bc94e1f57b738d905fb6e5/lib/helper/FileSystem.js#L66-L69 "Source code on GitHub")
[lib/helper/FileSystem.js:66-69](https://github.com/Codeception/CodeceptJS/blob/d8291463c033201c9ee70f96b4ef33137782c548/lib/helper/FileSystem.js#L66-L69 "Source code on GitHub")

Checks that file found by `seeFile` doesn't include text.

Expand All @@ -47,7 +47,7 @@ Checks that file found by `seeFile` doesn't include text.

## seeFile

[lib/helper/FileSystem.js:49-53](https://github.com/Codeception/CodeceptJS/blob/478d1362d9a1755b85bc94e1f57b738d905fb6e5/lib/helper/FileSystem.js#L49-L53 "Source code on GitHub")
[lib/helper/FileSystem.js:49-53](https://github.com/Codeception/CodeceptJS/blob/d8291463c033201c9ee70f96b4ef33137782c548/lib/helper/FileSystem.js#L49-L53 "Source code on GitHub")

Checks that file exists

Expand All @@ -57,7 +57,7 @@ Checks that file exists

## seeFileContentsEqual

[lib/helper/FileSystem.js:74-77](https://github.com/Codeception/CodeceptJS/blob/478d1362d9a1755b85bc94e1f57b738d905fb6e5/lib/helper/FileSystem.js#L74-L77 "Source code on GitHub")
[lib/helper/FileSystem.js:74-77](https://github.com/Codeception/CodeceptJS/blob/d8291463c033201c9ee70f96b4ef33137782c548/lib/helper/FileSystem.js#L74-L77 "Source code on GitHub")

Checks that contents of file found by `seeFile` equal to text.

Expand All @@ -68,7 +68,7 @@ Checks that contents of file found by `seeFile` equal to text.

## seeInThisFile

[lib/helper/FileSystem.js:58-61](https://github.com/Codeception/CodeceptJS/blob/478d1362d9a1755b85bc94e1f57b738d905fb6e5/lib/helper/FileSystem.js#L58-L61 "Source code on GitHub")
[lib/helper/FileSystem.js:58-61](https://github.com/Codeception/CodeceptJS/blob/d8291463c033201c9ee70f96b4ef33137782c548/lib/helper/FileSystem.js#L58-L61 "Source code on GitHub")

Checks that file found by `seeFile` includes a text.

Expand All @@ -79,7 +79,7 @@ Checks that file found by `seeFile` includes a text.

## writeToFile

[lib/helper/FileSystem.js:42-44](https://github.com/Codeception/CodeceptJS/blob/478d1362d9a1755b85bc94e1f57b738d905fb6e5/lib/helper/FileSystem.js#L42-L44 "Source code on GitHub")
[lib/helper/FileSystem.js:42-44](https://github.com/Codeception/CodeceptJS/blob/d8291463c033201c9ee70f96b4ef33137782c548/lib/helper/FileSystem.js#L42-L44 "Source code on GitHub")

Writes test to file

Expand Down
Loading

0 comments on commit 01c4b1c

Please sign in to comment.