Write tour integration for block_content.module

I'm looking at this in Portland sprint.

Here's an initial stab at creating some tour definitions for block and custom_block:

Updated issue summary.

Re-uploading because the test bot failed.

Would help if I uploaded the right file.

I ended up having to test this thing about 20 times, added bunch of combinations of different permissions and modules, I had to enable 'seven' theme as default in the TestBasic class, and had to set/place the the help block.

Pretty sure my last one was missing new line.

Checking for the path used by custom block

$ grep path core/modules/block/custom_block/custom_block.routing.yml

sorted by block and block type

path: '/admin/structure/block/custom-blocks'
path: '/block/add'
path: block/add/{custom_block_type}
path: '/block/{custom_block}'
path: '/block/{custom_block}/delete'

path: '/admin/structure/block/custom-blocks/types'
path: '/admin/structure/block/custom-blocks/manage/{custom_block_type}/delete'
path: '/admin/structure/block/custom-blocks/manage/{custom_block_type}'
path: '/admin/structure/block/custom-blocks/types/add'

Patch #5 covers

1. +++ b/core/modules/block/config/tour.tour.block.yml
   @@ -0,0 +1,44 @@
   +  - admin/structure/block
   

   Basic path

2. +++ b/core/modules/block/custom_block/config/tour.tour.custom-block-edit.yml
   @@ -0,0 +1,26 @@
   +  - 'admin/structure/custom-blocks/manage/*/edit'
   

   Custom block edit. This patch is replaced by block/*

3. +++ b/core/modules/block/custom_block/config/tour.tour.custom-blocks-list.yml
   @@ -0,0 +1,26 @@
   +  - admin/structure/custom-blocks
   

   List is moved to admin/structure/block/custom-blocks

+++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/TourCustomBlockTest.php
@@ -0,0 +1,45 @@
+class TourCustomBlockTest extends TourTestBasic {

I'm not sure I understand this tests.

For testing tours do we have to create content? That feels weird.

The custom block module should have code for testing creating custom blocks.

I guess our TourTestBasic missed some feature or the test should merge into a testcase of Custom Block itself.

For now I add only a fix for #5

No need for testing this patch now.

And now the complete fix patch from #5 ... consider #15 as the interdiff :p

Darn .. my bad. I try to move around the texts now.

1. +++ b/core/modules/block/custom_block/config/tour.tour.custom-block-edit.yml
   @@ -0,0 +1,26 @@
   +  editing-the-block:
   +    id: editing-the-block
   +    plugin: text
   +    label: 'Editing the block'
   +    weight: '-9'
   +    attributes:
   +      data-class: primary
   +    body: 'Select the tabs to edit the custom block fields, how they are displayed or to delete the custom block. '
   +    location: left
   

   This is not applicable on the path block/* anymore.

   Belong to path ...

2. +++ b/core/modules/block/custom_block/config/tour.tour.custom-blocks-list.yml
   @@ -0,0 +1,26 @@
   +  - 'block/*'
   

   Wrong path ... this belong to 2 different pages.

I've fixed mentioned issues from #17.

I don't think we need a tour for block/* as that is a simple edit page right?

Tomorrow I start working on #15 aka tests. I wrote part of the TourTestBase and it does not seem to fit it's job :-/

clemens.tolboom,

The TourTestBase was a complete rewrite as per our discussion. Can you please provide feedback to this issue as to how it does not fit?

As block_ui is still be worked on I do not recommend working on this issue until that is done.

I've merged the test from #8 without the patch on TourTestBase together with #18 to run into #2098325: Tour UI converts tip plugin from 'text' to 'text_extended'

Uninstalling Tour UI did not help removing bad tours provided by Tour UI or Tour Builder. That's another Core issue.

The tour in #8 test the block tour so I changed the code to reflect this.

@rcaracaus nicely added the help block but it is not activate. Error "Found corresponding page element for tour tip with id #block-help" I do not understand.

1. +++ b/core/modules/block/lib/Drupal/block/Tests/TourBlockTest.php
   @@ -0,0 +1,54 @@
   +    //'/admin/structure/block/seven' => array(),
   

   This path cannot be tested somehow. Does this has to do with

2. +++ b/core/modules/block/lib/Drupal/block/Tests/TourBlockTest.php
   @@ -0,0 +1,54 @@
   +      array(
   +        'plugin_id' => 'system_help_block',
   +        'settings' => array('region' => 'help', 'machine_name' => 'help'),
   +        'weight' => '0',
   +      ),
   +    );
   +    foreach ($this->testBlocks as $values) {
   +      $this->drupalPlaceBlock($values['plugin_id'], $values['settings']);
   

   This does not enable the help block somehow.

3. +++ b/core/modules/tour/lib/Drupal/tour/Tests/TourTestBasic.php
   @@ -48,6 +48,12 @@
   +    // Enable the admin theme.
   +    theme_enable(array('seven')); ¶
   +    \Drupal::config('system.theme')->set('admin', 'seven')->save();
   +    \Drupal::config('system.theme')->set('default', 'seven')->save();
   +    ¶
   

   This block is regarding #15 as I don't think our TourTestBasic should enable themes. That's up to the custom tests I guess in this case TourBlockTest as it wants to test theme seven.

#21: drupal8.block-module.1926294-21.patch queued for re-testing.

As @nick_schuch mentioned in #20 I wait for better times :

I simply re-rolled this to use routes because I wanted to have a play with tours after DrupalSouth. They're pretty neat!

On a side note, I read in the docs about route_params but would have been good if there was an example. https://drupal.org/developing/api/tour

I cleaned up the test, which was a mess to look at.

Most test failures were random, although there is one in the newly added test that I am getting locally as well and can't wrap my head around: \Drupal\tour\Tests\TourTestBase::assertTourTips() finds a rout with HTML ID block-help on the page using XPath, but later, when checking with PHPUnit, it can no longer find anything with that class, which causes the single test failure.

Fixed the config schema failures.

Only setting to needs review for tests. Reroll for block_content rename, PSR-4, move to config/install. Also fixed the long-standing problem with the help block test (block needed to be added for the admin theme).

As the block classes are being changed per #1896098: Add a plugin class to the blocks to identify instances in css and the current block id (block-$themename-help) requires a complicated selector, I didn't add it so it still doesn't pass though.

Didn't touch the strings in the UI because those haven't changed in block_content either at this time.

Moving to correct component.

This one seems like a good thing to do, but postponed on #1921152-109: META: Start providing tour tips for other core modules. for now.

This tour module is being deprecated, see #3336033: [Meta] Tasks to deprecate Tour module. It will be removed from core and moved to a contrib project, #3376099: [11.x] [Meta] Tasks to remove Tour.

This is now Postponed. The status is set according to two policies. The Remove a core extension and move it to a contributed project and the Extensions approved for removal policies.

I have integrated tour for custom block, attached the screenshots, not sure apart from it, nothing seems to be left.

PLease review, moving NR

Left a comment on MR.

Addressed the feedback, PLease review moving NR.

Rebased the MR, by mistaken added unrelated folder removed it.