debian-mirror-gitlab/doc/development/import_project.md

stage	group	info
none	unassigned	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Test import project

For testing, we can import our own GitLab CE project (named gitlabhq in this case) under a group named qa-perf-testing. Project tarballs that can be used for testing can be found over on the performance-data project. A different project could be used if required.

You can import the project into your GitLab environment in a number of ways. They are detailed as follows with the assumption that the recommended group qa-perf-testing and project gitlabhq are being set up.

Importing the project

Use one of these methods to import the test project.

Import by using the UI

The first option is to import the project tarball file by using the GitLab UI:

1. Create the group qa-perf-testing.
2. Import the GitLab FOSS project tarball into the group.

It should take up to 15 minutes for the project to fully import. You can head to the project's main page for the current status.

This method ignores all the errors silently (including the ones related to GITALY_DISABLE_REQUEST_LIMITS) and is used by GitLab users. For development and testing, check the other methods below.

Import by using the import-project script

A convenient script, bin/import-project, is provided with performance project to import the Project tarball into a GitLab environment via API from the terminal.

Note that to use the script, it requires some preparation if you haven't done so already:

1. First, set up Ruby and Ruby Bundler if they aren't already available on the machine.
2. Next, install the required Ruby Gems via Bundler with bundle install.

For details how to use bin/import-project, run:

bin/import-project --help

The process should take up to 15 minutes for the project to import fully. The script checks the status periodically and exits after the import has completed.

Import by using GitHub

There is also an option to import the project via GitHub:

1. Create the group qa-perf-testing
2. Import the GitLab FOSS repository that's mirrored on GitHub into the group via the UI.

This method takes longer to import than the other methods and depends on several factors. It's recommended to use the other methods.

Import by using a Rake task

To import the test project by using a Rake task, see Import large projects.

Import by using the Rails console

The last option is to import a project using a Rails console:

1. Start a Ruby on Rails console:

   # Omnibus GitLab
   gitlab-rails console
   
   # For installations from source
   sudo -u git -H bundle exec rails console -e production
   

2. Create a project and run Project::TreeRestorer:

   shared_class = Struct.new(:export_path) do
     def error(message)
       raise message
     end
   end
   
   user = User.first
   
   shared = shared_class.new(path)
   
   project = Projects::CreateService.new(user, { name: name, namespace: user.namespace }).execute
   begin
     #Enable Request store
     RequestStore.begin!
     Gitlab::ImportExport::Project::TreeRestorer.new(user: user, shared: shared, project: project).restore
   ensure
     RequestStore.end!
     RequestStore.clear!
   end
   

3. In case you need the repository as well, you can restore it using:

   repo_path = File.join(shared.export_path, Gitlab::ImportExport.project_bundle_filename)
   
   Gitlab::ImportExport::RepoRestorer.new(path_to_bundle: repo_path,
                                          shared: shared,
                                          importable: project).restore
   

   We are storing all import failures in the import_failures data table.

   To make sure that the project import finished without any issues, check:

   project.import_failures.all
   

Performance testing

For Performance testing, we should:

• Import a quite large project, gitlabhq should be a good example.
• Measure the execution time of Project::TreeRestorer.
• Count the number of executed SQL queries during the restore.
• Observe the number of GC cycles happening.

You can use this snippet: https://gitlab.com/gitlab-org/gitlab/snippets/1924954 (must be logged in), which restores the project, and measures the execution time of Project::TreeRestorer, number of SQL queries and number of GC cycles happening.

You can execute the script from the gdk/gitlab directory like this:

bundle exec rails r  /path_to_script/script.rb project_name /path_to_extracted_project request_store_enabled

Access token setup

Many of the tests also require a GitLab personal access token because numerous endpoints require authentication themselves.

The GitLab documentation details how to create this token. The tests require that the token is generated by an administrator and that it has the API and read_repository permissions.

Details on how to use the Access Token with each type of test are found in their respective documentation.