Testing React Native Apps
No Facebook, nós usamos Jest para testar as aplicações React Native
Obtenha uma visão mais profunda em como testar um app React Native de exemplo lendo a seguinte série: Parte 1: Jest – Snapshot entra em jogo (em inglês) e Parte 2: Jest – Snapshots Redux para suas Actions e Reducers (em inglês).
Instalação
A partir da versão 0.38 de react-native, uma instalação Jest é incluída por padrão, ao executar react-native init
. A seguinte configuração deve ser automaticamente adicionada ao seu arquivo package.json:
{
"scripts": {
"test": "jest"
},
"jest": {
"preset": "react-native"
}
}
Nota: Se você estiver atualizando seu aplicativo react-native e anteriormente usou a predefinição jest-react-native
, remova a dependência de seu arquivo package.json
e altere a predefinição para react-native
em vez disso.
Execute yarn test
para rodar os testes com o Jest.
Teste Snapshot
Vamos criar um teste snapshot para um pequeno componente "intro" com alguns "views" e componentes de texto e alguns estilos:
// Intro.js
import React, {Component} from 'react';
import {StyleSheet, Text, View} from 'react-native';
class Intro extends Component {
render() {
return (
<View style={styles.container}>
<Text style={styles.welcome}>Welcome to React Native!</Text>
<Text style={styles.instructions}>
This is a React Native snapshot test.
</Text>
</View>
);
}
}
const styles = StyleSheet.create({
container: {
alignItems: 'center',
backgroundColor: '#F5FCFF',
flex: 1,
justifyContent: 'center',
},
instructions: {
color: '#333333',
marginBottom: 5,
textAlign: 'center',
},
welcome: {
fontSize: 20,
margin: 10,
textAlign: 'center',
},
});
export default Intro;
Agora vamos usar o renderer de teste do React e o recurso de snapshot do Jest para interagir com o componente e capturar a saída renderizada e criar um arquivo de snapshot:
// __tests__/Intro-test.js
import React from 'react';
import renderer from 'react-test-renderer';
import Intro from '../Intro';
test('renders correctly', () => {
const tree = renderer.create(<Intro />).toJSON();
expect(tree).toMatchSnapshot();
});
Quando você roda yarn test
ou jest
, isso vai produzir uma saída de arquivo semelhante a este:
// __tests__/__snapshots__/Intro-test.js.snap
exports[`Intro renders correctly 1`] = `
<View
style={
Object {
"alignItems": "center",
"backgroundColor": "#F5FCFF",
"flex": 1,
"justifyContent": "center",
}
}>
<Text
style={
Object {
"fontSize": 20,
"margin": 10,
"textAlign": "center",
}
}>
Welcome to React Native!
</Text>
<Text
style={
Object {
"color": "#333333",
"marginBottom": 5,
"textAlign": "center",
}
}>
This is a React Native snapshot test.
</Text>
</View>
`;
Da próxima vez que você executar os testes, a saída renderizada será comparada ao snapshot criado anteriormente. The snapshot should be committed along with code changes. Quando um teste de snapshot falhar, você precisa inspecionar se é uma mudança pretendida ou não intencional. Se a mudança é esperada, você pode invocar Jest com jest -u
para substituir o snapshot existente.
O código deste exemplo está disponível em examples/react-native
Configuração predefinida
A predefinição configura o ambiente e é muito opinativa e baseada no que tem se mostrado ser útil no Facebook. Todas as opções de configuração podem ser substituídas assim como eles podem ser personalizados quando nenhuma predefinição é usada.
Ambiente
react-native
vem com uma pré-definição Jest, então o campo jest.preset
de seu package.json
deve apontar para react-native
. The preset is a node environment that mimics the environment of a React Native app. Because it doesn't load any DOM or browser APIs, it greatly improves Jest's startup time.
personalização de transformIgnorePatterns
A opção transformIgnorePatterns
pode ser usada para especificar quais arquivos devem ser transpilados pelo Babel. Muitos módulos npm de react-native infelizmente não pre-compilam seu código fonte antes de publicar.
Por padrão a predefinição jest-react-native só processa os arquivos fonte do projeto e react-native. Se você tem dependências NPM que precisam ser transpiladas, você pode customizar as opções de configuração incluindo outros módulos além do React Native.
{
"transformIgnorePatterns": [
"node_modules/(?!(react-native|my-project|react-native-button)/)"
]
}
setupFiles
Se você gostaria de fornecer configuração adicional para cada arquivo de teste, a opção de configuração setupFiles
pode ser usada para especificar os scripts de instalação.
moduleNameMapper
O moduleNameMapper
pode ser usado para mapear um caminho de módulo para um módulo diferente. Por padrão a predefinição mapeia todas as imagens para um módulo de esboço de imagem, mas se um módulo não pode ser encontrado esta opção de configuração pode ajudar:
{
"moduleNameMapper": {
"my-module.js": "<rootDir>/path/to/my-module.js"
}
}
Dicas
Simule (mock, em inglês) módulos nativos usando jest.mock
A predefinição Jest interna do react-native
vem com algumas simulações (mocks, em inglês) padrão que são aplicadas em um repositório react-native. No entanto, alguns componentes do React Native ou componentes de terceiro dependem de código nativo para serem renderizados. Em tais casos, o sistema manual de simulação do Jest pode ajudar a simular a implementação subjacente.
Por exemplo, se seu código depende de um componente de vídeo nativo de terceiros chamado react-native-video
convém esboçar ele com um simulação manual como esta:
jest.mock('react-native-video', () => 'Video');
Isto irá renderizar o componente como <Video {...props} />
com todas as suas propriedades no snapshot de saída. Veja também caveats através do do Enzyme e React 16.
Às vezes você precisa fornecer uma simulação manual mais complexa. Por exemplo, se você gostaria de transmitir os tipos das propriedades ou campos estáticos de um componente nativo para uma simulação (mock, em inglês), você pode retornar um componente React diferente a partir de uma simulação através deste auxiliar do jest-react-native:
jest.mock('path/to/MyNativeComponent', () => {
const mockComponent = require('react-native/jest/mockComponent');
return mockComponent('path/to/MyNativeComponent');
});
Ou se você gostaria de criar sua própria simulação manual, você pode fazer algo parecido com isto:
jest.mock('Text', () => {
const RealComponent = jest.requireActual('Text');
const React = require('react');
class Text extends React.Component {
render() {
return React.createElement('Text', this.props, this.props.children);
}
}
Text.propTypes = RealComponent.propTypes;
return Text;
});
Em outros casos, você pode querer simular um módulo nativo que não seja um componente React. A mesma técnica pode ser aplicada. Nós recomendamos inspecionar o código-fonte do módulo nativo e registrar o módulo ao executar um aplicativo react native em um dispositivo real e então modelar uma simulação manual após o módulo real.
Se você acabar por simular os mesmos módulos repetidamente vez após vez é recomendável definir estas simulações em um arquivo separado e adicioná-lo à lista de setupFiles
.