Skip to content
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

Jump to bottom

tests: Add tests for CoreHeading block #10

Merged
merged 14 commits into from
Sep 26, 2024
Merged

tests: Add tests for CoreHeading block #10

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
0ca59a1
feat: Add CoreHeadingTest
ashutoshgautams Sep 14, 2024
039a0d1
chore: refactor CoreHeadingTest
justlevine Sep 15, 2024
92e7ae6
chore: cleanup
justlevine Sep 15, 2024
cdec9ee
feat: Add tests for additional snippets
ashutoshgautams Sep 18, 2024
c0df3f1
Merge branch 'core-heading-test' of https://github.com/rtcamp/wp-grap…
justlevine Sep 18, 2024
eaf44ca
chore: phpcbf
justlevine Sep 18, 2024
9be31c6
fix: Update new tests so assertEquals()
ashutoshgautams Sep 18, 2024
7301ed9
feat: Add a changeset for patch
ashutoshgautams Sep 18, 2024
530233b
fix: Fix the remaining annotations and phpcbf
ashutoshgautams Sep 19, 2024
a474a46
fix: Add test coverage for preset color and font
ashutoshgautams Sep 23, 2024
ba1e532
fix: Remove phpcs.xml
ashutoshgautams Sep 23, 2024
110103c
fix: Add doc-blocks, remove duplicate tests
ashutoshgautams Sep 23, 2024
33d60f5
fix: Add a lock attribue test
ashutoshgautams Sep 23, 2024
9bc6fe9
docs: Add explicit list of "previously untested" attributes
ashutoshgautams Sep 23, 2024
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
290 changes: 50 additions & 240 deletions tests/unit/CoreHeadingTest.php
View file
Open in desktop
justlevine marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,16 @@
namespace WPGraphQL\ContentBlocks\Unit;

