Skip to content

Latest commit

 

History

History
416 lines (303 loc) · 44.8 KB

TESTING.md

File metadata and controls

416 lines (303 loc) · 44.8 KB
Raw

Testing in AMP HTML

This document provides details for testing and building your AMP code.

Contents

Testing commands

Before running these commands, make sure you have Node.js and Gulp installed. For installation instructions, see the One-time setup section in the Quick Start guide.

Pro tip: To see a full listing of gulp commands and their flags, run gulp help.

Command Description
gulp Starts the dev server, lazily builds JS files and extensions when requested, and watches them for changes. Use this for development.
gulp --extensions=amp-foo,amp-bar Same as gulp. Pre-builds the listed extensions, and lazily builds other files when requested.
gulp --extensions_from=examples/foo.amp.html Same as gulp. Pre-builds the extensions in the given example file, and lazily builds other files when requested.
gulp --compiled Same as gulp. Compiles and serves minified binaries. Can be used with --extensions and --extensions_from.
gulp --version_override=<version_override> Runs "watch" and "serve". Overrides the version written to the AMP_CONFIG.
gulp dist Builds minified AMP binaries and applies AMP_CONFIG to runtime files.
gulp dist --watch Builds minified AMP binaries and watches them for changes.
gulp dist --noconfig Builds minified AMP binaries without applying AMP_CONFIG to runtime files.
gulp dist --extensions=amp-foo,amp-bar Builds minified AMP binaries, with only the listed extensions.
gulp dist --extensions_from=examples/foo.amp.html Builds minified AMP binaries, with only extensions from the listed examples.
gulp dist --noextensions Builds minified AMP binaries without building any extensions.
gulp dist --core_runtime_only Builds minified AMP binaries for just the core runtime.
gulp dist --fortesting Builds minified AMP binaries for local testing. (Allows use cases like ads, tweets, etc. to work with minified sources. Overrides TESTING_HOST if specified. Uses the production AMP_CONFIG by default.)
gulp dist --fortesting --config=<config> Builds minified AMP binaries for local testing, with the specified AMP_CONFIG. config can be prod or canary. (Defaults to prod.)
gulp dist --version_override=<version_override> Builds minified AMP binaries and overrides the version written to the AMP_CONFIG.
gulp lint Validates JS files against the ESLint linter.
gulp lint --watch Watches for changes in files, and validates against the ESLint linter.
gulp lint --fix Fixes simple lint warnings/errors automatically.
gulp lint --files=<files-path-glob> Lints just the files provided. Can be used with --fix.
gulp lint --local_changes Lints just the files changed in the local branch. Can be used with --fix.
gulp prettify Validates non-JS files using Prettier.
gulp prettify --fix Fixes simple formatting errors automatically.
gulp prettify --files=<files-path-glob> Checks just the files provided. Can be used with --fix.
gulp prettify --local_changes Checks just the files changed in the local branch. Can be used with --fix.
gulp build Builds unminified AMP binaries.
gulp build --watch Builds unminified AMP binaries and watches them for changes.
gulp build --extensions=amp-foo,amp-bar Builds unminified AMP binaries, with only the listed extensions.
gulp build --extensions_from=examples/foo.amp.html Builds unminified AMP binaries, with only the extensions needed to load the listed examples.
gulp build --noextensions Builds unminified AMP binaries with no extensions.
gulp build --core_runtime_only Builds unminified AMP binaries for just the core runtime.
gulp build --fortesting Builds unminified AMP binaries and sets the test field in AMP_CONFIG to true.
gulp build --version_override=<version_override> Builds unminified AMP binaries with the specified version.
gulp check-links --files=<files-path-glob> Reports dead links in .md files.
gulp check-links --local_changes Reports dead links in .md files changed in the local branch.
gulp clean Removes build output.
gulp css Recompiles css to the build directory and builds the embedded css into js files for the AMP library.
gulp compile-jison Compiles jison parsers for extensions to build directory.
gulp pr-check Runs all the Travis CI checks locally.
gulp pr-check --nobuild Runs all the Travis CI checks locally, but skips the gulp build step.
gulp pr-check --files=<test-files-path-glob> Runs all the Travis CI checks locally, and restricts tests to the files provided.
gulp unit Runs the unit tests in Chrome (doesn't require the AMP library to be built).
gulp unit --local_changes Runs the unit tests directly affected by the files changed in the local branch in Chrome.
gulp integration Runs the integration tests in Chrome after building the unminified runtime with the prod version of AMP_CONFIG.
gulp integration --compiled Same as above, but builds the minified runtime.
gulp integration --config=<config> Same as above, but config can be prod or canary. (Defaults to prod.)
gulp integration --nobuild Same as above, but skips building the runtime.
gulp [unit|integration] --verbose Runs tests in Chrome with logging enabled.
gulp [unit|integration] --nobuild Runs tests without re-build.
gulp [unit|integration] --coverage Runs code coverage tests. After running, the report will be available at test/coverage/index.html
gulp [unit|integration] --watch Watches for changes in files, runs corresponding test(s) in Chrome.
gulp [unit|integration] --watch --verbose Same as watch, with logging enabled.
gulp [unit|integration] --safari Runs tests in Safari.
gulp [unit|integration] --firefox Runs tests in Firefox.
gulp [unit|integration] --edge Runs tests in Edge.
gulp [unit|integration] --ie Runs tests in Internet Explorer.
gulp [unit|integration] --files=<test-files-path-glob> Runs specific test files.
gulp [unit|integration] --testnames Lists the name of each test being run, and prints a summary at the end.
gulp serve Serves content from the repository root at http://localhost:8000/. Examples live in http://localhost:8000/examples/. Serves unminified binaries by default.
gulp serve --compiled Same as serve, but serves minified binaries.
gulp serve --cdn Same as serve, but serves CDN binaries.
gulp serve --rtv <rtv_number> Same as serve, but serves binaries with the given 15 digit RTV.
gulp serve --new_server Same as serve, but uses new Typescript based transforms. Still under active development.
gulp serve --new_server --esm Same as serve, but serves esm (module) binaries. Requires the new Typescript based transforms. Still under active development.
gulp serve --quiet Same as serve, with logging silenced.
gulp serve --port <port> Same as serve, but uses a port number other than the default of 8000.
gulp check-types Verifies that there are no errors associated with Closure typing. Run automatically upon push.
gulp dep-check Runs a dependency check on each module. Run automatically upon push.
gulp presubmit Run validation against files to check for forbidden and required terms. Run automatically upon push.
gulp validator Builds and tests the AMP validator. Run automatically upon push.
gulp ava Run node tests for tasks and offline/node code using ava.
gulp todos:find-closed Find TODOs in code for issues that have been closed.
gulp visual-diff Runs all visual diff tests on a headless instance of local Chrome after building the unminified runtime with the prod version of AMP_CONFIG. Requires PERCY_TOKEN to be set as an environment variable or passed to the task with --percy_token.
gulp visual-diff --compiled Same as above, but builds the minified runtime.
gulp visual-diff --config=<config> Same as above, but config can be prod or canary. (Defaults to prod.)
gulp visual-diff --nobuild Same as above, but skips building the runtime.
gulp visual-diff --chrome_debug --webserver_debug Same as above, with additional logging. Debug flags can be used independently.
gulp visual-diff --grep=<regular-expression-pattern> Same as above, but executes only those tests whose name matches the regular expression pattern.
gulp firebase Generates a folder firebase and copies over all files from examples and test/manual for firebase deployment.
gulp firebase --file path/to/file Same as above, but copies over the file specified as firebase/index.html.
gulp firebase --compiled Same as gulp firebase, but uses minified files of the form /dist/v0/amp-component-name.js instead of unminified files of the form /dist/v0/amp-component-name.max.js.
gulp firebase --nobuild Same as gulp firebase, but skips building the runtime.
gulp e2e Runs all end-to-end tests on Chrome after building the unminified runtime with the prod version of AMP_CONFIG..
gulp e2e --compiled Same as above, but builds the minified runtime. .
gulp e2e --config=<config> Same as above, but config can be prod or canary. (Defaults to prod.)
gulp e2e --nobuild Same as above, but skips building the runtime.
gulp e2e --files=<test-files-path-glob> Runs end-to-end tests from the specified files on the latest Chrome browser.
gulp e2e --testnames Lists the name of each test being run, and prints a summary at the end.
gulp e2e --engine=ENGINE Runs end-to-end tests with the given Web Driver engine. Allowed values are puppeteer and selenium.
gulp e2e --headless Runs end-to-end tests in a headless browser instance.
gulp e2e --watch Watches for changes in test files, runs tests.
gulp check-sourcemaps Checks sourcemaps generated during minified compilation for correctness.

Pro tip: All the above commands can be run in debug mode using node --inspect. This will make the Chrome debugger stop at debugger; statements, after which local state can be inspected using dev tools.

For example, in order to debug gulp serve, run the following command:

node --inspect $(which gulp) serve

Manual testing

For manual testing build AMP and start the Node.js server by running gulp.

Serve Mode

There are 5 serving modes:

  • DEFAULT mode serves unminified AMP. Use this during normal development by simply running gulp.
  • COMPILED mode serves minified AMP. This is closer to what is served in production on the stable channel. Serve this mode by running gulp --compiled.
  • CDN mode serves stable channel binaries. Local changes are not served in this mode. Serve CDN mode by running gulp serve --cdn.
  • RTV mode serves the bundle from the given RTV number (a 15 digit number). E.g. 001907161745080. Serve RTV mode by running gulp serve --rtv <rtv_number>
  • ESM mode serves the esm (module) binaries. First run gulp dist --fortesting --esm and then serve esm mode by running gulp serve --new_server --esm. This mode is new, and under active development.

To switch serving mode during runtime, go to http://localhost:8000/serve_mode=MODE and set MODE to one of the following values: default, compiled, cdn or <RTV_NUMBER>.

Examples

The content in the examples directory can be reached at: http://localhost:8000/examples/

Document proxy

AMP ships with a local proxy for testing production AMP documents with the local JS version.

For any public AMP document like: http://output.jsbin.com/pegizoq/quiet,

You can access it with the local JS by using the form in http://localhost:8000 or by accessing the proxy URL directly:

http://localhost:8000/proxy/output.jsbin.com/pegizoq/quiet.

Note: The local proxy will serve minified or unminified JS based on the current serve mode. When serve mode is cdn, the local proxy will serve remote JS. When accessing minified JS make sure you run gulp dist with the --fortesting flag so that we do not strip out the localhost code paths. (We do some code elimination to trim down the file size for the file we deploy to production)

If the origin resource is on HTTPS, the URLs are http://localhost:8000/proxy/s/output.jsbin.com/pegizoq/quiet

A4A envelope (/a4a/, /a4a-3p/)

If you are working on AMPHTML ads, you can use the local A4A envelope for testing local and production AMP documents with the local JS version.

A4A can be run either of these two modes:

  1. Friendly iframe mode: http://localhost:8000/a4a/...
  2. 3p iframe mode: http://localhost:8000/a4a-3p/...

The following forms are supported:

When accessing minified JS make sure you run gulp dist with the --fortesting flag so that we do not strip out the localhost code paths. (We do some code elimination to trim down the file size for the file we deploy to production)

If the origin resource is on HTTPS, the URLs are http://localhost:8000/a4a[-3p]/proxy/s/output.jsbin.com/pegizoq/quiet

Notice that all documents are assumed to have a "fake" signature. Thus, this functionality is only available in the localDev mode.

Additionally, the following query parameters can be provided:

  • width - the width of the amp-ad (default "300")
  • height - the height of the amp-ad (default "250")
  • offset - the offset to push the amp-ad down the page (default "0px"). Can be used to push the Ad out of the viewport, e.g. using offset=150vh.

In-a-box envelope (/inabox/)

If you are working on AMP In-a-box Ads, you can use the local in-a-box envelope for testing local and production AMP documents with the local JS version.

The following forms are supported:

Additionally, the following query parameters can be provided:

  • width - the width of the iframe (default "300")
  • height - the height of the iframe (default "250")
  • offset - the offset to push the iframe down the page (default "0px"). Can be used to push the Ad out of the viewport, e.g. using offset=150vh.

Chrome extension

For testing documents on arbitrary URLs with your current local version of the AMP runtime we created a Chrome extension.

Visual Diff Tests

In addition to building the AMP runtime and running gulp [unit|integration], the automatic test run on Travis includes a set of visual diff tests to make sure a new commit to master does not result in unintended changes to how pages are rendered. The tests load a few well-known pages in a browser and compare the results with known good versions of the same pages.

The technology stack used is:

  • Percy, a visual regression testing service for webpages
  • Puppeteer, a driver capable of loading webpages for diffing
  • Percy-Puppeteer, a framework that integrates Puppeteer with Percy
  • Headless Chrome, the Chrome/Chromium browser in headless mode

The ampproject/amphtml repository on GitHub is linked to the Percy project of the same name. All PRs will show a check called percy/amphtml in addition to the continuous-integration/travis-ci/pr check. If your PR results in visual diff(s), clicking on the details link will show you the snapshots with the diffs highlighted.

Failing Tests

When a test run fails due to visual diffs being present, click the details link next to percy/amphtml in your PR and examine the results. By default, Percy highlights the changes between snapshots in red. Clicking on the new snapshot will show it in its raw form. If the diffs indicate a problem that is likely to be due to your PR, you can try running the visual diffs locally in order to debug (see section below). However, if you are sure that the problem is not due to your PR, you may click the green Approve button on Percy to approve the snapshots and unblock your PR from being merged.

Flaky Tests

If a Percy test flakes and you would like to trigger a rerun, you can't do that from within Percy. Instead, from your PR on GitHub open up the "Details" for the continuous-integration/travis-ci/pr check to load the Travis run for your PR. There you should see a "passed" test shard labeled "Visual Diff Tests". Click the "Restart Job" icon on just that shard to trigger a rerun on Percy.

Running Visual Diff Tests Locally

You can also run the visual tests locally during development. You must first create a free Percy account at https://percy.io, create a project, and set the PERCY_TOKEN environment variable using the unique value you find at https://percy.io/<org>/<project>/integrations:

export PERCY_TOKEN="<unique-percy-token>"

Once the environment variable is set up, you can run the AMP visual diff tests.

First, build the AMP runtime in minified or unminified mode:

gulp build --fortesting # unminified mode
gulp dist --fortesting # minified mode

Next, run the gulp task that invokes the visual diff tests:

gulp visual-diff --nobuild # unminified mode
gulp visual-diff --compiled --nobuild # minified mode

Note that if you drop the --nobuild flag, gulp visual-diff will run gulp dist|build --fortesting on each execution.

The build will use the Percy credentials set via environment variables in the previous step, and run the tests on your local install of Chrome in headless mode. You can see the results at https://percy.io/<org>/<project>.

To see debugging info during Percy runs, you can run:

 gulp visual-diff --chrome_debug --webserver_debug

To run tests without uploading snapshots to Percy, you can run:

gulp visual-diff --percy_disabled

The debug flags --chrome_debug and --webserver_debug can be used independently. To enable both debug flags, you can also run:

 gulp visual-diff --debug

To execute only a subset of the tests (i.e., when creating or debugging an existing test) use the --grep regular expression flag. e.g., gulp visual-diff --grep="amp-[a-f]" will execute on tests that have an AMP component name between <amp-a...> through <amp-f...>.

After each run, a new set of results will be available at https://percy.io/<org>/<project>.

Isolated Component Testing

To speed up development and testing of components, it is advised to use the Storybook dashboard and develop "stories" (testing scenarios) for components. Storybook has many features that assist with the isolated development and manual testing of components including easy manual interaction with component parameters, integrated accessibility auditing, responsiveness testing, etc.

AMP includes two Storybook environments: storybook-amp (for components living inside AMP pages) and storybook-preact (simulating Bento components living in a Preact/React app).

To run these environments and explore existing AMP components, run

gulp storybook-amp
# ------ or ------
gulp storybook-preact

Test scenarios (stories) live inside each of the components' directories, stories ran in the AMP environment have the .amp.js extension:

# Preact environment test scenario
./extensions/amp-example/0.1/storybook/Basic.js
# AMP environment test scenario
./extensions/amp-example/0.1/storybook/Basic.amp.js

Read more about Writing Storybook Test Scenarios in the official Storybook documentation.

Testing on devices

Testing with ngrok

It's much faster to debug with local build (gulp + http://localhost:8000/). In Chrome you can use DevTools port forwarding. However, iOS Safari does not give a similar option. Instead, you can use ngrok. Just download the ngrok binary for your platform and run it like this:

ngrok http 8000

Once started, the ngrok will print URLs for both http and https. E.g. http://73774d8c.ngrok.io/ and https://73774d8c.ngrok.io/. These URLs can be used to debug on iOS and elsewhere.

Testing with Firebase

For deploying and testing local AMP builds on Firebase, install firebase and initialize firebase within this directory* (a firebase folder can be generated with the command, gulp firebase).

npm install -g firebase-tools
firebase login
firebase init
gulp firebase
firebase deploy
  • When initializing firebase within the directory via firebase init, make sure to select the following options when asked:
  • "Which Firebase CLI features do you want to setup for this folder?" select Hosting: Configure and deploy Firebase Hosting sites.
  • "What do you want to use as your public directory?" enter firebase.
  • "Select a default Firebase project for this directory:" select your project name if it's already created, otherwise choose [don't setup a new project] and add one later.
    • Note: If you haven't already, you will have to create a project via the Firebase Console after you are done initializing and before you deploy. Once you create the project, you can make it active in your CLI with firebase use your-project-name or give it an alias by selecting your project after running firebase use --add.
  • "Configure as a single-page app (rewrite all urls to /index.html)?" select n.

