MNT Behat test LinkField page and LinkField block #162

sabina-talipova · 2024-02-05T07:36:22Z

Parent issue

LinkField is covered by comprehensive Behat test coverage silverstripe-linkfield#98

GuySartorelli · 2024-02-05T08:27:12Z

Both of these should be able to be added as TestOnly extensions directly in linkfield. Happy to help get that working if you need it.
Edit: Turns out you can't do that if the extension is affecting the database. 😓

emteknetnz

Convert the block to an extension that's applied to ElementContent (not BaseElement) and move these classes to the LinkField PR

Also add relevant namespaces to classes after you've done this

emteknetnz · 2024-02-08T03:38:46Z

code/linkfield/Extensions/LinkPageExtension.php

+use SilverStripe\ORM\DataExtension;
+
+class LinkPageExtension extends DataExtension


Suggested change

use SilverStripe\ORM\DataExtension;

class LinkPageExtension extends DataExtension

use SilverStripe\ORM\Extension;

use SilverStripe\Dev\TestOnly;

class LinkPageExtension extends Extension implements TestOnly

DataExtension will be removed in a future version

emteknetnz · 2024-02-08T03:47:08Z

code/linkfield/Blocks/LinksListBlock.php

+<?php
+
+namespace SilverStripe\FrameworkTest\LinkField\Blocks;
+
+use DNADesign\Elemental\Models\BaseElement;
+use SilverStripe\LinkField\Form\LinkField;
+use SilverStripe\LinkField\Form\MultiLinkField;
+use SilverStripe\LinkField\Models\Link;
+use SilverStripe\LinkField\Models\EmailLink;
+use SilverStripe\LinkField\Models\PhoneLink;
+use SilverStripe\LinkField\Models\SiteTreeLink;
+
+class LinksListBlock extends BaseElement
+{
+    private static string $icon = 'font-icon-block-file-list';
+
+    private static string $table_name = 'LinksListBlock';
+
+    private static string $singular_name = 'Links List Block';
+
+    private static string $plural_name = 'Links List Blocks';
+
+    private static string $description = 'Displays a set of links which can be internal page links, external urls or '
+                                    . 'file links.';
+
+    private static bool $inline_editable = true;
+
+    private static array $has_one = [
+        'OneLink' => Link::class,
+    ];
+
+    private static $has_many = [
+        'ManyLinks' => Link::class . '.Owner',
+    ];
+
+    private static array $owns = [
+        'OneLink',
+        'ManyLinks',
+    ];
+
+    private static array $cascade_deletes = [
+        'OneLink',
+        'ManyLinks',
+    ];
+
+    private static array $cascade_duplicates = [
+        'OneLink',
+        'ManyLinks',
+    ];
+
+    public function getType(): string
+    {
+        return _t(self::class . '.BlockType', 'Links List');
+    }
+
+    public function getCMSFields()
+    {
+        $fields = parent::getCMSFields();
+
+        $fields->removeByName(['OneLinkID', 'ManyLinks']);
+
+        $fields->addFieldsToTab(
+            'Root.Main',
+            [
+                LinkField::create('OneLink')
+                ->setAllowedTypes([
+                    SiteTreeLink::class,
+                    EmailLink::class,
+                    PhoneLink::class
+                ]),
+                MultiLinkField::create('ManyLinks'),
+            ],
+        );
+
+        return $fields;
+    }
+}


Suggested change

<?php

namespace SilverStripe\FrameworkTest\LinkField\Blocks;

use DNADesign\Elemental\Models\BaseElement;

use SilverStripe\LinkField\Form\LinkField;

use SilverStripe\LinkField\Form\MultiLinkField;

use SilverStripe\LinkField\Models\Link;

use SilverStripe\LinkField\Models\EmailLink;

use SilverStripe\LinkField\Models\PhoneLink;

use SilverStripe\LinkField\Models\SiteTreeLink;

class LinksListBlock extends BaseElement

{

private static string $icon = 'font-icon-block-file-list';

private static string $table_name = 'LinksListBlock';

private static string $singular_name = 'Links List Block';

private static string $plural_name = 'Links List Blocks';

private static string $description = 'Displays a set of links which can be internal page links, external urls or '

. 'file links.';

private static bool $inline_editable = true;

private static array $has_one = [

'OneLink' => Link::class,

];

private static $has_many = [

'ManyLinks' => Link::class . '.Owner',

];

private static array $owns = [

'OneLink',

'ManyLinks',

];

private static array $cascade_deletes = [

'OneLink',

'ManyLinks',

];

private static array $cascade_duplicates = [

'OneLink',

'ManyLinks',

];

public function getType(): string

{

return _t(self::class . '.BlockType', 'Links List');

}

public function getCMSFields()

{

$fields = parent::getCMSFields();

$fields->removeByName(['OneLinkID', 'ManyLinks']);

$fields->addFieldsToTab(

'Root.Main',

[

LinkField::create('OneLink')

->setAllowedTypes([

SiteTreeLink::class,

EmailLink::class,

PhoneLink::class

]),

MultiLinkField::create('ManyLinks'),

],

);

return $fields;

}

}

