TestCase QML Type

このプロパティは、テストケースの実行が完了すると true に設定されます。テストケースは一度しか実行されません。初期値は false です。

running およびwhenも参照してください 。

このプロパティは、結果報告用のテストケースの名前を定義します。デフォルト値は空文字列です。

TestCase {
    name: "ButtonTests"
    ...
}

テストアプリケーションでは、複数のTestCase タイプを指定できます。すべて完了すると、アプリケーションは終了します。前提条件が失敗したため）テストケースを実行する必要がない場合は、このプロパティを true に設定できます。デフォルト値は false です。

TestCase {
    when: false
    optional: true
    function test_not_run() {
        verify(false)
    }
}

when およびcompletedも参照してください 。

このプロパティは、テストケースの実行中に true に設定されます。初期値は false で、テスト ケースが完了すると、値は再び false になります。

completed およびwhen も参照して ください。

このプロパティは、アプリケーションがテストケースの実行を希望するときに true に設定します。デフォルト値は true です。次の例では、ユーザーがマウスボタンを押したときにテストが実行されます：

Rectangle {
    id: foo
    width: 640; height: 480
    color: "cyan"

    MouseArea {
        id: area
        anchors.fill: parent
    }

    property bool bar: true

    TestCase {
        name: "ItemTests"
        when: area.pressed
        id: test1

        function test_bar() {
            verify(bar)
        }
    }
}

すべてのTestCase タイプがトリガされ、実行されると、テスト アプリケーションは終了します。optional プロパティを使用して、TestCase タイプを除外することができます。

optional およびcompletedも参照して ください。

このプロパティは、QML 表示ウィンドウが表示された後、true に設定されます。通常、テスト ケースは、テスト アプリケーションがロードされ、ウィンドウが表示される前に実行されます。テストケースに視覚的な型や動作が含まれる場合は、ウィンドウが表示された後まで遅らせる必要があるかもしれません。

Button {
    id: button
    onClicked: text = "Clicked"
    TestCase {
        name: "ClickTest"
        when: windowShown
        function test_click() {
            button.clicked();
            compare(button.text, "Clicked");
        }
    }
}

この関数は、TestCase 型で実行される各テスト関数の後に呼び出されます。デフォルトの実装は何もしません。アプリケーションは、各テスト関数の後にクリーンアップを実行するための独自の実装を提供することができます。

init() およびcleanupTestCase()も参照 。

この関数は、TestCase 型の他のすべてのテスト関数が完了した後に呼び出されます。デフォルトの実装では何も行いません。アプリケーションは、テストケースのクリーンアップを実行するための独自の実装を提供することができます。

initTestCase() およびcleanup() も参照 。

actual がexpected と同じでない場合、現在のテストケースに失敗し、オプションのmessage を表示します。C++ のQCOMPARE(actual, expected) に似ています。

tryCompare() およびfuzzyCompareも参照 。

この関数は、与えられたcomponent とオプションで指定されたparent およびproperties から QML オブジェクトを動的に生成します。返されたオブジェクトはcleanup() の実行が終了した後に破棄されます(まだ破棄されていない場合)。 つまり、この関数で作成されたオブジェクトは、テストの失敗の有無にかかわらず、 テストが終了するたびに破棄されることが保証されています。

オブジェクトの作成中にエラーがあった場合は、null が返されます。

この関数は内部的にcomponent.createObject() を呼び出す。

Managing Dynamically Created Test Objectsも参照してください 。

この関数は、与えられたqml 文字列から、指定されたparent を持つ QML オブジェクトを動的に生成します。返されたオブジェクトはcleanup() の実行終了後に破棄されます(破棄されていない場合)。 つまり、この関数で作成されたオブジェクトは、テストの失敗の有無にかかわらず、 テストが終わるたびに破棄されることが保証されています。

オブジェクトの作成中にエラーがあった場合は、null が返される。

filePath が指定された場合、作成されたオブジェクトのエラー報告に使用されます。

この関数は、内部的にQt.createQmlObject() を呼び出します。

Managing Dynamically Created Test Objectsも参照してください 。

データ駆動型テストでは、tag に関連付けられている行を失敗すると予想される行としてマークします。失敗が発生すると、message を表示し、テストを中止して、テストに合格のマークを付けます。C++のQEXPECT_FAIL(tag, message, Abort) 。

