xref: /aosp_15_r20/external/perfetto/ui/README.md (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1*6dbdd20aSAndroid Build Coastguard Worker# Perfetto UI
2*6dbdd20aSAndroid Build Coastguard Worker
3*6dbdd20aSAndroid Build Coastguard Worker## Quick Start
4*6dbdd20aSAndroid Build Coastguard Worker
5*6dbdd20aSAndroid Build Coastguard Worker```bash
6*6dbdd20aSAndroid Build Coastguard Worker$ git clone https://android.googlesource.com/platform/external/perfetto/
7*6dbdd20aSAndroid Build Coastguard Worker$ cd perfetto
8*6dbdd20aSAndroid Build Coastguard Worker
9*6dbdd20aSAndroid Build Coastguard Worker# Install build dependencies
10*6dbdd20aSAndroid Build Coastguard Workertools/install-build-deps --ui
11*6dbdd20aSAndroid Build Coastguard Worker
12*6dbdd20aSAndroid Build Coastguard Worker# Will build into ./out/ui by default. Can be changed with --out path/
13*6dbdd20aSAndroid Build Coastguard Worker# The final bundle will be available at ./ui/out/dist/.
14*6dbdd20aSAndroid Build Coastguard Worker# The build script creates a symlink from ./ui/out to $OUT_PATH/ui/.
15*6dbdd20aSAndroid Build Coastguard Workerui/build
16*6dbdd20aSAndroid Build Coastguard Worker
17*6dbdd20aSAndroid Build Coastguard Worker# This will automatically build the UI. There is no need to manually run
18*6dbdd20aSAndroid Build Coastguard Worker# ui/build before running ui/run-dev-server.
19*6dbdd20aSAndroid Build Coastguard Workerui/run-dev-server
20*6dbdd20aSAndroid Build Coastguard Worker```
21*6dbdd20aSAndroid Build Coastguard Worker
22*6dbdd20aSAndroid Build Coastguard WorkerThen navigate to `http://localhost:10000`.
23*6dbdd20aSAndroid Build Coastguard Worker
24*6dbdd20aSAndroid Build Coastguard WorkerSee also https://perfetto.dev/docs/contributing/build-instructions#ui-development
25*6dbdd20aSAndroid Build Coastguard Worker
26*6dbdd20aSAndroid Build Coastguard Worker## Unit tests
27*6dbdd20aSAndroid Build Coastguard Worker
28*6dbdd20aSAndroid Build Coastguard Worker```bash
29*6dbdd20aSAndroid Build Coastguard Workerui/run-unittests  # Add --watch to run them in watch mode.
30*6dbdd20aSAndroid Build Coastguard Worker```
31*6dbdd20aSAndroid Build Coastguard Worker
32*6dbdd20aSAndroid Build Coastguard Worker## Integration tests (browser screenshot difftests)
33*6dbdd20aSAndroid Build Coastguard Worker
34*6dbdd20aSAndroid Build Coastguard Worker```bash
35*6dbdd20aSAndroid Build Coastguard Workerrun-integrationtests
36*6dbdd20aSAndroid Build Coastguard Worker```
37*6dbdd20aSAndroid Build Coastguard Worker
38*6dbdd20aSAndroid Build Coastguard WorkerTo rebaseline screenshots after a UI change
39*6dbdd20aSAndroid Build Coastguard Worker
40*6dbdd20aSAndroid Build Coastguard Worker```bash
41*6dbdd20aSAndroid Build Coastguard Workerui/run-integrationtests --rebaseline
42*6dbdd20aSAndroid Build Coastguard Worker
43*6dbdd20aSAndroid Build Coastguard Workertools/test_data upload
44*6dbdd20aSAndroid Build Coastguard Worker
45*6dbdd20aSAndroid Build Coastguard Workergit add -A
46*6dbdd20aSAndroid Build Coastguard Worker
47*6dbdd20aSAndroid Build Coastguard Workergit commit
48*6dbdd20aSAndroid Build Coastguard Worker```
49*6dbdd20aSAndroid Build Coastguard Worker
50*6dbdd20aSAndroid Build Coastguard WorkerSee also https://perfetto.dev/docs/contributing/testing#ui-pixel-diff-tests
51