Shirates (shirates-core) 日本語ドキュメント

Shiratesは、モバイルアプリのテストコードを簡単かつ楽しく書くことができる統合テストフレームワークです。 shirates-coreはコアライブラリです。

リポジトリ

shirates-core

概要

• テスト済みの環境
• クイックスタート

チュートリアル(Basic)

サンプル

• チュートリアルのサンプル

推奨設定

• Actions on Save (IntelliJ IDEA)
• 右クリックによるテスト実行を有効にする (IntelliJ IDEA)
• propertiesファイルのエンコーディング設定
• Androidデバイスの設定

プロジェクトの作成

• プロジェクトの作成
• テスト構成テンプレート

テストクラスの作成

• テストクラスの作成
• 要素の選択と検証
• テストコードの構造
• テスト結果ファイル

マクロ

• マクロ

セレクターとニックネーム

• セレクター式
• ニックネーム
  • セレクターネックネーム
  • 画面ニックネーム
  • データセットニックネーム
• ウィジェット
• 相対セレクター
  • 相対セレクター(方向ベース)
  • 相対セレクター(ウィジェットフローベース)
  • 相対セレクター(XMLベース)
• スペシャルフィルター
  • クラスエイリアス
• スペシャルセレクター
  • タイトルセレクター
  • Webタイトルセレクター

パラメーター

• パラメーター構成ファイル
• パラメーター
• プロファイルの構成
• 自動デバイス検出

関数/プロパティ

• 要素を選択する

  • select
  • canSelect

• 要素をタップする

  • tap
  • tapAppIcon

• インストールとアプリの起動

  • installApp, removeApp
  • launchApp, terminateApp

• 画面をスワイプ/スクロールする

  • swipe, flick
  • scroll

• 属性を検証する

  • text属性の検証
  • id属性の検証
  • access属性の検証
  • value属性の検証
  • クラス名の検証
  • 任意の属性の検証

• 任意の値を検証する

  • 任意の値の検証 - 文字列の検証

• 存在することを検証する

  • 要素が存在することの検証
  • セルの内部に要素が存在することの検証
  • 画面が表示されていることの検証

• 画像を見つける - find image

• 画像を検証する

  • 画像の検証
  • 画像が存在することの検証（existImage, dontExistImage）

• その他を検証する

  • アプリが表示されていることの検証
  • キーボードが表示されていることの検証
  • 表示中のアプリのパッケージの検証

• 分岐する

  • 分岐関数 (ifTrue, ifFalse)
  • 分岐関数 (ifScreenIs, ifScreenIsNot)
  • 分岐関数 (ifCanSelect, ifCanSelectNot)
  • 分岐関数 (ifImageExist, ifImageExistNot)
  • 分岐関数 (ifImageIs, ifImageIsNot)
  • プラットフォーム関数 (android, ios, emulator, simulator, virtualDevice, realDevice)
  • プラットフォームプロパティ (platformName, platformVersion, isAndroid, isiOS, isVirtualDevice, isRealDevice)
  • おサイフケータイ関数 (osaifuKeitai, osaifuKeitaiNot)
  • スペシャルタグ分岐関数 (specialTag)

• 編集とキーボード操作を行う

  • sendKeys
  • clearInput
  • press keys
  • hideKeyboard

• 同期する

  • wait
  • waitScreen, waitScreenOf
  • waitForClose
  • waitForDisplay

• アクションを繰り返す

  • doUntilTrue

• データストレージ

  • writeMemo, readMemo, memoTextAs
  • clipboard, readClipboard
  • account
  • app
  • data

• ディスクリプター

  • describe, procedure, caption, comment, manual, knownIssue, target, output
  • manual
  • knownIssue

• テストフロー制御

  • SKIP/NOTIMPL

• ロギング

  • info, warn
  • silent, procedure

• 外部コマンドを実行する

  • shell

ビヘイビアヘルパー

• 言語設定
  • LanguageHelperAndroid
  • LanguageHelperIos

レポート

• HTMLレポート
• Test Report Index
• Spec-Report
• 無負荷実行モード
• TestList

バッチ処理を作成する

• Summary-Report
• Code Generator

チュートリアル(In action)

• 画面ニックネームを作成する

  • Appium Inspectorを使用する
  • 画面ニックネームファイルを作成する

• メッセージと言語

  • ログ出力の言語
  • デバイスの言語

• ログとスクリーンショット

  • ログ出力を構成する
  • スクリーンショットを構成する

• デバッグ

  • ソースXMLをファイルで確認する
  • ソースXMLをデバッガーで確認する
  • 内部実行ステップのトレース

• さまざまな環境に適応する

  • tapAppIcon関数を構成する
  • OSのメッセージの変更に適応する

• イレギュラーを処理する

  • イレギュラーハンドラー(グローバルハンドラー)
  • スクリーンハンドラー(onScreen関数)
  • エラーハンドラー

• テストフィクスチャ

  • テストフィクスチャ

• 画像マッチング

  • テンプレートマッチングのための画像を切り出す

• パフォーマンスとリソースの最適化

  • スクロール終端位置の検出の最適化
  • スクリーンショットの縮小率

• AppiumのAPIを使用する

  • Appium ClientのAPIを使用する

• テストを優先度でフィルターする

  • must, should, want

• 手動テストから移行する

  • テストコードのテンプレートを生成する

• コードファーストでテストを設計する

  • [コードファーストでテストを設計す](https://ldi-github.github.io/shirates-core/in_action/designing_and_implementing_test/designing_test_in_code_first_ja.html)る

• CIサーバーでテストを実行する

  • テストをGradleで実行する

• テストの実行を安定化させる(フレーキーテストの改善) - フレーキーテストの原因

  • scenarioの再実行

• キャッシュの制御によるパフォーマンスチューニング

  • iOSにおけるgetSource実行時のパフォーマンス問題 - ダイレクトアクセスモード

チュートリアル(Advanced)

• 独自のデータ関数を作成する
• メッセージをカスタマイズする
• スタブ(shirates-stub)を使用する
• ローカルへパブリッシュする
• HTMLレポートのスタイルをカスタマイズする
• 独自のオペレーション関数を作成する
• コード生成をカスタマイズする

ツールの設定

• IntelliJ IDEA
  • JVMのバージョン, JDKのバージョン

仮想マシンの設定

• Google Play Storeを有効にする

パッケージのインストール/アップデート

• nodeとnpmのインストール/アップデート
• Appiumとドライバーのインストール/アップデート

トラブルシューティング

• エラーメッセージ/警告メッセージ
• トラブルシューティング

Appendix

• アノテーション