テストがデータ駆動型でない場合は、tag を空文字列に設定する必要があります。

expectFailContinue()も参照 。

データ駆動型テストでは、tag に関連付けられた行を失敗とマークします。失敗が発生したら、message を表示し、テストを続行します。C++のQEXPECT_FAIL(tag, message, Continue) 。

テストがデータ駆動型でない場合は、tag を空文字列に設定する必要があります。

expectFail()も参照 。

オプションのmessage を指定して、現在のテスト・ケースを失敗させます。C++ のQFAIL(message) に似ています。

message にマッチする警告ごとに、テストの失敗をテストログに追加します。失敗が追加されると、テスト関数は実行を継続します。

message には文字列か、メッセージのパターンを指定する正規表現を指定します。後者の場合、遭遇した警告ごとに、最初にマッチしたパターンが失敗の原因となり、残りのパターンは無視されます。

すべてのパターンは、各テスト関数の最後でクリアされます。

例えば、以下のスニペットは、"Something bad happened" というテキストを含む警告が発生した場合、テストに失敗します：

failOnWarning("Something bad happened")

次のスニペットは、指定されたパターンにマッチする警告が発生した場合、テストに失敗します：

failOnWarning(/[0-9]+ bad things happened/)

与えられた警告をトリガーするすべてのテストを失敗させるには、init() でこの関数に適切な正規表現を渡します：

function init() {
    failOnWarning(/.?/)
}

このメソッドは Qt 6.3 で導入されました。

QTest::failOnWarning() およびwarn()も参照してください 。

objectName を持つparent の最初の子、またはそのような項目が存在しない場合はnull を返します。視覚的な子と非視覚的な子の両方が再帰的に検索され、視覚的な子が最初に検索されます。

compare(findChild(item, "childObject"), expectedChildObject);

actual とexpected の差がdelta より大きい場合、現在のテストケースは失敗し、オプションのmessage を表示します。C++のqFuzzyCompare(actual, expected) に似ていますが、delta の値が必要です。

この関数は、actual とexpected の両方の値がカラー値に変換できる場合、カラー比較にも使用できます。RGBA チ ャ ン ネル値の差のいずれかがdelta を超え る と き は、 テ ス ト は失敗 し ます。

tryCompare() およびcompare()も参照 。

与えられたitem のスナップショット画像オブジェクトを返します。

返される画像オブジェクトは、以下のプロパティを持ちます：

• width 基礎となる画像の幅を返します（5.10以降）。
• height 基礎となる画像の高さを返します（5.10以降）。
• size 基礎となる画像のサイズを返します（5.10以降）。

さらに、返される image オブジェクトには以下のメソッドがあります：

• red(x, y) x,y位置のピクセルの赤チャンネルの値を返します。
• green(x, y) x,y位置のピクセルの緑チャンネル値を返します。
• blue(x, y) x,y位置のピクセルの青チャンネル値を返します。
• alpha(x, y) x,y位置の画素のアルファチャンネル値を返します。
• pixel(x, y) x,y位置の画素の色値を返します。
• equals(image) この画像がimageと同一の場合は を返します - を参照（5.6以降）。true QImage::operator==

  例えば

  let image = grabImage(rect);
  compare(image.red(10, 10), 255);
  compare(image.pixel(20, 20), Qt.rgba(255, 0, 0, 255));
  
  rect.width += 10;
  let newImage = grabImage(rect);
  verify(!newImage.equals(image));

• save(path) 画像を与えられたパスに保存します。画像を保存できない場合は例外がスローされます。(5.10 以降)

  これは、失敗したテストの事後分析を行うときなどに便利です：

  let image = grabImage(rect);
  try {
      compare(image.width, 100);
  } catch (ex) {
      image.save("debug.png");
      throw ex;
  }

message を無視された警告メッセージとしてマークします。このメッセージが発生すると、警告は表示されずテストはパスします。このメッセージが表示されなければ、テストは失敗します。C++ のQTest::ignoreMessage(QtWarningMsg, message) に似ています。

Qt 5.12 以降、message は文字列か、無視するメッセージのパターンを指定する正規表現にすることができます。

例えば、以下のスニペットは文字列の警告メッセージを無視します：

ignoreWarning("Something sort of bad happened")

また、次のスニペットは、いくつかの警告メッセージにマッチする正規表現を無視します：

ignoreWarning(new RegExp("[0-9]+ bad things happened"))

