Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prongbang/integration_testgen
Generate Page Object Model dart class by spec.yml
https://github.com/prongbang/integration_testgen
dart flutter integration-test integration-testgen integration-testing
Last synced: about 1 month ago
JSON representation
Generate Page Object Model dart class by spec.yml
- Host: GitHub
- URL: https://github.com/prongbang/integration_testgen
- Owner: prongbang
- License: mit
- Created: 2022-06-09T09:32:05.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T09:24:16.000Z (about 1 year ago)
- Last Synced: 2024-10-24T08:09:18.811Z (3 months ago)
- Topics: dart, flutter, integration-test, integration-testgen, integration-testing
- Language: Dart
- Homepage:
- Size: 8.52 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# integration_testgen
Generate Page Object Model dart class by spec.yml
## Getting started
- Now install the application via homebrew
```shell
$ brew tap prongbang/homebrew-formulae
$ brew install integration_testgen
```
Or Install Manual
- Clone project
```yaml
git clone https://github.com/prongbang/integration_testgen.git
cd integration_testgen
```
- Build to binary file
```yaml
dart compile exe bin/integration_testgen.dart -o bin/integration_testgen
```
## Configuration
### Test case name
- `verify_test_case_name:` - Prefix `verify_` for verify finder `text` or `key`
- `tap_test_case_name:` - Prefix `tap_` for tap finder `text` or `key`
- `enter_test_case_name:` - Prefix `enter_` for enter text
### Finder
- `text: "xxxx"` - Find by text
- `key: "xxxx"` - Find by key
### Type
- `type: "verify"` - Matcher by finder
- `type: "tap"` - Tap by finder
- `type: "enter"` - Enter `text` by finder
### Action
- `action: "go"` - Action `go` on keyboard
- `action: "none"` - Action `none` on keyboard
- `action: "done"` - Action `done` on keyboard
- `action: "send"` - Action `send` on keyboard
- `action: "next"` - Action `next` on keyboard
- `action: "join"` - Action `join` on keyboard
- `action: "route"` - Action `route` on keyboard
- `action: "search"` - Action `search` on keyboard
- `action: "newline"` - Action `newline` on keyboard
- `action: "previous"` - Action `previous` on keyboard
- `action: "continueAction"` - Action `continueAction` on keyboard
- `action: "emergencyCall"` - Action `emergencyCall` on keyboard
- `action: "unspecified"` - Action `unspecified` on keyboard
## Usage
- pubspec.yml
```yaml
dev_dependencies:
widget_tester_extension: ^0.0.1
```
- Create spec `login_test_spec.yml` in `integration_test/login` folder
```shell
project
- integration_test
- login/login_test_spec.yml
```
and enter script
```yaml
screen: "Login"
specs:
verify_hello_text:
text: "Hello"
type: "verify"
matcher: "one" # "nothing", "one", "2"
tap_next_button:
key: "nextButton"
type: "tap"
delay: 500
enter_number_field:
key: "numberField"
type: "enter"
text: "123456"
```
## Run to generate in `project/integration_test/login`
```shell
integration_testgen
```
## Output
- login_test_screen.dart
```shell
project
- integration_test
- login/login_test_spec.yml
- login/login_test_screen.dart
```
```dart
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:integration_testgen/integration_testgen.dart';
import 'package:integration_testgen/widget_tester.dart';
class LoginTestScreen extends TestScreen {
final WidgetTester tester;
LoginTestScreen(this.tester) {
tester.printToConsole('✓ Login Screen Open');
}
Future verifyHelloText() async {
final finderVerifyHelloText = find.text('Hello');
await tester.pumpAndSettle();
await tester.pumpUntilFound(finderVerifyHelloText);
expect(finderVerifyHelloText, findsOneWidget);
await tester.pumpAndSettle();
}
Future tapNextButton() async {
final finderTapNextButton = find.byKey(const Key('nextButton'));
await tester.delay(500);
await tester.pumpAndSettle();
await tester.pumpUntilFound(finderTapNextButton);
await tester.tap(finderTapNextButton);
await tester.pumpAndSettle();
}
Future enterNumberField() async {
final finderEnterNumberField = find.byKey(const Key('numberField'));
await tester.pumpAndSettle();
await tester.pumpUntilFound(finderEnterNumberField);
await tester.enterText(finderEnterNumberField, '123456');
await tester.pumpAndSettle();
}
Future run() async {
await verifyHelloText();
await tapNextButton();
await enterNumberField();
}
}
```
- login_test.dart
```shell
project
- integration_test
- login/login_test_spec.yml
- login/login_test_screen.dart
- login/login_test.dart
```
```dart
import 'package:flutter_test/flutter_test.dart';
import 'package:integration_test/integration_test.dart';
import 'login_test_screen.dart';
void main() {
IntegrationTestWidgetsFlutterBinding.ensureInitialized();
testWidgets(
'Should OTP success when Login and OTP success',
(tester) async {
// Login Screen
await LoginTestScreen(tester).run();
},
);
}
```