GitLab QA의 리소스 클래스

리소스는 주로 브라우저 UI 단계를 사용하여 생성되지만, API 또는 CLI를 통해 생성할 수도 있습니다.

리소스 클래스를 올바르게 구현하는 방법

모든 리소스 클래스는 Resource::Base를 상속해야 합니다.

리소스 클래스를 정의하는 데 구현해야 하는 필수 메서드는 하나뿐입니다. 바로 리소스 클래스를 빌드하는 데 사용되는 #fabricate! 메서드입니다. 이 메서드에서는 웹 페이지와 상호 작용하기 위해 페이지 객체만 사용해야 합니다.

다음은 가상의 예시입니다. 

module QA
  module Resource
    class Shirt < Base
      attr_accessor :name
      
      def fabricate!
        Page::Dashboard::Index.perform do |dashboard_index|
          dashboard_index.go_to_new_shirt
        end
        
        Page::Shirt::New.perform do |shirt_new|
          shirt_new.set_name(name)
          shirt_new.create_shirt!
        end
      end
    end
  end
end

API 구현 정의

리소스 클래스는 공개 GitLab API를 통해 리소스를 생성할 수 있도록 다음 세 가지 메서드를 구현할 수도 있습니다.

  • #api_get_path: 기존 리소스를 가져오기 위한 GET 경로
  • #api_post_path: 새 리소스를 생성하기 위한 POST 경로
  • #api_post_body: 새 리소스를 생성하기 위한 POST 본문 (Ruby 해시 형식)

많은 API 리소스가 페이지별로 구성되어 있음을 명심하세요. 기대하는 결과를 찾을 수 없다면 결과가 여러 페이지에 걸쳐 있는지 확인하십시오.

이제 Shirt 리소스 클래스에서 이 세 가지 API 메서드를 추가해봅시다. 

module QA
  module Resource
    class Shirt < Base
      attr_accessor :name
      
      def fabricate!
        # ... 이전과 동일
      end
      
      def api_get_path
        "/shirt/#{name}"
      end
      
      def api_post_path
        "/shirts"
      end
      
      def api_post_body
        {
          name: name
        }
      end
    end
  end
end

Project 리소스는 브라우저 UI 및 API 구현의 좋은 실제 예입니다.

리소스 속성

리소스는 첫 번째로 다른 리소스가 존재해야 할 수도 있습니다. 예를 들어 프로젝트는 먼저 그룹이 생성되어 있어야 합니다.

리소스 속성을 정의하려면 attribute 메서드를 사용하여 다른 리소스 클래스를 사용하는 블록을 사용하면 됩니다.

이를 통해 리소스 개체의 메서드에서 다른 리소스에 액세스할 수 있습니다. 보통 이를 #fabricate!, #api_get_path, #api_post_path, #api_post_body에서 사용합니다.

이제 Shirt 리소스 클래스를 가져와 project 속성을 추가해봅시다. 

module QA
  module Resource
    class Shirt < Base
      attr_accessor :name
      
      attribute :project do
        Project.fabricate! do |resource|
          resource.name = 'project-to-create-a-shirt'
        end
      end
      
      def fabricate!
        project.visit!
        
        Page::Project::Show.perform do |project_show|
          project_show.go_to_new_shirt
        end
        
        Page::Shirt::New.perform do |shirt_new|
          shirt_new.set_name(name)
          shirt_new.create_shirt!
        end
      end
      
      def api_get_path
        "/project/#{project.path}/shirt/#{name}"
      end
      
      def api_post_path
        "/project/#{project.path}/shirts"
      end
      
      def api_post_body
        {
          name: name
        }
      end
    end
  end
end

모든 속성이 느리게 생성되는 점을 유의하십시오. 특정 속성이 먼저 생성되어야 한다면, 사용하든 안 하든 attribute 메서드를 먼저 호출해야 합니다.

제품 데이터 속성

생성된 후 Web 페이지나 API 응답에서 찾을 수 있는 속성으로 리소스를 채우고 싶을 수 있습니다. 예를 들어 프로젝트를 생성한 후, 리포지터리 SSH URL을 속성으로 저장할 수 있습니다.

