File: time_tracking_spec.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (183 lines) | stat: -rw-r--r-- 5,416 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Issuable::Callbacks::TimeTracking, feature_category: :team_planning do
  let_it_be(:group) { create(:group) }
  let_it_be(:project) { create(:project, :private, group: group) }
  let_it_be(:reporter) do
    create(:user, reporter_of: group)
  end

  let_it_be(:guest) do
    create(:user, guest_of: group)
  end

  let(:current_user) { reporter }
  let(:non_string_params) do
    {
      time_estimate: 12.hours.to_i,
      spend_time: {
        duration: 2.hours.to_i,
        user_id: current_user.id,
        spent_at: Date.today
      }
    }
  end

  let(:string_params) do
    {
      time_estimate: "12h",
      timelog: {
        time_spent: "2h",
        summary: "some summary"
      }
    }
  end

  let(:callback) { described_class.new(issuable: issuable, current_user: current_user, params: params) }

  describe '#after_initialize' do
    shared_examples 'raises an Error' do
      it { expect { subject }.to raise_error(::Issuable::Callbacks::Base::Error, message) }
    end

    shared_examples 'sets work item time tracking data' do
      it 'correctly sets time tracking data', :aggregate_failures do
        callback.after_initialize

        expect(issuable.time_spent).to eq(2.hours.to_i)
        expect(issuable.time_estimate).to eq(12.hours.to_i)
        expect(issuable.timelogs.last.time_spent).to eq(2.hours.to_i)
      end
    end

    shared_examples 'does not set work item time tracking data' do
      it 'does not change work item time tracking data', :aggregate_failures do
        callback.after_initialize

        if issuable.persisted?
          expect(issuable.time_estimate).to eq(2.hours.to_i)
          expect(issuable.total_time_spent).to eq(3.hours.to_i)
          expect(issuable.timelogs.last.time_spent).to eq(3.hours.to_i)
        else
          expect(issuable.time_estimate).to eq(0)
          expect(issuable.time_spent).to eq(nil)
          expect(issuable.timelogs).to be_empty
        end
      end
    end

    context 'when at project level' do
      let(:issuable) { project_work_item }

      context 'and work item is not persisted' do
        let(:project_work_item) { build(:work_item, :incident, project: project) }

        context 'with non string params' do
          let(:params) { non_string_params }

          it_behaves_like 'sets work item time tracking data'
        end

        context 'with string params' do
          let(:params) { string_params }

          it_behaves_like 'sets work item time tracking data'
        end

        context 'when time tracking param is not present' do
          let(:params) { {} }

          it_behaves_like 'does not set work item time tracking data'
        end

        context 'when widget does not exist in new type' do
          let(:params) { non_string_params }

          before do
            allow(callback).to receive(:excluded_in_new_type?).and_return(true)
          end

          it_behaves_like 'does not set work item time tracking data'
        end
      end

      context 'and work item is persisted' do
        let_it_be_with_reload(:project_work_item) do
          create(:work_item, :task, project: project, time_estimate: 2.hours.to_i)
        end

        let_it_be(:timelog) { create(:timelog, issue: project_work_item, time_spent: 3.hours.to_i) }

        context 'with non string params' do
          let(:params) { non_string_params }

          it_behaves_like 'sets work item time tracking data'
        end

        context 'with string params' do
          let(:params) { string_params }

          it_behaves_like 'sets work item time tracking data'
        end

        context 'when resetting time spent' do
          let(:params) do
            {
              timelog: {
                time_spent: ":reset",
                summary: "remove spent data"
              }
            }
          end

          it 'resets timelogs' do
            callback.after_initialize

            # latest timelog entry is not persisted yet so we cannot use total_time_spent
            expect(issuable.timelogs.sum(&:time_spent)).to eq(0)
          end
        end

        context 'when time tracking param is not present' do
          let(:params) { {} }

          it_behaves_like 'does not set work item time tracking data'
        end

        context 'when widget does not exist in new type' do
          let(:params) { string_params }

          before do
            allow(callback).to receive(:excluded_in_new_type?).and_return(true)
          end

          it_behaves_like 'does not set work item time tracking data'
        end
      end
    end

    context 'with invalid data' do
      let_it_be(:issuable) { create(:work_item, :task, project: project, time_estimate: 2.hours.to_i) }

      subject(:after_initialize) { callback.after_initialize }

      context 'when time_estimate is invalid' do
        let(:params) { { time_estimate: "12abc" } }

        it_behaves_like 'raises an Error' do
          let(:message) { 'Time estimate must be formatted correctly. For example: 1h 30m.' }
        end
      end

      context 'when time_spent is invalid' do
        let(:params) { { timelog: { time_spent: "2abc" } } }

        it_behaves_like 'raises an Error' do
          let(:message) { 'Time spent must be formatted correctly. For example: 1h 30m.' }
        end
      end
    end
  end
end