Files
nairobi/spec/shared/system/nested_imageable.rb
Javi Martín f638e50174 Wait for suggestions to finish loading in tests
Sometimes tests were hanging indefinitely. Debugging shows that in some
cases it's due to submitting a form before the AJAX request to get
proposals, debates or investments suggestions is finished, since having
an AJAX and a non-AJAX request at the same time when running the test
sometimes leads to unexpected results.

In our case, we were having many timeouts in Github Actions in the
branches where we use both ActiveStorage and Paperclip to store files
(based on pull request 4598). I can reproduce it in those branches
running the following test ("Should show new image after successful
creation with one uploaded file"), although only when my laptop isn't
plugged (!!):

```
rspec './spec/system/proposals_spec.rb[1:33:1:14]'
```

Since we didn't have a proper way to know the AJAX request had finished,
we're adding a `suggest-success` class to the element showing the
suggestions when that happens. Then in the tests we can look for that
class after filling in the title of a proposal, debate or investments.
Just for clarity's sake, we're also adding the `suggest-loading` class
when the suggestions are loading.

In order not to have expectations everywhere about the suggestions,
we're extracting methods to fill in those titles in the tests. Note we
aren't using these methods in the "edit" actions (suggestions are not
showing when editing) or in tests with the `no_js` tag (since
suggestions only work with JavaScript).
2021-09-22 18:29:23 +02:00

310 lines
9.0 KiB
Ruby

