Skip to content

chore: Add unit tests for MediaSharing and REST modules - Phase 3 #137

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

Open
sabbir1991 wants to merge 3 commits into
base: chore/php-unit-testing-phase-2
Choose a base branch
from
Open

chore: Add unit tests for MediaSharing and REST modules - Phase 3 #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c0be41
chore: Add unit tests for MediaSharing and REST
sabbir1991 Jun 5, 2026
6d59e53
chore: Add unit tests for few missing new REST code
sabbir1991 Jun 5, 2026
d57e30b
chore: Add unit tests for MediaSharing module
sabbir1991 Jun 5, 2026
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
86 changes: 86 additions & 0 deletions tests/phpunit/Unit/Modules/MediaSharing/AdminTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?php
/**
* Tests for the MediaSharing\Admin class.
*
* @package OneMedia\Tests\Unit\Modules\MediaSharing
*/

declare( strict_types = 1 );

namespace OneMedia\Tests\Unit\Modules\MediaSharing;

use OneMedia\Modules\Core\Assets;
use OneMedia\Modules\MediaSharing\Admin;
use OneMedia\Modules\Settings\Settings;
use OneMedia\Tests\TestCase;
use PHPUnit\Framework\Attributes\CoversClass;

/**
* Tests for the MediaSharing\Admin class.
*/
#[CoversClass( Admin::class )]
final class AdminTest extends TestCase {
/**
* {@inheritDoc}
*/
protected function tearDown(): void {
delete_option( Settings::OPTION_SITE_TYPE );

parent::tearDown();
}

/**
* Tests no errors on hook registration.
*/
public function test_register_hooks_adds_expected_hooks(): void {
$admin = new Admin();
$admin->register_hooks();

$this->assertTrue( true );
}

/**
* Tests add_submenu returns early when the site is not governing.
*/
public function test_add_submenu_returns_early_when_not_governing(): void {
update_option( Settings::OPTION_SITE_TYPE, Settings::SITE_TYPE_CONSUMER );

$admin = new Admin();
$admin->add_submenu();

$this->assertTrue( true );
}

/**
* Tests screen_callback outputs the media sharing mount point.
*/
public function test_screen_callback_outputs_expected_html(): void {
$admin = new Admin();

ob_start();
$admin->screen_callback();
$output = ob_get_clean();

$this->assertStringContainsString( 'onemedia-media-sharing', (string) $output );
}

/**
* Tests enqueue_scripts returns early for non-OneMedia admin pages.
*/
public function test_enqueue_scripts_returns_early_for_non_onemedia_hook(): void {
$admin = new Admin();
$admin->enqueue_scripts( 'plugins.php' );

$this->assertFalse( wp_script_is( Assets::MEDIA_SHARING_SCRIPT_HANDLE, 'enqueued' ) );
}

/**
* Tests add_help_tabs returns early without a matching current screen.
*/
public function test_add_help_tabs_returns_early_for_non_matching_screen(): void {
$admin = new Admin();
$admin->add_help_tabs();

$this->assertTrue( true );
}
}
21 changes: 21 additions & 0 deletions tests/phpunit/Unit/Modules/MediaSharing/AttachmentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,25 @@ public function test_update_and_get_sync_attachment_versions(): void {
public function test_get_sync_attachment_versions_returns_empty_when_not_set(): void {
$this->assertSame( [], Attachment::get_sync_attachment_versions( $this->attachment_id ) );
}

/**
* Tests update_sync_attachment_versions returns false for empty versions.
*/
public function test_update_sync_attachment_versions_returns_false_for_empty_versions(): void {
$this->assertFalse( Attachment::update_sync_attachment_versions( $this->attachment_id, [] ) );
}

/**
* Tests health_check_attachment_brand_sites returns an error payload for invalid attachment IDs.
*/
public function test_health_check_attachment_brand_sites_returns_error_payload_for_invalid_attachment_id(): void {
$this->assertSame(
[
'success' => false,
'failed_sites' => [],
'message' => 'Invalid attachment ID.',
],
Attachment::health_check_attachment_brand_sites( null )
);
}
}
256 changes: 256 additions & 0 deletions tests/phpunit/Unit/Modules/MediaSharing/MediaActionsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,256 @@
<?php
/**
* Tests for the MediaSharing\MediaActions class.
*
* @package OneMedia\Tests\Unit\Modules\MediaSharing
*/

