TestLoggingUtil Class Reference

Inheritance diagram for TestLoggingUtil:

Public Member Functions
	setMockLoggingUtil ()
	validateMockLogStatement ($type, $message, $context)
	validateMockLogStatmentRegex ($type, $regex, $context)
	clearMockLoggingUtil ()

Static Public Member Functions
static	getInstance ()

Detailed Description

Definition at line 16 of file TestLoggingUtil.php.

Member Function Documentation

clearMockLoggingUtil()

clearMockLoggingUtil

(

)

Function which clears the test logger context from the LogginUtil class. Should be run after a test class has executed.

Returns

void

Definition at line 101 of file TestLoggingUtil.php.

    {
        AspectMock::clean(LoggingUtil::class);
    }

getInstance()

static getInstance ( )

static

Static singleton get function

Returns

TestLoggingUtil

Definition at line 41 of file TestLoggingUtil.php.

    {
        if (self::$INSTANCE == null) {
            self::$INSTANCE = new TestLoggingUtil();
        }

        return self::$INSTANCE;
    }

setMockLoggingUtil()

setMockLoggingUtil

(

)

Function which sets a mock instance of the logger for testing purposes.

Returns

void

Definition at line 55 of file TestLoggingUtil.php.

    {
        $this->testLogHandler = new TestHandler();
        $testLogger = new MftfLogger('testLogger');
        $testLogger->pushHandler($this->testLogHandler);
        $mockLoggingUtil = AspectMock::double(
            LoggingUtil::class,
            ['getLogger' => $testLogger]
        )->make();
        $property = new \ReflectionProperty(LoggingUtil::class, 'INSTANCE');
        $property->setAccessible(true);
        $property->setValue($mockLoggingUtil);
    }

validateMockLogStatement()

validateMockLogStatement	(		$type,
			$message,
			$context
	)

Function which validates messages have been logged as intended during test execution.

Parameters

string	$type
string	$message
array	$context

Returns

void

Definition at line 77 of file TestLoggingUtil.php.

    {
        $records = $this->testLogHandler->getRecords();
        $record = $records[count($records)-1]; // we assume the latest record is what requires validation
        $this->assertEquals(strtoupper($type), $record['level_name']);
        $this->assertEquals($message, $record['message']);
        $this->assertEquals($context, $record['context']);
    }

validateMockLogStatmentRegex()

validateMockLogStatmentRegex	(		$type,
			$regex,
			$context
	)

Definition at line 86 of file TestLoggingUtil.php.

    {
        $records = $this->testLogHandler->getRecords();
        $record = $records[count($records)-1]; // we assume the latest record is what requires validation
        $this->assertEquals(strtoupper($type), $record['level_name']);
        $this->assertRegExp($regex, $record['message']);
        $this->assertEquals($context, $record['context']);
    }

---

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

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