IBX-6330: [Behat] Cover "My Drafts" Page #878

jwibexa · 2023-08-22T13:54:32Z

Question	Answer
Tickets	https://issues.ibexa.co/browse/IBX-6330
Bug fix?	no
New feature?	yes
BC breaks?	yes/no
Tests pass?	yes/no
Doc needed?	yes/no
License	GPL-2.0

Checklist:

Coding standards ($ composer fix-cs)
Ready for Code Review

…sions.

mnocon

Looks very, very promising, great start! 🎖️

mnocon · 2023-08-23T06:51:18Z

features/standard/MyDrafts.feature

+
+  Scenario: It is possible to delete a draft
+   Given I create "article" Content drafts
+      | title     | short_title | parentPath | language |


Nitpick: it would be best if the columns were aligned for better readability

mnocon · 2023-08-23T06:52:35Z

src/bundle/Resources/config/services/test/pages.yaml

@@ -56,7 +56,7 @@ services:

  Ibexa\AdminUi\Behat\Page\ChangePasswordPage: ~

-  Ibexa\AdminUi\Behat\Page\UserSettingsPage: ~
+  Ibexa\AdminUi\Behat\Page\MyDraftsPage: ~


Nice catch finding that the UserSettingPage service definition is doubled 💪

mnocon · 2023-08-23T06:53:20Z

src/lib/Behat/BrowserContext/MyDraftsContext.php

