Add latest changes from gitlab-org/gitlab@master

5 files changed, 352 insertions, 0 deletions

diff --git a/lib/gitlab/import_export/group/import_export.yml b/lib/gitlab/import_export/group/import_export.yml
new file mode 100644
index 00000000000..d4e0ff12373
--- /dev/null
+++ b/lib/gitlab/import_export/group/import_export.yml
@@ -0,0 +1,78 @@
+# Model relationships to be included in the group import/export
+#
+# This list _must_ only contain relationships that are available to both FOSS and
+# Enterprise editions. EE specific relationships must be defined in the `ee` section further
+# down below.
+tree:
+  group:
+    - :milestones
+    - :badges
+    - labels:
+      - :priorities
+    - boards:
+      - lists:
+        - label:
+          - :priorities
+        - :board
+    - members:
+      - :user
+
+included_attributes:
+  user:
+    - :id
+    - :email
+    - :username
+  author:
+    - :name
+
+excluded_attributes:
+  group:
+    - :id
+    - :owner_id
+    - :parent_id
+    - :created_at
+    - :updated_at
+    - :runners_token
+    - :runners_token_encrypted
+    - :saml_discovery_token
+    - :visibility_level
+
+methods:
+  labels:
+    - :type
+  label:
+    - :type
+  badges:
+    - :type
+  notes:
+    - :type
+  events:
+    - :action
+  lists:
+    - :list_type
+
+preloads:
+
+# EE specific relationships and settings to include. All of this will be merged
+# into the previous structures if EE is used.
+ee:
+  tree:
+    group:
+      - epics:
+        - :parent
+        - :award_emoji
+        - events:
+          - :push_event_payload
+        - notes:
+          - :author
+          - :award_emoji
+          - events:
+            - :push_event_payload
+      - boards:
+        - :board_assignee
+        - labels:
+          - :priorities
+        - lists:
+          - milestone:
+            - events:
+              - :push_event_payload
diff --git a/lib/gitlab/import_export/group/object_builder.rb b/lib/gitlab/import_export/group/object_builder.rb
new file mode 100644
index 00000000000..e171a31348e
--- /dev/null
+++ b/lib/gitlab/import_export/group/object_builder.rb
@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module ImportExport
+    module Group
+      # Given a class, it finds or creates a new object at group level.
+      #
+      # Example:
+      #   `Group::ObjectBuilder.build(Label, label_attributes)`
+      #    finds or initializes a label with the given attributes.
+      class ObjectBuilder < Base::ObjectBuilder
+        def self.build(*args)
+          ::Group.transaction do
+            super
+          end
+        end
+
+        def initialize(klass, attributes)
+          super
+
+          @group = @attributes['group']
+
+          update_description
+        end
+
+        private
+
+        attr_reader :group
+
+        # Convert description empty string to nil
+        # due to existing object being saved with description: nil
+        # Which makes object lookup to fail since nil != ''
+        def update_description
+          attributes['description'] = nil if attributes['description'] == ''
+        end
+
+        def where_clauses
+          [
+            where_clause_base,
+            where_clause_for_title,
+            where_clause_for_description,
+            where_clause_for_created_at
+          ].compact
+        end
+
+        # Returns Arel clause `"{table_name}"."group_id" = {group.id}`
+        def where_clause_base
+          table[:group_id].in(group_and_ancestor_ids)
+        end
+
+        def group_and_ancestor_ids
+          group.ancestors.map(&:id) << group.id
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/import_export/group/relation_factory.rb b/lib/gitlab/import_export/group/relation_factory.rb
new file mode 100644
index 00000000000..91637161377
--- /dev/null
+++ b/lib/gitlab/import_export/group/relation_factory.rb
@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module ImportExport
+    module Group
+      class RelationFactory < Base::RelationFactory
+        OVERRIDES = {
+          labels:     :group_labels,
+          priorities: :label_priorities,
+          label:      :group_label,
+          parent:     :epic
+        }.freeze
+
+        EXISTING_OBJECT_RELATIONS = %i[
+          epic
+          epics
+          milestone
+          milestones
+          label
+          labels
+          group_label
+          group_labels
+        ].freeze
+
+        private
+
+        def setup_models
+          setup_note if @relation_name == :notes
+
+          update_group_references
+        end
+
+        def update_group_references
+          return unless self.class.existing_object_relations.include?(@relation_name)
+          return unless @relation_hash['group_id']
+
+          @relation_hash['group_id'] = @importable.id
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/import_export/group/tree_restorer.rb b/lib/gitlab/import_export/group/tree_restorer.rb
new file mode 100644
index 00000000000..e6f49dcac7a
--- /dev/null
+++ b/lib/gitlab/import_export/group/tree_restorer.rb
@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module ImportExport
+    module Group
+      class TreeRestorer
+        attr_reader :user
+        attr_reader :shared
+        attr_reader :group
+
+        def initialize(user:, shared:, group:, group_hash:)
+          @path = File.join(shared.export_path, 'group.json')
+          @user = user
+          @shared = shared
+          @group = group
+          @group_hash = group_hash
+        end
+
+        def restore
+          @tree_hash = @group_hash || read_tree_hash
+          @group_members = @tree_hash.delete('members')
+          @children = @tree_hash.delete('children')
+
+          if members_mapper.map && restorer.restore
+            @children&.each do |group_hash|
+              group = create_group(group_hash: group_hash, parent_group: @group)
+              shared = Gitlab::ImportExport::Shared.new(group)
+
+              self.class.new(
+                user: @user,
+                shared: shared,
+                group: group,
+                group_hash: group_hash
+              ).restore
+            end
+          end
+
+          return false if @shared.errors.any?
+
+          true
+        rescue => e
+          @shared.error(e)
+          false
+        end
+
+        private
+
+        def read_tree_hash
+          json = IO.read(@path)
+          ActiveSupport::JSON.decode(json)
+        rescue => e
+          @shared.logger.error(
+            group_id:   @group.id,
+            group_name: @group.name,
+            message:    "Import/Export error: #{e.message}"
+          )
+
+          raise Gitlab::ImportExport::Error.new('Incorrect JSON format')
+        end
+
+        def restorer
+          @relation_tree_restorer ||= RelationTreeRestorer.new(
+            user:             @user,
+            shared:           @shared,
+            importable:       @group,
+            tree_hash:        @tree_hash.except('name', 'path'),
+            members_mapper:   members_mapper,
+            object_builder:   object_builder,
+            relation_factory: relation_factory,
+            reader:           reader
+          )
+        end
+
+        def create_group(group_hash:, parent_group:)
+          group_params = {
+            name:      group_hash['name'],
+            path:      group_hash['path'],
+            parent_id: parent_group&.id,
+            visibility_level: sub_group_visibility_level(group_hash, parent_group)
+          }
+
+          ::Groups::CreateService.new(@user, group_params).execute
+        end
+
+        def sub_group_visibility_level(group_hash, parent_group)
+          original_visibility_level = group_hash['visibility_level'] || Gitlab::VisibilityLevel::PRIVATE
+
+          if parent_group && parent_group.visibility_level < original_visibility_level
+            Gitlab::VisibilityLevel.closest_allowed_level(parent_group.visibility_level)
+          else
+            original_visibility_level
+          end
+        end
+
+        def members_mapper
+          @members_mapper ||= Gitlab::ImportExport::MembersMapper.new(exported_members: @group_members, user: @user, importable: @group)
+        end
+
+        def relation_factory
+          Gitlab::ImportExport::Group::RelationFactory
+        end
+
+        def object_builder
+          Gitlab::ImportExport::Group::ObjectBuilder
+        end
+
+        def reader
+          @reader ||= Gitlab::ImportExport::Reader.new(
+            shared: @shared,
+            config: Gitlab::ImportExport::Config.new(
+              config: Gitlab::ImportExport.group_config_file
+            ).to_h
+          )
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/import_export/group/tree_saver.rb b/lib/gitlab/import_export/group/tree_saver.rb
new file mode 100644
index 00000000000..48f6925884b
--- /dev/null
+++ b/lib/gitlab/import_export/group/tree_saver.rb
@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module ImportExport
+    module Group
+      class TreeSaver
+        attr_reader :full_path, :shared
+
+        def initialize(group:, current_user:, shared:, params: {})
+          @params       = params
+          @current_user = current_user
+          @shared       = shared
+          @group        = group
+          @full_path    = File.join(@shared.export_path, ImportExport.group_filename)
+        end
+
+        def save
+          group_tree = serialize(@group, reader.group_tree)
+          tree_saver.save(group_tree, @shared.export_path, ImportExport.group_filename)
+
+          true
+        rescue => e
+          @shared.error(e)
+          false
+        end
+
+        private
+
+        def serialize(group, relations_tree)
+          group_tree = tree_saver.serialize(group, relations_tree)
+
+          group.children.each do |child|
+            group_tree['children'] ||= []
+            group_tree['children'] << serialize(child, relations_tree)
+          end
+
+          group_tree
+        rescue => e
+          @shared.error(e)
+        end
+
+        def reader
+          @reader ||= Gitlab::ImportExport::Reader.new(
+            shared: @shared,
+            config: Gitlab::ImportExport::Config.new(
+              config: Gitlab::ImportExport.group_config_file
+            ).to_h
+          )
+        end
+
+        def tree_saver
+          @tree_saver ||= RelationTreeSaver.new
+        end
+      end
+    end
+  end
+end