File: desired_config_generator.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 (62 lines) | stat: -rw-r--r-- 2,226 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
# frozen_string_literal: true

require_relative '../suggestor'

module Tooling
  module Danger
    module RemoteDevelopment
      module DesiredConfigGenerator
        include ::Tooling::Danger::Suggestor

        WORKSPACE_LIB = 'ee/lib/remote_development/workspace_operations'
        SHARED_CONTEXT_PATH = 'ee/spec/support/shared_contexts/remote_development'
        DESIRED_CONFIG_GENERATOR = "#{WORKSPACE_LIB}/reconcile/output/desired_config_generator.rb".freeze
        DEVFILE_PARSER = "#{WORKSPACE_LIB}/reconcile/output/devfile_parser.rb".freeze
        REMOTE_DEVELOPMENT_SHARED_CONTEXT = "#{SHARED_CONTEXT_PATH}/remote_development_shared_contexts.rb".freeze

        def add_comment_if_shared_context_updated
          return unless remote_development_shared_context_updated? && either_config_files_updated?

          # Make the suggestion on any change to the file once
          add_suggestion(
            filename: REMOTE_DEVELOPMENT_SHARED_CONTEXT,
            regex: /.+/,
            comment_text: build_comment,
            once_per_file: true
          )
        end

        private

        def build_comment
          prefix = "This merge request updated the [`shared_context`](#{REMOTE_DEVELOPMENT_SHARED_CONTEXT}) file"
          prefix.concat(" as well as the [`devfile_parser`](#{DEVFILE_PARSER}) file") if devfile_parser_updated?

          if desired_config_generator_updated?
            prefix.concat(" and the [`desired_config_generator`](#{DESIRED_CONFIG_GENERATOR}) file")
          end

          suffix = ". Please consider reviewing any changes made to the `shared_context` file is valid."
          prefix.concat(suffix)
          prefix
        end

        def either_config_files_updated?
          devfile_parser_updated? || desired_config_generator_updated?
        end

        def remote_development_shared_context_updated?
          helper.all_changed_files.include?(REMOTE_DEVELOPMENT_SHARED_CONTEXT)
        end

        def desired_config_generator_updated?
          helper.all_changed_files.include?(DESIRED_CONFIG_GENERATOR)
        end

        def devfile_parser_updated?
          helper.all_changed_files.include?(DEVFILE_PARSER)
        end
      end
    end
  end
end