final class CoreHeadingTest extends PluginTestCase {
public int $post_id;

/**
* The ID of the post created for the test.
*
* @var int
*/
public $post_id;

/**
* Set up the test environment.
*/
public function setUp(): void {
parent::setUp();

Expand All @@ -19,6 +27,9 @@ public function setUp(): void {
\WPGraphQL::clear_schema();
}

/**
* Tear down the test environment.
*/
public function tearDown(): void {
parent::tearDown();

Expand All @@ -27,6 +38,11 @@ public function tearDown(): void {
\WPGraphQL::clear_schema();
}

/**
* Provide the GraphQL query for testing.
*
* @return string The GraphQL query.
*/
public function query(): string {
return '
fragment CoreHeadingBlockFragment on CoreHeading {
Expand Down Expand Up @@ -74,6 +90,11 @@ className
';
}

/**
* Test the retrieval of core/heading block attributes.
*
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The important part of the doc blocks I was referencing was the explicit list of "previously untested" attributes, so it's clear at a glance what each test is covering.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from line 94, everywhere else 'doc blocks' already contains => explicit list of "previously untested" attributes.
Added it here as well.

* @return void
*/
public function test_retrieve_core_heading_attributes() {
$block_content = '
<!-- wp:heading {"level":2,"textAlign":"center","style":{"typography":{"fontSize":"28px","fontStyle":"normal","fontWeight":"700"}}} -->
Expand Down Expand Up @@ -145,6 +166,11 @@ public function test_retrieve_core_heading_attributes() {
);
}

/**
* Test retrieval of core/heading block with colors and alignment.
*
* @return void
*/
public function test_retrieve_core_heading_with_colors_and_alignment() {
$block_content = '
<!-- wp:heading {"level":3,"textAlign":"right","align":"wide","style":{"color":{"background":"#cf2e2e","text":"#ffffff"}}} -->
Expand Down Expand Up @@ -198,6 +224,11 @@ public function test_retrieve_core_heading_with_colors_and_alignment() {
);
}

/**
* Test retrieval of core/heading block with background and text color.
*
* @return void
*/
public function test_retrieve_core_heading_with_background_text_color() {
$block_content = '
<!-- wp:heading {"textAlign":"right","level":3,"align":"wide","backgroundColor":"accent-4","textColor":"accent-3"} -->
Expand Down Expand Up @@ -244,6 +275,11 @@ public function test_retrieve_core_heading_with_background_text_color() {
);
}

/**
* Test retrieval of core/heading block with font and anchor.
*
* @return void
*/
public function test_retrieve_core_heading_with_font_and_anchor() {
$block_content = '
<!-- wp:heading {"anchor":"custom-id","style":{"typography":{"fontFamily":"Arial","fontSize":"32px"}}} -->
Expand Down Expand Up @@ -297,6 +333,11 @@ public function test_retrieve_core_heading_with_font_and_anchor() {
);
}

/**
* Test retrieval of core/heading block with className, font family and font size.
*
* @return void
*/
public function test_retrieve_core_heading_with_font_family_and_size() {
$block_content = '
<!-- wp:heading {"className":"is-style-default","backgroundColor":"accent","textColor":"contrast-2","fontSize":"xx-large","fontFamily":"system-sans-serif"} -->
Expand Down Expand Up @@ -326,7 +367,7 @@ public function test_retrieve_core_heading_with_font_family_and_size() {
'align' => null,
'anchor' => null,
'backgroundColor' => 'accent',
'className' => 'is-style-default',
'className' => 'is-style-default', // Previously untested
'content' => 'hurrah',
'cssClassName' => 'wp-block-heading is-style-default has-contrast-2-color has-accent-background-color has-text-color has-background has-system-sans-serif-font-family has-xx-large-font-size',
'fontFamily' => 'system-sans-serif', // Previously untested
Expand All @@ -343,6 +384,11 @@ public function test_retrieve_core_heading_with_font_family_and_size() {
);
}

/**
* Test retrieval of core/heading block with font size & gradient.
*
* @return void
*/
public function test_retrieve_core_heading_with_gradient() {
$block_content = '
<!-- wp:heading {"gradient":"gradient-3","fontSize":"medium"} -->
Expand Down Expand Up @@ -376,7 +422,7 @@ public function test_retrieve_core_heading_with_gradient() {
'content' => 'hello',
'cssClassName' => 'wp-block-heading has-gradient-3-gradient-background has-background has-medium-font-size',
'fontFamily' => null,
'fontSize' => 'medium',
'fontSize' => 'medium', // Previously untested
'gradient' => 'gradient-3', // Previously untested
'level' => 2.0,
'lock' => null,
Expand All @@ -388,240 +434,4 @@ public function test_retrieve_core_heading_with_gradient() {
$attributes
);
}

public function test_retrieve_core_heading_with_custom_gradient() {
$block_content = '
<!-- wp:heading {"style":{"color":{"gradient":"linear-gradient(135deg,rgb(6,147,227) 0%,rgb(155,81,224) 100%)"}}} -->
<h2 class="wp-block-heading has-background" style="background:linear-gradient(135deg,rgb(6,147,227) 0%,rgb(155,81,224) 100%)">Gradient Heading</h2>
<!-- /wp:heading -->
';

wp_update_post(
[
'ID' => $this->post_id,
'post_content' => $block_content,
]
);

$actual = graphql(
[
'query' => $this->query(),
'variables' => [ 'id' => $this->post_id ],
]
);

$block = $actual['data']['post']['editorBlocks'][0];
$attributes = $block['attributes'];

$this->assertEquals(
[
'align' => null,
'anchor' => null,
'backgroundColor' => null,
'className' => null,
'content' => 'Gradient Heading',
'cssClassName' => 'wp-block-heading has-background',
'fontFamily' => null,
'fontSize' => null,
'gradient' => null,
'level' => 2.0,
'lock' => null,
'placeholder' => null,
'style' => wp_json_encode(
[
'color' => [
'gradient' => 'linear-gradient(135deg,rgb(6,147,227) 0%,rgb(155,81,224) 100%)',
],
]
),
'textAlign' => null,
'textColor' => null,
],
$attributes
);
}

public function test_retrieve_core_heading_with_background_color() {
$block_content = '
<!-- wp:heading {"backgroundColor":"vivid-red-background-color"} -->
<h2 class="wp-block-heading has-vivid-red-background-color has-background">Heading with Background Color</h2>
<!-- /wp:heading>
';

wp_update_post(
[
'ID' => $this->post_id,
'post_content' => $block_content,
]
);

$actual = graphql(
[
'query' => $this->query(),
'variables' => [ 'id' => $this->post_id ],
]
);

$block = $actual['data']['post']['editorBlocks'][0];
$attributes = $block['attributes'];

$this->assertEquals(
[
'align' => null,
'anchor' => null,
'backgroundColor' => 'vivid-red-background-color',
'className' => null,
'content' => 'Heading with Background Color',
'cssClassName' => 'wp-block-heading has-vivid-red-background-color has-background',
'fontFamily' => null,
'fontSize' => null,
'gradient' => null,
'level' => 2.0,
'lock' => null,
'placeholder' => null,
'style' => null,
'textAlign' => null,
'textColor' => null,
],
$attributes
);
}

public function test_retrieve_core_heading_with_text_color() {
$block_content = '
<!-- wp:heading {"textColor":"vivid-red"} -->
<h2 class="wp-block-heading has-vivid-red-color has-text-color">Heading with Text Color</h2>
<!-- /wp:heading>
';

wp_update_post(
[
'ID' => $this->post_id,
'post_content' => $block_content,
]
);

$actual = graphql(
[
'query' => $this->query(),
'variables' => [ 'id' => $this->post_id ],
]
);

$block = $actual['data']['post']['editorBlocks'][0];
$attributes = $block['attributes'];

$this->assertEquals(
[
'align' => null,
'anchor' => null,
'backgroundColor' => null,
'className' => null,
'content' => 'Heading with Text Color',
'cssClassName' => 'wp-block-heading has-vivid-red-color has-text-color',
'fontFamily' => null,
'fontSize' => null,
'gradient' => null,
'level' => 2.0,
'lock' => null,
'placeholder' => null,
'style' => null,
'textAlign' => null,
'textColor' => 'vivid-red', // Previously untested
],
$attributes
);
}

public function test_retrieve_core_heading_with_font_size() {
$block_content = '
<!-- wp:heading {"fontSize":"large"} -->
<h2 class="wp-block-heading has-large-font-size">Heading with Font Size</h2>
<!-- /wp:heading>
';

wp_update_post(
[
'ID' => $this->post_id,
'post_content' => $block_content,
]
);

$actual = graphql(
[
'query' => $this->query(),
'variables' => [ 'id' => $this->post_id ],
]
);

$block = $actual['data']['post']['editorBlocks'][0];
$attributes = $block['attributes'];

$this->assertEquals(
[
'align' => null,
'anchor' => null,
'backgroundColor' => null,
'className' => null,
'content' => 'Heading with Font Size',
'cssClassName' => 'wp-block-heading has-large-font-size',
'fontFamily' => null,
'fontSize' => 'large', // Previously untested
'gradient' => null,
'level' => 2.0,
'lock' => null,
'placeholder' => null,
'style' => null,
'textAlign' => null,
'textColor' => null,
],
$attributes
);
}

public function test_retrieve_core_heading_with_class_name() {
$block_content = '
<!-- wp:heading {"className":"custom-class"} -->
<h2 class="wp-block-heading custom-class">Heading with Custom Class</h2>
<!-- /wp:heading>
';

wp_update_post(
[
'ID' => $this->post_id,
'post_content' => $block_content,
]
);

$actual = graphql(
[
'query' => $this->query(),
'variables' => [ 'id' => $this->post_id ],
]
);

$block = $actual['data']['post']['editorBlocks'][0];
$attributes = $block['attributes'];

$this->assertEquals(
[
'align' => null,
'anchor' => null,
'backgroundColor' => null,
'className' => 'custom-class', // Previously untested
'content' => 'Heading with Custom Class',
'cssClassName' => 'wp-block-heading custom-class',
'fontFamily' => null,
'fontSize' => null,
'gradient' => null,
'level' => 2.0,
'lock' => null,
'placeholder' => null,
'style' => null,
'textAlign' => null,
'textColor' => null,
],
$attributes
);
}
}