Teste seu app e seu código

Neste capítulo, você vai aprender a escrever testes para o seu código Dart. Testar é fundamental para garantir que a sua aplicação se comporte como esperado e continue estável conforme você faz mudanças. Você vai usar a biblioteca package:test, um framework de testes popular para Dart, para escrever testes unitários dos modelos de dados que você criou no capítulo anterior.

Antes de começar este capítulo, certifique-se de que você:

• Concluiu o Capítulo 10 e tem um ambiente de desenvolvimento Dart funcionando com o projeto dartpedia.
• Está familiarizado com conceitos básicos de programação, como variáveis, funções e controle de fluxo.
• Entende o propósito dos testes no desenvolvimento de software.

Neste capítulo, você vai adicionar testes ao pacote wikipedia, garantindo que a lógica de desserialização de JSON dos seus modelos de dados esteja funcionando corretamente.

Primeiro, confirme que o pacote test já é uma dependência de desenvolvimento do seu projeto.

1. Abra o arquivo wikipedia/pubspec.yaml dentro do seu projeto.

2. Localize a seção dev_dependencies.

3. Verifique se test: ^1.24.0 (ou a versão estável mais recente) está presente em dev_dependencies.

   wikipedia/pubspec.yaml

   yaml

   dev_dependencies:
     lints: ^5.0.0
     test: ^1.24.0
   

   content_copy

   Se a dependência test estiver ausente, adicione-a ao seu arquivo pubspec.yaml. O símbolo ^ permite o uso de versões compatíveis.

4. Se você fez alguma alteração no arquivo, salve o pubspec.yaml e execute dart pub get no seu terminal, a partir do diretório wikipedia. Esse comando baixa as dependências recém-adicionadas e as deixa disponíveis para uso no seu projeto.

   Você deve ver uma saída parecida com esta:

   bash

   Resolving dependencies...
   Downloading packages...
   + test 1.25.1
   Changed 2 dependencies!
   

   content_copy

Em seguida, crie um arquivo de teste para os seus modelos de dados e adicione as importações necessárias a ele.

1. Acesse o diretório wikipedia/test.

2. Crie um novo arquivo chamado model_test.dart nesse diretório.

3. Abra o arquivo wikipedia/test/model_test.dart e adicione as seguintes instruções import no topo do arquivo:

   wikipedia/test/model_test.dart

   dart

   import 'dart:convert';
   import 'dart:io';
   ​
   import 'package:test/test.dart';
   import 'package:wikipedia/src/model/article.dart';
   import 'package:wikipedia/src/model/search_results.dart';
   import 'package:wikipedia/src/model/summary.dart';
   ​
   const String dartLangSummaryJson = './test/test_data/dart_lang_summary.json';
   const String catExtractJson = './test/test_data/cat_extract.json';
   const String openSearchResponse = './test/test_data/open_search_response.json';
   

   content_copy

   Essas linhas importam o pacote test, que fornece o framework de testes, e os arquivos de modelo de dados que você quer testar. As constantes de texto declaram a localização dos seus dados de exemplo.

Os testes que você precisa escrever dependem de arquivos JSON locais que imitam as respostas da API da Wikipédia. Você precisa criar um diretório test_data e preenchê-lo com três arquivos.

1. Acesse o diretório wikipedia/test.

2. Crie um novo diretório chamado test_data.

