# WebPageTest

This is the official repository for the performance-testing code that runs at [webpagetest.org](https://www.webpagetest.org).

- 🥡 [Install your own instance](https://docs.webpagetest.org/private-instances/)
- 📕 [Documentation](https://github.com/WPO-Foundation/webpagetest-docs)
- 🕒 [Changelog](https://docs.webpagetest.org/change-log)
- 🌐 [Cross-platform browser agent](https://github.com/WPO-Foundation/wptagent)
- [WPT website global header repo](https://github.com/WebPageTest/wpt-header) and [documentation](https://wpt-header.netlify.app/)
- 💤 [REST API](https://docs.webpagetest.org/api/) examples:
  - 🐘 [`/bulktest`](/bulktest/): A PHP command-line tool that can submit a bulk set of tests, gather the results, and aggregate analyses.
  - 🐍 [`/batchtool`](/batchtool/): A Python tool that can submit a bulk set of tests and gather the results.

## Troubleshooting private instances

If your instance runs, but you’re having issues configuring agents, navigate to `http://{your_instance’s_ip}/install` to [check for a valid configuration](https://docs.webpagetest.org/private-instances/#web-server-install).

## Testing

WebPageTest uses [PHPUnit](https://phpunit.de) for unit tests. To set up and run the unit tests:

1. Install [Composer](https://getcomposer.org)
2. Install [apcu](https://www.php.net/manual/en/book.apcu.php)
3. Add the line `apc.enable_cli='on'` to your php.ini
4. Run `composer install`
5. Run `composer test`

## Contributing

There are separate lines of development under different licenses (pull requests accepted to either):

- The `master` branch where most active development occurs has the [Polyform Shield 1.0.0 license](LICENSE.md)
- The `apache` branch has the more permissive [Apache 2.0 license](https://opensource.org/licenses/Apache-2.0)

### Code style

WebPageTest uses PSR12 coding conventions for PHP linting and formatting.
For JavaScript and CSS formatting we use Prettier with its default configuration.
Additionally we use Stylelint for CSS linting.

Before you send a pull request please make sure to run: `composer lint && composer format`.

Alternatively you can run

 - `composer lint:php && composer format:php` if you only touched PHP code, or
 - `composer lint:css && composer format:prettier` if you only touched CSS or JavaScript code

### VSCode integration

If you use VSCode you might find it helpful to install Prettier and PHP Intelephence plugins and use these in your "settings.json":

```
{
  "[php]": {
    "editor.tabSize": 4
  },

  // uncomment to reformat on every file save
  //"editor.formatOnSave": true,

  "phpcs.standard": "PSR12",

  "files.trimTrailingWhitespace": true,

  "files.eol": "\n",

  "files.associations": {
    "*.inc": "php"
  }
}
```