端到端测试最佳实践

RSpec.describe 'Stage' do
  describe '被测功能的通用描述' do
    it '测试名称', testcase: 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/:test_case_id' do
      ...
    end

    it '另一个测试', testcase: 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/:another_test_case_id' do
      ...
    end
  end
end

RSpec.shared_examples '未选中的维护者' do |testcase|
  it '用户无法推送', testcase: testcase do
    ...
  end
end

RSpec.shared_examples '已选中的开发者' do |testcase|
  it '用户推送并合并', testcase: testcase do
    ...
  end
end

RSpec.describe '创建' do
  describe '受保护的分支推送与合并' do
    context '当仅允许一个用户向受保护分支推送和合并时' do
      ...

      it_behaves_like '未选中的维护者', 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/347775'
      it_behaves_like '已选中的开发者', 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/347774'
    end

    context '当仅允许一个组向受保护分支推送和合并时' do
      ...

      it_behaves_like '未选中的维护者', 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/347772'
      it_behaves_like '已选中的开发者', 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/347773'
    end
  end
end

# `RSpec.describe` 是所覆盖的 DevOps 阶段
RSpec.describe 'Plan', product_group: :knowledge do
  # `describe` 是被测的功能
  describe 'wiki content creation' do
    # `context` 提供被覆盖的条件
    context 'in a project'
      # `it` 定义测试的预期结果
      it 'adds a home page'
      ...
      end
    ...
    end
  ...
  end
end

#=> 好
Flow::Login.sign_in
Page::Main::Menu.perform do |menu|
  expect(menu).to be_signed_in
end

#=> 坏
Flow::Login.sign_in(as: user)
Page::Main::Menu.perform do |menu|
  expect(menu).to be_signed_in
  expect(page).to have_content(user.name) #=> 我们已验证过登录状态，冗余。
  expect(menu).to have_element(:nav_bar) #=> 可能没必要，已在低层验证，测试未要求验证此内容。
end

#=> 好
issue = create(:issue, name: 'issue-name')

Project::Issues::Index.perform do |index|
  expect(index).to have_issue(issue)
end

#=> 坏
issue = create(:issue, name: 'issue-name')

Project::Issues::Index.perform do |index|
  expect(index).to have_issue(issue)
  expect(page).to have_content(issue.name) #=> 页面内容检查冗余，因上一行已验证问题存在。
end

#=> 好
Page::Search::Results.perform do |search|
  search.switch_to_code

  aggregate_failures '测试搜索结果' do
    expect(search).to have_file_in_project(template[:file_name], project.name)
    expect(search).to have_file_with_content(template[:file_name], content[0..33])
  end
end

#=> 坏
Page::Search::Results.perform do |search|
  search.switch_to_code
  expect(search).to have_file_in_project(template[:file_name], project.name)
  expect(search).to have_file_with_content(template[:file_name], content[0..33])
end

#=> 好
it '搜索', :aggregate_failures do
  Page::Search::Results.perform do |search|
    expect(search).to have_file_in_project(template[:file_name], project.name)

    search.switch_to_code

    expect(search).to have_file_with_content(template[:file_name], content[0..33])
  end
end

#=> 坏
it '搜索' do
  Page::Search::Results.perform do |search|
    expect(search).to have_file_in_project(template[:file_name], project.name)

    search.switch_to_code

    expect(search).to have_file_with_content(template[:file_name], content[0..33])
  end
end

it "拥有 Owner 角色及 Owner 权限" do
  Page::Dashboard::Projects.perform do |projects|
    projects.filter_by_name(project.name)

    expect(projects).to have_project_with_access_role(project.name, 'Owner')
  end

  expect_owner_permissions_allow_delete_issue
end

#=> 好
def expect_owner_permissions_allow_delete_issue
  issue.visit!

  Page::Project::Issue::Show.perform(&:delete_issue)

  Page::Project::Issue::Index.perform do |index|
    expect(index).not_to have_issue(issue)
  end
end

#=> 不佳
def expect_owner_permissions_allow_delete_issue
  expect do
    issue.visit!

    Page::Project::Issue::Show.perform(&:delete_issue)

    Page::Project::Issue::Index.perform do |index|
      expect(index).not_to have_issue(issue)
    end
  end.not_to raise_error
end

after(:all) do
  login unless Page::Main::Menu.perform(&:signed_in?)

  # 在登录状态下执行某些操作

  Page::Main::Menu.perform(&:sign_out)
end

# 使用commit资源
Resource::Repository::Commit.fabricate_via_api! do |commit|
  commit.commit_message = '初始提交'
  commit.add_files([
    { file_path: 'README.md', content: '你好，GitLab' }
  ])
end

# 使用ProjectPush
Resource::Repository::ProjectPush.fabricate! do |push|
  push.commit_message = '初始提交'
  push.file_name = 'README.md'
  push.file_content = '你好，GitLab'
end

# 点击另一个元素来模糊输入框
def add_issue_to_epic(issue_url)
  find_element(:issue_actions_split_button).find('button', text: '添加问题').click
  fill_element(:add_issue_input, issue_url)
  # 点击标题来模糊输入框
  click_element(:title)
  click_element(:add_issue_button)
end

# 在存在遮罩/覆盖层的情况下使用原生鼠标点击事件
click_element_coordinates(:title)

Page::Project::Pipeline::Show.perform do |pipeline|
  expect(pipeline).to have_job('a_job')
end

expect { async_value }.to eventually_eq(value).within(max_duration: 120, max_attempts: 60, reload_page: page)

except(page).not_to have_text('hidden')
except(page).to have_no_text('hidden')

RSpec::Matchers.define :have_job do |job_name|
  match do |page_object|
    page_object.has_job?(job_name)
  end

  match_when_negated do |page_object|
    page_object.has_no_job?(job_name)
  end
end

Page::Project::Pipeline::Show.perform do |pipeline|
  expect(pipeline).not_to have_job('a_job')
  expect(pipeline).to have_no_job('a_job')
end

# 不良实践
Page::Project::Pipeline::Show.perform do |pipeline|
  expect(pipeline).not_to have_job('a_job')
end

# 不算太差但可能有缺陷
Page::Project::Pipeline::Show.perform do |pipeline|
  expect(pipeline).not_to have_job('a_job', wait: 0)
end