Import/Export 개발 문서
Import/Export feature에 대한 일반적인 개발 지침과 팁.
본 문서는 YouTube에서 제공하는 Import/Export 201 프레젠테이션을 기반으로 합니다.
더 많은 컨텍스트를 원한다면 YouTube의 Import / Export Development 심층 분석을 시청하세요.
보안
Import/Export 기능은 지속적으로 업데이트됩니다(내보낼 새로운 항목을 추가함). 그러나 코드는 오랜 시간 동안 리팩토링되지 않았습니다. 우리는 동적인 특성이 보안 문제 수를 증가시키지 않는지 확인하기 위해 코드 감사를 수행해야 합니다. GitLab 팀원들은 이 비밀 이슈에서 더 많은 정보를 확인할 수 있습니다: https://gitlab.com/gitlab-org/gitlab/-/issues/20720
.
코드 내의 보안
이러한 클래스 중 일부는 Import/Export에 대한 보안 계층을 제공합니다.
AttributeCleaner
는 금지된 키를 제거합니다:
# AttributeCleaner
# 모든 `_ids` 및 다른 금지된 키를 제거합니다.
class AttributeCleaner
ALLOWED_REFERENCES = RelationFactory::PROJECT_REFERENCES + RelationFactory::USER_REFERENCES + ['group_id']
def clean
@relation_hash.reject do |key, _value|
prohibited_key?(key) || !@relation_class.attribute_method?(key) || excluded_key?(key)
end.except('id')
end
...
AttributeConfigurationSpec
은 새 열의 추가를 확인하고 확인합니다:
# AttributeConfigurationSpec
<<-MSG
프로젝트 Import/Export를 사용하여 내보낸 #{relation_class}에 새 속성이 있는 것 같습니다:
새로운 속성을 내보낼 수 있는 경우 SAFE_MODEL_ATTRIBUTES에 해당 속성을 추가하세요.
해당 모델에서 EXCLUDED_ATTRIBUTES 섹션에 해당 속성을 추가하여 IMPORT_EXPORT_CONFIG에서 화이트리스트에 추가하세요.
SAFE_MODEL_ATTRIBUTES: #{File.expand_path(safe_attributes_file)}
IMPORT_EXPORT_CONFIG: #{Gitlab::ImportExport.config_file}
MSG
ModelConfigurationSpec
은 새 모델의 추가를 확인하고 확인합니다:
# ModelConfigurationSpec
<<-MSG
#{parent_model_name}과 관련된 새로운 모델 <#{new_models.join(',')}>이 Import/Export 기능으로 내보내집니다.
이 모델을 내보낼 필요가 있다고 생각되면 `#{Gitlab::ImportExport.config_file}`에 추가하세요.
또한 이 에러를 처리하고 나중에 표시되지 않도록 하기 위해 반드시 `#{File.expand_path(ce_models_yml)}`에 추가해야 합니다.
MSG
ExportFileSpec
은 암호화되거나 민감한 열을 감지합니다:
# ExportFileSpec
<<-MSG
해시 #{parent.inspect}에 있는 새로운 민감한 단어 <#{key_found}>을(를) 발견했습니다.
이 정보를 내보내면 안 된다고 생각하는 경우 IMPORT_EXPORT_CONFIG에서 모델 또는 속성을 제외하십시오.
그렇지 않은 경우 CURRENT_SPEC의 +safe_list+에 예외를 추가하여 #{sensitive_word}를 키로 사용하고 일치하는 해시 또는 모델을 값으로 사용하세요.
또한, 해당 속성이 생성된 고유한 토큰인 경우 (동일한 인스턴스로 가져올 때 중복 열 문제를 방지하기 위해) RelationFactory::TOKEN_RESET_MODELS에 추가하세요.
IMPORT_EXPORT_CONFIG: #{Gitlab::ImportExport.config_file}
CURRENT_SPEC: #{__FILE__}
MSG
버전 관리
Import/Export는 단일 GitLab 릴리스 중에 빈번한 변경이 있으므로 엄격한 SemVer를 사용하지 않습니다. 파괴적인 변경이 있는 경우에 업데이트가 필요합니다.
# ImportExport
module Gitlab
module ImportExport
extend self
# 버전 업데이트마다 import_export.md의 이력을 최신 상태로 유지해야 합니다.
VERSION = '0.2.4'
호환성
프로젝트를 가져오고 내보낼 때 호환성을 확인하십시오.
버전을 높이는 시점
모델/열의 이름을 바꾸거나 어떤 형식을 수행하는 경우에는 버전을 높여야 합니다. JSON 구조 또는 아카이브 파일의 파일 구조의 수정이 필요합니다.
다음의 경우에는 버전을 높일 필요가 없습니다:
- 새 열 또는 모델을 추가하는 경우
- 열 또는 모델을 제거하는 경우 (DB 제약 조건이 있는 경우를 제외)
- 새로운 항목을 내보내는 경우 (예: 새로운 유형의 업로드)
매번 버전을 높일 때마다 통합 스펙에서 실패하며 다음 명령으로 수정할 수 있습니다:
bundle exec rake gitlab:import_export:bump_version
코드로 간단히 들여다보기
Import/Export 구성 (import_export.yml
)
기본 구성 import_export.yml
은 내보내거나 가져올 수 있는 모델을 정의합니다.
프로젝트 import/export에 포함될 모델 관계:
project_tree:
- labels:
- :priorities
- milestones:
- events:
- :push_event_payload
- issues:
- events:
# ...
지정된 모델에 대해 다음과 같은 속성만 포함합니다:
included_attributes:
user:
- :id
- :public_email
# ...
지정된 모델에 대해 다음과 같은 속성은 포함하지 않습니다:
excluded_attributes:
project:
- :name
- :path
- ...
내보내려는 모델에 의해 호출될 추가 메서드:
# Methods
methods:
labels:
- :type
label:
- :type
모델 관계의 내보내기 순서를 사용자 정의:
# 지정된 관계에 대한 사용자 정의 내보내기 재정렬 지정
# 예를 들어 issues의 경우, 우리는 :relative_position을 기준으로 사용자 정의 내보내기 재정렬을 사용합니다. 그래서 가져오기시에 관계의 상대적 위치 값을 재설정할 수 있지만 전체 문제 순서를 유지할 수 있습니다.
# 기본적으로 관계의 정렬은 기본키(PK)로 수행됩니다.
# column - 순서를 재정렬하는데 사용할 열을 지정하며, 기본값은 관계의 PK입니다.
# direction - 순서를 지정하는 방향을 지정합니다. :asc 또는 :desc, 기본값은 :asc입니다.
# nulls_position - null 값이 배치될 위치를 지정합니다. 사용자 정의 정렬 열에는 null이 포함될 수 있기 때문에 null 값이 배치될 위치를 지정해야 합니다.
# :nulls_last 또는 :nulls_first를 지정할 수 있으며, 기본값은 :nulls_last입니다.
export_reorders:
project:
issues:
column: :relative_position
direction: :asc
nulls_position: :nulls_last
조건부 내보내기
프로젝트 외부의 연관 리소스인 경우, 프로젝트 또는 그룹을 내보내는 사용자가 해당 연관성에 액세스할 수 있는지 확인해야 할 수도 있습니다. include_if_exportable
은 리소스의 연관 배열을 수락합니다. 내보내기 중에 리소스의 exportable_association?
메서드는 연관성의 이름과 사용자의 유효성을 확인합니다.
예를 들어:
include_if_exportable:
project:
issues:
- epic_issue
이 정의:
- 이슈의
exportable_association?(:epic_issue, current_user: current_user)
메서드를 호출합니다. - 메서드가 true를 반환하면 이슈의
epic_issue
연관을 포함합니다.
가져오기
가져오기 작업 상태는 none
에서 scheduled
로 이동되고 이후에는 started
로 이동되며 최종적으로 finished
또는 failed
로 이동됩니다.
상태가 started
인 동안 Importer
코드는 가져오기에 필요한 각 단계를 처리합니다.
# ImportExport::Importer
module Gitlab
module ImportExport
class Importer
def execute
if import_file && check_version! && restorers.all?(&:restore) && overwrite_project
project
else
raise Projects::ImportService::Error.new(@shared.errors.join(', '))
end
rescue => e
raise Projects::ImportService::Error.new(e.message)
ensure
remove_import_file
end
def restorers
[repo_restorer, wiki_restorer, project_tree, avatar_restorer,
uploads_restorer, lfs_restorer, statistics_restorer]
end
Export 서비스는 데이터를 저장하는 대신 데이터를 복원합니다.
Export
# ImportExport::ExportService
module Projects
module ImportExport
class ExportService < BaseService
def save_all!
if save_services
Gitlab::ImportExport::Saver.save(project: project, shared: @shared)
notify_success
else
cleanup_and_notify_error!
end
end
def save_services
[version_saver, avatar_saver, project_tree_saver, uploads_saver, repo_saver,
wiki_repo_saver, lfs_saver].all?(&:save)
end
테스트용 픽스처
수입/수출 스펙에 사용되는 픽스처는 spec/fixtures/lib/gitlab/import_export
에 있습니다. 프로젝트 및 그룹 픽스처가 모두 있습니다.
각각의 픽스처에는 두 가지 버전이 있습니다.
- 모든 객체를 포함한 사람이 읽을 수 있는 단일 JSON 파일로,
project.json
또는group.json
로 불립니다. -
ndjson
형식의 파일 트리를 포함하는tree
라는 폴더가 있습니다. 절대로 꼭 필요한 경우가 아니라면이 폴더 아래의 파일을 매뉴얼으로 편집하지 마십시오.
인간이 읽을 수 있는 JSON 파일에서 NDJSON 트리를 생성하는 도구는 gitlab-org/memory-team/team-tools
프로젝트에 있습니다.
프로젝트
legacy-project-json-to-ndjson.sh
을 사용하여 NDJSON 트리를 생성합니다.
NDJSON 트리는 다음과 같이 보입니다:
tree
├── project
│ ├── auto_devops.ndjson
│ ├── boards.ndjson
│ ├── ci_cd_settings.ndjson
│ ├── ci_pipelines.ndjson
│ ├── container_expiration_policy.ndjson
│ ├── custom_attributes.ndjson
│ ├── error_tracking_setting.ndjson
│ ├── external_pull_requests.ndjson
│ ├── issues.ndjson
│ ├── labels.ndjson
│ ├── merge_requests.ndjson
│ ├── milestones.ndjson
│ ├── pipeline_schedules.ndjson
│ ├── project_badges.ndjson
│ ├── project_feature.ndjson
│ ├── project_members.ndjson
│ ├── protected_branches.ndjson
│ ├── protected_tags.ndjson
│ ├── releases.ndjson
│ ├── services.ndjson
│ ├── snippets.ndjson
│ └── triggers.ndjson
└── project.json
그룹
legacy-group-json-to-ndjson.rb
을 사용하여 NDJSON 트리를 생성합니다.
NDJSON 트리는 다음과 같이 보입니다:
tree
└── groups
├── 4351
│ ├── badges.ndjson
│ ├── boards.ndjson
│ ├── epics.ndjson
│ ├── labels.ndjson
│ ├── members.ndjson
│ └── milestones.ndjson
├── 4352
│ ├── badges.ndjson
│ ├── boards.ndjson
│ ├── epics.ndjson
│ ├── labels.ndjson
│ ├── members.ndjson
│ └── milestones.ndjson
├── _all.ndjson
├── 4351.json
└── 4352.json
json
파일과tree
폴더 모두 업데이트하는 것을 확인하십시오.
```