diff --git a/.travis.yml b/.travis.yml index 5a53d2652..aaf414d4e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -129,11 +129,7 @@ jobs: branch: - master - stage: smoke - install: - - cd test/integration - - npm install - - cd - - script: npm run test:smoke:sauce + script: npm run test:integration:remote stages: - test - name: smoke diff --git a/package.json b/package.json index b6571d0ef..7e352b769 100644 --- a/package.json +++ b/package.json @@ -6,10 +6,13 @@ "start": "node ./dev-server/index.js", "test": "npm run test:lint && npm run build && npm run test:unit:tap", "test:lint": "eslint . --ext .js,.jsx,.json", + "test:integration": "npm run test:integration:jest && npm run test:smoke", "test:integration:jest": "jest ./test/integration/*.test.js", + "test:integration:remote": "npm run test:integration:jest && npm run test:smoke:sauce", "test:smoke": "tap ./test/integration-legacy/smoke-testing/*.js --timeout=3600 --no-coverage -R classic", "test:smoke:verbose": "tap ./test/integration-legacy/smoke-testing/*.js --timeout=3600 --no-coverage -R spec", "test:smoke:sauce": "SMOKE_REMOTE=true tap ./test/integration-legacy/smoke-testing/*.js --timeout=60000 --no-coverage -R classic", + "test:unit": "npm run test:unit:jest && npm run test:unit:tap", "test:unit:jest": "jest ./test/unit/*.test.js && jest ./test/localization/*.test.js", "test:unit:tap": "tap ./test/{unit-legacy,localization-legacy}/*.js --no-coverage -R classic", "test:coverage": "tap ./test/{unit-legacy,localization-legacy}/*.js --coverage --coverage-report=lcov", diff --git a/test/README.md b/test/README.md new file mode 100644 index 000000000..251e5d29a --- /dev/null +++ b/test/README.md @@ -0,0 +1,35 @@ +# Requirements + +* Selenium + * See this directory's package.json +* TAP + * In the scratch-www repo's package.json +* [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/) + +# Running the tests + +* By default, tests run against our Staging instance, but you can pass in a different location if you want to run the tests against e.g. your local build +* Tests can be run using Saucelabs, an online service that can test browser/os combinations remotely. Currently all tests are written for use for chrome on mac. + +## Using tap +* Run all tests in the smoke-testing directory from the command-line: `$ SMOKE_USERNAME=username SMOKE_PASSWORD=password ROOT_URL=https://scratch.mit.edu npm run smoke` +* To run a single file from the command-line: `$ SMOKE_USERNAME=username SMOKE_PASSWORD=password ROOT_URL=https://scratch.mit.edu node_modules/.bin/tap ./test/integration/smoke-testing/filename.js --timeout=3600` + * The timeout var is for the length of the entire tap test-suite; if you are getting a timeout error, you may need to adjust this value (some of the Selenium tests take a while to run) +* To run tests using saucelabs run this command `$ SMOKE_USERNAME=username SMOKE_PASSWORD=password SAUCE_USERNAME=saucelabsUsername SAUCE_ACCESS_KEY=saucelabsAccessKey ROOT_URL=https://scratch.mit.edu npm run smoke-sauce` + + +### Configuration + +| Variable | Default | Description | +| --------------------- | --------------------- | --------------------------------------------------------- | +| `ROOT_URL` | `scratch.ly` | Location you want to run the tests against | +| `SMOKE_USERNAME` | `None` | Username for Scratch user you're signing in with to test | +| `SMOKE_PASSWORD` | `None` | Password for Scratch user you're signing in with to test | +| `SMOKE_REMOTE` | `false` | Tests with Sauce Labs or not. True if running smoke-sauce | +| `SMOKE_HEADLESS` | `false` | Run browser in headless mode. Flaky at the moment | +| `SAUCE_USERNAME` | `None` | Username for your Sauce Labs account | +| `SAUCE_ACCESS_KEY` | `None` | Access Key for Sauce Labs found under User Settings | + + +## Using Saucelabs +* You will need a Saucelabs account in order to use it for testing. To find the Access Key, click your username and select User Settings from the dropdown menu. Near the bottom of the page is your access key that you can copy and use in the command line.