BigW Consortium Gitlab

environment.rb 5.96 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 10
  has_many :deployments, dependent: :destroy
  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 43 44 45 46 47
  scope :order_by_last_deployed_at, -> do
    max_deployment_id_sql =
      Deployment.select(Deployment.arel_table[:id].maximum).
      where(Deployment.arel_table[:environment_id].eq(arel_table[:id])).
      to_sql
    order(Gitlab::Database.nulls_first_order("(#{max_deployment_id_sql})", 'ASC'))
  end
48

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

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

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

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

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

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

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

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

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

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

95
    last_deployment.includes_commit?(commit)
96
  end
97

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

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

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

    return nil unless ref

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

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

  def formatted_external_url
    return nil unless external_url

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

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

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

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

  def actions_for(environment)
    return [] unless manual_actions

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

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

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

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

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

Nick Thomas committed
160 161 162 163 164 165 166 167 168 169 170 171
  # 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
172 173 174 175
    slugified = 'env-' + slugified unless LETTERS.cover?(slugified[0])

    # Repeated dashes are invalid (OpenShift limitation)
    slugified.gsub!(/\-+/, '-')
Nick Thomas committed
176 177 178 179

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

180 181
    # Cannot end with a dash (Kubernetes label limitation)
    slugified.chop! if slugified.end_with?('-')
Nick Thomas committed
182 183 184

    # Add a random suffix, shortening the current string if necessary, if it
    # has been slugified. This ensures uniqueness.
185 186 187 188 189
    if slugified != name
      slugified = slugified[0..16]
      slugified << '-' unless slugified.end_with?('-')
      slugified << random_suffix
    end
Nick Thomas committed
190 191 192 193

    self.slug = slugified
  end

194 195 196 197 198 199
  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

200
    [external_url, public_path].join('/')
201 202
  end

203 204
  def expire_etag_cache
    Gitlab::EtagCaching::Store.new.tap do |store|
205
      store.touch(etag_cache_key)
206 207 208
    end
  end

209 210 211
  def etag_cache_key
    Gitlab::Routing.url_helpers.namespace_project_environments_path(
      project.namespace,
212 213
      project,
      format: :json)
214 215
  end

Nick Thomas committed
216 217 218 219 220 221 222 223 224
  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
225
end