Discource-C
/
discourse
mirror of https://github.com/discourse/discourse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DEV: Improve PageObjects::Components::Sidebar#has_tag_section_links? (#22250) 

Why this change?

Predicate matchers are poor at providing good error messages when it
fails if all the predicate matcher does is to return a boolean. Prior to
this change, we were using `has_css? && all?` to assert for the tag
section links. There are two problems here. Firstly, when one of the matchers
fail, the error message does not provide any indication of which matcher
failed making it hard to debug failures. Secondly, the matchers were not
able to assert for the ordering of the tag section links which is an
important behaviour to assert for.

This commit changes `PageObjects::Components::Sidebar#has_tag_section_links?`
such that we make use of assertions to ensure ordering. The usage of
`all` will also provide a clear error message when things go wrong.
This commit is contained in:
Alan Guo Xiang Tan 2023-06-23 08:39:37 +08:00 committed by GitHub
parent 6e3f3dff86
commit 2dd9ac6277
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
spec/system/page_objects/components/sidebar.rb
View File

@ -91,17 +91,16 @@ module PageObjects
has_section_link?(I18n.t("js.sidebar.all_tags"))
end
def has_tags_section_links?(tags)
section_selector = ".sidebar-section[data-section-name='tags']"
def has_tag_section_links?(tags)
tag_names = tags.map(&:name)
has_css?(
"#{section_selector} .sidebar-section-link-wrapper[data-tag-name]",
count: tag_names.length,
) &&
all("#{section_selector} .sidebar-section-link-wrapper[data-tag-name]").all? do |row|
tag_names.include?(row["data-tag-name"].to_s)
end
tag_section_links =
all(
".sidebar-section[data-section-name='tags'] .sidebar-section-link-wrapper[data-tag-name]",
count: tag_names.length,
)
expect(tag_section_links.map(&:text)).to eq(tag_names)
end
def has_no_section?(name)

6
spec/system/viewing_sidebar_as_anonymous_user_spec.rb
View File

@ -32,7 +32,7 @@ describe "Viewing sidebar as anonymous user", type: :system do
expect(sidebar).to have_tags_section
expect(sidebar).to have_all_tags_section_link
expect(sidebar).to have_tags_section_links([tag1, tag2, tag3, tag4, tag5])
expect(sidebar).to have_tag_section_links([tag3, tag2, tag4, tag5, tag1])
end
it "should display the site's top tags when `default_navigation_menu_tags` site setting has been set but the tags configured are hidden to the user" do
@ -43,7 +43,7 @@ describe "Viewing sidebar as anonymous user", type: :system do
expect(sidebar).to have_tags_section
expect(sidebar).to have_all_tags_section_link
expect(sidebar).to have_tags_section_links([tag1, tag2, tag3, tag4, tag6])
expect(sidebar).to have_tag_section_links([tag3, tag2, tag4, tag1, tag6])
end
it "should display the tags configured in `default_navigation_menu_tags` site setting when it has been set" do
@ -53,7 +53,7 @@ describe "Viewing sidebar as anonymous user", type: :system do
expect(sidebar).to have_tags_section
expect(sidebar).to have_all_tags_section_link
expect(sidebar).to have_tags_section_links([tag3, tag4])
expect(sidebar).to have_tag_section_links([tag3, tag4])
end
end
end