BigW Consortium Gitlab

environment.rb 6.29 KB
Newer Older
1
class Environment < ActiveRecord::Base
Nick Thomas committed
2
  # Used to generate random suffixes for the slug
3
  LETTERS = 'a'..'z'
Nick Thomas committed
4
  NUMBERS = '0'..'9'
5
  SUFFIX_CHARS = LETTERS.to_a + NUMBERS.to_a
Nick Thomas committed
6

7
  belongs_to :project, required: true, validate: true
8

9
  has_many :deployments, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
10
  has_one :last_deployment, -> { order('deployments.id DESC') }, class_name: 'Deployment'
11

Z.J. van de Weg committed
12
  before_validation :nullify_external_url
Nick Thomas committed
13 14
  before_validation :generate_slug, if: ->(env) { env.slug.blank? }

15
  before_save :set_environment_type
Z.J. van de Weg committed
16

17 18
  validates :name,
            presence: true,
19
            uniqueness: { scope: :project_id },
20
            length: { maximum: 255 },
21 22
            format: { with: Gitlab::Regex.environment_name_regex,
                      message: Gitlab::Regex.environment_name_regex_message }
23

Nick Thomas committed
24 25 26 27 28 29 30
  validates :slug,
            presence: true,
            uniqueness: { scope: :project_id },
            length: { maximum: 24 },
            format: { with: Gitlab::Regex.environment_slug_regex,
                      message: Gitlab::Regex.environment_slug_regex_message }

31 32
  validates :external_url,
            uniqueness: { scope: :project_id },
Z.J. van de Weg committed
33 34 35
            length: { maximum: 255 },
            allow_nil: true,
            addressable_url: true
36

37
  delegate :stop_action, :manual_actions, to: :last_deployment, allow_nil: true
38

39 40
  scope :available, -> { with_state(:available) }
  scope :stopped, -> { with_state(:stopped) }
Douwe Maan committed
41 42
  scope :order_by_last_deployed_at, -> do
    max_deployment_id_sql =
43 44 45
      Deployment.select(Deployment.arel_table[:id].maximum)
      .where(Deployment.arel_table[:environment_id].eq(arel_table[:id]))
      .to_sql
Douwe Maan committed
46 47
    order(Gitlab::Database.nulls_first_order("(#{max_deployment_id_sql})", 'ASC'))
  end
48
  scope :in_review_folder, -> { where(environment_type: "review") }
49

50 51 52
  state_machine :state, initial: :available do
    event :start do
      transition stopped: :available
53 54
    end

55 56
    event :stop do
      transition available: :stopped
57 58
    end

59 60
    state :available
    state :stopped
61 62 63 64

    after_transition do |environment|
      environment.expire_etag_cache
    end
65 66
  end

67 68 69
  def predefined_variables
    [
      { key: 'CI_ENVIRONMENT_NAME', value: name, public: true },
70
      { key: 'CI_ENVIRONMENT_SLUG', value: slug, public: true }
71 72 73
    ]
  end

74
  def recently_updated_on_branch?(ref)
75
    ref.to_s == last_deployment.try(:ref)
76 77
  end

Z.J. van de Weg committed
78 79 80
  def nullify_external_url
    self.external_url = nil if self.external_url.blank?
  end
81

82 83 84 85 86 87 88 89 90 91 92
  def set_environment_type
    names = name.split('/')

    self.environment_type =
      if names.many?
        names.first
      else
        nil
      end
  end

93
  def includes_commit?(commit)
Z.J. van de Weg committed
94
    return false unless last_deployment
95

96
    last_deployment.includes_commit?(commit)
97
  end
98

99 100 101 102
  def last_deployed_at
    last_deployment.try(:created_at)
  end

103
  def update_merge_request_metrics?
104
    (environment_type || name) == "production"
105
  end
106

107
  def first_deployment_for(commit)
108 109 110 111
    ref = project.repository.ref_name_for_sha(ref_path, commit.sha)

    return nil unless ref

112 113
    deployment_iid = ref.split('/').last
    deployments.find_by(iid: deployment_iid)