warn()も参照 。

この関数は、TestCase 型で実行される各テスト関数の前に呼び出されます。デフォルトの実装は何もしません。アプリケーションは、各テスト関数の前に初期化を行う独自の実装を提供することができます。

cleanup() およびinitTestCase()も参照 。

この関数は、TestCase 型の他のテスト関数の前に呼び出されます。デフォルトの実装では何も行いません。アプリケーションは、テストケースの初期化を行うための独自の実装を提供することができます。

cleanupTestCase() およびinit()も参照 。

itemOrWindow がItem の場合、この関数は、最後にpolish() が呼び出されてからupdatePolish() が呼び出されていなければtrue を返し、そうでなければfalse を返します。

Qt 6.5 以降では、itemOrWindow がWindow である場合、この関数は、updatePolish() が最後にpolish() を呼び出したとき以降に、管理しているアイテムに対して呼び出されていなければtrue を返し、そうでなければfalse を返します。

QMLでプロパティに値を代入する場合、代入の結果としてアイテムが行わなけれ ばならないレイアウトは、すぐに反映されないかもしれません。このような場合、この関数を使用することで、テストの実行が続行される前に項目が磨かれたことを確認することができます。たとえば、次のようになります：

verify(isPolishScheduled(item))
verify(waitForItemPolished(item))

上記のisPolishScheduled() への呼び出しがない場合、waitForItemPolished() への呼び出しは、磨きが予定されていないことがわかり、そのため項目はすでに磨かれていると仮定して即座にパスするかもしれません。この関数を使用することで、なぜアイテムが磨かれなかったのかが明らかになり、そのような状況下でテストが早期に失敗するようになります。

waitForPolish(),QQuickItem::polish(),QQuickItem::updatePolish()も参照 。

現在フォーカスされているアイテムに対して、オプションのmodifiers でkey をクリックすることをシミュレートします。delay が 0 より大きい場合、テストはdelay ミリ秒待ちます。

イベントは、TestCase ウィンドウか、複数のウィンドウの場合は、現在のアクティブなウィンドウに送られます。詳細はQGuiApplication::focusWindow （）を参照。

keyPress() およびkeyRelease()も参照の こと。

現在フォーカスされているアイテムに対して、オプションでmodifiers を指定してkey を押すことをシミュレートする。delay が 0 より大きい場合、テストはdelay ミリ秒待ちます。

イベントは、TestCase ウィンドウか、複数のウィンドウの場合は、現在のアクティブなウィンドウに送られます。詳細はQGuiApplication::focusWindow() を参照。

注意：ある時点で、keyRelease （）を使ってキーを離す必要がある。

keyRelease() およびkeyClick()も参照 。

現在フォーカスされているアイテムに対して、オプションのmodifiers でkey を解放することをシミュレートする。delay が 0 より大きい場合、テストはdelay ミリ秒待ちます。

イベントは、TestCase ウィンドウか、複数のウィンドウの場合は、現在のアクティブなウィンドウに送られます。詳細はQGuiApplication::focusWindow （）を参照。

keyPress() およびkeyClick()も参照の こと。

keySequence のタイピングをシミュレートする。 キーシーケンスは、standard keyboard shortcuts のいずれかに設定するか、最大4つのキー押下シーケンスを含む文字列で記述することができる。

各イベントは、TestCase ウィンドウに送信され、複数のウィンドウがある場合は、現在のアクティブなウィンドウに送信される。詳細はQGuiApplication::focusWindow() を参照のこと。

keyPress()、keyRelease()、GNU Emacs Style Key Sequences 、およびShortcut.sequenceも参照の こと。

button modifiers itemクリックの位置は、x とy で定義される。x とy が定義されていない場合、位置はitem の中心となる。delay が指定されている場合、ボタンを押す前とボタンを離す前に、指定されたミリ秒の間待機する。

x とy で指定された位置は、item の座標系からウィンドウ座標系に変換され、配信される。item が他のアイテムで隠されていたり、item の子アイテムがその位置を占めている場合、イベントは代わりに他のアイテムに配信されます。

mousePress(),mouseRelease(),mouseDoubleClickSequence(),mouseMove(),mouseDrag(),mouseWheel()も参照のこと 。

マウスのダブルクリックによって生成されるイベントの完全なシーケンスをシミュレートしますbutton modifiers オプション付きitem 。

