Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update e2e tests in README #3778

Merged
merged 3 commits into from
May 1, 2019
Merged

update e2e tests in README #3778

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a155c9
update e2e tests in README
jsnellbaker Apr 24, 2019
cfd8c0e
add clarifying note
jsnellbaker Apr 24, 2019
9031ca5
added note about Prebid.org members + browserstack
bretg May 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,10 +207,20 @@ gulp test-coverage
gulp view-coverage
```

For end-to-end testing, edit the example file `./integrationExamples/gpt/pbjs_example_gpt.html`:
For Prebid.org members with access to BrowserStack, additional end-to-end testing can be done with:

1. Change `{id}` values appropriately to set up ad units and bidders
2. Set the path to Prebid.js in your example file as shown below (see `pbs.src`).
```bash
gulp e2e-test --host=test.localhost
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will it work if i use any other alias which is also defined in host file ? e.g my.localhost
If yes can you update the description accordingly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have that described below?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops...

```

To run these tests, the following items are required:
- setup an alias of localhost in your `hosts` file (eg `127.0.0.1 test.localhost`); note - you can use any alias. Use this alias in the command-line argument above.
- access to [BrowserStack](https://www.browserstack.com/) account. Assign the following variables in your bash_profile:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see how we can require most users to have access to a browserstack account. I don't think even most of us PBJS regulars have access to the account.

I would suggest that reference to this test be added to https://github.com/prebid/Prebid.js/blob/master/RELEASE_SCHEDULE.md instead of this file.

Regular community members should have the previous end-to-end option IMO.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bretg This is not a requirement. In our README we have mentioned gulp commands to do all the tasks. Since we updated our end to end test architecture, we are documenting the new commands here. Maybe we can add the language stating that it is optional ?

For prebid users, this is completely optional. It is not mandatory to run end to end tests.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok - I added a note here about needing to be a prebid.org member to do these tests. Am satisfied with that.

```bash
export BROWSERSTACK_USERNAME='YourUserNameHere'
export BROWSERSTACK_ACCESS_KEY='YourAccessKeyHere'
```
You can get these BrowserStack values from your profile page.

For development:

Expand Down