+     */
+    public function iSeeTheDraftIsDeleted(string $draftName): void
+    {
+        assert($this->myDraftsPage->doSeeDraft($draftName));


In our case we don't want to see the draft - we expect doSeeDraft to return false. Also we use PHPUnit's assertions, so the code could look like this:

Assert::assertFalse($this->myDraftsPage->doSeeDraft($draftName))

mnocon · 2023-08-23T06:56:55Z

src/lib/Behat/BrowserContext/MyDraftsContext.php

+     */
+    public function iClickEdit(string $draftName): void
+    {
+        $this->myDraftsPage->clickEditDraft($draftName);


Suggested change

$this->myDraftsPage->clickEditDraft($draftName);

$this->myDraftsPage->edit($draftName);

It's better to avoid naming the action (clicking, hovering, ...) directly - it's the intention that matters the most (editing), not the action (clicking). The action can change in future redesigns, avoiding naming it makes our lives a little easier

mnocon · 2023-08-23T06:57:11Z

src/lib/Behat/BrowserContext/MyDraftsContext.php

+    }
+
+    /**
+     * @Given I click edit :draftName


Suggested change

* @Given I click edit :draftName

* @Given I edit :draftName draft on MyDrafts page

I'm afraid that a I click edit :string step definition is too generic

mnocon · 2023-08-23T06:57:35Z

features/standard/MyDrafts.feature

+      | Short title | TestMyDraftSavePublish |
+      | Intro       | TestMyDraftIntro       |
+    And I click on the edit action bar button "Save"
+    Then I should be on Content update page for "TestMyDraftSavePublish"


Nitpick: missing newline

mnocon · 2023-08-23T06:58:14Z

src/lib/Behat/Page/MyDraftsPage.php

+    }
+
+    public function verifyIsLoaded(): void
+    {


Please fill in this method - we can make sure that the correct page title (header) is displayed.

mnocon · 2023-08-23T07:01:13Z

src/lib/Behat/Page/MyDraftsPage.php

+        $this->dialog->confirm();
+    }
+
+    public function doSeeDraft(string $draftName): bool


Suggested change

public function doSeeDraft(string $draftName): bool

public function isDraftOnTheList(string $draftName): bool

We can use https://github.com/ibexa/admin-ui/blob/main/src/lib/Behat/Component/Table/TableInterface.php#L15 here, meaning that we should be able to do this:

public function isDraftOnTheList(string $draftName): bool { return $this->table->hasElement(['Name' => $draftName]); }

mnocon

Looks great, thanks! 😎

mnocon · 2023-08-24T06:52:40Z

features/standard/MyDrafts.feature

+      | TestMyDraft | TestMyDraft   | root       | eng-GB   |
+    And I am logged as admin
+    And I open "MyDrafts" page in admin SiteAccess
+    When I click edit "TestMyDraft" on MyDrafts page


Suggested change

When I click edit "TestMyDraft" on MyDrafts page

When I edit "TestMyDraft" on MyDrafts page

Just one small suggestion

sonarcloud · 2023-08-24T07:26:46Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

katarzynazawada · 2023-08-24T08:19:55Z

What about 4.5 version? Shouldn't we add those tests there as well? 🙂

mnocon · 2023-08-24T10:22:08Z

When creating this task I thought that 4.6 is enough, it makes the task a bit easier (no need for upmerge changes etc. - and this is the first task for Kuba).

We can backport it as a follow-up, what do you think?

micszo

Great start! 🚀

* Initial implementation * FInished the task of testing draft deletion * Added the test for the edition of draft, splited the tests into 2 versions. * cleanup * Improvemtn of the edit table selector * Fixes regarding editing draft selectors * code style check fix * Fixes regarding veryfiing deletion, style fixes, veryfiisloaded added * Added fix regarding not finding delete confirmation, naming fix --------- Co-authored-by: Marek Nocoń <mnocon@users.noreply.github.com> (cherry picked from commit b0e1549)

* IBX-6330: [Behat] Cover "My Drafts" Page (#878) * Initial implementation * FInished the task of testing draft deletion * Added the test for the edition of draft, splited the tests into 2 versions. * cleanup * Improvemtn of the edit table selector * Fixes regarding editing draft selectors * code style check fix * Fixes regarding veryfiing deletion, style fixes, veryfiisloaded added * Added fix regarding not finding delete confirmation, naming fix --------- Co-authored-by: Marek Nocoń <mnocon@users.noreply.github.com> (cherry picked from commit b0e1549) * Cover "My Drafts" Page * Cleanup

mnocon and others added 6 commits August 17, 2023 16:18

Initial implementation

15e4db1

FInished the task of testing draft deletion

a101525

Added the test for the edition of draft, splited the tests into 2 ver…

ce02d33

…sions.

cleanup

ce60cf9

Improvemtn of the edit table selector

d18ed29

Fixes regarding editing draft selectors

46ff77d

github-actions bot assigned ciastektk, mikadamczyk, Nattfarinn and ViniTou Aug 22, 2023

code style check fix

7598d52

mnocon reviewed Aug 23, 2023

View reviewed changes

Fixes regarding veryfiing deletion, style fixes, veryfiisloaded added

0564386

jwibexa mentioned this pull request Aug 23, 2023

IBX-6330: Cover "My Drafts" Page, adding new contexts ibexa/behat#73

Merged

jwibexa requested a review from a team August 23, 2023 14:01

mnocon approved these changes Aug 24, 2023

View reviewed changes

Added fix regarding not finding delete confirmation, naming fix

ed4d919

jwibexa requested review from micszo, katarzynazawada, tomaszszopinski, bogusez and krzbro August 24, 2023 08:21

katarzynazawada approved these changes Aug 24, 2023

View reviewed changes

micszo approved these changes Aug 25, 2023

View reviewed changes

bogusez approved these changes Aug 25, 2023

View reviewed changes

micszo changed the title ~~IBX - 6330 Cover "My Drafts" Page~~ IBX-6330: [Behat] Cover "My Drafts" Page Aug 25, 2023

micszo merged commit b0e1549 into main Aug 25, 2023
16 checks passed

micszo deleted the behat-training branch August 25, 2023 09:01

jwibexa mentioned this pull request Aug 31, 2023

IBX-6406: Cover "My Drafts" Page - Back-port to 4.5 #890

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IBX-6330: [Behat] Cover "My Drafts" Page #878

IBX-6330: [Behat] Cover "My Drafts" Page #878

jwibexa commented Aug 22, 2023 •

edited

Loading

mnocon left a comment

mnocon Aug 23, 2023

mnocon Aug 23, 2023

mnocon Aug 23, 2023

mnocon Aug 23, 2023

mnocon Aug 23, 2023

mnocon Aug 23, 2023

mnocon Aug 23, 2023

mnocon Aug 23, 2023

mnocon left a comment

mnocon Aug 24, 2023

sonarcloud bot commented Aug 24, 2023

katarzynazawada commented Aug 24, 2023

mnocon commented Aug 24, 2023

micszo left a comment

	$this->myDraftsPage->clickEditDraft($draftName);
	$this->myDraftsPage->edit($draftName);

	* @Given I click edit :draftName
	* @Given I edit :draftName draft on MyDrafts page

	public function doSeeDraft(string $draftName): bool
	public function isDraftOnTheList(string $draftName): bool

	When I click edit "TestMyDraft" on MyDrafts page
	When I edit "TestMyDraft" on MyDrafts page

IBX-6330: [Behat] Cover "My Drafts" Page #878

IBX-6330: [Behat] Cover "My Drafts" Page #878

Conversation

jwibexa commented Aug 22, 2023 • edited Loading

Checklist:

mnocon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mnocon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Aug 24, 2023

katarzynazawada commented Aug 24, 2023

mnocon commented Aug 24, 2023

micszo left a comment

Choose a reason for hiding this comment

jwibexa commented Aug 22, 2023 •

edited

Loading