このメソッドは、ユーザがダブルクリックしたときに発生する一連のマウスイベントを再現します：Press-Release-Press-DoubleClick-Release。

クリックの位置はx とy で定義されます。x とy が定義されていない場合、位置はitem の中心になります。delay が指定されている場合、テストはボタンを押す前と離す前に指定されたミリ秒の間待機します。

x とy で指定された位置は、item の座標系からウィンドウ座標系に変換され、配信される。もし、item が他のアイテムで隠されていたり、item の子アイテムがその位置を占めていたりすると、イベントは代わりに他のアイテムに配信されます。

この QML メソッドは Qt 5.5 で導入されました。

mousePress(),mouseRelease(),mouseClick(),mouseMove(),mouseDrag(),mouseWheel()も参照してください 。

button が押され、オプションでmodifiers が指定された状態で、item 上でマウスをドラッグすることをシミュレートします。 最初のドラッグ位置はx とy で定義され、ドラッグ距離はdx とdy で定義されます。delay が指定された場合、このテストはボタンを離す前に指定されたミリ秒の間待機します。

x とy で指定された位置は、item の座標系からウィンドウ座標系に変換され、配信されます。item が他のアイテムで隠されていたり、item の子がその位置を占有している場合、イベントは代わりに他のアイテムに配信されます。

mousePress()、mouseClick()、mouseDoubleClickSequence()、mouseMove()、mouseRelease()、mouseWheel()も参照のこと 。

buttons マウスポインタをitem 内のx とy で指定された位置に移動します。Qt 6.0 以降、x とy が定義されていない場合、その位置はitem の中心となります。

delay （ミリ秒単位）が与えられると、テストはマウスポインタを動かす前に待機します。

x とy で与えられた位置は、item の座標系からウィンドウ座標系に変換され、配信される。item が他のアイテムによって隠されていたり、item の子アイテムがその位置を占めている場合、イベントは代わりに他のアイテムに送られます。

mousePress(),mouseRelease(),mouseClick(),mouseDoubleClickSequence(),mouseDrag(),mouseWheel()も参照 。

item の上で、オプションのmodifiers でマウスbutton を押すことをシミュレートする。 位置はx とy で定義される。x またはy が定義されていない場合、位置はitem の中心となる。delay が指定されている場合、テストは押す前に指定されたミリ秒の間待つ。

x とy で指定された位置は、item の座標系からウィンドウ座標系に変換され、配信される。item が他のアイテムで隠されていたり、item の子がその位置を占めていたりすると、イベントは代わりに他のアイテムに配信されます。

mouseRelease(),mouseClick(),mouseDoubleClickSequence(),mouseMove(),mouseDrag(),mouseWheel()も参照 。

item にオプションのmodifiers を指定して、マウスbutton を離すことをシミュレートする。離す位置はx とy で定義される。x またはy が定義されていない場合、位置はitem の中心となる。delay が指定されている場合、テストはボタンを離す前に指定されたミリ秒の間待つ。

x とy で指定された位置は、item の座標系からウィンドウ座標系に変換され、配信される。item が他のアイテムで隠されていたり、item の子がその位置を占有している場合、イベントは代わりに他のアイテムに配信されます。

mousePress(),mouseClick(),mouseDoubleClickSequence(),mouseMove(),mouseDrag(),mouseWheel()も参照 。

button が押され、オプションでmodifiers が押されたitem 上でマウスホイールを回転させることをシミュレートする。ホイールイベントの位置はx とy で定義されます。delay が指定された場合、テストはボタンを離す前に指定されたミリ秒の間待機します。

x とy で指定された位置は、item の座標系からウィンドウ座標系に変換され、配信されます。item が他のアイテムによって隠されていたり、item の子アイテムがその位置を占めていたりすると、イベントは代わりに他のアイテムに配信されます。

xDelta とyDelta には、車輪の回転距離が8分の1度単位で格納されている。詳しくはQWheelEvent::angleDelta() を参照。

mousePress()、mouseClick()、mouseDoubleClickSequence()、mouseMove()、mouseRelease()、mouseDrag()、QWheelEvent::angleDelta()も参照の こと。

現在のテストケースをスキップし、オプションのmessage を表示します。これがデータ駆動型テストの場合は、現在の行だけがスキップされます。C++ のQSKIP(message) に似ています。

