decidim-dev 0.26.5 → 0.27.0.rc1

data/lib/decidim/dev/assets/geocoder_result_here.json

@@ -1,72 +1,51 @@
 {
-    "Response": {
-      "MetaInfo": {
-        "Timestamp": "2013-02-08T16:26:39.382+0000"
+  "items": [
+    {
+      "title": "5 Rue Daunou, 75002 Paris, France",
+      "id": "here:af:streetsection:bI4Le6cyA.1mlQyLunYpjC:CggIBCCi-9SPARABGgE1KGQ",
+      "resultType": "houseNumber",
+      "houseNumberType": "PA",
+      "address": {
+        "label": "5 Rue Daunou, 75002 Paris, France",
+        "countryCode": "FRA",
+        "countryName": "France",
+        "stateCode": "IDF",
+        "state": "Île-de-France",
+        "county": "Paris",
+        "city": "Paris",
+        "district": "2e Arrondissement",
+        "street": "Rue Daunou",
+        "postalCode": "75002",
+        "houseNumber": "5"
       },
-      "View": [
+      "position": {
+        "lat": 48.86926,
+        "lng": 2.3321
+      },
+      "access": [
         {
-          "_type": "SearchResultsViewType",
-          "ViewId": 0,
-          "Result": [
-            {
-              "Relevance": 1.0,
-              "MatchLevel": "houseNumber",
-              "MatchQuality": {
-                "State": 1.0,
-                "City": 1.0,
-                "Street": [
-                  1.0
-                ],
-                "HouseNumber": 1.0
-              },
-              "MatchType": "pointAddress",
-              "Location": {
-                "LocationId": "NT_ArsGdYbpo6dqjPQel9gTID_4",
-                "LocationType": "point",
-                "DisplayPosition": {
-                  "Latitude": 40.7504692,
-                  "Longitude": -73.9933777
-                },
-                "NavigationPosition": [
-                  {
-                    "Latitude": 40.7500305,
-                    "Longitude": -73.9942398
-                  }
-                ],
-                "MapView": {
-                  "TopLeft": {
-                    "Latitude": 40.7515934,
-                    "Longitude": -73.9948616
-                  },
-                  "BottomRight": {
-                    "Latitude": 40.7493451,
-                    "Longitude": -73.9918938
-                  }
-                },
-                "Address": {
-                  "Label": "4 Penn Plz, New York, NY 10001, United States",
-                  "Country": "USA",
-                  "State": "NY",
-                  "County": "New York",
-                  "City": "New York",
-                  "Street": "Penn Plz",
-                  "HouseNumber": "4",
-                  "PostalCode": "10001",
-                  "AdditionalData": [
-                    {
-                      "value": "United States",
-                      "key": "CountryName"
-                    },
-                    {
-                      "value": "New York",
-                      "key": "StateName"
-                    }
-                  ]
-                }
-              }
-            }
-          ]
+          "lat": 48.86931,
+          "lng": 2.33215
+        }
+      ],
+      "mapView": {
+        "west": 2.33073,
+        "south": 48.86836,
+        "east": 2.33347,
+        "north": 48.87016
+      },
+      "scoring": {
+        "queryScore": 0.97,
+        "fieldScore": {
+          "country": 1,
+          "city": 1,
+          "streets": [
+            1
+          ],
+          "houseNumber": 1,
+          "postalCode": 0.82
         }
-      ]
+      }
     }
-  }
+  ]
+}

data/lib/decidim/dev/common_rake.rb

@@ -3,6 +3,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "decidim/dev"
+require "parallel_tests/tasks"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = "--format progress --format RspecJunitFormatter -o ~/rspec/rspec.xml" if ENV["CI"]

data/lib/decidim/dev/railtie.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rails"
+require "decidim/rails"
 
 module Decidim
   module Dev

data/lib/decidim/dev/test/base_spec_helper.rb

@@ -3,6 +3,7 @@
 require "decidim/dev"
 
 ENV["RAILS_ENV"] ||= "test"
+ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"] ||= "1"
 
 engine_spec_dir = File.join(Dir.pwd, "spec")
 
@@ -18,7 +19,7 @@ require_relative "rspec_support/authorization"
 
 require "#{Decidim::Dev.dummy_app_path}/config/environment"
 
-Dir["#{engine_spec_dir}/shared/**/*.rb"].sort.each { |f| require f }
+Dir["#{engine_spec_dir}/shared/**/*.rb"].each { |f| require f }
 
 require "paper_trail/frameworks/rspec"
 

data/lib/decidim/dev/test/rspec_support/accessibility_examples.rb

@@ -2,9 +2,7 @@
 
 shared_examples_for "accessible page" do
   it "passes accessibility tests" do
-    expect(page).to be_axe_clean.excluding(
-      'a[title="Find out more about cookies"]'
-    )
+    expect(page).to be_axe_clean
   end
 
   it "passes HTML validation" do

data/lib/decidim/dev/test/rspec_support/attachment_helpers.rb

@@ -9,6 +9,36 @@ module AttachmentHelpers
   def attachment_file_size(attachment)
     ActiveSupport::NumberHelper.number_to_human_size(attachment.file_size)
   end
+
+  # Creates ActiveStorage::Blob object and returns its signed_id
+  # Used in non-system tests that need files.
+  def upload_test_file(file, options = {})
+    filename = options[:filename] || upload_test_file_filename(file)
+    content_type = options[:content_type] || upload_test_file_content_type(file)
+
+    blob = ActiveStorage::Blob.create_and_upload!(
+      io: File.open(file),
+      filename: filename,
+      content_type: content_type
+    )
+    return blob if options[:return_blob]
+
+    blob.signed_id
+  end
+
+  private
+
+  def upload_test_file_filename(file)
+    return file.original_filename if file.respond_to? :original_filename
+
+    file.split("/").last
+  end
+
+  def upload_test_file_content_type(file)
+    return file.content_type if file.respond_to? :content_type
+
+    MIME::Types.type_for(file).first.content_type
+  end
 end
 
 RSpec.configure do |config|

data/lib/decidim/dev/test/rspec_support/autocomplete_select.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Capybara
+  module AutoCompleteJS
+    def autocomplete_select(value, from:)
+      within("div[data-autocomplete-for='#{from}']") do
+        find(".autocomplete-input").click
+        find(".autocomplete-input").native.send_keys(value[0..4])
+        expect(page).to have_css("#autoComplete_list_1") # select should be open now
+
+        expect(page).to have_css("#autoComplete_result_0", text: value)
+        find("#autoComplete_result_0", text: value).hover
+        expect(page).to have_css("#autoComplete_result_0", text: value)
+        find("#autoComplete_result_0", text: value).click
+        expect(page).to have_css(".autocomplete__selected-item", text: value)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Capybara::AutoCompleteJS, type: :system
+end

data/lib/decidim/dev/test/rspec_support/capybara.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "selenium-webdriver"
-require "system_test_html_screenshots"
 
 module Decidim
   # Helpers meant to be used only during capybara test runs.
@@ -32,11 +31,40 @@ Capybara.register_driver :headless_chrome do |app|
                   else
                     "--window-size=1920,1080"
                   end
+  Capybara::Selenium::Driver.new(
+    app,
+    browser: :chrome,
+    capabilities: [options]
+  )
+end
+
+Capybara.server_port = rand(5000..6999)
+
+# In order to work with PWA apps, Chrome can't be run in headless mode, and requires
+# setting up special prefs and flags
+Capybara.register_driver :pwa_chrome do |app|
+  options = ::Selenium::WebDriver::Chrome::Options.new
+  options.args << "--no-sandbox"
+  # Don't limit browser resources
+  options.args << "--disable-dev-shm-usage"
+  # Add pwa.lvh.me host as a secure origin
+  options.args << "--unsafely-treat-insecure-origin-as-secure=http://pwa.lvh.me:#{Capybara.server_port}"
+  # User data flag is mandatory when preferences and locale state is set
+  options.args << "--user-data-dir=/tmp/decidim_tests_user_data_#{rand(1000)}"
+  options.args << if ENV["BIG_SCREEN_SIZE"].present?
+                    "--window-size=1920,3000"
+                  else
+                    "--window-size=1920,1080"
+                  end
+  # Set notifications allowed in http protocol
+  options.local_state["browser.enabled_labs_experiments"] = ["enable-system-notifications@1", "unsafely-treat-insecure-origin-as-secure"]
+  # Mark notification permission as enabled
+  options.prefs["profile.default_content_setting_values.notifications"] = 1
 
   Capybara::Selenium::Driver.new(
     app,
     browser: :chrome,
-    options: options
+    capabilities: [options]
   )
 end
 
@@ -49,11 +77,11 @@ Capybara.register_driver :iphone do |app|
   Capybara::Selenium::Driver.new(
     app,
     browser: :chrome,
-    options: options
+    capabilities: [options]
   )
 end
 
-Capybara.server = :puma, { Silent: true, Threads: "1:1" }
+Capybara.server = :puma, { Silent: true, queue_requests: false }
 
 Capybara.asset_host = "http://localhost:3000"
 
@@ -65,6 +93,16 @@ RSpec.configure do |config|
   config.before :each, type: :system do
     driven_by(:headless_chrome)
     switch_to_default_host
+    domain = (try(:organization) || try(:current_organization))&.host
+    if domain
+      page.driver.browser.execute_cdp(
+        "Network.setCookie",
+        domain: domain,
+        name: Decidim.consent_cookie_name,
+        value: { essential: true }.to_json,
+        path: "/"
+      )
+    end
   end
 
   config.before :each, driver: :rack_test do
@@ -80,7 +118,7 @@ RSpec.configure do |config|
   end
 
   config.after(type: :system) do |example|
-    warn page.driver.browser.manage.logs.get(:browser) unless example.metadata[:driver].eql?(:rack_test)
+    warn page.driver.browser.logs.get(:browser) unless example.metadata[:driver].eql?(:rack_test)
   end
 
   config.include Decidim::CapybaraTestHelpers, type: :system

data/lib/decidim/dev/test/rspec_support/comments.rb

@@ -3,7 +3,7 @@
 module CommentsHelpers
   def have_comment_from(user, text, opts = {})
     within "#comments" do
-      have_content(user.name, opts) && have_content(text, opts)
+      have_content(user.name, **opts) && have_content(text, **opts)
     end
   end
 

data/lib/decidim/dev/test/rspec_support/component.rb

@@ -89,7 +89,7 @@ module Decidim
       include Followable
       include Traceable
       include Publicable
-      include Decidim::DataPortability
+      include Decidim::DownloadYourData
       include Searchable
       include Paddable
       include Amendable
@@ -236,8 +236,8 @@ Decidim.register_component(:dummy) do |component|
     settings.attribute :comments_enabled, type: :boolean, default: true
     settings.attribute :comments_max_length, type: :integer, required: false
     settings.attribute :resources_permissions_enabled, type: :boolean, default: true
-    settings.attribute :dummy_global_attribute_1, type: :boolean
-    settings.attribute :dummy_global_attribute_2, type: :boolean, readonly: ->(_context) { false }
+    settings.attribute :dummy_global_attribute1, type: :boolean
+    settings.attribute :dummy_global_attribute2, type: :boolean, readonly: ->(_context) { false }
     settings.attribute :readonly_attribute, type: :boolean, default: true, readonly: ->(_context) { true }
     settings.attribute :enable_pads_creation, type: :boolean, default: false
     settings.attribute :amendments_enabled, type: :boolean, default: false
@@ -246,8 +246,8 @@ Decidim.register_component(:dummy) do |component|
 
   component.settings(:step) do |settings|
     settings.attribute :comments_blocked, type: :boolean, default: false
-    settings.attribute :dummy_step_attribute_1, type: :boolean
-    settings.attribute :dummy_step_attribute_2, type: :boolean, readonly: ->(_context) { false }
+    settings.attribute :dummy_step_attribute1, type: :boolean
+    settings.attribute :dummy_step_attribute2, type: :boolean, readonly: ->(_context) { false }
     settings.attribute :dummy_step_translatable_text, type: :text, translated: true, editor: true, required: true
     settings.attribute :readonly_step_attribute, type: :boolean, default: true, readonly: ->(_context) { true }
     settings.attribute :amendment_creation_enabled, type: :boolean, default: true

data/lib/decidim/dev/test/rspec_support/controller_example_group.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ControllerExampleGroup
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def routes
+        before do
+          routes = yield
+          @orig_default_url_options = routes.default_url_options.dup
+          routes.default_url_options[:script_name] = ""
+
+          self.routes = routes
+        end
+
+        after do
+          routes.default_url_options = @orig_default_url_options
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Decidim::ControllerExampleGroup, type: :controller
+end

data/lib/decidim/dev/test/rspec_support/cookies.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Cookies
+    # Update cookie consent
+    def select_cookies(cookies = "all", options = {})
+      visit decidim.root_path if options[:visit_root]
+
+      dialog_present = begin
+        find("#cc-dialog-wrapper")
+      rescue Capybara::ElementNotFound => _e
+        false
+      end
+
+      if dialog_present
+        click_button "Settings"
+      else
+        within ".footer" do
+          click_link "Cookie settings"
+        end
+      end
+
+      if [true, "all"].include?(cookies)
+        click_button "Accept all"
+      elsif cookies.is_a?(Array)
+        cookies.each do |cookie|
+          within "[data-id='#{cookie}']" do
+            find(".switch-paddle").click
+          end
+        end
+        click_button "Save settings"
+      elsif [false, "essential"].include?(cookies)
+        click_button "Accept only essential"
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Capybara::Cookies, type: :system
+end

data/lib/decidim/dev/test/rspec_support/dynamic_attach.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Adapted from https://github.com/JedWatson/react-select/issues/832#issuecomment-276441836
+
+module Capybara
+  module UploadModal
+    # Replaces attach_file.
+    # Beware that modal does not open within form!
+    def dynamically_attach_file(name, file_location, options = {})
+      find("##{name}_button").click
+      filename = options[:filename] || file_location.to_s.split("/").last
+
+      yield if block_given?
+
+      within ".upload-modal" do
+        find(".remove-upload-item").click if options[:remove_before]
+        input_element = find("input[type='file']", visible: :all)
+        input_element.attach_file(file_location)
+        within "[data-filename='#{filename}']" do
+          expect(page).to have_css("div.progress-bar.filled", wait: 5)
+        end
+        all("input.attachment-title").last.set(options[:title]) if options.has_key?(:title)
+        click_button "Save" unless options[:keep_modal_open]
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Capybara::UploadModal, type: :system
+end

data/lib/decidim/dev/test/rspec_support/frontend.rb

@@ -4,7 +4,7 @@ module FrontendHelpers
   # Thanks to:
   # https://medium.com/@coorasse/catch-javascript-errors-in-your-system-tests-89c2fe6773b1
   def expect_no_js_errors
-    errors = page.driver.browser.manage.logs.get(:browser)
+    errors = page.driver.browser.logs.get(:browser)
     return if errors.blank?
 
     aggregate_failures "javascript errors" do

data/lib/decidim/dev/test/rspec_support/geocoder.rb

@@ -17,8 +17,9 @@ module GeocoderHelpers
   # Waits for the front-end geocoding request to finish in order to ensure there
   # are no pending requests when proceeding.
   def fill_in_geocoding(attribute, options = {})
-    fill_in attribute, options
-    expect(page).to have_selector(".tribute-container ul#results", count: 1)
+    fill_in attribute, **options
+    expect(page).to have_selector(".autoComplete_wrapper ul#autoComplete_list_1", count: 1)
+    find("li#autoComplete_result_0").click
   end
 
   module_function
@@ -38,6 +39,7 @@ module Decidim::Map::Provider
   module Geocoding
     class Test < ::Decidim::Map::Geocoding; end
   end
+
   module Autocomplete
     class Test < ::Decidim::Map::Autocomplete
       def self.stubs
@@ -66,9 +68,11 @@ module Decidim::Map::Provider
       end
     end
   end
+
   module DynamicMap
     class Test < ::Decidim::Map::DynamicMap; end
   end
+
   module StaticMap
     class Test < ::Decidim::Map::StaticMap; end
   end

data/lib/decidim/dev/test/rspec_support/helpers.rb

@@ -39,18 +39,6 @@ module Decidim::ComponentTestHelpers
   def have_admin_callout(text)
     have_selector(".callout--full", text: text)
   end
-
-  def stub_get_request_with_format(rq_url, rs_format)
-    stub_request(:get, rq_url)
-      .with(
-        headers: {
-          "Accept" => "*/*",
-          "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
-          "User-Agent" => "Ruby"
-        }
-      )
-      .to_return(status: 200, body: "", headers: { content_type: rs_format })
-  end
 end
 
 RSpec.configure do |config|

data/lib/decidim/dev/test/rspec_support/html_matchers.rb

@@ -2,6 +2,16 @@
 
 require "rspec-html-matchers"
 
+module EscapeHtmlHelpers
+  def escaped_html(string)
+    CGI.escapeHTML(string)
+  end
+
+  def have_escaped_html(string)
+    include(escaped_html(string))
+  end
+end
+
 RSpec::Matchers.define(:have_equivalent_markup_to) do |expected|
   cleaner = ->(str) { str.gsub(/>[[:space:]]*/, ">").gsub(/[[:space:]]*</, "<").strip }
 
@@ -14,4 +24,5 @@ end
 
 RSpec.configure do |config|
   config.include RSpecHtmlMatchers
+  config.include EscapeHtmlHelpers
 end

data/lib/decidim/dev/test/rspec_support/imports_controller_shared_examples.rb

@@ -19,14 +19,9 @@ shared_examples "admin imports controller" do
   end
 
   describe "POST create" do
-    let(:file) do
-      # The file does not really matter for the dummies creator because it
-      # will always create a record for each data row regardless of the data.
-      Rack::Test::UploadedFile.new(
-        Decidim::Dev.test_file("import_proposals.csv", "text/csv"),
-        "text/csv"
-      )
-    end
+    # The file does not really matter for the dummies creator because it
+    # will always create a record for each data row regardless of the data.
+    let(:file) { upload_test_file(Decidim::Dev.test_file("import_proposals.csv", "text/csv")) }
     let(:params) do
       default_params.merge(extra_params).merge(file: file)
     end

data/lib/decidim/dev/test/rspec_support/network_conditions_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NetworkConditionsHelpers
+  def with_browser_in_offline_mode
+    page.driver.browser.network_conditions = { offline: true }
+
+    # Wait for the browser to be offline
+    sleep 1
+
+    yield
+
+    page.driver.browser.network_conditions = { offline: false }
+  end
+end
+
+RSpec.configure do |config|
+  config.include NetworkConditionsHelpers, type: :system
+end

data/lib/decidim/dev/test/rspec_support/rake_tasks.rb

@@ -32,7 +32,6 @@ module RakeTaskOutputHelpers
   included do
     let!(:original_stdout) { $stdout }
 
-    # rubocop:disable RSpec/ExpectOutput
     before do
       $stdout = StringIO.new
     end
@@ -40,7 +39,6 @@ module RakeTaskOutputHelpers
     after do
       $stdout = original_stdout
     end
-    # rubocop:enable RSpec/ExpectOutput
   end
 
   def check_no_errors_have_been_printed

data/lib/decidim/dev/test/rspec_support/screenshot_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "action_dispatch/system_testing/test_helpers/screenshot_helper"
+
+module ActionDispatch
+  module SystemTesting
+    module TestHelpers
+      module ScreenshotHelper
+        private
+
+        # Customize the screenshot helper to fix the file paths for examples that have
+        # unallowed characters in them. Otherwise the artefacts creation and upload
+        # fails at GitHub actions. See the list of unallowed characters from:
+        # https://github.com/actions/toolkit/blob/main/packages/artifact/docs/additional-information.md#non-supported-characters
+        def image_name
+          # By default, this only cleans up the forward and backward slash characters.
+          sanitized_method_name = method_name.tr("/\\()\":<>|*?", "-----------")
+          name = "#{unique}_#{sanitized_method_name}"
+          name[0...225]
+        end
+
+        # Add the file URI scheme so terminal emulators can open one click
+        def display_image
+          message = +"[Screenshot Image]: file://#{image_path}\n"
+          message << +"[Screenshot HTML]: file://#{html_path}\n" if save_html?
+
+          case output_type
+          when "artifact"
+            message << "\e]1338;url=artifact://#{absolute_image_path}\a\n"
+          when "inline"
+            name = inline_base64(File.basename(absolute_image_path))
+            image = inline_base64(File.read(absolute_image_path))
+            message << "\e]1337;File=name=#{name};height=400px;inline=1:#{image}\a\n"
+          end
+
+          message
+        end
+      end
+    end
+  end
+end

data/lib/decidim/dev/test/rspec_support/warden.rb

@@ -18,6 +18,7 @@ end
 
 RSpec.configure do |config|
   config.include Decidim::WardenTestHelpers, type: :system
+  config.include Decidim::WardenTestHelpers, type: :request
   config.include Devise::Test::ControllerHelpers, type: :controller
 
   config.before :each, type: :cell do
@@ -30,4 +31,8 @@ RSpec.configure do |config|
   config.after :each, type: :system do
     Warden.test_reset!
   end
+
+  config.after :each, type: :request do
+    Warden.test_reset!
+  end
 end