sylph 0.2.0

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 50

pub package Build Status

A sylph is a mythological invisible being of the air. Wikipedia

Sylph #

Sylph is a command line utility for running Flutter integration and end-to-end tests on pools of real iOS and Android devices in the cloud. Sylph runs on a developer mac or in a CI environment.

Installation #

pub global activate sylph

Usage #

sylph

or, if not using the default config file:

sylph -c <path to config file>

Configuration #

All configuration information is passed to Sylph using a configuration file. The default config file is called sylph.yaml:

project_name: flutter tests
default_job_timeout: 5 # minutes

tmp_dir: /tmp/sylph

device_pools:

  - pool_name: android pool 1
    pool_type: android
    devices:
      - name: Samsung Galaxy S9 (Unlocked)
        model: SM-G960U1
        os: 8.0.0

  - pool_name: ios pool 1
    pool_type: ios
    devices:
      - name: Apple iPhone X
        model: A1865
        os: 12.0

test_suites:

  - test_suite: example tests 1
    main: test_driver/main1.dart
    testspec: test_driver/test_spec.yaml
    tests:
      - test_driver/main1_test1.dart
      - test_driver/main1_test2.dart
    device_pools:
      - android pool 1
#      - ios pool 1
    job_timeout: 5 # minutes
    
  - test_suite: example tests 2
    main: test_driver/main2.dart
    testspec: test_driver/test_spec.yaml
    tests:
      - test_driver/main2_test1.dart
      - test_driver/main2_test2.dart
    device_pools:
      - android pool 1
#      - ios pool 1
    job_timeout: 5 # minutes

Live demo #

To see Sylph in action, a live demo of the example app is available.

The log of the live run is here:
https://travis-ci.com/mmcc007/sylph

The resulting artifacts are here:
https://github.com/mmcc007/sylph/releases
(includes a video of test running on device)

Contributing #

When contributing to this repository, please feel free to discuss via issue or pull request.

Issues and pull requests are welcome.

Your feedback is used to guide where development effort is focused. So feel free to create as many issues and pull requests as you want. You should expect a timely and considered response.

0.2.0 #

  • Added support for iOS real devices
    (now supports both iOS and Android real devices)

0.1.1 #

  • Downloads artifacts from AWS Device Farm
    (including video and log of running test)

0.1.0 #

  • Initial version

example/README.md

example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate sylph

2. Use it

The package has the following executables:


$ sylph

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  sylph: ^0.2.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:sylph/sylph.dart';
  
Version Uploaded Documentation Archive
0.2.0 Jun 22, 2019 Go to the documentation of sylph 0.2.0 Download sylph 0.2.0 archive
0.1.1 Mar 17, 2019 Go to the documentation of sylph 0.1.1 Download sylph 0.1.1 archive
0.1.0 Mar 17, 2019 Go to the documentation of sylph 0.1.0 Download sylph 0.1.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
50
Learn more about scoring.

We analyzed this package on Jun 25, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.3.2
  • pana: 0.12.18

Platforms

Detected platforms: Flutter, other

Primary library: package:sylph/sylph.dart with components: io.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
args ^1.5.1 1.5.2
path ^1.6.2 1.6.2
resource ^2.1.5 2.1.5
uuid ^2.0.0 2.0.2
yaml ^2.1.15 2.1.16
Transitive dependencies
charcode 1.1.2
collection 1.14.11
convert 2.1.1
crypto 2.0.6
meta 1.1.7
source_span 1.5.5
string_scanner 1.0.4
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
test ^1.0.0