cell에 대해 변경 사항 테스트
GitLab v19.6요약
cell은 레거시 cell(기존 GitLab.com 인스턴스)과 다른 점이 있으며, 단일 인스턴스 데이터베이스에서 실행하는 단위 테스트로는 이 차이를 확인할 수 없습니다. 워크스테이션에서 둘 이상의 cell을 실행하려면 gitlab-caproni의 cells rig를 사용합니다.
cell은 레거시 cell(기존 GitLab.com 인스턴스)과 다른 점이 있으며, 단일 인스턴스 데이터베이스에서 실행하는 단위 테스트로는 이 차이를 확인할 수 없습니다. 사용자가 문제를 겪기 전에 이러한 차이를 찾으려면 cell에 대해 기능을 테스트합니다.
로컬에서 테스트#
워크스테이션에서 둘 이상의 cell을 실행하려면
gitlab-caproni의 cells rig를 사용합니다.
이 rig는 각 cell을 별도의 로컬 Kubernetes 클러스터에서 실행하며, colima를 사용하는 macOS만 지원합니다.
GitLab Development Kit(GDK)를 사용한다면 GDK에서 Cells 설정을 참조합니다.
cell에 대해 엔드 투 엔드 테스트 실행#
엔드 투 엔드 테스트 프레임워크는 QA_RUNNING_ON_CELL 환경 변수가 true이면 환경을 cell로 취급합니다.
이전에는 QA_COOKIES 환경 변수가 cell-로 시작하는 값의 _gitlab_session 쿠키를 설정했습니다.
이 쿠키는 환경을 cell로 표시하고 요청을 해당 cell로 라우팅했습니다.
프레임워크는 QA_RUNNING_ON_CELL로 전환하는 동안 이 쿠키를 계속 허용하지만, 쿠키는 더 이상 필요하지 않습니다.
이 쿠키가 설정되어 있으면 프레임워크는 자격 증명을 입력하기 전에 로그인 페이지를 새로 고칩니다.
새로 고치면 쿠키가 cell의 유효한 세션 쿠키로 바뀝니다.
요청이 cell에 도달하는 방식#
요청을 cell로 직접 라우팅할 필요는 없습니다. HTTP Router는 사용자의 Topology Service 클레임을 기준으로 테스트 사용자의 요청을 해당 사용자의 cell로 라우팅합니다.
- 로그인: 프레임워크는 2단계 로그인 흐름을 사용합니다.
HTTP Router는
/users/sign_in?login=<username>요청을 해당 사용자 이름을 클레임한 cell로 라우팅합니다. 그러면 cell이 cell의 접두사가 붙은_gitlab_session쿠키를 설정합니다. HTTP Router는 사용자가 로그아웃한 후에도 이 접두사를 기준으로 이후의 브라우저 요청을 라우팅합니다. - API: HTTP Router는 cell이 발급한 액세스 토큰의 접두사를 기준으로 요청을 라우팅합니다.
- HTTP를 통한 Git: HTTP Router는 HTTP Basic 인증 헤더의 사용자 이름을 기준으로 요청을 라우팅합니다.
따라서 테스트가 로그인에 사용하는 모든 사용자는 대상 cell에 존재해야 합니다.
GITLAB_USERNAME, GITLAB_ADMIN_USERNAME, GITLAB_QA_USERNAME_1 같은 각 QA 사용자 환경 변수는
대상 cell에서 생성된 사용자를 지정해야 합니다.
테스트가 관리자 API로 생성하는 사용자는 같은 cell에 생성됩니다.
변수 목록은
지원되는 환경 변수를 참조합니다.
일부 요청은 대상 cell이 아니라 레거시 cell에 도달합니다.
- 로그인하지 않는 브라우저. HTTP Router는 익명 요청을 cell에 대응시킬 수 없으므로 요청이 레거시 cell로 전달됩니다.
- 체험판 등록 같은 가입 및 등록 흐름. 새 사용자가 아직 존재하지 않으므로 HTTP Router가 라우팅 기준으로 삼을 클레임이 없습니다.
cell에서 달라지는 점#
프레임워크를 cell에 대해 실행하면 다음과 같이 동작합니다.
- 테스트 러너(
bin/qa)는:skip_cells태그가 붙은 테스트를 제외합니다. - API로 생성한 리소스가 사용 가능해질 때까지 기다리는 검사는 리소스를 사용할 수 없으면
테스트를 실패시킵니다.
모든 환경에서 이 검사는 리소스의 API 경로로 인증된
GET요청을 보냅니다. 리소스에 API 경로가 없으면 대신 리소스의 웹 URL을 요청합니다. 다섯 번 시도한 후에도 응답이200 OK가 아니면, cell에서는 이 검사가ResourceNotFoundError를 발생시킵니다. 다른 환경에서는 오류 없이 검사를 포기합니다.
프레임워크에 리소스를 추가한다면 해당 리소스의 GET 요청에 필요한 모든 매개변수가 포함되도록 합니다.
쿼리 매개변수를 추가하려면 리소스에서 query_parameters를 재정의합니다.
매개변수가 빠지면 POST 요청이 리소스를 생성했더라도 cell에서는 가용성 검사가 실패하므로
테스트가 실패합니다.
예를 들어 파일 리소스는 ref를 전달해야 합니다.
cell에서 통과할 수 없는 테스트 건너뛰기#
환경적인 이유로 테스트가 cell에서 통과할 수 없는 경우에만 :skip_cells 태그를 사용합니다.
예를 들면 다음과 같습니다.
- 테스트가 canary Gitaly 스토리지처럼 cell에 없는 인프라에 의존하는 경우.
- 테스트가 레거시 cell에만 있는 픽스처 데이터에 의존하는 경우.
제품 버그를 숨기는 데 이 태그를 사용하지 않습니다. 기능이 cell에서 동작하지 않는다면 대신 버그에 대한 이슈를 생성합니다.
태그를 추가할 때는 이유와 해당 차이를 추적하는 이슈 링크를 담은 주석을 추가합니다.
# Cells have no canary Gitaly storage: https://gitlab.com/gitlab-com/gl-infra/tenant-scale/cells-infrastructure/team/-/work_items/978
describe 'Git push to canary Gitaly node over HTTP', :skip_cells do
태그가 붙은 테스트를 그래도 cell에 대해 실행하는 방법은 엔드 투 엔드 테스트를 위한 RSpec 메타데이터를 참조합니다.
cell에서 동작하는 코드와 테스트 작성#
다음 가정은 cell에서 실패할 수 있습니다. 예시는 cell에 대해 엔드 투 엔드 테스트 스위트를 처음 실행했을 때 나온 것입니다. 기능에 같은 가정이 있는지 확인합니다.
ID가 4바이트에 들어가지 않음#
데이터베이스 시퀀스는 모든 cell에 걸쳐 고유하므로, 각 cell은 자체 범위에서 ID를 할당합니다. 자세한 내용은 데이터베이스 시퀀스를 참조합니다. 예를 들어 스테이징 Cell 9의 ID는 약 9,000,000,000,000부터 시작합니다. 이 값은 4바이트 정수의 최대값인 2,147,483,647보다 훨씬 큽니다. 레거시 cell에서 동작하는 코드가 cell에서는 실패할 수 있습니다.
- 칼럼 제한을 없애는 타입 캐스트는
ActiveModel::RangeError를 발생시킵니다.Gitlab::Database::BulkUpdate는bigint칼럼을 4바이트 정수로 바인딩해 이슈 보드가 동작하지 않았습니다. 자세한 내용은 이슈 981을 참조합니다. - 레코드 ID를
:integer로 저장하는jsonb_accessor속성은ActiveModel::RangeError를 발생시킵니다. - 레코드 ID를 32비트 타입인
GraphQL::Types::Int로 노출하는 GraphQL 필드는 ID를 반환할 때GraphQL::IntegerEncodingError를 발생시킵니다. 대신 글로벌 ID 타입 또는GraphQL::Types::BigInt를 사용합니다. 자세한 내용은 이슈 1051을 참조합니다.
코드가 레코드 ID를 캐스트, 직렬화 또는 저장한다면 2,147,483,647보다 큰 ID를 사용하는 spec을 추가합니다. 큰 ID로 전체 테스트 스위트를 실행하는 작업은 에픽 19924에서 추적합니다.
cell에는 기본 조직이 없음#
Organizations::Organization.default_organization은 cell에서 nil을 반환합니다.
대신 요청이나 레코드에서 조직을 가져옵니다.
요청에서 조직을 가져오려면 Current.organization 사용을 참조합니다.
예를 들어 기본 조직을 읽던 애플리케이션 설정 때문에 애플리케이션 설정 API가 500 오류를 반환했습니다.
자세한 내용은
이슈 971을 참조합니다.
클레임된 값은 모든 cell에서 고유함#
GPG 키의 지문 같은 클레임된 속성은 클러스터에서 하나의 cell에만 존재할 수 있습니다. 실행할 때마다 같은 고정 값을 생성하는 테스트는 다른 cell이 이미 그 값을 클레임한 경우 cell에서 실패할 수 있습니다. 대신 테스트를 실행할 때마다 새 값을 생성합니다. 자세한 내용은 이슈 975를 참조합니다.
일부 테이블과 데이터는 레거시 cell에만 존재함#
새 cell의 데이터베이스는 db/structure.sql과 프로덕션 픽스처로 생성됩니다.
이 데이터베이스에는 GitLab.com의 이력에서만 추가된 항목이 포함되어 있지 않습니다.
db/structure.sql에 없는 테이블.Gitlab.com?은 레거시 cell만이 아니라 cell에서도 참입니다.Gitlab.com?이 참일 때만 실행되는 마이그레이션도 cell에서 실행됩니다. 예를 들어 아카이브된 테이블에서 읽는 배치 백그라운드 마이그레이션은 테이블이 존재하지 않으므로 cell에서 실패합니다. 테이블이 없으면 마이그레이션이 아무 작업도 하지 않도록 합니다. 자세한 내용은 이슈 973을 참조합니다.- 더 이상 존재하지 않는 데이터 마이그레이션이 생성한 레코드.
예를 들어 새 cell의
plans테이블에는 기본 플랜과 무료 플랜의 행만 있습니다. 이 테이블에서 유료 플랜을 읽는 코드는 행을 찾지 못합니다. 대신GitlabSubscriptions::SystemDefined::Plan을 사용해 플랜을 조회합니다. 자세한 내용은 이슈 977을 참조합니다.