Merge branch '339406-gitlab-migration-migrate-snippets-with-notes-and-awards' into 'master'

Resolve "GitLab Migration - Migrate Snippets with Notes and Awards"

See merge request gitlab-org/gitlab!73271

ee/spec/lib/ee/bulk_imports/projects/stage_spec.rb

@@ -10,6 +10,7 @@ RSpec.describe BulkImports::Projects::Stage do
       [2, BulkImports::Common::Pipelines::LabelsPipeline],
       [2, BulkImports::Common::Pipelines::MilestonesPipeline],
       [3, BulkImports::Projects::Pipelines::IssuesPipeline],
+      [3, BulkImports::Projects::Pipelines::SnippetsPipeline],
       [4, BulkImports::Common::Pipelines::BoardsPipeline],
       [4, BulkImports::Projects::Pipelines::MergeRequestsPipeline],
       [4, BulkImports::Projects::Pipelines::ExternalPullRequestsPipeline],

lib/bulk_imports/projects/pipelines/snippets_pipeline.rb

+# frozen_string_literal: true
+
+module BulkImports
+  module Projects
+    module Pipelines
+      class SnippetsPipeline
+        include NdjsonPipeline
+
+        relation_name 'snippets'
+
+        extractor ::BulkImports::Common::Extractors::NdjsonExtractor, relation: relation
+      end
+    end
+  end
+end

lib/bulk_imports/projects/stage.rb

@@ -27,6 +27,10 @@ module BulkImports
             pipeline: BulkImports::Projects::Pipelines::IssuesPipeline,
             stage: 3
           },
+          snippets: {
+            pipeline: BulkImports::Projects::Pipelines::SnippetsPipeline,
+            stage: 3
+          },
           boards: {
             pipeline: BulkImports::Common::Pipelines::BoardsPipeline,
             stage: 4

spec/factories/notes.rb

@@ -8,6 +8,7 @@ FactoryBot.define do
     note { generate(:title) }
     author { project&.creator || association(:user) }
     on_issue
+    updated_by { author }
 
     factory :note_on_commit,             traits: [:on_commit]
     factory :note_on_issue,              traits: [:on_issue], aliases: [:votable_note]

spec/lib/bulk_imports/projects/pipelines/snippets_pipeline_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe BulkImports::Projects::Pipelines::SnippetsPipeline do
+  let_it_be(:user) { create(:user) }
+  let_it_be(:group) { create(:group) }
+  let_it_be(:project) { create(:project, group: group) }
+  let_it_be(:bulk_import) { create(:bulk_import, user: user) }
+  let_it_be(:entity) do
+    create(
+      :bulk_import_entity,
+      :project_entity,
+      project: project,
+      bulk_import: bulk_import,
+      source_full_path: 'source/full/path',
+      destination_name: 'My Destination Project',
+      destination_namespace: group.full_path
+    )
+  end
+
+  let_it_be(:tracker) { create(:bulk_import_tracker, entity: entity) }
+  let_it_be(:context) { BulkImports::Pipeline::Context.new(tracker) }
+
+  let(:snippet_attributes) { {} }
+  let(:exported_snippet) do
+    {
+      'id' => 25,
+      'title' => 'Snippet with 2 files',
+      'content' => 'content',
+      'author_id' => 22,
+      'project_id' => 6,
+      'created_at' => '2021-10-28T20:21:59.712Z',
+      'updated_at' => '2021-10-28T20:31:10.408Z',
+      'file_name' => 'galactic_empire.rb',
+      'visibility_level' => 0,
+      'description' => 'How to track your Galactic armies.'
+    }.merge(snippet_attributes)
+  end
+
+  subject(:pipeline) { described_class.new(context) }
+
+  describe '#run' do
+    before do
+      group.add_owner(user)
+      snippet_with_index = [exported_snippet.dup, 0]
+
+      allow_next_instance_of(BulkImports::Common::Extractors::NdjsonExtractor) do |extractor|
+        allow(extractor).to receive(:extract).and_return(BulkImports::Pipeline::ExtractedData.new(data: [snippet_with_index]))
+      end
+
+      pipeline.run
+    end
+
+    it 'imports snippet into destination project' do
+      imported_snippet = project.snippets.last
+
+      expect(imported_snippet).to have_attributes(
+        title: exported_snippet['title'],
+        content: exported_snippet['content'],
+        author_id: user.id,
+        created_at: DateTime.parse(exported_snippet['created_at']),
+        updated_at: DateTime.parse(exported_snippet['updated_at']),
+        file_name: exported_snippet['file_name'],
+        visibility_level: exported_snippet['visibility_level'])
+    end
+
+    context 'with award_emoji' do
+      let(:snippet_attributes) { { 'award_emoji' => [expected_award] } }
+      let(:expected_award) do
+        {
+          'id' => 580,
+          'name' => 'rocket',
+          'user_id' => 1,
+          'awardable_type' => 'Snippet',
+          'created_at' => '2021-10-28T20:30:25.802Z',
+          'updated_at' => '2021-10-28T20:30:25.802Z'
+        }
+      end
+
+      it 'restores the award_emoji' do
+        snippet_award = project.snippets.first.award_emoji.first
+
+        expect(snippet_award).to have_attributes(
+          name: expected_award['name'],
+          user_id: user.id,
+          awardable_type: expected_award['awardable_type'],
+          created_at: DateTime.parse(expected_award['created_at']),
+          updated_at: DateTime.parse(expected_award['updated_at']))
+      end
+    end
+
+    context 'with notes', :freeze_time do
+      # To properly emulate a fixture that is expected to be read from a file, we dump a json
+      # object, then parse it right away. We expected that some attrs like Datetimes be
+      # converted to Strings.
+      let(:exported_snippet) { Gitlab::Json.parse(note.noteable.attributes.merge('notes' => notes).to_json) }
+      let(:note) { create(:note_on_project_snippet, :with_attachment) }
+      let(:notes) { [note.attributes.merge('author' => { 'name' => note.author.name })] }
+
+      it 'restores the notes' do
+        snippet_note = project.snippets.last.notes.first
+        author_name = note.author.name
+        note_updated_at = exported_snippet['notes'].first['updated_at'].split('.').first
+
+        expect(snippet_note).to have_attributes(
+          note: note.note + "\n\n *By #{author_name} on #{note_updated_at} (imported from GitLab)*",
+          noteable_type: note.noteable_type,
+          author_id: user.id,
+          updated_at: note.updated_at,
+          line_code: note.line_code,
+          commit_id: note.commit_id,
+          system: note.system,
+          st_diff: note.st_diff,
+          updated_by_id: user.id)
+      end
+    end
+  end
+end

spec/lib/bulk_imports/projects/stage_spec.rb

@@ -10,6 +10,7 @@ RSpec.describe BulkImports::Projects::Stage do
       [2, BulkImports::Common::Pipelines::LabelsPipeline],
       [2, BulkImports::Common::Pipelines::MilestonesPipeline],
       [3, BulkImports::Projects::Pipelines::IssuesPipeline],
+      [3, BulkImports::Projects::Pipelines::SnippetsPipeline],
       [4, BulkImports::Common::Pipelines::BoardsPipeline],
       [4, BulkImports::Projects::Pipelines::MergeRequestsPipeline],
       [4, BulkImports::Projects::Pipelines::ExternalPullRequestsPipeline],