TestDataArrayBuilder Class Reference

Public Member Functions
	withName ($name)
	withAnnotations ($annotations=null)
	withBeforeHook ($beforeHook=null)
	withAfterHook ($afterHook=null)
	withFailedHook ($failedHook=null)
	withTestActions ($actions=null)
	withFileName ($filename=null)
	withTestReference ($reference=null)
	build ()

Data Fields
	$testName = 'testTest'
	$filename = null
	$testActionBeforeName = 'testActionBefore'
	$testActionAfterName = 'testActionAfter'
	$testActionFailedName = 'testActionFailed'
	$testTestActionName = 'testActionInTest'
	$testActionType = 'testAction'

Detailed Description

Definition at line 13 of file TestDataArrayBuilder.php.

Member Function Documentation

build()

build

(

)

Output the resulting test data array based on parameters set in the object

Returns

array

Definition at line 240 of file TestDataArrayBuilder.php.

    {
        // return a static data array representing a single test
        return [$this->testName => array_merge(
            [
                TestObjectExtractor::NAME => $this->testName,
                TestObjectExtractor::TEST_ANNOTATIONS => $this->annotations,
                TestObjectExtractor::TEST_BEFORE_HOOK => $this->beforeHook,
                TestObjectExtractor::TEST_AFTER_HOOK => $this->afterHook,
                TestObjectExtractor::TEST_FAILED_HOOK => $this->failedHook,
                "filename" => $this->filename,
                "extends" => $this->testReference
            ],
            $this->testActions
        )];
    }

withAfterHook()

withAfterHook

(

$afterHook = null

)

Add an after hook passed in by arg (or default if no arg)

Parameters

null

$afterHook

Returns

$this

Definition at line 147 of file TestDataArrayBuilder.php.

    {
        if ($afterHook == null) {
            $this->afterHook = [$this->testActionAfterName => [
                    ActionObjectExtractor::NODE_NAME => $this->testActionType,
                    ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionAfterName

            ]];
        } else {
            $this->afterHook = $afterHook;
        }

        return $this;
    }

withAnnotations()

withAnnotations

(

$annotations = null

)

Add annotations passed in by arg (or default if no arg)

Parameters

array

$annotations

Returns

$this

Definition at line 110 of file TestDataArrayBuilder.php.

    {
        if ($annotations == null) {
            $this->annotations = ['group' => [['value' => 'test']]];
        } else {
            $this->annotations = $annotations;
        }

        return $this;
    }

withBeforeHook()

withBeforeHook

(

$beforeHook = null

)

Add a before hook passed in by arg (or default if no arg)

Parameters

null

$beforeHook

Returns

$this

Definition at line 127 of file TestDataArrayBuilder.php.

    {
        if ($beforeHook == null) {
            $this->beforeHook = [$this->testActionBeforeName => [
                ActionObjectExtractor::NODE_NAME => $this->testActionType,
                ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionBeforeName
            ]];
        } else {
            $this->beforeHook = $beforeHook;
        }

        return $this;
    }

withFailedHook()

withFailedHook

(

$failedHook = null

)

Add a failed hook passed in by arg (or default if no arg)

Parameters

null

$failedHook

Returns

$this

Definition at line 168 of file TestDataArrayBuilder.php.

    {
        if ($failedHook == null) {
            $this->failedHook = [$this->testActionFailedName => [
                ActionObjectExtractor::NODE_NAME => $this->testActionType,
                ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionFailedName

            ]];
        } else {
            $this->failedHook = $failedHook;
        }

        return $this;
    }

withFileName()

withFileName

(

$filename = null

)

Add file name passe in by arg (or default if no arg)

Parameters

string

$filename

Returns

$this

Definition at line 208 of file TestDataArrayBuilder.php.

    {
        if ($filename == null) {
            $this->filename =
                "/magento2-functional-testing-framework/dev/tests/verification/TestModule/Test/BasicFunctionalTest.xml";
        } else {
            $this->filename = $filename;
        }

        return $this;
    }

withName()

withName

(

$name

)

Parameters

string

$name

Returns

$this

Definition at line 98 of file TestDataArrayBuilder.php.

    {
        $this->testName = $name;
        return $this;
    }

withTestActions()

withTestActions

(

$actions = null

)

Add test actions passed in by arg (or default if no arg)

Parameters

array

$actions

Returns

$this

Definition at line 189 of file TestDataArrayBuilder.php.

    {
        if ($actions == null) {
            $this->testActions = [$this->testTestActionName => [
                ActionObjectExtractor::NODE_NAME => $this->testActionType,
                ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testTestActionName
            ]];
        } else {
            $this->testActions = $actions;
        }

        return $this;
    }

withTestReference()

withTestReference

(

$reference = null

)

Add test reference passed in by arg (or default if no arg)

Parameters

string

$reference

Returns

$this

Definition at line 226 of file TestDataArrayBuilder.php.

    {
        if ($reference != null) {
            $this->testReference = $reference;
        }

        return $this;
    }

Field Documentation

$filename

$filename = null

Definition at line 27 of file TestDataArrayBuilder.php.

$testActionAfterName

$testActionAfterName = 'testActionAfter'

Definition at line 41 of file TestDataArrayBuilder.php.

$testActionBeforeName

$testActionBeforeName = 'testActionBefore'

Definition at line 34 of file TestDataArrayBuilder.php.

$testActionFailedName

$testActionFailedName = 'testActionFailed'

Definition at line 48 of file TestDataArrayBuilder.php.

$testActionType

$testActionType = 'testAction'

Definition at line 62 of file TestDataArrayBuilder.php.

$testName

$testName = 'testTest'

Definition at line 20 of file TestDataArrayBuilder.php.

$testTestActionName

$testTestActionName = 'testActionInTest'

Definition at line 55 of file TestDataArrayBuilder.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-functional-testing-framework/dev/tests/unit/Util/TestDataArrayBuilder.php