<?php

use SilverStripe\Core\Extension;

use SilverStripe\Dev\TestOnly;

use SilverStripe\LinkField\Models\SiteTreeLink;

use SilverStripe\LinkField\Models\EmailLink;

use SilverStripe\LinkField\Models\PhoneLink;

use SilverStripe\LinkField\Form\MultiLinkField;

use SilverStripe\LinkField\Form\LinkField;

use SilverStripe\LinkField\Models\Link;

class ElementContentExtension extends Extension implements TestOnly

{

private static bool $inline_editable = true;

private static array $has_one = [

'OneLink' => Link::class,

];

private static $has_many = [

'ManyLinks' => Link::class . '.Owner',

];

private static array $owns = [

'OneLink',

'ManyLinks',

];

private static array $cascade_deletes = [

'OneLink',

'ManyLinks',

];

private static array $cascade_duplicates = [

'OneLink',

'ManyLinks',

];

public function updateCMSFields($fields)

{

$fields->removeByName(['OneLinkID', 'ManyLinks']);

$fields->addFieldsToTab(

'Root.Main',

[

LinkField::create('OneLink')

->setAllowedTypes([

SiteTreeLink::class,

EmailLink::class,

PhoneLink::class

]),

MultiLinkField::create('ManyLinks'),

],

);

}

}

Updated. Unfortunately, we cannot use TestOnly. Please see this comment. I created new issue for this.

@emteknetnz, for using Extension in these test classes I need to rebuild db, since I need to add new relations between classes. For doing this I need to update this block of code, that can be the potential problem for another behat tests in another modules. Do you want me to update FixtureContext as part of this PR? Or if we are planning to get rid of DataExtension in the future then we will make required updates and all test classes will extend DataExtension for now?
Note: As temporary solution I can enforce execution of dev/build as additional step. What would you prefer?

Don't worry about refactoring other things right now. For now simply make this a regular Extension and add a step to manually run dev/build

Does this work even with TestOnly though? If it doesn't could you double check with Guy who seems pretty certain that shouldn't need to use non-TestOnly in frameworktest

emteknetnz

Ideally we don't need this PR, and all the code here should be in linkfield as TestOnly extensions.

If you're having trouble getting that to work please double check with Guy about the specifics of getting this to work

sabina-talipova · 2024-02-12T02:56:06Z

Ideally we don't need this PR, and all the code here should be in linkfield as TestOnly extensions.

If you're having trouble getting that to work please double check with Guy about the specifics of getting this to work

We have already discussed this issue last week and I added new ticket silverstripe/silverstripe-behat-extension#260 to fix this issue. Unfortunately, there are some problems with getting has_one \ has_many properties of mock classes in Behat tests.

emteknetnz

These files need to be in the LinkField PR, and this PR should be closed

I tested this locally, while it's true you cannot use TestOnly classes within framework test, if you added them into LinkField they will work

For instance add LinkPageExtension to vendor/silverstripe/linkfield/tests/php/Extensions/LinkFieldExtension.php and change the namespace to SilverStripe\LinkField\Tests\Extensions\LinkPageExtension and make it implement TestOnly, and update the behat test to add this extension. The behat test will work correctly.

emteknetnz · 2024-02-12T03:25:06Z

code/linkfield/Extensions/LinkPageExtension.php

+use SilverStripe\LinkField\Models\EmailLink;
+use SilverStripe\LinkField\Models\PhoneLink;
+use SilverStripe\LinkField\Models\SiteTreeLink;
+use SilverStripe\ORM\DataExtension;


Suggested change

use SilverStripe\ORM\DataExtension;

emteknetnz · 2024-02-12T03:25:28Z

code/linkfield/Extensions/LinkPageExtension.php

+                LinkField::create('HasOneLink')
+                ->setAllowedTypes([
+                    SiteTreeLink::class,
+                    EmailLink::class,
+                    PhoneLink::class
+                ]),


Suggested change

LinkField::create('HasOneLink')

->setAllowedTypes([

SiteTreeLink::class,

EmailLink::class,

PhoneLink::class

]),

