diff options
Diffstat (limited to 'spec/lib/gitlab/github_import/importer')
8 files changed, 595 insertions, 0 deletions
diff --git a/spec/lib/gitlab/github_import/importer/events/changed_label_spec.rb b/spec/lib/gitlab/github_import/importer/events/changed_label_spec.rb new file mode 100644 index 00000000000..b773598853d --- /dev/null +++ b/spec/lib/gitlab/github_import/importer/events/changed_label_spec.rb @@ -0,0 +1,61 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::GithubImport::Importer::Events::ChangedLabel do + subject(:importer) { described_class.new(project, user.id) } + + let_it_be(:project) { create(:project, :repository) } + let_it_be(:user) { create(:user) } + + let(:issue) { create(:issue, project: project) } + let!(:label) { create(:label, project: project) } + + let(:issue_event) do + Gitlab::GithubImport::Representation::IssueEvent.from_json_hash( + 'id' => 6501124486, + 'actor' => { 'id' => 4, 'login' => 'alice' }, + 'event' => event_type, + 'commit_id' => nil, + 'label_title' => label.title, + 'issue_db_id' => issue.id, + 'created_at' => '2022-04-26 18:30:53 UTC' + ) + end + + let(:event_attrs) do + { + user_id: user.id, + issue_id: issue.id, + label_id: label.id, + created_at: issue_event.created_at + }.stringify_keys + end + + shared_examples 'new event' do + it 'creates a new label event' do + expect { importer.execute(issue_event) }.to change { issue.resource_label_events.count } + .from(0).to(1) + expect(issue.resource_label_events.last) + .to have_attributes(expected_event_attrs) + end + end + + before do + allow(Gitlab::Cache::Import::Caching).to receive(:read_integer).and_return(label.id) + end + + context 'when importing a labeled event' do + let(:event_type) { 'labeled' } + let(:expected_event_attrs) { event_attrs.merge(action: 'add') } + + it_behaves_like 'new event' + end + + context 'when importing an unlabeled event' do + let(:event_type) { 'unlabeled' } + let(:expected_event_attrs) { event_attrs.merge(action: 'remove') } + + it_behaves_like 'new event' + end +end diff --git a/spec/lib/gitlab/github_import/importer/events/closed_spec.rb b/spec/lib/gitlab/github_import/importer/events/closed_spec.rb new file mode 100644 index 00000000000..116917d3e06 --- /dev/null +++ b/spec/lib/gitlab/github_import/importer/events/closed_spec.rb @@ -0,0 +1,72 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::GithubImport::Importer::Events::Closed do + subject(:importer) { described_class.new(project, user.id) } + + let_it_be(:project) { create(:project, :repository) } + let_it_be(:user) { create(:user) } + + let(:issue) { create(:issue, project: project) } + let(:commit_id) { nil } + + let(:issue_event) do + Gitlab::GithubImport::Representation::IssueEvent.from_json_hash( + 'id' => 6501124486, + 'node_id' => 'CE_lADOHK9fA85If7x0zwAAAAGDf0mG', + 'url' => 'https://api.github.com/repos/elhowm/test-import/issues/events/6501124486', + 'actor' => { 'id' => 4, 'login' => 'alice' }, + 'event' => 'closed', + 'created_at' => '2022-04-26 18:30:53 UTC', + 'commit_id' => commit_id, + 'issue_db_id' => issue.id + ) + end + + let(:expected_event_attrs) do + { + project_id: project.id, + author_id: user.id, + target_id: issue.id, + target_type: Issue.name, + action: 'closed', + created_at: issue_event.created_at, + updated_at: issue_event.created_at + }.stringify_keys + end + + let(:expected_state_event_attrs) do + { + user_id: user.id, + issue_id: issue.id, + state: 'closed', + created_at: issue_event.created_at + }.stringify_keys + end + + it 'creates expected event and state event' do + importer.execute(issue_event) + + expect(issue.events.count).to eq 1 + expect(issue.events[0].attributes) + .to include expected_event_attrs + + expect(issue.resource_state_events.count).to eq 1 + expect(issue.resource_state_events[0].attributes) + .to include expected_state_event_attrs + end + + context 'when closed by commit' do + let!(:closing_commit) { create(:commit, project: project) } + let(:commit_id) { closing_commit.id } + + it 'creates expected event and state event' do + importer.execute(issue_event) + + expect(issue.events.count).to eq 1 + state_event = issue.resource_state_events.last + expect(state_event.source_commit).to eq commit_id[0..40] + end + end +end diff --git a/spec/lib/gitlab/github_import/importer/events/cross_referenced_spec.rb b/spec/lib/gitlab/github_import/importer/events/cross_referenced_spec.rb new file mode 100644 index 00000000000..118c482a7d9 --- /dev/null +++ b/spec/lib/gitlab/github_import/importer/events/cross_referenced_spec.rb @@ -0,0 +1,96 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::GithubImport::Importer::Events::CrossReferenced, :clean_gitlab_redis_cache do + subject(:importer) { described_class.new(project, user.id) } + + let_it_be(:project) { create(:project, :repository) } + let_it_be(:user) { create(:user) } + + let(:sawyer_stub) { Struct.new(:iid, :issuable_type, keyword_init: true) } + + let(:issue) { create(:issue, project: project) } + let(:referenced_in) { build_stubbed(:issue, project: project) } + let(:commit_id) { nil } + + let(:issue_event) do + Gitlab::GithubImport::Representation::IssueEvent.from_json_hash( + 'id' => 6501124486, + 'node_id' => 'CE_lADOHK9fA85If7x0zwAAAAGDf0mG', + 'url' => 'https://api.github.com/repos/elhowm/test-import/issues/events/6501124486', + 'actor' => { 'id' => 4, 'login' => 'alice' }, + 'event' => 'cross-referenced', + 'source' => { + 'type' => 'issue', + 'issue' => { + 'number' => referenced_in.iid, + 'pull_request' => pull_request_resource + } + }, + 'created_at' => '2022-04-26 18:30:53 UTC', + 'issue_db_id' => issue.id + ) + end + + let(:pull_request_resource) { nil } + let(:expected_note_attrs) do + { + system: true, + noteable_type: Issue.name, + noteable_id: issue_event.issue_db_id, + project_id: project.id, + author_id: user.id, + note: expected_note_body, + created_at: issue_event.created_at + }.stringify_keys + end + + context 'when referenced in other issue' do + let(:expected_note_body) { "mentioned in issue ##{issue.iid}" } + + before do + other_issue_resource = sawyer_stub.new(iid: referenced_in.iid, issuable_type: 'Issue') + Gitlab::GithubImport::IssuableFinder.new(project, other_issue_resource) + .cache_database_id(referenced_in.iid) + end + + it 'creates expected note' do + importer.execute(issue_event) + + expect(issue.notes.count).to eq 1 + expect(issue.notes[0]).to have_attributes expected_note_attrs + expect(issue.notes[0].system_note_metadata.action).to eq 'cross_reference' + end + end + + context 'when referenced in pull request' do + let(:referenced_in) { build_stubbed(:merge_request, project: project) } + let(:pull_request_resource) { { 'id' => referenced_in.iid } } + + let(:expected_note_body) { "mentioned in merge request !#{referenced_in.iid}" } + + before do + other_issue_resource = + sawyer_stub.new(iid: referenced_in.iid, issuable_type: 'MergeRequest') + Gitlab::GithubImport::IssuableFinder.new(project, other_issue_resource) + .cache_database_id(referenced_in.iid) + end + + it 'creates expected note' do + importer.execute(issue_event) + + expect(issue.notes.count).to eq 1 + expect(issue.notes[0]).to have_attributes expected_note_attrs + expect(issue.notes[0].system_note_metadata.action).to eq 'cross_reference' + end + end + + context 'when referenced in out of project issue/pull_request' do + it 'creates expected note' do + importer.execute(issue_event) + + expect(issue.notes.count).to eq 0 + end + end +end diff --git a/spec/lib/gitlab/github_import/importer/events/renamed_spec.rb b/spec/lib/gitlab/github_import/importer/events/renamed_spec.rb new file mode 100644 index 00000000000..a8c3fbcb05d --- /dev/null +++ b/spec/lib/gitlab/github_import/importer/events/renamed_spec.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::GithubImport::Importer::Events::Renamed do + subject(:importer) { described_class.new(project, user.id) } + + let_it_be(:project) { create(:project, :repository) } + let_it_be(:user) { create(:user) } + + let(:issue) { create(:issue, project: project) } + + let(:issue_event) do + Gitlab::GithubImport::Representation::IssueEvent.from_json_hash( + 'id' => 6501124486, + 'actor' => { 'id' => 4, 'login' => 'alice' }, + 'event' => 'renamed', + 'commit_id' => nil, + 'created_at' => '2022-04-26 18:30:53 UTC', + 'old_title' => 'old title', + 'new_title' => 'new title', + 'issue_db_id' => issue.id + ) + end + + let(:expected_note_attrs) do + { + noteable_id: issue.id, + noteable_type: Issue.name, + project_id: project.id, + author_id: user.id, + note: "changed title from **{-old-} title** to **{+new+} title**", + system: true, + created_at: issue_event.created_at, + updated_at: issue_event.created_at + }.stringify_keys + end + + let(:expected_system_note_metadata_attrs) do + { + action: "title", + created_at: issue_event.created_at, + updated_at: issue_event.created_at + }.stringify_keys + end + + describe '#execute' do + it 'creates expected note' do + expect { importer.execute(issue_event) }.to change { issue.notes.count } + .from(0).to(1) + + expect(issue.notes.last) + .to have_attributes(expected_note_attrs) + end + + it 'creates expected system note metadata' do + expect { importer.execute(issue_event) }.to change { SystemNoteMetadata.count } + .from(0).to(1) + + expect(SystemNoteMetadata.last) + .to have_attributes( + expected_system_note_metadata_attrs.merge( + note_id: Note.last.id + ) + ) + end + end +end diff --git a/spec/lib/gitlab/github_import/importer/events/reopened_spec.rb b/spec/lib/gitlab/github_import/importer/events/reopened_spec.rb new file mode 100644 index 00000000000..81653b0ecdc --- /dev/null +++ b/spec/lib/gitlab/github_import/importer/events/reopened_spec.rb @@ -0,0 +1,56 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::GithubImport::Importer::Events::Reopened, :aggregate_failures do + subject(:importer) { described_class.new(project, user.id) } + + let_it_be(:project) { create(:project, :repository) } + let_it_be(:user) { create(:user) } + + let(:issue) { create(:issue, project: project) } + + let(:issue_event) do + Gitlab::GithubImport::Representation::IssueEvent.from_json_hash( + 'id' => 6501124486, + 'node_id' => 'CE_lADOHK9fA85If7x0zwAAAAGDf0mG', + 'url' => 'https://api.github.com/repos/elhowm/test-import/issues/events/6501124486', + 'actor' => { 'id' => 4, 'login' => 'alice' }, + 'event' => 'reopened', + 'created_at' => '2022-04-26 18:30:53 UTC', + 'issue_db_id' => issue.id + ) + end + + let(:expected_event_attrs) do + { + project_id: project.id, + author_id: user.id, + target_id: issue.id, + target_type: Issue.name, + action: 'reopened', + created_at: issue_event.created_at, + updated_at: issue_event.created_at + }.stringify_keys + end + + let(:expected_state_event_attrs) do + { + user_id: user.id, + state: 'reopened', + created_at: issue_event.created_at + }.stringify_keys + end + + it 'creates expected event and state event' do + importer.execute(issue_event) + + expect(issue.events.count).to eq 1 + expect(issue.events[0].attributes) + .to include expected_event_attrs + + expect(issue.resource_state_events.count).to eq 1 + expect(issue.resource_state_events[0].attributes) + .to include expected_state_event_attrs + end +end diff --git a/spec/lib/gitlab/github_import/importer/issue_event_importer_spec.rb b/spec/lib/gitlab/github_import/importer/issue_event_importer_spec.rb new file mode 100644 index 00000000000..da32a3b3766 --- /dev/null +++ b/spec/lib/gitlab/github_import/importer/issue_event_importer_spec.rb @@ -0,0 +1,112 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::GithubImport::Importer::IssueEventImporter, :clean_gitlab_redis_cache do + let(:importer) { described_class.new(issue_event, project, client) } + + let(:project) { create(:project) } + let(:client) { instance_double('Gitlab::GithubImport::Client') } + let(:user) { create(:user) } + let(:issue) { create(:issue, project: project) } + + let(:issue_event) do + Gitlab::GithubImport::Representation::IssueEvent.from_json_hash( + 'id' => 6501124486, + 'node_id' => 'CE_lADOHK9fA85If7x0zwAAAAGDf0mG', + 'url' => 'https://api.github.com/repos/elhowm/test-import/issues/events/6501124486', + 'actor' => { 'id' => actor_id, 'login' => 'alice' }, + 'event' => event_name, + 'commit_id' => '570e7b2abdd848b95f2f578043fc23bd6f6fd24d', + 'commit_url' => + 'https://api.github.com/repos/octocat/Hello-World/commits/570e7b2abdd848b95f2f578043fc23bd6f6fd24d', + 'created_at' => '2022-04-26 18:30:53 UTC', + 'performed_via_github_app' => nil + ) + end + + let(:actor_id) { user.id } + let(:event_name) { 'closed' } + + shared_examples 'triggers specific event importer' do |importer_class| + it importer_class.name do + specific_importer = double(importer_class.name) # rubocop:disable RSpec/VerifiedDoubles + + expect(importer_class) + .to receive(:new).with(project, user.id) + .and_return(specific_importer) + expect(specific_importer).to receive(:execute).with(issue_event) + + importer.execute + end + end + + describe '#execute' do + before do + allow_next_instance_of(Gitlab::GithubImport::UserFinder) do |finder| + allow(finder).to receive(:author_id_for) + .with(issue_event, author_key: :actor) + .and_return(user.id, true) + end + + issue_event.attributes[:issue_db_id] = issue.id + end + + context "when it's closed issue event" do + let(:event_name) { 'closed' } + + it_behaves_like 'triggers specific event importer', + Gitlab::GithubImport::Importer::Events::Closed + end + + context "when it's reopened issue event" do + let(:event_name) { 'reopened' } + + it_behaves_like 'triggers specific event importer', + Gitlab::GithubImport::Importer::Events::Reopened + end + + context "when it's labeled issue event" do + let(:event_name) { 'labeled' } + + it_behaves_like 'triggers specific event importer', + Gitlab::GithubImport::Importer::Events::ChangedLabel + end + + context "when it's unlabeled issue event" do + let(:event_name) { 'unlabeled' } + + it_behaves_like 'triggers specific event importer', + Gitlab::GithubImport::Importer::Events::ChangedLabel + end + + context "when it's renamed issue event" do + let(:event_name) { 'renamed' } + + it_behaves_like 'triggers specific event importer', + Gitlab::GithubImport::Importer::Events::Renamed + end + + context "when it's cross-referenced issue event" do + let(:event_name) { 'cross-referenced' } + + it_behaves_like 'triggers specific event importer', + Gitlab::GithubImport::Importer::Events::CrossReferenced + end + + context "when it's unknown issue event" do + let(:event_name) { 'fake' } + + it 'logs warning and skips' do + expect(Gitlab::GithubImport::Logger).to receive(:debug) + .with( + message: 'UNSUPPORTED_EVENT_TYPE', + event_type: issue_event.event, + event_github_id: issue_event.id + ) + + importer.execute + end + end + end +end diff --git a/spec/lib/gitlab/github_import/importer/issue_importer_spec.rb b/spec/lib/gitlab/github_import/importer/issue_importer_spec.rb index 2a06983417d..570d26cdf2d 100644 --- a/spec/lib/gitlab/github_import/importer/issue_importer_spec.rb +++ b/spec/lib/gitlab/github_import/importer/issue_importer_spec.rb @@ -131,6 +131,7 @@ RSpec.describe Gitlab::GithubImport::Importer::IssueImporter, :clean_gitlab_redi title: 'My Issue', author_id: user.id, project_id: project.id, + namespace_id: project.project_namespace_id, description: 'This is my issue', milestone_id: milestone.id, state_id: 1, @@ -160,6 +161,7 @@ RSpec.describe Gitlab::GithubImport::Importer::IssueImporter, :clean_gitlab_redi title: 'My Issue', author_id: project.creator_id, project_id: project.id, + namespace_id: project.project_namespace_id, description: "*Created by: alice*\n\nThis is my issue", milestone_id: milestone.id, state_id: 1, diff --git a/spec/lib/gitlab/github_import/importer/single_endpoint_issue_events_importer_spec.rb b/spec/lib/gitlab/github_import/importer/single_endpoint_issue_events_importer_spec.rb new file mode 100644 index 00000000000..087faeffe02 --- /dev/null +++ b/spec/lib/gitlab/github_import/importer/single_endpoint_issue_events_importer_spec.rb @@ -0,0 +1,128 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::GithubImport::Importer::SingleEndpointIssueEventsImporter do + let(:client) { double } + + let_it_be(:project) { create(:project, :import_started, import_source: 'http://somegithub.com') } + let_it_be(:issue) { create(:issue, project: project) } + + subject { described_class.new(project, client, parallel: parallel) } + + let(:parallel) { true } + + it { is_expected.to include_module(Gitlab::GithubImport::ParallelScheduling) } + + describe '#importer_class' do + it { expect(subject.importer_class).to eq(Gitlab::GithubImport::Importer::IssueEventImporter) } + end + + describe '#representation_class' do + it { expect(subject.representation_class).to eq(Gitlab::GithubImport::Representation::IssueEvent) } + end + + describe '#sidekiq_worker_class' do + it { expect(subject.sidekiq_worker_class).to eq(Gitlab::GithubImport::ImportIssueEventWorker) } + end + + describe '#object_type' do + it { expect(subject.object_type).to eq(:issue_event) } + end + + describe '#collection_method' do + it { expect(subject.collection_method).to eq(:issue_timeline) } + end + + describe '#page_counter_id' do + it { expect(subject.page_counter_id(issue)).to eq("issues/#{issue.iid}/issue_timeline") } + end + + describe '#id_for_already_imported_cache' do + let(:event) { instance_double('Event', id: 1) } + + it { expect(subject.id_for_already_imported_cache(event)).to eq(1) } + end + + describe '#collection_options' do + it do + expect(subject.collection_options) + .to eq({ state: 'all', sort: 'created', direction: 'asc' }) + end + end + + describe '#each_object_to_import', :clean_gitlab_redis_cache do + let(:issue_event) do + struct = Struct.new(:id, :event, :created_at, :issue_db_id, keyword_init: true) + struct.new(id: rand(10), event: 'closed', created_at: '2022-04-26 18:30:53 UTC') + end + + let(:page) do + instance_double( + Gitlab::GithubImport::Client::Page, + number: 1, objects: [issue_event] + ) + end + + let(:page_counter) { instance_double(Gitlab::GithubImport::PageCounter) } + + before do + allow(client).to receive(:each_page) + .once + .with( + :issue_timeline, + project.import_source, + issue.iid, + { state: 'all', sort: 'created', direction: 'asc', page: 1 } + ).and_yield(page) + end + + it 'imports each issue event page by page' do + counter = 0 + subject.each_object_to_import do |object| + expect(object).to eq issue_event + expect(issue_event.issue_db_id).to eq issue.id + counter += 1 + end + expect(counter).to eq 1 + end + + it 'triggers page number increment' do + expect(Gitlab::GithubImport::PageCounter) + .to receive(:new).with(project, 'issues/1/issue_timeline') + .and_return(page_counter) + expect(page_counter).to receive(:current).and_return(1) + expect(page_counter) + .to receive(:set).with(page.number).and_return(true) + + counter = 0 + subject.each_object_to_import { counter += 1 } + expect(counter).to eq 1 + end + + context 'when page is already processed' do + before do + page_counter = Gitlab::GithubImport::PageCounter.new( + project, subject.page_counter_id(issue) + ) + page_counter.set(page.number) + end + + it "doesn't process this page" do + counter = 0 + subject.each_object_to_import { counter += 1 } + expect(counter).to eq 0 + end + end + + context 'when event is already processed' do + it "doesn't process this event" do + subject.mark_as_imported(issue_event) + + counter = 0 + subject.each_object_to_import { counter += 1 } + expect(counter).to eq 0 + end + end + end +end |