Skip to content

Add unit tests for Events AAMSettings class #3369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sol-loup wants to merge 2 commits into from
Closed

Add unit tests for Events AAMSettings class #3369

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa91ae2
Add unit tests for Events AAMSettings class
sol-loup Jun 13, 2025
0e19076
Update version placeholder to 3.5.2
sol-loup Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
245 changes: 245 additions & 0 deletions tests/Unit/Events/AAMSettingsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,245 @@
<?php
declare( strict_types=1 );

namespace WooCommerce\Facebook\Tests\Unit\Events;

use WooCommerce\Facebook\Events\AAMSettings;
use WooCommerce\Facebook\Tests\AbstractWPUnitTestWithOptionIsolationAndSafeFiltering;

/**
* Unit tests for Events AAMSettings class.
*
* @since 3.5.2
*/
class AAMSettingsTest extends AbstractWPUnitTestWithOptionIsolationAndSafeFiltering {

/**
* Test that the AAMSettings class exists and can be instantiated.
*/
public function test_aam_settings_class_exists() {
$this->assertTrue( class_exists( AAMSettings::class ) );
}

/**
* Test AAMSettings instantiation with empty data.
*/
public function test_aam_settings_with_empty_data() {
$settings = new AAMSettings();

$this->assertNull( $settings->get_enable_automatic_matching() );
$this->assertNull( $settings->get_enabled_automatic_matching_fields() );
$this->assertNull( $settings->get_pixel_id() );
}

/**
* Test AAMSettings instantiation with complete data.
*/
public function test_aam_settings_with_complete_data() {
$data = [
'enableAutomaticMatching' => true,
'enabledAutomaticMatchingFields' => [ 'em', 'fn', 'ln', 'ph' ],
'pixelId' => '1234567890',
];

$settings = new AAMSettings( $data );

$this->assertTrue( $settings->get_enable_automatic_matching() );
$this->assertEquals( [ 'em', 'fn', 'ln', 'ph' ], $settings->get_enabled_automatic_matching_fields() );
$this->assertEquals( '1234567890', $settings->get_pixel_id() );
}

/**
* Test AAMSettings with partial data.
*/
public function test_aam_settings_with_partial_data() {
$data = [
'enableAutomaticMatching' => false,
'pixelId' => '9876543210',
];

$settings = new AAMSettings( $data );

$this->assertFalse( $settings->get_enable_automatic_matching() );
$this->assertNull( $settings->get_enabled_automatic_matching_fields() );
$this->assertEquals( '9876543210', $settings->get_pixel_id() );
}

/**
* Test setting enable automatic matching.
*/
public function test_set_enable_automatic_matching() {
$settings = new AAMSettings();

$result = $settings->set_enable_automatic_matching( true );
$this->assertInstanceOf( AAMSettings::class, $result );
$this->assertTrue( $settings->get_enable_automatic_matching() );

$settings->set_enable_automatic_matching( false );
$this->assertFalse( $settings->get_enable_automatic_matching() );
}

/**
* Test setting enabled automatic matching fields.
*/
public function test_set_enabled_automatic_matching_fields() {
$settings = new AAMSettings();
$fields = [ 'em', 'fn', 'ln', 'ph', 'ct', 'st', 'zp' ];

$result = $settings->set_enabled_automatic_matching_fields( $fields );
$this->assertInstanceOf( AAMSettings::class, $result );
$this->assertEquals( $fields, $settings->get_enabled_automatic_matching_fields() );

// Test with empty array
$settings->set_enabled_automatic_matching_fields( [] );
$this->assertEquals( [], $settings->get_enabled_automatic_matching_fields() );
}

/**
* Test setting pixel ID.
*/
public function test_set_pixel_id() {
$settings = new AAMSettings();
$pixelId = '1234567890';

$result = $settings->set_pixel_id( $pixelId );
$this->assertInstanceOf( AAMSettings::class, $result );
$this->assertEquals( $pixelId, $settings->get_pixel_id() );

// Test with different pixel ID
$settings->set_pixel_id( '0987654321' );
$this->assertEquals( '0987654321', $settings->get_pixel_id() );
}

/**
* Test method chaining.
*/
public function test_method_chaining() {
$settings = new AAMSettings();

$result = $settings
->set_enable_automatic_matching( true )
->set_enabled_automatic_matching_fields( [ 'em', 'fn' ] )
->set_pixel_id( '123456' );

$this->assertInstanceOf( AAMSettings::class, $result );
$this->assertTrue( $settings->get_enable_automatic_matching() );
$this->assertEquals( [ 'em', 'fn' ], $settings->get_enabled_automatic_matching_fields() );
$this->assertEquals( '123456', $settings->get_pixel_id() );
}

/**
* Test get_url static method.
*/
public function test_get_url() {
$pixelId = '1234567890';
$expectedUrl = 'https://connect.facebook.net/signals/config/json/' . $pixelId;

$url = AAMSettings::get_url( $pixelId );

$this->assertEquals( $expectedUrl, $url );
}

/**
* Test get_url with different pixel IDs.
*/
public function test_get_url_with_various_pixel_ids() {
$testCases = [
'123' => 'https://connect.facebook.net/signals/config/json/123',
'abc123xyz' => 'https://connect.facebook.net/signals/config/json/abc123xyz',
'9876543210' => 'https://connect.facebook.net/signals/config/json/9876543210',
];

foreach ( $testCases as $pixelId => $expectedUrl ) {
$this->assertEquals( $expectedUrl, AAMSettings::get_url( $pixelId ) );
}
}

/**
* Test toString method with all data.
*/
public function test_to_string_with_all_data() {
$data = [
'enableAutomaticMatching' => true,
'enabledAutomaticMatchingFields' => [ 'em', 'fn', 'ln' ],
'pixelId' => '1234567890',
];

$settings = new AAMSettings( $data );
$json = (string) $settings;

$decoded = json_decode( $json, true );

$this->assertIsArray( $decoded );
$this->assertTrue( $decoded['enableAutomaticMatching'] );
$this->assertEquals( [ 'em', 'fn', 'ln' ], $decoded['enabledAutomaticMatchingFields'] );
$this->assertEquals( '1234567890', $decoded['pixelId'] );
}

/**
* Test toString method with null values.
*/
public function test_to_string_with_null_values() {
$settings = new AAMSettings();
$json = (string) $settings;

$decoded = json_decode( $json, true );

$this->assertIsArray( $decoded );
$this->assertNull( $decoded['enableAutomaticMatching'] );
$this->assertNull( $decoded['enabledAutomaticMatchingFields'] );
$this->assertNull( $decoded['pixelId'] );
}

/**
* Test toString method with mixed values.
*/
public function test_to_string_with_mixed_values() {
$settings = new AAMSettings();
$settings->set_enable_automatic_matching( false )
->set_enabled_automatic_matching_fields( [] )
->set_pixel_id( 'test123' );

$json = (string) $settings;
$decoded = json_decode( $json, true );

$this->assertFalse( $decoded['enableAutomaticMatching'] );
$this->assertEquals( [], $decoded['enabledAutomaticMatchingFields'] );
$this->assertEquals( 'test123', $decoded['pixelId'] );
}

/**
* Test AAMSettings with boolean string values.
*/
public function test_aam_settings_with_boolean_string_values() {
$data = [
'enableAutomaticMatching' => 'true', // string instead of boolean
'enabledAutomaticMatchingFields' => [ 'em' ],
'pixelId' => '123',
];

$settings = new AAMSettings( $data );

// PHP will treat the string 'true' as truthy
$this->assertEquals( 'true', $settings->get_enable_automatic_matching() );
}

/**
* Test AAMSettings with unexpected data keys.
*/
public function test_aam_settings_with_unexpected_keys() {
$data = [
'enableAutomaticMatching' => true,
'enabledAutomaticMatchingFields' => [ 'em' ],
'pixelId' => '123',
'unexpectedKey' => 'unexpectedValue',
'anotherKey' => 123,
];

$settings = new AAMSettings( $data );

// Should only set the expected properties
$this->assertTrue( $settings->get_enable_automatic_matching() );
$this->assertEquals( [ 'em' ], $settings->get_enabled_automatic_matching_fields() );
$this->assertEquals( '123', $settings->get_pixel_id() );
}
}