gulp firebase will generate a firebase folder and copy over all files from dist, examples and test/manual. It will rewrite all urls in the copied files to point to the local versions of AMP (i.e. the ones copied from dist to firebase/dist). When you initialize firebase, you should set the firebase public directory to firebase. This way firebase deploy will just directly copy and deploy the contents of the generated firebase folder. As an example, your firebase.json file can look something like this:

{
  "hosting": {
    "public": "firebase",
    "ignore": ["firebase.json", "**/.*", "**/node_modules/**"]
  }
}

If you are only testing a single file, you can use gulp firebase --file=path/to/my/file.amp.html to avoid copying over all of test/manual and examples. It will copy over the specified file to firebase/index.html, which simplifies debugging.

After deploying, you can access your project publically at its hosting URL https://your-project-name.firebaseapp.com.

Additionally, you can create multiple projects and switch between them in the CLI using firebase use your-project-name.

Testing Ads

Testing ads in deployed demos requires allowlisting of 3p urls. You can do this by adding your intended deployment hostname as an environemnt variable AMP_TESTING_HOST and using the fortesting flag. For example:

export AMP_TESTING_HOST="my-project.firebaseapp.com"
gulp firebase --fortesting
firebase deploy

This will write "my-project.firebaseapp.com" as a third party url to relevant attributes in AMP_CONFIG, which is prepended to amp.js and integration.js files in the firebase folder. If you're curious about how this is done, feel free to inspect build-system/tasks/firebase.js.

End-to-End Tests

You can run and create E2E tests locally during development. Currently tests only run on Chrome, but support for additional browsers is underway. These tests have not been added to our CI build yet - but they will be added soon.

Run all tests with:

gulp e2e

The task will kick off gulp build and then gulp serve before running the tests. To skip building the runtime, use --nobuild.

Consult the E2E testing documentation to learn how to create your own end-to-end tests.

Performance Testing Node Build Tools

You can create flamecharts for any node process used by the build system by leveraging 0x which is included as a devDepenendency.

Here's an example for gulp dist --closure_concurrency=1:

npx 0x -o node_modules/.bin/gulp dist --closure_concurrency=1

Important to note is 0x will automatically create a flamechart and a serving folder locally within the repository, please don't add them to PRs!