114 115
  end

116
  def ref_path
117
    "refs/environments/#{Shellwords.shellescape(name)}"
118
  end
119 120 121 122 123 124

  def formatted_external_url
    return nil unless external_url

    external_url.gsub(/\A.*?:\/\//, '')
  end
125

Kamil Trzcinski committed
126
  def stop_action?
127 128
    available? && stop_action.present?
  end
129

Kamil Trzcinski committed
130
  def stop_with_action!(current_user)
131
    return unless available?
132

Kamil Trzcinski committed
133
    stop!
134
    stop_action&.play(current_user)
135
  end
136 137 138 139

  def actions_for(environment)
    return [] unless manual_actions

140 141
    manual_actions.select do |action|
      action.expanded_environment_name == environment
142
    end
143
  end
Nick Thomas committed
144

145 146 147 148 149 150 151 152
  def has_terminals?
    project.deployment_service.present? && available? && last_deployment.present?
  end

  def terminals
    project.deployment_service.terminals(self) if has_terminals?
  end

153 154 155 156 157
  def has_metrics?
    project.monitoring_service.present? && available? && last_deployment.present?
  end

  def metrics
158
    project.monitoring_service.environment_metrics(self) if has_metrics?
159 160
  end

161
  def has_additional_metrics?
162
    project.prometheus_service.present? && available? && last_deployment.present?
163 164
  end

165
  def additional_metrics
166
    if has_additional_metrics?
167
      project.prometheus_service.additional_environment_metrics(self)
168
    end
169 170
  end

Nick Thomas committed
171 172 173 174 175 176 177 178 179 180 181 182
  # An environment name is not necessarily suitable for use in URLs, DNS
  # or other third-party contexts, so provide a slugified version. A slug has
  # the following properties:
  #   * contains only lowercase letters (a-z), numbers (0-9), and '-'
  #   * begins with a letter
  #   * has a maximum length of 24 bytes (OpenShift limitation)
  #   * cannot end with `-`
  def generate_slug
    # Lowercase letters and numbers only
    slugified = name.to_s.downcase.gsub(/[^a-z0-9]/, '-')

    # Must start with a letter
183 184 185 186
    slugified = 'env-' + slugified unless LETTERS.cover?(slugified[0])

    # Repeated dashes are invalid (OpenShift limitation)
    slugified.gsub!(/\-+/, '-')
Nick Thomas committed
187 188 189 190

    # Maximum length: 24 characters (OpenShift limitation)
    slugified = slugified[0..23]

191 192
    # Cannot end with a dash (Kubernetes label limitation)
    slugified.chop! if slugified.end_with?('-')
Nick Thomas committed
193 194 195

    # Add a random suffix, shortening the current string if necessary, if it
    # has been slugified. This ensures uniqueness.
196 197 198 199 200
    if slugified != name
      slugified = slugified[0..16]
      slugified << '-' unless slugified.end_with?('-')
      slugified << random_suffix
    end
Nick Thomas committed
201 202 203 204

    self.slug = slugified
  end

205 206 207 208 209 210
  def external_url_for(path, commit_sha)
    return unless self.external_url

    public_path = project.public_path_for_source_path(path, commit_sha)
    return unless public_path

211
    [external_url, public_path].join('/')
212 213
  end

214 215
  def expire_etag_cache
    Gitlab::EtagCaching::Store.new.tap do |store|
216
      store.touch(etag_cache_key)
217 218 219
    end
  end

220
  def etag_cache_key
221
    Gitlab::Routing.url_helpers.project_environments_path(
222 223
      project,
      format: :json)
224 225
  end

Nick Thomas committed
226 227 228 229 230 231 232 233 234
  private

  # Slugifying a name may remove the uniqueness guarantee afforded by it being
  # based on name (which must be unique). To compensate, we add a random
  # 6-byte suffix in those circumstances. This is not *guaranteed* uniqueness,
  # but the chance of collisions is vanishingly small
  def random_suffix
    (0..5).map { SUFFIX_CHARS.sample }.join
  end
235
end