3. Dentro do diretório test_data, crie um novo arquivo chamado dart_lang_summary.json e cole nele o conteúdo a seguir:

   wikipedia/test/test_data/dart_lang_summary.json

   json

   {
     "type": "standard",
     "title": "Dart (programming language)",
     "displaytitle": "<span class=\"mw-page-title-main\">Dart (programming language)</span>",
     "namespace": {
         "id": 0,
         "text": ""
     },
     "wikibase_item": "Q406009",
     "titles": {
       "canonical": "Dart_(programming_language)",
       "normalized": "Dart (programming language)",
       "display": "<span class=\"mw-page-title-main\">Dart (programming language)</span>"
     },
     "pageid": 33033735,
     "lang": "en",
     "dir": "ltr",
     "revision": "1259309990",
     "tid": "671bc7c6-aa67-11ef-aa2a-7c1da4fbe8fb",
     "timestamp": "2024-11-24T13:24:16Z",
     "description": "Programming language",
     "description_source": "local",
     "content_urls": {
       "desktop": {
         "page": "https://en.wikipedia.org/wiki/Dart_(programming_language)",
         "revisions": "https://en.wikipedia.org/wiki/Dart_(programming_language)?action=history",
         "edit": "https://en.wikipedia.org/wiki/Dart_(programming_language)?action=edit",
         "talk": "https://en.wikipedia.org/wiki/Talk:Dart_(programming_language)"
       },
       "mobile": {
         "page": "https://en.m.wikipedia.org/wiki/Dart_(programming_language)",
         "revisions": "https://en.m.wikipedia.org/wiki/Special:History/Dart_(programming_language)",
         "edit": "https://en.m.wikipedia.org/wiki/Dart_(programming_language)?action=edit",
         "talk": "https://en.m.wikipedia.org/wiki/Talk:Dart_(programming_language)"
       }
     },
     "extract": "Dart is a programming language designed by Lars Bak and Kasper Lund and developed by Google. It can be used to develop web and mobile apps as well as server and desktop applications.",
     "extract_html": "<p><b>Dart</b> is a programming language designed by Lars Bak and Kasper Lund and developed by Google. It can be used to develop web and mobile apps as well as server and desktop applications.</p>"
   }
   

   content_copy

4. Em seguida, crie um arquivo chamado cat_extract.json. Esse arquivo é bem longo, então copie o conteúdo deste link: https://github.com/ericwindmill/dash_getting_started/blob/main/dart_step_by_step/step_10/wikipedia/test/test_data/cat_extract.json

5. Por fim, crie um arquivo chamado open_search_response.json e cole nele o conteúdo a seguir:

   wikipedia/test/test_data/open_search_response.json

   json

   [
       "dart",
       [
           "Dart",
           "Darth Vader",
           "Dartmouth College",
           "Darts",
           "Darth Maul",
           "Dartford Crossing",
           "Dart (programming language)",
           "Dartmouth College fraternities and sororities",
           "Dartmoor",
           "Dartmouth, Massachusetts"
       ],
       [
           "",
           "",
           "",
           "",
           "",
           "",
           "",
           "",
           "",
           ""
       ],
       [
           "https://en.wikipedia.org/wiki/Dart",
           "https://en.wikipedia.org/wiki/Darth_Vader",
           "https://en.wikipedia.org/wiki/Dartmouth_College",
           "https://en.wikipedia.org/wiki/Darts",
           "https://en.wikipedia.org/wiki/Darth_Maul",
           "https://en.wikipedia.org/wiki/Dartford_Crossing",
           "https://en.wikipedia.org/wiki/Dart_(programming_language)",
           "https://en.wikipedia.org/wiki/Dartmouth_College_fraternities_and_sororities",
           "https://en.wikipedia.org/wiki/Dartmoor",
           "https://en.wikipedia.org/wiki/Dartmouth,_Massachusetts"
       ]
   ]
   

   content_copy

Com esses arquivos no lugar, você está pronto para escrever os testes que vão verificar os seus modelos de dados.

Agora, você vai escrever testes para a lógica de desserialização de JSON dos seus modelos de dados. Você vai usar as funções group, test e expect do pacote test.

1. Use a função group para agrupar testes relacionados. Adicione o seguinte ao seu arquivo wikipedia/test/model_test.dart:

   wikipedia/test/model_test.dart

   dart

   void main() {
     group('deserialize example JSON responses from wikipedia API', () {
       // Tests will go here
     });
   }
   

   content_copy

   A função group recebe uma descrição do grupo e uma função de callback que contém os testes.

2. Crie um teste para o modelo Summary. Adicione a seguinte função test dentro da função group:

   wikipedia/test/model_test.dart

   dart

   void main() {
     group('deserialize example JSON responses from wikipedia API', () {
       test('deserialize Dart Programming Language page summary example data from '
           'json file into a Summary object', () async {
         final String pageSummaryInput =
             await File(dartLangSummaryJson).readAsString();
         final Map<String, Object?> pageSummaryMap =
             jsonDecode(pageSummaryInput) as Map<String, Object?>;
         final Summary summary = Summary.fromJson(pageSummaryMap);
         expect(summary.titles.canonical, 'Dart_(programming_language)');
       });
     });
   }
   

   content_copy

   Esta função test faz o seguinte:

   • Lê o conteúdo do arquivo dart_lang_summary.json.
   • Decodifica a string JSON para um Map<String, Object?>.
   • Cria um objeto Summary a partir do mapa, usando o construtor Summary.fromJson.
   • Usa a função expect para verificar se a propriedade canonical do objeto titles é igual a 'Dart_(programming_language)'.

   A função expect recebe um valor e um matcher. O matcher é usado para verificar se o valor atende a determinados critérios. Neste caso, o matcher equals é usado para verificar se o valor é igual a uma string específica.

