summaryrefslogtreecommitdiff
path: root/lib/gitlab/analytics/cycle_analytics/default_stages.rb
blob: 286c393005ffb74506342fdaf63333adfa352fcc (plain)
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
# frozen_string_literal: true

# This module represents the default Cycle Analytics stages that are currently provided by CE
# Each method returns a hash that can be used to build a new stage object.
#
# Example:
#
# params = Gitlab::Analytics::CycleAnalytics::DefaultStages.params_for_issue_stage
# Analytics::CycleAnalytics::ProjectStage.new(params)
module Gitlab
  module Analytics
    module CycleAnalytics
      module DefaultStages
        def self.all
          [
            params_for_issue_stage,
            params_for_plan_stage,
            params_for_code_stage,
            params_for_test_stage,
            params_for_review_stage,
            params_for_staging_stage,
            params_for_production_stage
          ]
        end

        def self.params_for_issue_stage
          {
            name: 'issue',
            custom: false, # this stage won't be customizable, we provide it as it is
            relative_position: 1, # when opening the CycleAnalytics page in CE, this stage will be the first item
            start_event_identifier: :issue_created, # IssueCreated class is used as start event
            end_event_identifier: :issue_stage_end # IssueStageEnd class is used as end event
          }
        end

        def self.params_for_plan_stage
          {
            name: 'plan',
            custom: false,
            relative_position: 2,
            start_event_identifier: :plan_stage_start,
            end_event_identifier: :issue_first_mentioned_in_commit
          }
        end

        def self.params_for_code_stage
          {
            name: 'code',
            custom: false,
            relative_position: 3,
            start_event_identifier: :code_stage_start,
            end_event_identifier: :merge_request_created
          }
        end

        def self.params_for_test_stage
          {
            name: 'test',
            custom: false,
            relative_position: 4,
            start_event_identifier: :merge_request_last_build_started,
            end_event_identifier: :merge_request_last_build_finished
          }
        end

        def self.params_for_review_stage
          {
            name: 'review',
            custom: false,
            relative_position: 5,
            start_event_identifier: :merge_request_created,
            end_event_identifier: :merge_request_merged
          }
        end

        def self.params_for_staging_stage
          {
            name: 'staging',
            custom: false,
            relative_position: 6,
            start_event_identifier: :merge_request_merged,
            end_event_identifier: :merge_request_first_deployed_to_production
          }
        end

        def self.params_for_production_stage
          {
            name: 'production',
            custom: false,
            relative_position: 7,
            start_event_identifier: :merge_request_merged,
            end_event_identifier: :merge_request_first_deployed_to_production
          }
        end
      end
    end
  end
end