Roadmap for developing the 8.x-2.x branch of Sitemap.

Splitting into open issues, any further work can hopefully be done there now that all tests are passing.

See also #3148838: Automated Drupal 9 compatibility fixes.

Step 1: Convert to plugin-based architecture

  • Create Annotation for Plugin type "SitemapMap"
  • Create Plugin Mangager for Plugin type "SitemapMap"
  • Create SitemapMap plugin for the Frontpage (proof-of-concept)
  • Define settings for SitemapMaps
  • Define configuration form for SitemapMaps
  • Store configuration for plugin settings (basic config for now)
  • Proof-of-concept part 2: Derived plugin for Menus
  • Finalize naming scheme: SitemapMap, map/maps/mapping? Or, "outline" (though that's really just a type of diagram/map), "element" (VERY general) NEW: Rename plugin type to "Sitemap"
  • Write documentation on how to define Sitemap plugins
  • Write tests for Sitemap (global)
  • Write tests for SitemapFrontpage
  • Write tests for SitemapMenus

Step 2: Create plugins with tests for module-provided Sitemap instances

Including, potentially, sitemap 'global' default settings and plugin-specific overrides -- see commented code in SitemapSettingsForm.

  • Menus
  • Books
  • Vocabularies/Taxonomy
  • Forum

Tests

Convert tests:

  • SitemapContentTest: Page title, message
  • from SitemapContentTest, to frontpage: front page, section title
  • from SitemapRssTest, to frontpage: show RSS portion"
  • SitemapCssTest: Include CSS file
  • SitemapMenuTest
  • SitemapBookTest
  • SitemapTaxonomyTest

Other module clean-up

  • Inject Drupal::config() in SitemapController
  • Move from Simpletest to PHPUnit (or other appropriate tests)

Other random ideas

  • Allow multiple sitemaps via a sitemap config entity type?
  • Use a plugin collection class? (see FilterPluginCollection)
  • Would anybody miss the RSS options?
  • Are there any tests related to using plugins in general that we would need to implement?

Comments

akalata created an issue. See original summary.

akalata’s picture

akalata commented
Issue summary: View changes

  • akalata committed 7962fe4 on 8.x-2.x 
    Issue #2862229: [meta] Sitemap 2.x, working proof-of-concept for...
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes

  • akalata committed 0ad30a5 on 8.x-2.x 
    Issue #2862229: [meta] Sitemap 2.x -- initial settings and plugin...
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Version: 8.x-1.x-dev » 8.x-2.x-dev
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes

  • akalata committed b84ee43 on 8.x-2.x 
    Issue #2862229: [meta] Sitemap 2.x -- Derivative plugin proof-of-concept...
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes

  • akalata committed 52aad0d on 8.x-2.x 
    Issue #2862229: [meta] Sitemap 2.x - rename plugin type to Sitemap
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
Lowell’s picture

Lowell commented

It was a bumpy flight, but I managed to look through the existing tests.
Here is a list of all the old (d7) assertions that I found in those tests (from before the latest updates so this may be redundant). Please disregard if not helpful.

I was thinking we might need to identify which are unit/functional/kernel tests, and maybe organize them that way.
Also noticed we have a Tests directory, but it is spelled lowercase as tests in other modules.
And because we have namespaces now, maybe we want to name the tests without the Sitemap prefix. (for example: BookTest instead of SitemapBookTest)

BookTest
Assert that books are not included in the sitemap by default.
Assert that all book links are displayed by default.
Assert that the top-level book link is displayed, but that the others are not.

ContentTest
Assert default page title.
Assert that page title is changed.
Assert that sitemap message is not included in the sitemap by default.
Assert sitemap message is included in the sitemap.
Assert that front page is included in the sitemap by default.
Assert that front page is not included in the sitemap.
Assert that titles are included in the sitemap by default.
Assert that titles are not included in the sitemap.

CssTest
Assert that css file is included by default.
Assert that css file is not included.

MenuCustomTitleTest
Assert that main menu is included in the sitemap.
Check that the custom title appears on the sitemap

MenuTest
Assert that main menu is not included in the sitemap by default.
Assert that main menu is included in the sitemap.
Assert that node 1 and the admin link are listed in the sitemap, but not node 2.
Assert that both node 1 and node 2 are listed in the sitemap.
Check anon user doesn't see an inaccessible link for the admin link.

RssTest
Assert default RSS feed for front page.
Assert that RSS feed for front page has been changed.
Assert that RSS link for front page is included in the sitemap.
Assert that RSS links are included in the sitemap.
Assert that the 'sitemap-rss-left' class is found.
Assert that RSS link for front page is not included in the sitemap.
Assert that RSS links are not included in the sitemap.
Assert that all RSS links are not included in the sitemap.
Assert that all RSS links are included in the sitemap.
Assert that RSS links are not included in the sitemap.
Assert that only RSS feed link for term 1 is included in the sitemap.
Assert that RSS feed link for term 1 and term 2 is included in the site map.
Assert that all RSS links are included in the sitemap.

TaxonomyTermsRssTest
Assert that RSS links for terms are included in the sitemap.
Assert that RSS links are not included in the sitemap.
Assert that all RSS links are included in the sitemap.
Assert that RSS links are not included in the sitemap.
Assert that only RSS feed link for term 1 is included in the sitemap.
Assert that RSS feed link for term 1 and term 2 is included in the site map.
Assert that all RSS links are included in the sitemap.

TaxonomyTermsTest
Confirm that terms without content are not displayed by default.
Assert that terms without nodes are now displayed on the sitemap.
Assert that terms with content are displayed on the sitemap as links when term_threshold is set to -1.
Assert that terms with content are displayed on the sitemap as links.
Assert that node counts are included in the sitemap by default.
Assert that node counts are not included in the sitemap.
Assert that all tags are listed in the sitemap.
Assert that no tags are listed in the sitemap.
Assert that only tag 1 is listed in the sitemap.
Assert that tag 1 and tag 2 are listed in the sitemap.
Assert that all tags are listed in the sitemap.

TaxonomyTest
Assert that vocabulary description is not included if no tags are displayed.
Assert that the vocabulary description is included in the sitemap when terms are displayed.
Assert that vocabulary description is not included in the sitemap.

akalata’s picture

akalata commented
Issue tags: +MidCamp2017

Thanks Lowell!

At the sprint yesterday I was trying to get the non-plugin-related tests working, but I keep coming up against schema definition errors. Maybe because my local tests were running on 8.4 dev (but similar core tests weren't having that issue so idk).

Right now, every test is a Simpletest, which is part of why the files are in a weird spot. I thought about converting the tests into PHPUnit, but a quick attempt at that didn't fix the schema issues so I decided to limit the changes for now.

When we get to converting the tests, that's when we'll want to change the location of the files from sitemap/src/Tests to sitemap/tests/src/Functional|Kernel|Unit to match the standards. (Not sure which standards, but they were mentioned in this session).

Core modules appear to namespace their tests, so I think that should be kept -- this makes it easy to find and run specific test classes via the Testing module's UI.

Should we spin off this testing work into a separate issue? Might be a good place to silo the discussion and document it for other projects that are looking to convert their tests.

akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes

  • akalata committed 0fe5eee on 8.x-2.x 
    Issue #2862229: [meta] Sitemap 2.x - update Menu and Book tests
akalata’s picture

akalata commented
Issue summary: View changes

  • akalata committed a7ef3bd on 8.x-2.x 
    Issue #2862229 by akalata: [meta] Sitemap 2.x - update custom title...

  • akalata committed 0c85d67 on 8.x-2.x 
    Issue #2862229 by akalata: [meta] Sitemap 2.x - Vocabulary tests and...
akalata’s picture

akalata commented
Issue summary: View changes

Tests are passing!

akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Issue summary: View changes
akalata’s picture

akalata commented
Status: Active » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.