chemlab 0.0.1

data/qa/flow/user.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module QA
+  module Flow
+    module User
+      module_function
+
+      def page
+        Capybara.current_session
+      end
+
+      def confirm_user(username)
+        Flow::Login.while_signed_in_as_admin do
+          Page::Main::Menu.perform(&:go_to_admin_area)
+          Page::Admin::Menu.perform(&:go_to_users_overview)
+          Page::Admin::Overview::Users::Index.perform do |index|
+            index.search_user(username)
+            index.click_user(username)
+          end
+
+          Page::Admin::Overview::Users::Show.perform(&:confirm_user)
+        end
+      end
+    end
+  end
+end

data/qa/git/location.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'forwardable'
+
+module QA
+  module Git
+    class Location
+      extend Forwardable
+
+      attr_reader :git_uri, :uri
+      def_delegators :@uri, :user, :host, :path
+
+      # See: config/initializers/1_settings.rb
+      # Settings#build_gitlab_shell_ssh_path_prefix
+      def initialize(git_uri)
+        @git_uri = git_uri
+        @uri =
+          if git_uri =~ %r{\A(?:ssh|http|https)://}
+            URI.parse(git_uri)
+          else
+            *rest, path = git_uri.split(':')
+            # Host cannot have : so we'll need to escape it
+            user_host = rest.join('%3A').sub(/\A\[(.+)\]\z/, '\1')
+            URI.parse("ssh://#{user_host}/#{path}")
+          end
+      end
+
+      def port
+        uri.port || 22
+      end
+    end
+  end
+end

data/qa/git/repository.rb

@@ -0,0 +1,269 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'uri'
+require 'open3'
+require 'fileutils'
+require 'tmpdir'
+require 'tempfile'
+require 'securerandom'
+
+module QA
+  module Git
+    class Repository
+      include Scenario::Actable
+      RepositoryCommandError = Class.new(StandardError)
+
+      attr_writer :use_lfs, :gpg_key_id
+      attr_accessor :env_vars
+
+      InvalidCredentialsError = Class.new(RuntimeError)
+
+      def initialize
+        # We set HOME to the current working directory (which is a
+        # temporary directory created in .perform()) so the temporarily dropped
+        # .netrc can be utilised
+        self.env_vars = [%Q{HOME="#{tmp_home_dir}"}]
+        @use_lfs = false
+        @gpg_key_id = nil
+      end
+
+      def self.perform(*args)
+        Dir.mktmpdir do |dir|
+          Dir.chdir(dir) { super }
+        end
+      end
+
+      def password=(password)
+        @password = password
+
+        raise InvalidCredentialsError, "Please provide a username when setting a password" unless username
+
+        try_add_credentials_to_netrc
+      end
+
+      def uri=(address)
+        @uri = URI(address)
+      end
+
+      def username=(username)
+        @username = username
+        # Only include the user in the URI if we're using HTTP as this breaks
+        # SSH authentication.
+        @uri.user = username unless ssh_key_set?
+      end
+
+      def use_default_credentials
+        self.username, self.password = default_credentials
+      end
+
+      def clone(opts = '')
+        clone_result = run("git clone #{opts} #{uri} ./")
+        return clone_result.response unless clone_result.success
+
+        enable_lfs_result = enable_lfs if use_lfs?
+
+        clone_result.to_s + enable_lfs_result.to_s
+      end
+
+      def checkout(branch_name, new_branch: false)
+        opts = new_branch ? '-b' : ''
+        run(%Q{git checkout #{opts} "#{branch_name}"}).to_s
+      end
+
+      def shallow_clone
+        clone('--depth 1')
+      end
+
+      def configure_identity(name, email)
+        run(%Q{git config user.name "#{name}"})
+        run(%Q{git config user.email #{email}})
+      end
+
+      def commit_file(name, contents, message)
+        add_file(name, contents)
+        commit(message)
+      end
+
+      def add_file(name, contents)
+        FileUtils.mkdir_p(::File.dirname(name))
+
+        ::File.write(name, contents)
+
+        if use_lfs?
+          git_lfs_track_result = run(%Q{git lfs track #{name} --lockable})
+          return git_lfs_track_result.response unless git_lfs_track_result.success
+        end
+
+        git_add_result = run(%Q{git add #{name}})
+
+        git_lfs_track_result.to_s + git_add_result.to_s
+      end
+
+      def delete_tag(tag_name)
+        run(%Q{git push origin --delete #{tag_name}}).to_s
+      end
+
+      def commit(message)
+        run(%Q{git commit -m "#{message}"}).to_s
+      end
+
+      def commit_with_gpg(message)
+        run(%Q{git config user.signingkey #{@gpg_key_id} && git config gpg.program $(which gpg) && git commit -S -m "#{message}"}).to_s
+      end
+
+      def push_changes(branch = 'master')
+        run("git push #{uri} #{branch}").to_s
+      end
+
+      def merge(branch)
+        run("git merge #{branch}")
+      end
+
+      def commits
+        run('git log --oneline').to_s.split("\n")
+      end
+
+      def use_ssh_key(key)
+        @private_key_file = Tempfile.new("id_#{SecureRandom.hex(8)}")
+        File.binwrite(private_key_file, key.private_key)
+        File.chmod(0700, private_key_file)
+
+        @known_hosts_file = Tempfile.new("known_hosts_#{SecureRandom.hex(8)}")
+        keyscan_params = ['-H']
+        keyscan_params << "-p #{uri.port}" if uri.port
+        keyscan_params << uri.host
+        res = run("ssh-keyscan #{keyscan_params.join(' ')} >> #{known_hosts_file.path}")
+        return res.response unless res.success?
+
+        self.env_vars << %Q{GIT_SSH_COMMAND="ssh -i #{private_key_file.path} -o UserKnownHostsFile=#{known_hosts_file.path}"}
+      end
+
+      def delete_ssh_key
+        return unless ssh_key_set?
+
+        private_key_file.close(true)
+        known_hosts_file.close(true)
+      end
+
+      def push_with_git_protocol(version, file_name, file_content, commit_message = 'Initial commit')
+        self.git_protocol = version
+        add_file(file_name, file_content)
+        commit(commit_message)
+        push_changes
+
+        fetch_supported_git_protocol
+      end
+
+      def git_protocol=(value)
+        raise ArgumentError, "Please specify the protocol you would like to use: 0, 1, or 2" unless %w[0 1 2].include?(value.to_s)
+
+        run("git config protocol.version #{value}")
+      end
+
+      def fetch_supported_git_protocol
+        # ls-remote is one command known to respond to Git protocol v2 so we use
+        # it to get output including the version reported via Git tracing
+        output = run("git ls-remote #{uri}", "GIT_TRACE_PACKET=1")
+        output.response[/git< version (\d+)/, 1] || 'unknown'
+      end
+
+      def try_add_credentials_to_netrc
+        return unless add_credentials?
+        return if netrc_already_contains_content?
+
+        save_netrc_content
+      end
+
+      private
+
+      attr_reader :uri, :username, :password, :known_hosts_file,
+        :private_key_file, :use_lfs
+
+      alias_method :use_lfs?, :use_lfs
+
+      Result = Struct.new(:success, :response) do
+        alias_method :success?, :success
+        alias_method :to_s, :response
+      end
+
+      def add_credentials?
+        return false if !username || !password
+        return true unless ssh_key_set?
+
+        false
+      end
+
+      def ssh_key_set?
+        !private_key_file.nil?
+      end
+
+      def enable_lfs
+        # git lfs install *needs* a .gitconfig defined at ${HOME}/.gitconfig
+        FileUtils.mkdir_p(tmp_home_dir)
+        touch_gitconfig_result = run("touch #{tmp_home_dir}/.gitconfig")
+        return touch_gitconfig_result.response unless touch_gitconfig_result.success?
+
+        git_lfs_install_result = run('git lfs install')
+
+        touch_gitconfig_result.to_s + git_lfs_install_result.to_s
+      end
+
+      def run(command_str, *extra_env)
+        command = [env_vars, *extra_env, command_str, '2>&1'].compact.join(' ')
+        Runtime::Logger.debug "Git: pwd=[#{Dir.pwd}], command=[#{command}]"
+
+        output, status = Open3.capture2e(command)
+        output.chomp!
+        Runtime::Logger.debug "Git: output=[#{output}], exitstatus=[#{status.exitstatus}]"
+
+        unless status.success?
+          raise RepositoryCommandError, "The command #{command} failed (#{status.exitstatus}) with the following output:\n#{output}"
+        end
+
+        Result.new(status.exitstatus == 0, output)
+      end
+
+      def default_credentials
+        if ::QA::Runtime::User.ldap_user?
+          [Runtime::User.ldap_username, Runtime::User.ldap_password]
+        else
+          [Runtime::User.username, Runtime::User.password]
+        end
+      end
+
+      def read_netrc_content
+        File.exist?(netrc_file_path) ? File.readlines(netrc_file_path) : []
+      end
+
+      def save_netrc_content
+        # Despite libcurl supporting a custom .netrc location through the
+        # CURLOPT_NETRC_FILE environment variable, git does not support it :(
+        # Info: https://curl.haxx.se/libcurl/c/CURLOPT_NETRC_FILE.html
+        #
+        # This will create a .netrc in the correct working directory, which is
+        # a temporary directory created in .perform()
+        #
+        FileUtils.mkdir_p(tmp_home_dir)
+        File.open(netrc_file_path, 'a') { |file| file.puts(netrc_content) }
+        File.chmod(0600, netrc_file_path)
+      end
+
+      def tmp_home_dir
+        @tmp_home_dir ||= File.join(Dir.tmpdir, "qa-netrc-credentials", $$.to_s)
+      end
+
+      def netrc_file_path
+        @netrc_file_path ||= File.join(tmp_home_dir, '.netrc')
+      end
+
+      def netrc_content
+        "machine #{uri.host} login #{username} password #{password}"
+      end
+
+      def netrc_already_contains_content?
+        read_netrc_content.grep(/^#{Regexp.escape(netrc_content)}$/).any?
+      end
+    end
+  end
+end

data/qa/page/admin/menu.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      class Menu < Page::Base
+        view 'app/views/layouts/nav/sidebar/_admin.html.haml' do
+          element :admin_sidebar
+          element :admin_sidebar_settings_submenu
+          element :admin_settings_item
+          element :admin_settings_repository_item
+          element :admin_settings_general_item
+          element :admin_settings_metrics_and_profiling_item
+          element :admin_settings_preferences_link
+          element :admin_monitoring_link
+          element :admin_sidebar_monitoring_submenu_content
+          element :admin_sidebar_overview_submenu_content
+          element :users_overview_link
+          element :groups_overview_link
+          element :integration_settings_link
+        end
+
+        def go_to_preferences_settings
+          hover_element(:admin_settings_item) do
+            within_submenu(:admin_sidebar_settings_submenu) do
+              click_element :admin_settings_preferences_link
+            end
+          end
+        end
+
+        def go_to_repository_settings
+          hover_element(:admin_settings_item) do
+            within_submenu(:admin_sidebar_settings_submenu) do
+              click_element :admin_settings_repository_item
+            end
+          end
+        end
+
+        def go_to_integration_settings
+          hover_element(:admin_settings_item) do
+            within_submenu(:admin_sidebar_settings_submenu) do
+              click_element :integration_settings_link
+            end
+          end
+        end
+
+        def go_to_general_settings
+          hover_element(:admin_settings_item) do
+            within_submenu(:admin_sidebar_settings_submenu) do
+              click_element :admin_settings_general_item
+            end
+          end
+        end
+
+        def go_to_metrics_and_profiling_settings
+          hover_element(:admin_settings_item) do
+            within_submenu(:admin_sidebar_settings_submenu) do
+              click_element :admin_settings_metrics_and_profiling_item
+            end
+          end
+        end
+
+        def go_to_network_settings
+          hover_element(:admin_settings_item) do
+            within_submenu(:admin_sidebar_settings_submenu) do
+              click_element :admin_settings_network_item
+            end
+          end
+        end
+
+        def go_to_users_overview
+          within_submenu(:admin_sidebar_overview_submenu_content) do
+            click_element :users_overview_link
+          end
+        end
+
+        def go_to_groups_overview
+          within_submenu(:admin_sidebar_overview_submenu_content) do
+            click_element :groups_overview_link
+          end
+        end
+
+        private
+
+        def hover_element(element)
+          within_sidebar do
+            scroll_to_element(element)
+            find_element(element).hover
+
+            yield
+          end
+        end
+
+        def within_sidebar
+          within_element(:admin_sidebar) do
+            yield
+          end
+        end
+
+        def within_submenu(element)
+          within_element(element) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end
+
+QA::Page::Admin::Menu.prepend_if_ee('QA::EE::Page::Admin::Menu')

data/qa/page/admin/new_session.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module QA
+  module Page
+    module Admin
+      class NewSession < Page::Base
+        view 'app/views/admin/sessions/_new_base.html.haml' do
+          element :enter_admin_mode_button
+          element :password_field
+        end
+
+        def set_password(password)
+          fill_element :password_field, password
+        end
+
+        def click_enter_admin_mode
+          click_element :enter_admin_mode_button
+        end
+      end
+    end
+  end
+end