2016-06-10 17:36:54 -04:00
|
|
|
class Environment < ActiveRecord::Base
|
2016-12-07 20:09:18 -05:00
|
|
|
# Used to generate random suffixes for the slug
|
2017-01-19 09:42:03 -05:00
|
|
|
LETTERS = 'a'..'z'
|
2016-12-07 20:09:18 -05:00
|
|
|
NUMBERS = '0'..'9'
|
2017-01-19 09:42:03 -05:00
|
|
|
SUFFIX_CHARS = LETTERS.to_a + NUMBERS.to_a
|
2016-12-07 20:09:18 -05:00
|
|
|
|
2016-06-15 09:09:50 -04:00
|
|
|
belongs_to :project, required: true, validate: true
|
2016-06-10 17:36:54 -04:00
|
|
|
|
|
|
|
has_many :deployments
|
|
|
|
|
2016-07-26 08:19:37 -04:00
|
|
|
before_validation :nullify_external_url
|
2016-12-07 20:09:18 -05:00
|
|
|
before_validation :generate_slug, if: ->(env) { env.slug.blank? }
|
|
|
|
|
2016-09-13 08:14:55 -04:00
|
|
|
before_save :set_environment_type
|
2016-07-26 08:19:37 -04:00
|
|
|
|
2016-06-14 07:04:21 -04:00
|
|
|
validates :name,
|
|
|
|
presence: true,
|
2016-06-14 12:34:48 -04:00
|
|
|
uniqueness: { scope: :project_id },
|
2016-12-02 07:54:57 -05:00
|
|
|
length: { maximum: 255 },
|
2016-06-14 07:04:21 -04:00
|
|
|
format: { with: Gitlab::Regex.environment_name_regex,
|
|
|
|
message: Gitlab::Regex.environment_name_regex_message }
|
2016-06-10 17:36:54 -04:00
|
|
|
|
2016-12-07 20:09:18 -05:00
|
|
|
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 }
|
|
|
|
|
2016-07-26 03:35:47 -04:00
|
|
|
validates :external_url,
|
|
|
|
uniqueness: { scope: :project_id },
|
2016-07-26 08:19:37 -04:00
|
|
|
length: { maximum: 255 },
|
|
|
|
allow_nil: true,
|
|
|
|
addressable_url: true
|
2016-07-26 03:35:47 -04:00
|
|
|
|
2016-11-21 07:47:18 -05:00
|
|
|
delegate :stop_action, :manual_actions, to: :last_deployment, allow_nil: true
|
2016-10-06 07:10:50 -04:00
|
|
|
|
2016-10-17 15:06:10 -04:00
|
|
|
scope :available, -> { with_state(:available) }
|
|
|
|
scope :stopped, -> { with_state(:stopped) }
|
|
|
|
|
2016-10-17 06:45:31 -04:00
|
|
|
state_machine :state, initial: :available do
|
|
|
|
event :start do
|
|
|
|
transition stopped: :available
|
2016-10-06 07:10:50 -04:00
|
|
|
end
|
|
|
|
|
2016-10-17 06:45:31 -04:00
|
|
|
event :stop do
|
|
|
|
transition available: :stopped
|
2016-10-06 07:10:50 -04:00
|
|
|
end
|
|
|
|
|
2016-10-17 06:45:31 -04:00
|
|
|
state :available
|
|
|
|
state :stopped
|
2016-10-06 07:10:50 -04:00
|
|
|
end
|
|
|
|
|
2016-12-08 11:21:16 -05:00
|
|
|
def predefined_variables
|
|
|
|
[
|
|
|
|
{ key: 'CI_ENVIRONMENT_NAME', value: name, public: true },
|
|
|
|
{ key: 'CI_ENVIRONMENT_SLUG', value: slug, public: true },
|
|
|
|
]
|
|
|
|
end
|
|
|
|
|
2016-11-16 04:54:20 -05:00
|
|
|
def recently_updated_on_branch?(ref)
|
2016-11-16 05:26:36 -05:00
|
|
|
ref.to_s == last_deployment.try(:ref)
|
2016-11-15 08:48:14 -05:00
|
|
|
end
|
|
|
|
|
2016-06-10 17:36:54 -04:00
|
|
|
def last_deployment
|
|
|
|
deployments.last
|
|
|
|
end
|
2016-07-26 08:19:37 -04:00
|
|
|
|
|
|
|
def nullify_external_url
|
|
|
|
self.external_url = nil if self.external_url.blank?
|
|
|
|
end
|
2016-08-02 08:01:22 -04:00
|
|
|
|
2016-09-13 08:14:55 -04:00
|
|
|
def set_environment_type
|
|
|
|
names = name.split('/')
|
|
|
|
|
|
|
|
self.environment_type =
|
|
|
|
if names.many?
|
|
|
|
names.first
|
|
|
|
else
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-08-09 09:11:14 -04:00
|
|
|
def includes_commit?(commit)
|
2016-08-03 07:37:39 -04:00
|
|
|
return false unless last_deployment
|
2016-08-02 08:01:22 -04:00
|
|
|
|
2016-08-09 09:11:14 -04:00
|
|
|
last_deployment.includes_commit?(commit)
|
2016-08-02 08:01:22 -04:00
|
|
|
end
|
2016-09-20 05:36:54 -04:00
|
|
|
|
|
|
|
def update_merge_request_metrics?
|
2017-01-06 09:51:06 -05:00
|
|
|
(environment_type || name) == "production"
|
2016-09-20 05:36:54 -04:00
|
|
|
end
|
2016-09-30 09:45:27 -04:00
|
|
|
|
2016-10-05 07:52:15 -04:00
|
|
|
def first_deployment_for(commit)
|
2016-10-04 10:03:13 -04:00
|
|
|
ref = project.repository.ref_name_for_sha(ref_path, commit.sha)
|
|
|
|
|
|
|
|
return nil unless ref
|
|
|
|
|
2016-10-19 08:49:09 -04:00
|
|
|
deployment_iid = ref.split('/').last
|
|
|
|
deployments.find_by(iid: deployment_iid)
|
2016-10-04 10:03:13 -04:00
|
|
|
end
|
|
|
|
|
2016-09-30 09:45:27 -04:00
|
|
|
def ref_path
|
2016-10-03 09:39:12 -04:00
|
|
|
"refs/environments/#{Shellwords.shellescape(name)}"
|
2016-09-30 09:45:27 -04:00
|
|
|
end
|
2016-10-12 09:21:01 -04:00
|
|
|
|
|
|
|
def formatted_external_url
|
|
|
|
return nil unless external_url
|
|
|
|
|
|
|
|
external_url.gsub(/\A.*?:\/\//, '')
|
|
|
|
end
|
2016-10-17 10:13:19 -04:00
|
|
|
|
|
|
|
def stoppable?
|
|
|
|
available? && stop_action.present?
|
|
|
|
end
|
2016-10-18 06:02:50 -04:00
|
|
|
|
|
|
|
def stop!(current_user)
|
|
|
|
return unless stoppable?
|
|
|
|
|
2016-11-14 08:35:29 -05:00
|
|
|
stop
|
2016-10-18 06:02:50 -04:00
|
|
|
stop_action.play(current_user)
|
|
|
|
end
|
2016-11-21 07:47:18 -05:00
|
|
|
|
|
|
|
def actions_for(environment)
|
|
|
|
return [] unless manual_actions
|
|
|
|
|
2016-11-21 11:26:35 -05:00
|
|
|
manual_actions.select do |action|
|
|
|
|
action.expanded_environment_name == environment
|
2016-11-21 07:47:18 -05:00
|
|
|
end
|
|
|
|
end
|
2016-12-07 20:09:18 -05:00
|
|
|
|
2016-11-22 14:55:56 -05:00
|
|
|
def has_terminals?
|
|
|
|
project.deployment_service.present? && available? && last_deployment.present?
|
|
|
|
end
|
|
|
|
|
|
|
|
def terminals
|
|
|
|
project.deployment_service.terminals(self) if has_terminals?
|
|
|
|
end
|
|
|
|
|
2016-12-07 20:09:18 -05:00
|
|
|
# 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
|
2017-01-19 09:42:03 -05:00
|
|
|
slugified = 'env-' + slugified unless LETTERS.cover?(slugified[0])
|
|
|
|
|
|
|
|
# Repeated dashes are invalid (OpenShift limitation)
|
|
|
|
slugified.gsub!(/\-+/, '-')
|
2016-12-07 20:09:18 -05:00
|
|
|
|
|
|
|
# Maximum length: 24 characters (OpenShift limitation)
|
|
|
|
slugified = slugified[0..23]
|
|
|
|
|
2017-01-19 09:42:03 -05:00
|
|
|
# Cannot end with a dash (Kubernetes label limitation)
|
|
|
|
slugified.chop! if slugified.end_with?('-')
|
2016-12-07 20:09:18 -05:00
|
|
|
|
|
|
|
# Add a random suffix, shortening the current string if necessary, if it
|
|
|
|
# has been slugified. This ensures uniqueness.
|
2017-01-19 09:42:03 -05:00
|
|
|
if slugified != name
|
|
|
|
slugified = slugified[0..16]
|
|
|
|
slugified << '-' unless slugified.end_with?('-')
|
|
|
|
slugified << random_suffix
|
|
|
|
end
|
2016-12-07 20:09:18 -05:00
|
|
|
|
|
|
|
self.slug = slugified
|
|
|
|
end
|
|
|
|
|
|
|
|
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
|
2016-06-10 17:36:54 -04:00
|
|
|
end
|