shared_examples "nested imageable" do |imageable_factory_name, path, imageable_path_arguments,
fill_resource_method_name, submit_button, imageable_success_notice,
has_many_images = false, management: false|
let!(:user) { create(:user, :level_two) }
let!(:arguments) { {} }
let!(:imageable) { create(imageable_factory_name) }
let(:management) { management }
before do
create(:administrator, user: user)
imageable_path_arguments&.each do |argument_name, path_to_value|
arguments.merge!("#{argument_name}": imageable.send(path_to_value))
end
imageable.update(author: user) if imageable.respond_to?(:author)
end
describe "at #{path}" do
scenario "Should show new image link when imageable has not an associated image defined" do
do_login_for user
visit send(path, arguments)
expect(page).to have_selector "#new_image_link"
end
scenario "Should hide new image link after adding one image" do
do_login_for user
visit send(path, arguments)
click_on "Add image"
expect(page).not_to have_selector "#new_image_link"
end
scenario "Should update nested image file name after choosing any file" do
do_login_for user
visit send(path, arguments)
click_link "Add image"
attach_file "Choose image", Rails.root.join("spec/fixtures/files/clippy.jpg")
expect(page).to have_selector ".file-name", text: "clippy.jpg"
end
scenario "Should update nested image file title with file name after choosing a file when no title defined" do
do_login_for user
visit send(path, arguments)
imageable_attach_new_file(
imageable_factory_name,
Rails.root.join("spec/fixtures/files/clippy.jpg")
)
expect_image_has_title("clippy.jpg")
end
scenario "Should not update nested image file title with file name after choosing a file when title already defined" do
do_login_for user
visit send(path, arguments)
click_link "Add image"
input_title = find(".image input[name$='[title]']")
fill_in input_title[:id], with: "Title"
attach_file "Choose image", Rails.root.join("spec/fixtures/files/clippy.jpg")
if has_many_images
expect(find("input[id$='_title']").value).to eq "Title"
else
expect(find("##{imageable_factory_name}_image_attributes_title").value).to eq "Title"
end
end
scenario "Should update loading bar style after valid file upload" do
do_login_for user
visit send(path, arguments)
imageable_attach_new_file(
imageable_factory_name,
Rails.root.join("spec/fixtures/files/clippy.jpg")
)
expect(page).to have_selector ".loading-bar.complete"
end
scenario "Should update loading bar style after invalid file upload" do
do_login_for user
visit send(path, arguments)
imageable_attach_new_file(
imageable_factory_name,
Rails.root.join("spec/fixtures/files/logo_header.png"),
false
)
expect(page).to have_selector ".loading-bar.errors"
end
scenario "Should update image cached_attachment field after valid file upload" do
do_login_for user
visit send(path, arguments)
imageable_attach_new_file(
imageable_factory_name,
Rails.root.join("spec/fixtures/files/clippy.jpg")
)
expect_image_has_cached_attachment(".jpg")
end
scenario "Should not update image cached_attachment field after invalid file upload" do
do_login_for user
visit send(path, arguments)
imageable_attach_new_file(
imageable_factory_name,
Rails.root.join("spec/fixtures/files/logo_header.png"),
false
)
expect_image_has_cached_attachment("")
end
scenario "Should show nested image errors after invalid form submit" do
do_login_for user
visit send(path, arguments)
click_link "Add image"
click_on submit_button
if has_many_images
# Pending. Review soon and test
else
within "#nested-image .image" do
expect(page).to have_content("can't be blank", count: 2)
end
end
end
scenario "Should remove nested image after valid file upload and click on remove button" do
do_login_for user
visit send(path, arguments)
imageable_attach_new_file(
imageable_factory_name,
Rails.root.join("spec/fixtures/files/clippy.jpg")
)
within "#nested-image .image" do
click_link "Remove image"
end
expect(page).not_to have_selector("#nested-image .image")
end
scenario "Should show successful notice when resource filled correctly without any nested images" do
if has_many_images
skip "no need to test, there are no attributes for the parent resource"
else
do_login_for user
visit send(path, arguments)
send(fill_resource_method_name) if fill_resource_method_name
click_on submit_button
expect(page).to have_content imageable_success_notice
end
end
scenario "Should show successful notice when resource filled correctly and after valid file uploads" do
do_login_for user
visit send(path, arguments)
send(fill_resource_method_name) if fill_resource_method_name
imageable_attach_new_file(
imageable_factory_name,
Rails.root.join("spec/fixtures/files/clippy.jpg")
)
expect(page).to have_selector ".loading-bar.complete"
click_on submit_button
expect(page).to have_content imageable_success_notice
end
scenario "Should show new image after successful creation with one uploaded file" do
do_login_for user
visit send(path, arguments)
send(fill_resource_method_name) if fill_resource_method_name
imageable_attach_new_file(
imageable_factory_name,
Rails.root.join("spec/fixtures/files/clippy.jpg")
)
expect(page).to have_selector ".loading-bar.complete"
click_on submit_button
imageable_redirected_to_resource_show_or_navigate_to
if has_many_images
# Pending. Review soon and test
else
expect(page).to have_selector "figure img"
expect(page).to have_selector "figure figcaption" if show_caption_for?(imageable_factory_name)
end
end
if path.include? "edit"
scenario "show persisted image" do
create(:image, imageable: imageable)
do_login_for user
visit send(path, arguments)
expect(page).to have_css ".image", count: 1
expect(page).not_to have_css "a#new_image_link"
end
scenario "remove nested field after removing the image" do
create(:image, imageable: imageable)
do_login_for user
visit send(path, arguments)
click_link "Remove image"
expect(page).not_to have_css ".image"
expect(page).to have_css "a#new_image_link"
end
scenario "don't duplicate fields after removing and adding an image" do
create(:image, imageable: imageable)
do_login_for user
visit send(path, arguments)
click_link "Remove image"
click_link "Add image"
expect(page).to have_css ".image", count: 1, visible: :all
end
end
end
end
def do_login_for(user)
common_do_login_for(user, management: management)
end
def imageable_redirected_to_resource_show_or_navigate_to
case imageable.class.to_s
when "Budget"
visit edit_admin_budget_path(Budget.last)
when "Proposal"
click_on "Not now, go to my proposal" rescue Capybara::ElementNotFound
end
end
def imageable_attach_new_file(_imageable_factory_name, path, success = true)
click_link "Add image"
within "#nested-image" do
image = find(".image")
attach_file "Choose image", path
within image do
if success
expect(page).to have_css(".loading-bar.complete")
else
expect(page).to have_css(".loading-bar.errors")
end
end
end
end
def imageable_fill_new_valid_proposal
fill_in_new_proposal_title with: "Proposal title"
fill_in "Proposal summary", with: "Proposal summary"
check :proposal_terms_of_service
end
def imageable_fill_new_valid_budget
fill_in "Name", with: "Budget name"
end
def imageable_fill_new_valid_budget_investment
fill_in_new_investment_title with: "Budget investment title"
fill_in_ckeditor "Description", with: "Budget investment description"
check :budget_investment_terms_of_service
end
def expect_image_has_title(title)
image = find(".image")
within image do
expect(find("input[name$='[title]']").value).to eq title
end
end
def expect_image_has_cached_attachment(extension)
within "#nested-image" do
image = find(".image")
within image do
expect(find("input[name$='[cached_attachment]']", visible: :hidden).value).to end_with(extension)
end
end
end
def show_caption_for?(imageable_factory_name)
imageable_factory_name != "budget"
end