다시 한 번, 페이지 객체를 사용하여 페이지에서 데이터를 검색하는 블록을 사용하여 attribute 메서드를 사용할 수 있습니다.

이제 Shirt 리소스 클래스를 가져와 :brand 속성을 정의해봅시다. 

module QA
  module Resource
    class Shirt < Base
      attr_accessor :name
      
      attribute :project do
        Project.fabricate! do |resource|
          resource.name = 'project-to-create-a-shirt'
        end
      end
      
      # 브라우저 UI에서 생성된 속성 (블록 사용)
      attribute :brand do
        Page::Shirt::Show.perform do |shirt_show|
          shirt_show.fetch_brand_from_page
        end
      end
      
      # ... 이전과 동일
    end
  end
end

다시 한번, 모든 속성이 느리게 생성되는 점을 유의하십시오. 다른 페이지로 이동한 후에 shirt.brand를 호출하면 데이터를 올바르게 검색하지 못하기 때문에 주의하십시오.

이를 고려하면 다음과 같습니다. 

shirt =
  QA::Resource::Shirt.fabricate! do |resource|
    resource.name = "GitLab QA"
  end

shirt.project.visit!

shirt.brand # => FAIL!

위 예제는 실패합니다. 왜냐하면 이미 프로젝트 페이지로 이동한 상태에서 셔츠 페이지에서 브랜드 데이터를 생성하려 하기 때문입니다. 이 문제를 해결하는 방법은 두 가지가 있습니다. 하나는 프로젝트를 다시 방문하기 전에 브랜드를 검색하려는 것입니다. 

shirt =
  QA::Resource::Shirt.fabricate! do |resource|
    resource.name = "GitLab QA"
  end

shirt.brand # => OK!

shirt.project.visit!

shirt.brand # => OK!

속성은 인스턴스에 저장되므로 이후의 모든 호출은 이전에 생성된 데이터를 사용하여 정상적으로 작동합니다. 이것이 지나치게 약한 것 같다면, 프로덕션을 완료하기 전에 데이터를 즉시 생성하는 것이 좋습니다. 

module QA
  module Resource
    class Shirt < Base
      # ... 이전과 동일
      
      def fabricate!
        project.visit!
        
        Page::Project::Show.perform do |project_show|
          project_show.go_to_new_shirt
        end
        
        Page::Shirt::New.perform do |shirt_new|
          shirt_new.set_name(name)
          shirt_new.create_shirt!
        end
        
        populate(:brand) # 데이터를 즉시 생성
      end
    end
  end
end

populate 메서드는 각 속성을 호출하여 인수를 반복합니다. 여기서 populate(:brand)는 단순히 brand와 동일한 효과를 갖습니다. populate 메서드를 사용하면 의도가 더 명확해집니다.

이를 통해 셔츠를 생성한 직후에 데이터를 생성하도록 보장합니다. 단점은 속성이 필요 없더라도 리소스를 프로덕션할 때 항상 데이터를 생성한다는 것입니다. 또 다른 방법은 데이터를 생성하기 전에 올바른 페이지에 있는지 확인하는 것입니다. 

module QA
  module Resource
    class Shirt < Base
      attr_accessor :name
      
      attribute :project do
        Project.fabricate! do |resource|
          resource.name = 'project-to-create-a-shirt'
        end
      end
      
      # 브라우저 UI에서 생성된 속성 (블록 사용)
      attribute :brand do
        back_url = current_url
        visit!
        
        Page::Shirt::Show.perform do |shirt_show|
          shirt_show.fetch_brand_from_page
        end
        
        visit(back_url)
      end
      
      # ... 이전과 동일
    end
  end
end

이렇게 함으로써 브랜드를 생성하기 전에 셔츠 페이지에 있는지 확인하고 상태를 깨뜨리지 않도록 이전 페이지로 이동할 수 있습니다.

API 응답을 기반으로 속성 정의하기

가끔은 API 응답을 기반으로 리소스 속성을 정의하고자 할 때가 있습니다. 예를 들어, API를 통해 셔츠를 생성하는 경우 다음과 같은 응답을 받을 수 있습니다. 

