gitlab-org--gitlab-foss/spec/finders/milestones_finder_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe MilestonesFinder do
  let_it_be(:now) { Date.current }
  let_it_be(:group) { create(:group) }
  let_it_be(:project_1) { create(:project, namespace: group) }
  let_it_be(:project_2) { create(:project, namespace: group) }
  let_it_be(:milestone_2) { create(:milestone, group: group, start_date: now + 1.day, due_date: now + 2.days) }
  let_it_be(:milestone_4) { create(:milestone, project: project_2, state: 'active', start_date: now + 4.days, due_date: now + 5.days) }

  context 'without filters' do
    let_it_be(:milestone_1) { create(:milestone, group: group, start_date: now - 1.day, due_date: now) }
    let_it_be(:milestone_3) { create(:milestone, project: project_1, state: 'active', start_date: now + 2.days) }
    let_it_be(:milestone_5) { create(:milestone, group: group, due_date: now - 2.days) }

    it 'returns milestones for projects' do
      result = described_class.new(project_ids: [project_1.id, project_2.id], state: 'all').execute

      expect(result).to contain_exactly(milestone_3, milestone_4)
    end

    it 'returns milestones for groups' do
      result = described_class.new(group_ids: group.id,  state: 'all').execute

      expect(result).to contain_exactly(milestone_5, milestone_1, milestone_2)
    end

    context 'milestones for groups and project' do
      let(:extra_params) { {} }
      let(:result) do
        described_class.new({ project_ids: [project_1.id, project_2.id], group_ids: group.id, state: 'all' }.merge(extra_params)).execute
      end

      it 'returns milestones for groups and projects' do
        expect(result).to contain_exactly(milestone_5, milestone_1, milestone_2, milestone_3, milestone_4)
      end

      it 'orders milestones by due date', :aggregate_failures do
        expect(result.first).to eq(milestone_5)
        expect(result.second).to eq(milestone_1)
        expect(result.third).to eq(milestone_2)
      end

      context 'when grouping and sorting by expired_last' do
        let(:extra_params) { { sort: :expired_last_due_date_asc } }

        it 'current milestones are returned first, then milestones without due date followed by expired milestones, sorted by due date in ascending order' do
          expect(result).to eq([milestone_1, milestone_2, milestone_4, milestone_3, milestone_5])
        end
      end
    end

    describe '#find_by' do
      it 'finds a single milestone' do
        finder = described_class.new(project_ids: [project_1.id], state: 'all')

        expect(finder.find_by(iid: milestone_3.iid)).to eq(milestone_3)
      end
    end
  end

  context 'with filters' do
    let_it_be(:milestone_1) { create(:milestone, group: group, state: 'closed', title: 'one test', start_date: now - 1.day, due_date: now) }
    let_it_be(:milestone_3) { create(:milestone, project: project_1, state: 'closed', start_date: now + 2.days, due_date: now + 3.days) }

    let(:params) do
      {
        project_ids: [project_1.id, project_2.id],
        group_ids: group.id,
        state: 'all'
      }
    end

    it 'filters by id' do
      params[:ids] = [milestone_1.id, milestone_2.id]

      result = described_class.new(params).execute

      expect(result).to contain_exactly(milestone_1, milestone_2)
    end

    it 'filters by active state' do
      params[:state] = 'active'
      result = described_class.new(params).execute

      expect(result).to contain_exactly(milestone_2, milestone_4)
    end

    it 'filters by closed state' do
      params[:state] = 'closed'
      result = described_class.new(params).execute

      expect(result).to contain_exactly(milestone_1, milestone_3)
    end

    it 'filters by title' do
      result = described_class.new(params.merge(title: 'one test')).execute

      expect(result.to_a).to contain_exactly(milestone_1)
    end

    it 'filters by search_title' do
      result = described_class.new(params.merge(search_title: 'one t')).execute

      expect(result.to_a).to contain_exactly(milestone_1)
    end

    context 'by timeframe' do
      it 'returns milestones with start_date and due_date between timeframe' do
        params.merge!(start_date: now - 1.day, end_date: now + 3.days)

        milestones = described_class.new(params).execute

        expect(milestones).to match_array([milestone_1, milestone_2, milestone_3])
      end

      it 'returns milestones which starts before the timeframe' do
        milestone = create(:milestone, project: project_2, start_date: now - 5.days)
        params.merge!(start_date: now - 3.days, end_date: now - 2.days)

        milestones = described_class.new(params).execute

        expect(milestones).to match_array([milestone])
      end

      it 'returns milestones which ends after the timeframe' do
        milestone = create(:milestone, project: project_2, due_date: now + 6.days)
        params.merge!(start_date: now + 6.days, end_date: now + 7.days)

        milestones = described_class.new(params).execute

        expect(milestones).to match_array([milestone])
      end
    end
  end
end