declare( strict_types = 1 );

namespace OneMedia\Tests\Unit\Modules\MediaSharing;

use OneMedia\Modules\MediaSharing\Attachment;
use OneMedia\Modules\MediaSharing\MediaActions;
use OneMedia\Modules\Settings\Settings;
use OneMedia\Tests\TestCase;
use PHPUnit\Framework\Attributes\CoversClass;

/**
* Tests for the MediaSharing\MediaActions class.
*/
#[CoversClass( MediaActions::class )]
final class MediaActionsTest extends TestCase {
/**
* Attachment post for testing.
*
* @var \WP_Post
*/
private \WP_Post $attachment;

/**
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();

$this->attachment = get_post( self::factory()->attachment->create() );
}

/**
* {@inheritDoc}
*/
protected function tearDown(): void {
delete_option( Settings::OPTION_SITE_TYPE );
delete_option( Settings::BRAND_SITES_SYNCED_MEDIA );

parent::tearDown();
}

/**
* Tests no errors on hook registration.
*/
public function test_register_hooks_adds_expected_hooks(): void {
$actions = new MediaActions();
$actions->register_hooks();

$this->assertTrue( true );
}

/**
* Tests add_replace_media_button returns unchanged fields on consumer sites.
*/
public function test_add_replace_media_button_returns_fields_on_consumer_site(): void {
update_option( Settings::OPTION_SITE_TYPE, Settings::SITE_TYPE_CONSUMER );

$actions = new MediaActions();
$form_fields = [ 'title' => [ 'label' => 'Title' ] ];

$this->assertSame( $form_fields, $actions->add_replace_media_button( $form_fields, $this->attachment ) );
}

/**
* Tests add_replace_media_button returns unchanged fields for non-synced media.
*/
public function test_add_replace_media_button_returns_fields_for_non_synced_media(): void {
$actions = new MediaActions();
$form_fields = [ 'title' => [ 'label' => 'Title' ] ];

$this->assertSame( $form_fields, $actions->add_replace_media_button( $form_fields, $this->attachment ) );
}

/**
* Tests add_replace_media_button adds the replace media field for synced governing media.
*/
public function test_add_replace_media_button_adds_field_for_synced_media(): void {
update_option( Settings::OPTION_SITE_TYPE, Settings::SITE_TYPE_GOVERNING );
Attachment::set_is_synced( $this->attachment->ID, true );

$actions = new MediaActions();
$result = $actions->add_replace_media_button( [], $this->attachment );

$this->assertArrayHasKey( 'replace_media', $result );
$this->assertSame( 'Replace Media', $result['replace_media']['label'] );
$this->assertStringContainsString( 'replace-media-react-container', $result['replace_media']['html'] );
}

/**
* Tests remove_sync_meta returns early when there is no synced media option.
*/
public function test_remove_sync_meta_returns_early_without_synced_media_option(): void {
Attachment::set_is_synced( $this->attachment->ID, true );

$actions = new MediaActions();
$actions->remove_sync_meta( $this->attachment->ID );

$this->assertTrue( Attachment::is_sync_attachment( $this->attachment->ID ) );
}

/**
* Tests remove_sync_meta removes local sync metadata and option mapping.
*/
public function test_remove_sync_meta_removes_local_sync_data(): void {
Attachment::set_is_synced( $this->attachment->ID, true );
update_post_meta(
$this->attachment->ID,
Attachment::SYNC_SITES_POSTMETA_KEY,
[
[
'site' => 'https://brand.example',
'id' => 123,
],
]
);
update_option(
Settings::BRAND_SITES_SYNCED_MEDIA,
[
$this->attachment->ID => [ 'https://brand.example' => 123 ],
]
);

$actions = new MediaActions();
$actions->remove_sync_meta( $this->attachment->ID );

$this->assertFalse( Attachment::is_sync_attachment( $this->attachment->ID ) );
$this->assertSame( '', get_post_meta( $this->attachment->ID, Attachment::SYNC_SITES_POSTMETA_KEY, true ) );
$this->assertSame( [], get_option( Settings::BRAND_SITES_SYNCED_MEDIA ) );
}

/**
* Tests sanitize_file_input returns an error when no file is provided.
*/
public function test_sanitize_file_input_returns_error_for_missing_file(): void {
$actions = new MediaActions();
$result = $actions->sanitize_file_input( null );

$this->assertWPError( $result );
$this->assertSame( 'invalid_input', $result->get_error_code() );
}

/**
* Tests sanitize_file_input returns an error for unsupported mime types.
*/
public function test_sanitize_file_input_returns_error_for_invalid_file_type(): void {
$actions = new MediaActions();
$result = $actions->sanitize_file_input(
[
'name' => 'document.pdf',
'type' => 'application/pdf',
'tmp_name' => '/tmp/document.pdf',
'error' => 0,
'size' => 100,
]
);

$this->assertWPError( $result );
$this->assertSame( 'invalid_file_type', $result->get_error_code() );
}

/**
* Tests sanitize_file_input returns sanitized supported file data.
*/
public function test_sanitize_file_input_returns_sanitized_file_data(): void {
$actions = new MediaActions();
$result = $actions->sanitize_file_input(
[
'name' => 'Test &amp; Image.jpg',
'type' => 'image/jpeg',
'tmp_name' => '/tmp/test-image.jpg',
'error' => 0,
'size' => '100',
'attachment_id' => '12',
'url' => 'https://example.com/test-image.jpg',
'alt' => 'Alt text',
'caption' => 'Caption text',
]
);

$this->assertSame(
[
'name' => 'Test-amp-Image.jpg',
'type' => 'image/jpeg',
'tmp_name' => '/tmp/test-image.jpg',
'error' => 0,
'size' => 100,
'attachment_id' => 12,
'url' => 'https://example.com/test-image.jpg',
'alt' => 'Alt text',
'caption' => 'Caption text',
],
$result
);
}

/**
* Tests update_attachment returns an error for invalid attachments.
*/
public function test_update_attachment_returns_error_for_invalid_attachment(): void {
$actions = new MediaActions();
$result = $actions->update_attachment( 0, [] );

$this->assertWPError( $result );
$this->assertSame( 'invalid_attachment', $result->get_error_code() );
}

/**
* Tests restore_attachment_version returns an error when no version history exists.
*/
public function test_restore_attachment_version_returns_error_without_version_history(): void {
$actions = new MediaActions();
$result = $actions->restore_attachment_version(
$this->attachment->ID,
[
'path' => '/tmp/missing.jpg',
]
);

$this->assertWPError( $result );
$this->assertSame( 'no_version_history', $result->get_error_code() );
}

/**
* Tests add_sync_meta returns the original response when attachment ID is missing.
*/
public function test_add_sync_meta_returns_response_when_attachment_id_missing(): void {
$actions = new MediaActions();
$response = [ 'id' => 0 ];

$this->assertSame( $response, $actions->add_sync_meta( $response, new \stdClass() ) );
}

/**
* Tests add_sync_meta adds the sync status for attachment responses.
*/
public function test_add_sync_meta_adds_sync_status(): void {
Attachment::set_is_synced( $this->attachment->ID, true );

$actions = new MediaActions();

$this->assertSame(
[
'id' => $this->attachment->ID,
'is_onemedia_sync' => true,
],
$actions->add_sync_meta( [ 'id' => $this->attachment->ID ], $this->attachment )
);
}
}
Loading
Loading