{
  brand: 'a-brand-new-brand',
  style: 't-shirt',
  materials: [[:cotton, 80], [:polyamide, 20]]
}

여기서는 style을 리소스에 그대로 저장하고, materials의 첫 번째 값인 cotton을 main_fabric 속성에 저장하고 싶을 수 있습니다.

이때 Shirt 리소스 클래스를 가져와 :style 및 :main_fabric 속성을 정의해봅시다. 

module QA
  module Resource
    class Shirt < Base
      # ... 이전 내용과 동일
      
      # 인스턴스에서 @style을 가져오거나, API 응답으로부터 가져오거나, 그렇지 않으면 QA::Resource::Base::NoValueError를 발생시킵니다.
      attribute :style
      
      # 만약 @main_fabric이 존재하지 않고 API에 이 필드가 없는 경우, 이 블록은 API 응답을 기반으로 값을 생성하고 @main_fabric에 결과를 저장합니다.
      attribute :main_fabric do
        api_response.&dig(:materials, 0, 0)
      end
      
      # ... 이전 내용과 동일
    end
  end
end

속성 우선 순위에 대한 참고 사항:

  • 리소스 인스턴스 변수가 가장 높은 우선 순위를 갖습니다.
  • API 응답에서 가져온 속성이 블록(보통 브라우저 UI에서 가져옴)의 속성보다 우선합니다.
  • 값이 없는 속성은 QA::Resource::Base::NoValueError 오류를 발생시킵니다.

테스트에서 리소스 생성

테스트에서 리소스를 생성하려면, 리소스 클래스에 있는 .fabricate! 메서드를 호출하거나 팩토리를 사용할 수 있습니다. 리소스 클래스가 API 생성을 지원하는 경우, 이 기본적으로 이 생성을 사용합니다.

아래는 Shirt 리소스 클래스가 지원하는 API 생성 메서드를 사용하는 예시입니다. 

my_shirt = Resource::Shirt.fabricate! do |shirt|
  shirt.name = 'my-shirt'
end

expect(page).to have_text(my_shirt.name) # => 리소스의 인스턴스 변수에서 "my-shirt"을 가져옴
expect(page).to have_text(my_shirt.brand) # => API 응답에서 가져온 "a-brand-new-brand"
expect(page).to have_text(my_shirt.style) # => API 응답에서 가져온 "t-shirt"
expect(page).to have_text(my_shirt.main_fabric) # => 블록을 통해 API 응답에서 가져온 "cotton"

명시적으로 브라우저 UI 생성 방법을 사용하고 싶다면, 대신 .fabricate_via_browser_ui! 메서드를 호출할 수 있습니다. 

my_shirt = Resource::Shirt.fabricate_via_browser_ui! do |shirt|
  shirt.name = 'my-shirt'
end

expect(page).to have_text(my_shirt.name) # => 리소스의 인스턴스 변수에서 "my-shirt"을 가져옴
expect(page).to have_text(my_shirt.brand) # => 블록을 통해 가져온 `Page::Shirt::Show` 페이지에서 가져온 브랜드 이름
expect(page).to have_text(my_shirt.style) # => API 응답이나 블록에서 제공되지 않아서 QA::Resource::Base::NoValueError가 발생
expect(page).to have_text(my_shirt.main_fabric) # => API 응답이 없으며 블록이 값을 제공하지 않았기 때문에 QA::Resource::Base::NoValueError가 발생합니다

또한 API 생성 방법을 명시적으로 사용하고 싶다면, .fabricate_via_api!를 호출할 수 있습니다. 

my_shirt = Resource::Shirt.fabricate_via_api! do |shirt|
  shirt.name = 'my-shirt'
end

이 경우에는 Resource::Shirt.fabricate!를 호출하는 것과 유사한 결과가 나옵니다.

팩토리

테스트 내에서 리소스를 생성하고 가져오기 위해 FactoryBot을 사용할 수 있습니다. 

# 테스트에서 사용하기 위해 API를 통해 프로젝트 생성
let(:project) { create(:project) }