LinkField::create('HasOneLink')

->setAllowedTypes([

SiteTreeLink::class,

EmailLink::class,

PhoneLink::class

]),

sabina-talipova · 2024-02-12T19:55:43Z

These files need to be in the LinkField PR, and this PR should be closed

I tested this locally, while it's true you cannot use TestOnly classes within framework test, if you added them into LinkField they will work

For instance add LinkPageExtension to vendor/silverstripe/linkfield/tests/php/Extensions/LinkFieldExtension.php and change the namespace to SilverStripe\LinkField\Tests\Extensions\LinkPageExtension and make it implement TestOnly, and update the behat test to add this extension. The behat test will work correctly.

@emteknetnz, Did all tests run successfully? I still have the same problem with has_one \ has_many.

emteknetnz · 2024-02-12T23:33:45Z

@sabina-talipova OK don't worry about trying to get these into linkfield module, it really is technically just too hard

There's still a couple of remaining minor changes on this PR

sabina-talipova force-pushed the pulls/1/support-behat-test-linkfield branch from 8307847 to 04f6755 Compare February 7, 2024 21:41

sabina-talipova marked this pull request as ready for review February 7, 2024 22:08

This was referenced Feb 7, 2024

LinkField is covered by comprehensive Behat test coverage silverstripe/silverstripe-linkfield#98

Closed

NEW LinkField Behat tests silverstripe/silverstripe-linkfield#201

Merged

emteknetnz requested changes Feb 8, 2024

View reviewed changes

sabina-talipova force-pushed the pulls/1/support-behat-test-linkfield branch from 04f6755 to 7d21d8c Compare February 8, 2024 23:21

emteknetnz requested changes Feb 12, 2024

View reviewed changes

sabina-talipova force-pushed the pulls/1/support-behat-test-linkfield branch from 7d21d8c to 7318985 Compare February 13, 2024 00:01

MNT Behat test LinkField page and LinkField block

60230da

sabina-talipova force-pushed the pulls/1/support-behat-test-linkfield branch from 7318985 to 60230da Compare February 13, 2024 00:02

emteknetnz approved these changes Feb 13, 2024

View reviewed changes

emteknetnz merged commit f8eac08 into silverstripe:1 Feb 13, 2024

emteknetnz deleted the pulls/1/support-behat-test-linkfield branch February 13, 2024 01:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MNT Behat test LinkField page and LinkField block #162

MNT Behat test LinkField page and LinkField block #162

sabina-talipova commented Feb 5, 2024

GuySartorelli commented Feb 5, 2024 •

edited

Loading

emteknetnz left a comment

emteknetnz Feb 8, 2024

sabina-talipova Feb 8, 2024

emteknetnz Feb 8, 2024

sabina-talipova Feb 8, 2024

sabina-talipova Feb 9, 2024 •

edited

Loading

emteknetnz Feb 12, 2024 •

edited

Loading

emteknetnz left a comment

sabina-talipova commented Feb 12, 2024 •

edited

Loading

emteknetnz left a comment

emteknetnz Feb 12, 2024

sabina-talipova Feb 13, 2024

emteknetnz Feb 12, 2024

sabina-talipova Feb 13, 2024

sabina-talipova commented Feb 12, 2024

emteknetnz commented Feb 12, 2024

		use SilverStripe\ORM\DataExtension;

		class LinkPageExtension extends DataExtension

-use SilverStripe\ORM\DataExtension;
-class LinkPageExtension extends DataExtension
+use SilverStripe\ORM\Extension;
+use SilverStripe\Dev\TestOnly;
+class LinkPageExtension extends Extension implements TestOnly

MNT Behat test LinkField page and LinkField block #162

MNT Behat test LinkField page and LinkField block #162

Conversation

sabina-talipova commented Feb 5, 2024

Parent issue

GuySartorelli commented Feb 5, 2024 • edited Loading

emteknetnz 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

sabina-talipova Feb 9, 2024 • edited Loading

Choose a reason for hiding this comment

emteknetnz Feb 12, 2024 • edited Loading

Choose a reason for hiding this comment

emteknetnz left a comment

Choose a reason for hiding this comment

sabina-talipova commented Feb 12, 2024 • edited Loading

emteknetnz 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

sabina-talipova commented Feb 12, 2024

emteknetnz commented Feb 12, 2024

GuySartorelli commented Feb 5, 2024 •

edited

Loading

sabina-talipova Feb 9, 2024 •

edited

Loading

emteknetnz Feb 12, 2024 •

edited

Loading

sabina-talipova commented Feb 12, 2024 •

edited

Loading