3. Crie um teste para o modelo Article. Adicione a seguinte função test dentro da função group, depois do teste anterior:

   wikipedia/test/model_test.dart

   dart

   void main() {
     group('deserialize example JSON responses from wikipedia API', () {
       test('deserialize Dart Programming Language page summary example data from '
           'json file into a Summary object', () async {
         final String pageSummaryInput =
             await File(dartLangSummaryJson).readAsString();
         final Map<String, Object?> pageSummaryMap =
             jsonDecode(pageSummaryInput) as Map<String, Object?>;
         final Summary summary = Summary.fromJson(pageSummaryMap);
         expect(summary.titles.canonical, 'Dart_(programming_language)');
       });
   ​
       test('deserialize Cat article example data from json file into '
           'an Article object', () async {
         final String articleJson = await File(catExtractJson).readAsString();
         final Map<String, Object?> articleMap =
             jsonDecode(articleJson) as Map<String, Object?>;
         final List<Article> articles = Article.listFromJson(articleMap);
         expect(articles.first.title.toLowerCase(), 'cat');
       });
     });
   }
   

   content_copy

   Esta função test faz o seguinte:

   • Lê o conteúdo do arquivo cat_extract.json.
   • Decodifica a string JSON para um Map<String, Object?>.
   • Cria o objeto List<Article> a partir do mapa, usando o método estático Article.listFromJson.
   • Usa a função expect para verificar se a propriedade title do primeiro artigo é igual a 'cat'.

4. Crie um teste para o modelo SearchResults. Adicione a seguinte função test dentro da função group, depois do teste anterior:

   wikipedia/test/model_test.dart

   dart

   void main() {
     group('deserialize example JSON responses from wikipedia API', () {
       test('deserialize Dart Programming Language page summary example data from '
             'json file into a Summary object', () async {
         final String pageSummaryInput =
             await File(dartLangSummaryJson).readAsString();
         final Map<String, Object?> pageSummaryMap =
             jsonDecode(pageSummaryInput) as Map<String, Object?>;
         final Summary summary = Summary.fromJson(pageSummaryMap);
         expect(summary.titles.canonical, 'Dart_(programming_language)');
       });
   ​
       test('deserialize Cat article example data from json file into '
           'an Article object', () async {
         final String articleJson = await File(catExtractJson).readAsString();
         final Map<String, Object?> articleMap =
             jsonDecode(articleJson) as Map<String, Object?>;
         final List<Article> articles = Article.listFromJson(articleMap);
         expect(articles.first.title.toLowerCase(), 'cat');
       });
   ​
       test('deserialize Open Search results example data from json file '
           'into an SearchResults object', () async {
         final String resultsString =
             await File(openSearchResponse).readAsString();
         final List<Object?> resultsAsList =
             jsonDecode(resultsString) as List<Object?>;
         final SearchResults results = SearchResults.fromJson(resultsAsList);
         expect(results.results.length, greaterThan(1));
       });
     });
   }
   

   content_copy

   Esta função test faz o seguinte:

   • Lê o conteúdo do arquivo open_search_response.json.
   • Decodifica a string JSON para um List<Object?> (diferente das respostas de resumo e de artigo, que são objetos JSON decodificados como mapas, a resposta OpenSearch de nível superior é um array JSON).
   • Cria um objeto SearchResults a partir da lista, usando o construtor SearchResults.fromJson.
   • Usa a função expect para verificar se a lista results tem tamanho maior que 1.

Agora que você escreveu os testes, pode executá-los para verificar se eles passam.

1. Abra o terminal e acesse o diretório wikipedia.

2. Execute o comando dart test.

   Você deve ver uma saída parecida com esta:

   bash

   00:02 +4: All tests passed!
   

   content_copy

   Isso confirma que os três testes estão passando.

Na próxima lição, você vai implementar as chamadas à API da Wikipédia na sua aplicação dartpedia. Você vai usar o pacote http para buscar dados da API da Wikipédia e exibi-los ao usuário.