Merge branch 'kassio/bulkimports-group-labels-pipeline' into 'master'

BulkImports: Import Group Labels

See merge request gitlab-org/gitlab!52260

changelogs/unreleased/kassio-bulkimports-group-labels-pipeline.yml

+---
+title: 'BulkImports: Import Group Labels'
+merge_request: 52260
+author:
+type: added

ee/spec/lib/ee/bulk_imports/importers/group_importer_spec.rb

@@ -24,6 +24,7 @@ RSpec.describe BulkImports::Importers::GroupImporter do
   describe '#execute' do
     it "starts the entity and run its pipelines" do
       expect_to_run_pipeline BulkImports::Groups::Pipelines::GroupPipeline, context: context
+      expect_to_run_pipeline BulkImports::Groups::Pipelines::LabelsPipeline, context: context
       expect_to_run_pipeline EE::BulkImports::Groups::Pipelines::EpicsPipeline, context: context
       expect_to_run_pipeline BulkImports::Groups::Pipelines::SubgroupEntitiesPipeline, context: context
 

lib/bulk_imports/groups/graphql/get_labels_query.rb

+# frozen_string_literal: true
+
+module BulkImports
+  module Groups
+    module Graphql
+      module GetLabelsQuery
+        extend self
+
+        def to_s
+          <<-'GRAPHQL'
+          query ($full_path: ID!, $cursor: String) {
+            group(fullPath: $full_path) {
+              labels(first: 100, after: $cursor) {
+                page_info: pageInfo {
+                  end_cursor: endCursor
+                  has_next_page: hasNextPage
+                }
+                nodes {
+                  title
+                  description
+                  color
+                }
+              }
+            }
+          }
+          GRAPHQL
+        end
+
+        def variables(entity)
+          {
+            full_path: entity.source_full_path,
+            cursor: entity.next_page_for(:labels)
+          }
+        end
+      end
+    end
+  end
+end

lib/bulk_imports/groups/loaders/labels_loader.rb

+# frozen_string_literal: true
+
+module BulkImports
+  module Groups
+    module Loaders
+      class LabelsLoader
+        def initialize(*); end
+
+        def load(context, data)
+          Array.wrap(data['nodes']).each do |entry|
+            Labels::CreateService.new(entry)
+              .execute(group: context.entity.group)
+          end
+
+          context.entity.update_tracker_for(
+            relation: :labels,
+            has_next_page: data.dig('page_info', 'has_next_page'),
+            next_page: data.dig('page_info', 'end_cursor')
+          )
+        end
+      end
+    end
+  end
+end

lib/bulk_imports/groups/pipelines/labels_pipeline.rb

+# frozen_string_literal: true
+
+module BulkImports
+  module Groups
+    module Pipelines
+      class LabelsPipeline
+        include Pipeline
+
+        extractor BulkImports::Common::Extractors::GraphqlExtractor,
+          query: BulkImports::Groups::Graphql::GetLabelsQuery
+
+        transformer BulkImports::Common::Transformers::HashKeyDigger, key_path: %w[data group labels]
+        transformer Common::Transformers::ProhibitedAttributesTransformer
+
+        loader BulkImports::Groups::Loaders::LabelsLoader
+
+        def after_run(context)
+          if context.entity.has_next_page?(:labels)
+            run(context)
+          end
+        end
+      end
+    end
+  end
+end

lib/bulk_imports/importers/group_importer.rb

@@ -29,7 +29,8 @@ module BulkImports
       def pipelines
         [
           BulkImports::Groups::Pipelines::GroupPipeline,
-          BulkImports::Groups::Pipelines::SubgroupEntitiesPipeline
+          BulkImports::Groups::Pipelines::SubgroupEntitiesPipeline,
+          BulkImports::Groups::Pipelines::LabelsPipeline
         ]
       end
     end

spec/lib/bulk_imports/groups/pipelines/labels_pipeline_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe BulkImports::Groups::Pipelines::LabelsPipeline do
+  let(:user) { create(:user) }
+  let(:group) { create(:group) }
+  let(:entity) do
+    create(
+      :bulk_import_entity,
+      source_full_path: 'source/full/path',
+      destination_name: 'My Destination Group',
+      destination_namespace: group.full_path,
+      group: group
+    )
+  end
+
+  let(:context) do
+    BulkImports::Pipeline::Context.new(
+      current_user: user,
+      entity: entity
+    )
+  end
+
+  def extractor_data(title:, has_next_page:, cursor: "")
+    {
+      "data" => {
+        "group" => {
+          "labels" => {
+            "page_info" => {
+              "end_cursor" => cursor,
+              "has_next_page" => has_next_page
+            },
+            "nodes" => [
+              {
+                "title" => title,
+                "description" => "desc",
+                "color" => "#428BCA"
+              }
+            ]
+          }
+        }
+      }
+    }
+  end
+
+  describe '#run' do
+    it 'imports a group labels' do
+      first_page = extractor_data(title: 'label1', has_next_page: true, cursor: 'nextPageCursor')
+      last_page = extractor_data(title: 'label2', has_next_page: false)
+
+      allow_next_instance_of(BulkImports::Common::Extractors::GraphqlExtractor) do |extractor|
+        allow(extractor)
+          .to receive(:extract)
+          .and_return(first_page, last_page)
+      end
+
+      expect { subject.run(context) }.to change(Label, :count).by(2)
+
+      label = group.labels.order(:created_at).last
+
+      expect(label.title).to eq('label2')
+      expect(label.description).to eq('desc')
+      expect(label.color).to eq('#428BCA')
+    end
+  end
+
+  describe 'pipeline parts' do
+    it { expect(described_class).to include_module(BulkImports::Pipeline) }
+    it { expect(described_class).to include_module(BulkImports::Pipeline::Runner) }
+
+    it 'has extractors' do
+      expect(described_class.get_extractor)
+        .to eq(
+          klass: BulkImports::Common::Extractors::GraphqlExtractor,
+          options: {
+            query: BulkImports::Groups::Graphql::GetLabelsQuery
+          }
+        )
+    end
+
+    it 'has transformers' do
+      expect(described_class.transformers)
+        .to contain_exactly(
+          { klass: BulkImports::Common::Transformers::HashKeyDigger, options: { key_path: %w[data group labels] } },
+          { klass: BulkImports::Common::Transformers::ProhibitedAttributesTransformer, options: nil }
+        )
+    end
+
+    it 'has loaders' do
+      expect(described_class.get_loader).to eq(klass: BulkImports::Groups::Loaders::LabelsLoader, options: nil)
+    end
+  end
+end

spec/lib/bulk_imports/importers/group_importer_spec.rb

@@ -24,6 +24,7 @@ RSpec.describe BulkImports::Importers::GroupImporter do
   describe '#execute' do
     it 'starts the entity and run its pipelines' do
       expect_to_run_pipeline BulkImports::Groups::Pipelines::GroupPipeline, context: context
+      expect_to_run_pipeline BulkImports::Groups::Pipelines::LabelsPipeline, context: context
       expect_to_run_pipeline('EE::BulkImports::Groups::Pipelines::EpicsPipeline'.constantize, context: context) if Gitlab.ee?
       expect_to_run_pipeline BulkImports::Groups::Pipelines::SubgroupEntitiesPipeline, context: context