Executar o Winscope

O rastreamento do Winscope faz parte do framework do Android. Esta página descreve as etapas necessárias para baixar, criar e executar o visualizador de rastreamento do Winscope localmente.

Criar o Winscope localmente

Siga estas etapas para configurar seu PC e executar o rastreador Winscope:

1. Baixe a origem do Android.

2. Navegue até a pasta Winscope:

   cd development/tools/winscope
   

3. Instale as dependências usando:

   npm install
   

   Para ver uma lista de comandos disponíveis, execute: npm run

4. Crie todos os destinos de produção e teste usando:

   npm run build:prod
   

5. Execute o Winscope usando:

   npm run start
   

Observação: também é possível fazer o download e criar o Winscope para hospedar em um servidor da Web padrão e receber um link compartilhável para a ferramenta.

Construir partes separadas

É possível criar partes individuais do Winscope separadamente usando os seguintes comandos:

Comando	Descrição
build:trace_processor	Faz o check-out e recria a versão mais recente do trace_processor do Perfetto.
build:protos	Recompila as definições de proto.

Executar testes

Dica: o Winscope não é criado no Soong e não pode ser criado pelo Tradefed. Por isso, é recomendado ter um hook Git local para os testes no seu ambiente local.

O Winscope contém testes de unidade e completos. Para executá-los, use npm run <command>:

Comando	Descrição
test:unit:ci	Executa os testes de unidade em um formato menos detalhado para CI ou hook de pré-envio.
test:unit:dev	Executa os testes de unidade em um formato mais detalhado para desenvolvimento local. Esse modo monitora as mudanças e executa automaticamente os testes corretos.
test:e2e	Executa os testes completos, como os do protocolo entre ferramentas .
test:presubmit:quiet	Cria todos os testes de unidade de pré-envio, linters e análise de gráfico em um formato menos detalhado para CI ou hook de pré-envio .
test:presubmit	Cria todos os testes de unidade de pré-envio, linters e análise de gráfico em um formato mais detalhado para o desenvolvimento local.
test:all	Executa todos os testes (de unidade e de ponta a ponta), linters e análise de gráfico em um formato mais detalhado para desenvolvimento local.

Testes de ponta a ponta

Antes de executar testes de ponta a ponta, inicie a ferramenta remota e instale a versão correta do driver do Chrome. No snippet de código a seguir, o comando run test:e2e instala automaticamente o driver do Chrome.

$ npm run start
$ npm run start:remote_tool_mock
$ npm run test:e2e

A tabela a seguir lista os comandos necessários e as descrições deles. Para executar use npm run command:

Comando	Descrição
start:remote_tool_mock	Inicia o simulacro da ferramenta remota para testar o protocolo entre ferramentas.
install:chromedriver	Instala o driver do Chrome necessário para executar testes completos.

Atualizar o mapeamento @IntDef

@IntDef é uma anotação usada no Android para restringir os valores possíveis de um inteiro. O Winscope usa um mapeamento dessas anotações para mostrar o nome do valor em vez do número inteiro.

Para atualizar o mapeamento @IntDef, faça o seguinte:

1. Crie :framework-minus-apex-intdefs para que o pré-processador de anotações seja executado:

   mp :framework-minus-apex-intdefs
   

2. Copie o arquivo intDefMapping.json gerado para o repositório de pré-builds:

   $ python3 -c 'import sys,json,collections; print(json.dumps(collections.OrderedDict(sorted(collections.ChainMap(*map(lambda x:json.load(open(x)), sys.argv[1:])).items())), indent=2))' $(find out/soong/.intermediates/frameworks/base -iname intDefMapping.json) > ./development/tools/winscope/src/common/intDefMapping.json
   

3. Faça upload das mudanças no Winscope usando repo upload.

Outros comandos

Além de builds e testes, os scripts do Winscope têm outros recursos, conforme mostrado na tabela. Para executá-los, use npm run command:

Comando	Descrição
format:check	Verifica problemas de formatação de código usando prettier.
format:fix	Verifica e corrige automaticamente problemas de formatação de código usando prettier.
eslint:check	Verifica problemas de formatação de código usando eslint.
eslint:fix	Verifica e corrige automaticamente problemas de formatação de código usando eslint.
tslint:check	Verifica problemas de formatação de código usando tslint.
tslint:fix	Verifica e corrige automaticamente problemas de formatação de código usando tslint.
deps_graph:check_cycles	Analisa o código em busca de dependências cíclicas.

Resolver problemas

Use as dicas a seguir para resolver problemas:

• Erro ProtocolError: missing required '<FIELD>' ou TypeError: Cannot read property '<PROP>' of null

  • Isso ocorre quando o arquivo de rastreamento foi criado com uma nova definição proto, que contém novos campos obrigatórios.

    1. Confira se você está abrindo o rastreamento na versão correta do Winscope (master, S ou R).

    2. Se você criar o novo campo no proto, recompile os protos no Winscope usando npm run build:protos.

       Observação: não é necessário um novo campo obrigatório porque os protos são compatíveis com versões anteriores.

• Algumas versões de dependências instaladas estão erradas (falha na build)

  • Reverta as mudanças em package.json e package-lock.json. Remova node_modules. Execute npm install novamente.

• Adicionei um novo campo a um dos arquivos proto. Como faço para mostrar isso?

  • O Winscope usa as definições de proto de quando foi compilado, então novos campos não aparecem por padrão. Para mostrar novos campos, recrie os protos usando npm run build:protos.