chemlab 0.0.1

data/qa/page/admin/overview/groups/edit.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Overview
+        module Groups
+          class Edit < QA::Page::Base
+            view 'app/views/admin/groups/_form.html.haml' do
+              element :save_changes_button, required: true
+            end
+
+            def click_save_changes_button
+              click_element :save_changes_button, Groups::Show
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+QA::Page::Admin::Overview::Groups::Edit.prepend_if_ee('QA::EE::Page::Admin::Overview::Groups::Edit')

data/qa/page/admin/overview/groups/index.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Overview
+        module Groups
+          class Index < QA::Page::Base
+            view 'app/views/admin/groups/index.html.haml' do
+              element :group_search_field, required: true
+            end
+
+            view 'app/views/admin/groups/_group.html.haml' do
+              element :group_row_content
+              element :group_name_link
+            end
+
+            def search_group(group_name)
+              find_element(:group_search_field).set(group_name).send_keys(:return)
+            end
+
+            def click_group(group_name)
+              within_element(:group_row_content, text: group_name) do
+                click_element(:group_name_link)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/overview/groups/show.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Overview
+        module Groups
+          class Show < QA::Page::Base
+            view 'app/views/admin/groups/show.html.haml' do
+              element :edit_group_link, required: true
+            end
+
+            def click_edit_group_link
+              click_element :edit_group_link, Groups::Edit
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/overview/users/index.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Overview
+        module Users
+          class Index < QA::Page::Base
+            view 'app/views/admin/users/index.html.haml' do
+              element :user_search_field
+            end
+
+            view 'app/views/admin/users/_user.html.haml' do
+              element :user_row_content
+            end
+
+            view 'app/views/admin/users/_user_detail.html.haml' do
+              element :username_link
+            end
+
+            def search_user(username)
+              find_element(:user_search_field).set(username).send_keys(:return)
+            end
+
+            def click_user(username)
+              within_element(:user_row_content, text: username) do
+                click_element(:username_link)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/overview/users/show.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Overview
+        module Users
+          class Show < QA::Page::Base
+            view 'app/views/admin/users/_head.html.haml' do
+              element :impersonate_user_link
+            end
+
+            view 'app/views/admin/users/show.html.haml' do
+              element :confirm_user_button
+            end
+
+            def click_impersonate_user
+              click_element(:impersonate_user_link)
+            end
+
+            def confirm_user
+              accept_confirm do
+                click_element :confirm_user_button
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/component/account_and_limit.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        module Component
+          class AccountAndLimit < Page::Base
+            view 'app/views/admin/application_settings/_account_and_limit.html.haml' do
+              element :receive_max_input_size_field
+              element :save_changes_button
+            end
+
+            def set_max_file_size(size)
+              fill_element :receive_max_input_size_field, size
+            end
+
+            def save_settings
+              click_element :save_changes_button
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/component/ip_limits.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        module Component
+          class IpLimits < Page::Base
+            view 'app/views/admin/application_settings/_ip_limits.html.haml' do
+              element :throttle_unauthenticated_checkbox
+              element :throttle_authenticated_api_checkbox
+              element :throttle_authenticated_web_checkbox
+              element :save_changes_button
+            end
+
+            def enable_throttles
+              check_element :throttle_unauthenticated_checkbox
+              check_element :throttle_authenticated_api_checkbox
+              check_element :throttle_authenticated_web_checkbox
+            end
+
+            def save_settings
+              click_element :save_changes_button
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/component/outbound_requests.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        module Component
+          class OutboundRequests < Page::Base
+            view 'app/views/admin/application_settings/_outbound.html.haml' do
+              element :allow_requests_from_services_checkbox
+              element :save_changes_button
+            end
+
+            def allow_requests_to_local_network_from_services
+              check_allow_requests_to_local_network_from_services_checkbox
+              click_save_changes_button
+            end
+
+            private
+
+            def check_allow_requests_to_local_network_from_services_checkbox
+              check_element :allow_requests_from_services_checkbox
+            end
+
+            def click_save_changes_button
+              click_element :save_changes_button
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/component/performance_bar.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        module Component
+          class PerformanceBar < Page::Base
+            view 'app/views/admin/application_settings/_performance_bar.html.haml' do
+              element :enable_performance_bar_checkbox
+              element :save_changes_button
+            end
+
+            def enable_performance_bar
+              click_element :enable_performance_bar_checkbox
+              Capybara.current_session.driver.browser.manage.add_cookie(name: 'perf_bar_enabled', value: 'true')
+            end
+
+            def save_settings
+              click_element :save_changes_button
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/component/repository_storage.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        module Component
+          class RepositoryStorage < Page::Base
+            view 'app/views/admin/application_settings/_repository_storage.html.haml' do
+              element :hashed_storage_checkbox
+              element :save_changes_button
+            end
+
+            def enable_hashed_storage
+              check_element :hashed_storage_checkbox
+            end
+
+            def save_settings
+              click_element :save_changes_button
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/general.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        class General < Page::Base
+          include QA::Page::Settings::Common
+
+          view 'app/views/admin/application_settings/general.html.haml' do
+            element :account_and_limit_settings
+          end
+
+          def expand_account_and_limit(&block)
+            expand_section(:account_and_limit_settings) do
+              Component::AccountAndLimit.perform(&block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/metrics_and_profiling.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        class MetricsAndProfiling < Page::Base
+          include QA::Page::Settings::Common
+
+          view 'app/views/admin/application_settings/metrics_and_profiling.html.haml' do
+            element :performance_bar_settings
+          end
+
+          def expand_performance_bar(&block)
+            expand_section(:performance_bar_settings) do
+              Component::PerformanceBar.perform(&block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/network.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        class Network < Page::Base
+          include QA::Page::Settings::Common
+
+          view 'app/views/admin/application_settings/network.html.haml' do
+            element :ip_limits_section
+            element :outbound_requests_section
+          end
+
+          def expand_ip_limits(&block)
+            expand_section(:ip_limits_section) do
+              Component::IpLimits.perform(&block)
+            end
+          end
+
+          def expand_outbound_requests(&block)
+            expand_section(:outbound_requests_section) do
+              Component::OutboundRequests.perform(&block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/admin/settings/repository.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      module Settings
+        class Repository < Page::Base
+          include QA::Page::Settings::Common
+
+          view 'app/views/admin/application_settings/repository.html.haml' do
+            element :repository_storage_settings
+          end
+
+          def expand_repository_storage(&block)
+            expand_section(:repository_storage_settings) do
+              Component::RepositoryStorage.perform(&block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/qa/page/alert/auto_devops_alert.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Alert
+      class AutoDevopsAlert < Page::Base
+        view 'app/views/shared/_auto_devops_implicitly_enabled_banner.html.haml' do
+          element :auto_devops_banner
+        end
+      end
+    end
+  end
+end

data/qa/page/base.rb

@@ -0,0 +1,348 @@
+# frozen_string_literal: true
+
+require 'capybara/dsl'
+
+module QA
+  module Page
+    class Base
+      prepend Support::Page::Logging if Runtime::Env.debug?
+      include Capybara::DSL
+      include Scenario::Actable
+      include Support::WaitForRequests
+      extend Validatable
+      extend SingleForwardable
+
+      ElementNotFound = Class.new(RuntimeError)
+
+      class NoRequiredElementsError < RuntimeError
+        def initialize(page_class)
+          @page_class = page_class
+          super
+        end
+
+        def to_s
+          <<~MSG.strip % { page: @page_class }
+            %{page} has no required elements.
+            See https://docs.gitlab.com/ee/development/testing_guide/end_to_end/dynamic_element_validation.html#required-elements
+          MSG
+        end
+      end
+
+      def_delegators :evaluator, :view, :views
+
+      def initialize
+        @retry_later_backoff = QA::Support::Repeater::DEFAULT_MAX_WAIT_TIME
+      end
+
+      def assert_no_element(name)
+        assert_no_selector(element_selector_css(name))
+      end
+
+      def refresh
+        page.refresh
+
+        wait_for_requests
+      end
+
+      def wait_until(max_duration: 60, sleep_interval: 0.1, reload: true, raise_on_failure: true)
+        Support::Waiter.wait_until(max_duration: max_duration, sleep_interval: sleep_interval, raise_on_failure: raise_on_failure) do
+          yield || (reload && refresh && false)
+        end
+      end
+
+      def retry_until(max_attempts: 3, reload: false, sleep_interval: 0, raise_on_failure: true)
+        Support::Retrier.retry_until(max_attempts: max_attempts, reload_page: (reload && self), sleep_interval: sleep_interval, raise_on_failure: raise_on_failure) do
+          yield
+        end
+      end
+
+      def retry_on_exception(max_attempts: 3, reload: false, sleep_interval: 0.5)
+        Support::Retrier.retry_on_exception(max_attempts: max_attempts, reload_page: (reload && self), sleep_interval: sleep_interval) do
+          yield
+        end
+      end
+
+      def scroll_to(selector, text: nil)
+        wait_for_requests
+
+        page.execute_script <<~JS
+          var elements = Array.from(document.querySelectorAll('#{selector}'));
+          var text = '#{text}';
+
+          if (text.length > 0) {
+            elements.find(e => e.textContent === text).scrollIntoView();
+          } else {
+            elements[0].scrollIntoView();
+          }
+        JS
+
+        page.within(selector) { yield } if block_given?
+      end
+
+      # Returns true if successfully GETs the given URL
+      # Useful because `page.status_code` is unsupported by our driver, and
+      # we don't have access to the `response` to use `have_http_status`.
+      def asset_exists?(url)
+        page.execute_script <<~JS
+          xhr = new XMLHttpRequest();
+          xhr.open('GET', '#{url}', true);
+          xhr.send();
+        JS
+
+        return false unless wait_until(sleep_interval: 0.5, max_duration: 60, reload: false) do
+          page.evaluate_script('xhr.readyState == XMLHttpRequest.DONE')
+        end
+
+        page.evaluate_script('xhr.status') == 200
+      end
+
+      def find_element(name, **kwargs)
+        wait_for_requests
+
+        find(element_selector_css(name), kwargs)
+      end
+
+      def active_element?(name)
+        find_element(name, class: 'active')
+      end
+
+      def all_elements(name, **kwargs)
+        if kwargs.keys.none? { |key| [:minimum, :maximum, :count, :between].include?(key) }
+          raise ArgumentError, "Please use :minimum, :maximum, :count, or :between so that all is more reliable"
+        end
+
+        wait_for_requests
+
+        all(element_selector_css(name), **kwargs)
+      end
+
+      def check_element(name)
+        retry_until(sleep_interval: 1) do
+          find_element(name).set(true)
+
+          find_element(name).checked?
+        end
+      end
+
+      def uncheck_element(name)
+        retry_until(sleep_interval: 1) do
+          find_element(name).set(false)
+
+          !find_element(name).checked?
+        end
+      end
+
+      # replace with (..., page = self.class)
+      def click_element(name, page = nil, text: nil, wait: Capybara.default_max_wait_time)
+        find_element(name, text: text, wait: wait).click
+        page.validate_elements_present! if page
+      end
+
+      def fill_element(name, content)
+        find_element(name).set(content)
+      end
+
+      def select_element(name, value)
+        element = find_element(name)
+
+        return if element.text == value
+
+        element.select value
+      end
+
+      def has_active_element?(name, **kwargs)
+        has_element?(name, class: 'active', **kwargs)
+      end
+
+      def has_element?(name, **kwargs)
+        wait_for_requests
+
+        wait = kwargs.delete(:wait) || Capybara.default_max_wait_time
+        text = kwargs.delete(:text)
+        klass = kwargs.delete(:class)
+
+        has_css?(element_selector_css(name, kwargs), text: text, wait: wait, class: klass)
+      end
+
+      def has_no_element?(name, **kwargs)
+        wait_for_requests
+
+        wait = kwargs.delete(:wait) || Capybara.default_max_wait_time
+        text = kwargs.delete(:text)
+
+        has_no_css?(element_selector_css(name, kwargs), wait: wait, text: text)
+      end
+
+      def has_text?(text, wait: Capybara.default_max_wait_time)
+        wait_for_requests
+
+        page.has_text?(text, wait: wait)
+      end
+
+      def has_no_text?(text, wait: Capybara.default_max_wait_time)
+        wait_for_requests
+
+        page.has_no_text?(text, wait: wait)
+      end
+
+      def has_normalized_ws_text?(text, wait: Capybara.default_max_wait_time)
+        has_text?(text.gsub(/\s+/, " "), wait: wait)
+      end
+
+      def finished_loading?
+        wait_for_requests
+
+        # The number of selectors should be able to be reduced after
+        # migration to the new spinner is complete.
+        # https://gitlab.com/groups/gitlab-org/-/epics/956
+        has_no_css?('.gl-spinner, .fa-spinner, .spinner', wait: QA::Support::Repeater::DEFAULT_MAX_WAIT_TIME)
+      end
+
+      def finished_loading_block?
+        wait_for_requests
+
+        has_no_css?('.fa-spinner.block-loading', wait: Capybara.default_max_wait_time)
+      end
+
+      def has_loaded_all_images?
+        # I don't know of a foolproof way to wait for all images to load
+        # This loop gives time for the img tags to be rendered and for
+        # images to start loading.
+        previous_total_images = 0
+        wait_until(sleep_interval: 1) do
+          current_total_images = all("img").size
+          result = previous_total_images == current_total_images
+          previous_total_images = current_total_images
+          result
+        end
+
+        # Retry until all images found can be fetched via HTTP, and
+        # check that the image has a non-zero natural width (a broken
+        # img tag could have a width, but wouldn't have a natural width)
+
+        # Unfortunately, this doesn't account for SVGs. They're rendered
+        # as HTML, so there doesn't seem to be a way to check that they
+        # display properly via Selenium. However, if the SVG couldn't be
+        # rendered (e.g., because the file doesn't exist), the whole page
+        # won't display properly, so we should catch that with the test
+        # this method is called from.
+
+        # The user's avatar is an img, which could be a gravatar image,
+        # so we skip that by only checking for images hosted internally
+        retry_until(sleep_interval: 1) do
+          all("img").all? do |image|
+            next true unless URI(image['src']).host == URI(page.current_url).host
+
+            asset_exists?(image['src']) && image['naturalWidth'].to_i > 0
+          end
+        end
+      end
+
+      def wait_for_animated_element(name)
+        # It would be ideal if we could detect when the animation is complete
+        # but in some cases there's nothing we can easily access via capybara
+        # so instead we wait for the element, and then we wait a little longer
+        raise ElementNotFound, %Q(Couldn't find element named "#{name}") unless has_element?(name)
+
+        sleep 1
+      end
+
+      def within_element(name, text: nil)
+        page.within(element_selector_css(name), text: text) do
+          yield
+        end
+      end
+
+      def within_element_by_index(name, index)
+        page.within all_elements(name, minimum: index + 1)[index] do
+          yield
+        end
+      end
+
+      def scroll_to_element(name, *args)
+        scroll_to(element_selector_css(name), *args)
+      end
+
+      def element_selector_css(name, *attributes)
+        return name.selector_css if name.is_a? Page::Element
+
+        Page::Element.new(name, *attributes).selector_css
+      end
+
+      def click_link_with_text(text)
+        wait_for_requests
+
+        click_link text
+      end
+
+      def visit_link_in_element(name)
+        visit find_element(name)['href']
+      end
+
+      def wait_if_retry_later
+        return if @retry_later_backoff > QA::Support::Repeater::DEFAULT_MAX_WAIT_TIME * 5
+
+        if has_css?('body', text: 'Retry later', wait: 0)
+          QA::Runtime::Logger.warn("`Retry later` error occurred. Sleeping for #{@retry_later_backoff} seconds...")
+          sleep @retry_later_backoff
+          refresh
+          @retry_later_backoff += QA::Support::Repeater::DEFAULT_MAX_WAIT_TIME
+
+          wait_if_retry_later
+        end
+      end
+
+      def self.path
+        raise NotImplementedError
+      end
+
+      def self.evaluator
+        @evaluator ||= Page::Base::DSL.new
+      end
+
+      def self.errors
+        if views.empty?
+          return ["Page class does not have views / elements defined!"]
+        end
+
+        views.flat_map(&:errors)
+      end
+
+      def self.elements
+        views.flat_map(&:elements)
+      end
+
+      def self.required_elements
+        elements.select(&:required?)
+      end
+
+      def send_keys_to_element(name, keys)
+        find_element(name).send_keys(keys)
+      end
+
+      def visible?
+        raise NoRequiredElementsError.new(self.class) if self.class.required_elements.empty?
+
+        self.class.required_elements.each do |required_element|
+          return false if has_no_element? required_element
+        end
+
+        true
+      end
+
+      class DSL
+        attr_reader :views
+
+        def initialize
+          @views = []
+        end
+
+        def view(path, &block)
+          Page::View.evaluate(&block).tap do |view|
+            @views.push(Page::View.new(path, view.elements))
+          end
+        end
+      end
+    end
+  end
+end