Skip to content

Commit

Permalink
Improvements to Maestro example (#513)
Browse files Browse the repository at this point in the history
- Remove unused app screen
- Add separate Maestro flows for Expo Go and development builds
(different app IDs)
- Add instructions for local testing to `README.md`
- Add missing app scheme to `app.json`
- Remove assets and minimize number of files for better maintainability
  • Loading branch information
douglowder authored Sep 24, 2024
1 parent b862596 commit 1b0d96c
Show file tree
Hide file tree
Showing 43 changed files with 121 additions and 998 deletions.
4 changes: 2 additions & 2 deletions with-maestro/.eas/build/build-and-maestro-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ build:
- eas/maestro_test:
inputs:
flow_path: |
maestro/home.yml
maestro/expand_test.yml
maestro/dev_build/home.yml
maestro/dev_build/expand_test.yml
31 changes: 28 additions & 3 deletions with-maestro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,43 @@
<img alt="Supports Expo Android" longdesc="Supports Expo Android" src="https://img.shields.io/badge/Android-4630EB.svg?style=flat-square&logo=ANDROID&labelColor=A4C639&logoColor=fff" />
</p>

## 🚀 How to use
> _Prerequisite:_ Install the Maestro app following [these instructions](https://maestro.mobile.dev/getting-started/installing-maestro).
## 🚀 Quick start

- Install with `yarn` or `npm install`.

## 🚀 Build and test locally with Expo Go

- Start the app in Expo Go:
- Android: `yarn start` to start the packager, then press `a` to install and start Expo Go on Android
- iOS: `yarn start` to start the packager, then press `i` to install and start Expo Go on iOS
- In a separate terminal, execute a Maestro test flow:
- Home screen test: `maestro test maestro/expo_go/home.yml`
- Expanding component test: `maestro test maestro/expo_go/expand_test.yml`
- Once the test flow starts and Expo Go starts, select "Reload" or the app name from the Expo Go UI in the simulator/emulator. Once the dev menu is hidden and this app is visible, the test flow will continue.

## 🚀 Build and test locally with a development build

- Build the development build and start it on your simulator/emulator:
- Android: `yarn android`.
- iOS: `yarn ios`.
- In a separate terminal, execute a Maestro test flow:
- Home screen test: `maestro test maestro/dev_build/home.yml`
- Expanding component test: `maestro test maestro/dev_build/expand_test.yml`

## 🚀 Build and test on EAS

- Initialize the app as an EAS project with `eas init`.
- iOS:
- Start an EAS run to build and test the app with `eas build -e build-and-maestro-test -p ios`.
- Android:
- Follow the [instructions to disable the new Android builds infrastructure for the EAS project](https://docs.expo.dev/build-reference/e2e-tests/#disable-new-android-builds-infrastructure).
- Start an EAS run to build and test the app with `eas build -e build-and-maestro-test -p android`.

> _Note:_ The Maestro flows in the [maestro](./maestro/) folder must have the app's package name (Android) or bundle identifier (iOS) defined. To make this example work out of the box without changes, the [app.json](./app.json) and the Maestro flows are preconfigured with these values set to `dev.expo.eastestsexample`. In your actual development, these should be changed to the correct values for your app.
> _Note:_ The Maestro flows in the [maestro/dev_build](./maestro/dev_build) folder must have the app's package name (Android) or bundle identifier (iOS) defined. To make this example work out of the box without changes, the [app.json](./app.json) and the Maestro flows for dev builds are preconfigured with these values set to `dev.expo.eastestsexample`. In your actual development, these should be changed to the correct values for your app.
## 📝 Further information

See the Expo guide: [Run E2E Tests On EAS Build](https://docs.expo.dev/build-reference/e2e-tests/).
- [Expo guide on E2E tests with EAS](https://docs.expo.dev/build-reference/e2e-tests/)
- [Maestro guide on creating React Native tests](https://maestro.mobile.dev/platform-support/react-native)
1 change: 1 addition & 0 deletions with-maestro/app.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"expo": {
"scheme": "dev.expo.eastestsexample",
"plugins": [
"expo-router"
],
Expand Down
25 changes: 11 additions & 14 deletions with-maestro/app/(tabs)/_layout.tsx
Original file line number Diff line number Diff line change
@@ -1,35 +1,32 @@
import { Tabs } from 'expo-router';
import React from 'react';

import { TabBarIcon } from '@/components/navigation/TabBarIcon';
import { Colors } from '@/constants/Colors';
import { useColorScheme } from '@/hooks/useColorScheme';

export default function TabLayout() {
const colorScheme = useColorScheme();

return (
<Tabs
screenOptions={{
tabBarActiveTintColor: Colors[colorScheme ?? 'light'].tint,
tabBarActiveTintColor: '#eeeeee',
headerShown: false,
}}>
}}
>
<Tabs.Screen
name="index"
options={{
title: 'Home',
tabBarIcon: ({ color, focused }) => (
<TabBarIcon name={focused ? 'home' : 'home-outline'} color={color} />
),
tabBarIcon: () => null,
tabBarLabelStyle: {
fontSize: 18,
},
}}
/>
<Tabs.Screen
name="explore"
options={{
title: 'Explore',
tabBarIcon: ({ color, focused }) => (
<TabBarIcon name={focused ? 'code-slash' : 'code-slash-outline'} color={color} />
),
tabBarIcon: () => null,
tabBarLabelStyle: {
fontSize: 18,
},
}}
/>
</Tabs>
Expand Down
105 changes: 17 additions & 88 deletions with-maestro/app/(tabs)/explore.tsx
Original file line number Diff line number Diff line change
@@ -1,102 +1,31 @@
import Ionicons from '@expo/vector-icons/Ionicons';
import { StyleSheet, Image, Platform } from 'react-native';
import { StyleSheet, Text, SafeAreaView } from 'react-native';

import { Collapsible } from '@/components/Collapsible';
import { ExternalLink } from '@/components/ExternalLink';
import ParallaxScrollView from '@/components/ParallaxScrollView';
import { ThemedText } from '@/components/ThemedText';
import { ThemedView } from '@/components/ThemedView';

export default function TabTwoScreen() {
return (
<ParallaxScrollView
headerBackgroundColor={{ light: '#D0D0D0', dark: '#353636' }}
headerImage={<Ionicons size={310} name="code-slash" style={styles.headerImage} />}>
<ThemedView style={styles.titleContainer}>
<ThemedText type="title">Explore</ThemedText>
</ThemedView>
<ThemedText>This app includes example code to help you get started.</ThemedText>
<SafeAreaView style={styles.container}>
<Text style={styles.title}>Explore</Text>
<Collapsible title="File-based routing">
<ThemedText>
This app has two screens:{' '}
<ThemedText type="defaultSemiBold">app/(tabs)/index.tsx</ThemedText> and{' '}
<ThemedText type="defaultSemiBold">app/(tabs)/explore.tsx</ThemedText>
</ThemedText>
<ThemedText>
The layout file in <ThemedText type="defaultSemiBold">app/(tabs)/_layout.tsx</ThemedText>{' '}
sets up the tab navigator.
</ThemedText>
<ExternalLink href="https://docs.expo.dev/router/introduction">
<ThemedText type="link">Learn more</ThemedText>
</ExternalLink>
<Text>This app has two screens</Text>
</Collapsible>
<Collapsible title="Android, iOS, and web support">
<ThemedText>
You can open this project on Android, iOS, and the web. To open the web version, press{' '}
<ThemedText type="defaultSemiBold">w</ThemedText> in the terminal running this project.
</ThemedText>
</Collapsible>
<Collapsible title="Images">
<ThemedText>
For static images, you can use the <ThemedText type="defaultSemiBold">@2x</ThemedText> and{' '}
<ThemedText type="defaultSemiBold">@3x</ThemedText> suffixes to provide files for
different screen densities
</ThemedText>
<Image source={require('@/assets/images/react-logo.png')} style={{ alignSelf: 'center' }} />
<ExternalLink href="https://reactnative.dev/docs/images">
<ThemedText type="link">Learn more</ThemedText>
</ExternalLink>
</Collapsible>
<Collapsible title="Custom fonts">
<ThemedText>
Open <ThemedText type="defaultSemiBold">app/_layout.tsx</ThemedText> to see how to load{' '}
<ThemedText style={{ fontFamily: 'SpaceMono' }}>
custom fonts such as this one.
</ThemedText>
</ThemedText>
<ExternalLink href="https://docs.expo.dev/versions/latest/sdk/font">
<ThemedText type="link">Learn more</ThemedText>
</ExternalLink>
</Collapsible>
<Collapsible title="Light and dark mode components">
<ThemedText>
This template has light and dark mode support. The{' '}
<ThemedText type="defaultSemiBold">useColorScheme()</ThemedText> hook lets you inspect
what the user's current color scheme is, and so you can adjust UI colors accordingly.
</ThemedText>
<ExternalLink href="https://docs.expo.dev/develop/user-interface/color-themes/">
<ThemedText type="link">Learn more</ThemedText>
</ExternalLink>
</Collapsible>
<Collapsible title="Animations">
<ThemedText>
This template includes an example of an animated component. The{' '}
<ThemedText type="defaultSemiBold">components/HelloWave.tsx</ThemedText> component uses
the powerful <ThemedText type="defaultSemiBold">react-native-reanimated</ThemedText> library
to create a waving hand animation.
</ThemedText>
{Platform.select({
ios: (
<ThemedText>
The <ThemedText type="defaultSemiBold">components/ParallaxScrollView.tsx</ThemedText>{' '}
component provides a parallax effect for the header image.
</ThemedText>
),
})}
</Collapsible>
</ParallaxScrollView>
</SafeAreaView>
);
}

const styles = StyleSheet.create({
headerImage: {
color: '#808080',
bottom: -90,
left: -35,
position: 'absolute',
},
titleContainer: {
flexDirection: 'row',
container: {
flex: 1,
gap: 8,
width: '80%',
height: '80%',
marginTop: '20%',
marginLeft: '10%',
},
title: {
alignItems: 'center',
fontSize: 18,
fontWeight: 'bold',
marginBottom: 20,
},
});
74 changes: 15 additions & 59 deletions with-maestro/app/(tabs)/index.tsx
Original file line number Diff line number Diff line change
@@ -1,70 +1,26 @@
import { Image, StyleSheet, Platform } from 'react-native';

import { HelloWave } from '@/components/HelloWave';
import ParallaxScrollView from '@/components/ParallaxScrollView';
import { ThemedText } from '@/components/ThemedText';
import { ThemedView } from '@/components/ThemedView';
import { StyleSheet, Text, SafeAreaView } from 'react-native';

export default function HomeScreen() {
return (
<ParallaxScrollView
headerBackgroundColor={{ light: '#A1CEDC', dark: '#1D3D47' }}
headerImage={
<Image
source={require('@/assets/images/partial-react-logo.png')}
style={styles.reactLogo}
/>
}>
<ThemedView style={styles.titleContainer}>
<ThemedText type="title">Welcome!</ThemedText>
<HelloWave />
</ThemedView>
<ThemedView style={styles.stepContainer}>
<ThemedText type="subtitle">Step 1: Try it</ThemedText>
<ThemedText>
Edit <ThemedText type="defaultSemiBold">app/(tabs)/index.tsx</ThemedText> to see changes.
Press{' '}
<ThemedText type="defaultSemiBold">
{Platform.select({ ios: 'cmd + d', android: 'cmd + m' })}
</ThemedText>{' '}
to open developer tools.
</ThemedText>
</ThemedView>
<ThemedView style={styles.stepContainer}>
<ThemedText type="subtitle">Step 2: Explore</ThemedText>
<ThemedText>
Tap the Explore tab to learn more about what's included in this starter app.
</ThemedText>
</ThemedView>
<ThemedView style={styles.stepContainer}>
<ThemedText type="subtitle">Step 3: Get a fresh start</ThemedText>
<ThemedText>
When you're ready, run{' '}
<ThemedText type="defaultSemiBold">npm run reset-project</ThemedText> to get a fresh{' '}
<ThemedText type="defaultSemiBold">app</ThemedText> directory. This will move the current{' '}
<ThemedText type="defaultSemiBold">app</ThemedText> to{' '}
<ThemedText type="defaultSemiBold">app-example</ThemedText>.
</ThemedText>
</ThemedView>
</ParallaxScrollView>
<SafeAreaView style={styles.container}>
<Text style={styles.title}>Welcome!</Text>
</SafeAreaView>
);
}

const styles = StyleSheet.create({
titleContainer: {
flexDirection: 'row',
alignItems: 'center',
container: {
flex: 1,
gap: 8,
width: '80%',
height: '80%',
marginTop: '20%',
marginLeft: '10%',
},
stepContainer: {
gap: 8,
marginBottom: 8,
},
reactLogo: {
height: 178,
width: 290,
bottom: 0,
left: 0,
position: 'absolute',
title: {
alignItems: 'center',
fontSize: 18,
fontWeight: 'bold',
marginBottom: 20,
},
});
73 changes: 0 additions & 73 deletions with-maestro/app/(tabs)/tv_focus.tsx

This file was deleted.

Loading

0 comments on commit 1b0d96c

Please sign in to comment.