aboutsummaryrefslogtreecommitdiff
path: root/ui/README.md
blob: e64d31c93347d2e3dee5acb5e9f49d1d60bddaec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# Perfetto UI

## Quick Start

```bash
$ git clone https://android.googlesource.com/platform/external/perfetto/
$ cd perfetto

# Will build into ./out/ui by default. Can be changed with --out path/
# The final bundle will be available at ./ui/out/dist/.
# The build script creates a symlink from ./ui/out to $OUT_PATH/ui/.
ui/build

# This will automatically build the UI. There is no need to manually run
# ui/build before running ui/run-dev-server.
ui/run-dev-server
```

Then navigate to `http://localhost:10000`.

See also https://perfetto.dev/docs/contributing/build-instructions#ui-development

## Unit tests

```bash
ui/run-unittests  # Add --watch to run them in watch mode.
```

## Integration tests (browser screenshot difftests)

```bash
run-integrationtests
```

To rebaseline screenshots after a UI change

```bash
ui/run-integrationtests --rebaseline

tools/test_data upload

git add -A

git commit
```

See also https://perfetto.dev/docs/contributing/testing#ui-pixel-diff-tests