# 테스트에서 사용하기 위해 프로젝트에 속하는 이슈를 생성
let(:issue) { create(:issue, project: project) }

# 특정 이름을 가진 비공개 프로젝트를 API를 통해 생성
let(:project) { create(:project, :private, name: 'my-project-name', add_name_uuid: false) }

# 세 가지 액션을 수행하는 프로젝트에 커밋을 하나 생성
let(:commit) do
  create(:commit, commit_message: 'my message', project: project, actions: [
    { action: 'create', file_path: 'README.md', content: '# Welcome!' },
    { action: 'update', file_path: 'README.md', content: '# Updated' },
    { action: 'delete', file_path: 'README.md' }
  ])
end

###

# 아직 API를 통해 생성되지 않은 이슈 레코드를 인스턴스화
let(:issue) { build(:issue) }

# 생성하기 전에 몇 가지 액션을 수행하는 프로젝트 레코드를 인스턴스화
let(:project) do
  build(:project) do |p|
    p.name = 'Test'
    p.add_name_uuid = false
  end
end

# API를 통해 기존 이슈 레코드를 가져오되, 속성들을 가지고 오기
let(:existing_issue) { build(:issue, project: project, iid: issue.iid).reload! }

모든 팩토리는 qa/qa/factories에 정의되어 있으며, 각각의 QA::Resource::Base 클래스를 대표합니다.

예를 들어, :issue 팩토리는 qa/resource/issue.rb에서 찾을 수 있습니다. :project 팩토리는 qa/resource/project.rb에서 찾을 수 있습니다.

새로운 팩토리 생성

다음과 같은 리소스가 주어졌다고 합시다. 

# qa/resource/shirt.rb
module QA
  module Resource
    class Shirt < Base
      attr_accessor :name
      attr_reader :read_only
      
      attribute :brand
      
      def api_post_body
        { name: name, brand: brand }
      end
    end
  end
end

기본값과 오버라이드를 가진 팩토리를 정의합니다. 

# qa/factories/shirts.rb
module QA
  FactoryBot.define do
    factory :shirt, class: 'QA::Resource::Shirt' do
      brand { 'BrandName' }
      
      trait :with_name do
        name { 'Shirt Name' }
      end
    end
  end
end

테스트에서 API를 통해 리소스를 생성합니다. 

let(:my_shirt) { create(:shirt, brand: 'AnotherBrand') } # <Resource::Shirt @brand="AnotherBrand" @name=nil>
let(:named_shirt) { create(:shirt, :with_name) } # <Resource::Shirt @brand="Brand Name" @name="Shirt Name">
let(:invalid_shirt) { create(:shirt, read_only: true) } # NoMethodError

it 'creates a shirt' do
  expect(my_shirt.brand).to eq('AnotherBrand')
  expect(named_shirt.name).to eq('Shirt Name')
  expect(invalid_shirt).to raise_error(NoMethodError) # Resource::Shirt#read_only=를 호출하려고 시도합니다
end

리소스 정리

테스트 실행 중에 생성된 모든 리소스를 수집하는 메커니즘과, 이러한 리소스를 처리하는 다른 메커니즘을 가지고 있습니다. 닷컴 환경의 경우에는 테스트 스위트가 QA 파이프라인에서 끝나면, 통과한 모든 테스트의 리소스가 동일한 파이프라인 실행에서 자동으로 삭제됩니다. 실패한 테스트의 모든 리소스는 조사를 위해 예약되어 있으며, 예약된 파이프라인에 의해 다음 토요일까지 삭제되지 않습니다. 새로운 리소스를 도입할 때에는 삭제할 수 없는 모든 리소스를 IGNORED_RESOURCES 디렉터리에 추가하는 것도 잊지 마십시오.

도움을 요청할 위치

더 많은 정보가 필요한 경우 Slack의 #test-platform 채널에서 도움을 요청하십시오 (내부, GitLab 팀 전용).

팀 멤버가 아니지만 기여를 위해 도움이 필요한 경우, ~QA 라벨이 있는 GitLab CE 이슈 트래커에서 이슈를 열어주세요.