Qt イベントを処理せずにms ミリ秒スリープします。

wait() およびwaitForRendering()も参照してください 。

シミュレートされたタッチスクリーン (QPointingDevice) を通して、一連のタッチイベントを開始します。イベントはitem を含むウィンドウに送られます。

返されたオブジェクトは、単一のQTouchEvent を通して配信されるイベントを列挙するために使用されます。タッチは、特に指定がない限り、TestCase を含むウィンドウに配信される。

Rectangle {
    width: 640; height: 480

    MultiPointTouchArea {
        id: area
        anchors.fill: parent

        property bool touched: false

        onPressed: touched = true
    }

    TestCase {
        name: "ItemTests"
        when: windowShown
        id: test1

        function test_touch() {
            let touch = touchEvent(area);
            touch.press(0, area, 10, 10);
            touch.commit();
            verify(area.touched);
        }
    }
}

TouchEventSequence::press()、TouchEventSequence::move()、TouchEventSequence::release()、TouchEventSequence::stationary()、TouchEventSequence::commit()、QInputDevice::DeviceTypeも参照のこと 。

obj で指定されたproperty がexpected と同じでない場合、現在のテストケースに失敗し、オプションのmessage を表示します。テストは、timeout （ミリ秒単位）に達するまで複数回再試行されます。

この関数は、プロパティが非同期イベントに基づいて値を変更するアプリケーションをテストするためのものです。同期的なプロパティ変更のテストには、compare() を使用してください。

tryCompare(img, "status", BorderImage.Ready)
compare(img.width, 120)
compare(img.height, 120)
compare(img.horizontalTileMode, BorderImage.Stretch)
compare(img.verticalTileMode, BorderImage.Stretch)

SignalSpy::wait() は、シグナルが発せられるのを待つための代替方法を提供します。

compare() およびSignalSpy::wait()も参照 。

指定されたtimeout （ミリ秒単位）が経過する前にfunction がtrue に評価されない場合、現在のテストケースは失敗となる。この関数は、タイムアウトに達するまで複数回評価されます。失敗すると、オプションでmessage が表示される。

この関数は、非同期イベントに基づいて条件が変化するアプリケーションをテストするためのものです。同期的な条件変更のテストにはverify() を使用し、非同期的なプロパティ変更のテストにはtryCompare() を使用します。

たとえば、以下のコードでは、tryCompare （）を使用することはできません。なぜなら、currentItem プロパティが短期間だけnull になる可能性があるからです：

tryCompare(listView.currentItem, "text", "Hello");

その代わりに、tryVerify() を使用して、まずcurrentItem がnull でないことをチェックし、その後に通常の比較を使用することができます：

tryVerify(function(){ return listView.currentItem })
compare(listView.currentItem.text, "Hello")

verify()、compare()、tryCompare()、SignalSpy::wait()も参照のこと 。

condition が偽の場合、現在のテストケースに失敗し、オプションのmessage を表示します。C++ のQVERIFY(condition) またはQVERIFY2(condition, message) に似ています。

Qt イベントを処理している間、ms ミリ秒待機します。

sleep(),waitForRendering(),Qt::TimerTypeも参照して ください。

windowOrItem がアイテムの場合、この関数はtimeout ミリ秒またはisPolishScheduled(windowOrItem) がfalse を返すまで待つ。isPolishScheduled(windowOrItem) がtimeout ミリ秒以内にfalse を返した場合はtrue を返し、そうでない場合はfalse を返します。

windowOrItem がウィンドウの場合、この関数はウィンドウが管理するすべてのアイテムについて、timeout ミリ秒またはisPolishScheduled() がfalse を返すまで待ちます。isPolishScheduled() がtimeout ミリ秒以内にすべてのアイテムについてfalse を返す場合はtrue を返し、そうでない場合はfalse を返します。

このメソッドは Qt 6.5 で導入されました。

isPolishScheduled(),QQuickItem::polish(),QQuickItem::updatePolish()も参照してください 。

timeout ミリ秒またはレンダラーによってitem がレンダリングされるまで待ちます。timeout ミリ秒以内にitem がレンダリングされた場合は true を返し、そうでない場合は false を返します。デフォルトのtimeout の値は 5000 です。

sleep() およびwait()も参照のこと 。

警告メッセージとしてmessage を表示する。C++ のqWarning(message) に似ています。

ignoreWarning()も参照 。