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

Add Sauce Labs guide for manual browser support testing #171

Merged
merged 8 commits into from
Jul 12, 2018
Merged

Add Sauce Labs guide for manual browser support testing #171

merged 8 commits into from
Jul 12, 2018

Conversation

cfarm
Copy link
Contributor

@cfarm cfarm commented Apr 12, 2018 •
edited
Loading

Adds guide on using Sauce Labs, for issue Manual testing with Sauce Labs pairing sessions + getting started docs #162

Additions

  • new guide documenting how to get a Sauce Labs account, how to use the Sauce Connect proxy to test local sites, how to add an alias for using the proxy more quickly in the future, and how to start a new Manual test (with or without the proxy)

Removals

Changes

  • link to the new guide from the Testing guide

Testing

Screenshots

Notes

Todos

Checklist

  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows the standards laid out in the development playbook
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Browsers

  • Chrome
  • Firefox
  • Safari
  • Internet Explorer 8, 9, 10, and 11
  • Edge
  • iOS Safari
  • Chrome for Android

Accessibility

  • Keyboard friendly
  • Screen reader friendly

Other

  • Is useable without CSS
  • Is useable without JS
  • Flexible from small to large screens
  • No linting errors or warnings
  • JavaScript tests are passing

@cfarm cfarm requested review from contolini and jimmynotjim April 12, 2018 22:30
@cfarm cfarm changed the title Add sauce labs guide Add Sauce Labs guide for manual browser support testing Apr 12, 2018
jimmynotjim
jimmynotjim approved these changes Apr 13, 2018
View reviewed changes
Copy link
Contributor

@jimmynotjim jimmynotjim left a comment

Choose a reason for hiding this comment

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

🎊 🎉 💯

Scotchester
Scotchester approved these changes Apr 13, 2018
View reviewed changes
Copy link
Contributor

@Scotchester Scotchester left a comment

Choose a reason for hiding this comment

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

The testing instructions worked great for me!

Approved pending resolution of one comment on the browser support table.

standards/browser-support-table.html Outdated
</body>
</html>

<table cellspacing="0" cellpadding="0" class="o-table o-table__striped o-table__stack-on-small o-table__entry-header-on-small">
Copy link
Contributor

Choose a reason for hiding this comment

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

The content should go inside the <body> :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

best code review ever

Copy link
Contributor Author

Choose a reason for hiding this comment

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

totally meant to add this in a separate branch anyway. i'm develop

contolini
contolini requested changes Apr 13, 2018
View reviewed changes
Copy link
Member

@contolini contolini left a comment

Choose a reason for hiding this comment

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

Great guide! 💯 Couple minor comments about the alias.

guides/sauce-labs.md Outdated

1. Add the following line of code to your `.aliases` file, using your credentials from SauceLabs.com:
```
alias saucy="cd ~/Applications/sc-4.4.12-osx/ && bin/sc -u YOUR_USERNAME -k YOUR_ACCESS_KEY"
Copy link
Member

@contolini contolini Apr 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

An aliases file isn't a great place to store secret keys. I'd recommend instructing the user to store their sauce credentials in their .exports file:

export SAUCE_USERNAME=<sauce_username>
export SAUCE_ACCESS_KEY=<sauce_access_key>

Sauce Connect will automatically check for the existence of those variables when it starts up.

Copy link
Member

@contolini contolini Apr 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

And instead of cd'ing I would just point directly to the executable:

alias saucy="~/Applications/sc-4.4.12-osx/bin/sc"

Otherwise the user will be in ~/Applications/sc-4.4.12-osx/ after they're done testing which might be annoying if they were previously in their web app's directory.

@jimmynotjim jimmynotjim mentioned this pull request Jul 2, 2018
Merged
1 task
@cfarm cfarm merged commit 1fa3eab into master Jul 12, 2018
@anselmbradford anselmbradford deleted the add-sauce-labs-guide branch February 16, 2023 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Scotchester Scotchester Scotchester approved these changes

@contolini contolini contolini approved these changes

@jimmynotjim jimmynotjim jimmynotjim approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@cfarm @Scotchester @contolini @jimmynotjim