Class: Gitlab::QA::Release

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/qa/release.rb

Constant Summary collapse

CANONICAL_REGEX =
/
  \A
    (?<edition>ce|ee)
    (-qa)?
    (:(?<tag>.+))?
  \z
/xi
CUSTOM_GITLAB_IMAGE_REGEX =
%r{
  \A
    (?<image_without_tag>
      (?<registry>[^\/:]+(:(?<port>\d+))?)
      .+
      gitlab-
      (?<edition>ce|ee)
    )
    (-qa)?
    (:(?<tag>.+))?
  \z
}xi
DEV_OFFICIAL_TAG_REGEX =

Official dev tag example:

12.5.4(-rc42)-ee

|————-|–|

|             |
|             |
|             |
|          edition

version

/
  \A
    (?<version>\d+\.\d+.\d+(?:-rc\d+)?)-(?<edition>ce|ee)
  \z
/xi
DEV_TAG_REGEX =

Dev tag example:

12.1.201906121026-325a6632895.b340d0bd35d

|—-|————|———–|———–|

|         |           |           |
|         |           |      omnibus-ref
|         |       gitlab-ee ref
|     timestamp

version

/
  \A
    (?<version>\d+\.\d+(.\d+)?)\.(?<timestamp>\d+)\-(?<gitlab_ref>[A-Za-z0-9]+)\.(?<omnibus_ref>[A-Za-z0-9]+)
  \z
/xi
DEFAULT_TAG =
'latest'.freeze
DEFAULT_CANONICAL_TAG =
'nightly'.freeze
DEV_REGISTRY =
'dev.gitlab.org:5005'.freeze
InvalidImageNameError =
Class.new(RuntimeError)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(release) ⇒ Release

Returns a new instance of Release.



61
62
63
64
65
# File 'lib/gitlab/qa/release.rb', line 61

def initialize(release)
  @release = release.to_s.downcase

  raise InvalidImageNameError, "The release image name '#{@release}' does not have the expected format." unless valid?
end

Instance Attribute Details

#releaseObject (readonly)

Returns the value of attribute release.



58
59
60
# File 'lib/gitlab/qa/release.rb', line 58

def release
  @release
end

#tagObject

Tag scheme for gitlab-ce,ee images is like 11.1.0-rc12.ee.0



119
120
121
122
123
124
125
126
# File 'lib/gitlab/qa/release.rb', line 119

def tag
  @tag ||=
    if canonical?
      release.match(CANONICAL_REGEX)[:tag] || DEFAULT_CANONICAL_TAG
    else
      release.match(CUSTOM_GITLAB_IMAGE_REGEX)&.[](:tag) || DEFAULT_TAG
    end
end

Instance Method Details

#dev_gitlab_org?Boolean

Returns:

  • (Boolean)


137
138
139
# File 'lib/gitlab/qa/release.rb', line 137

def dev_gitlab_org?
  image.start_with?(DEV_REGISTRY)
end

#editionObject



77
78
79
80
81
82
83
84
# File 'lib/gitlab/qa/release.rb', line 77

def edition
  @edition ||=
    if canonical?
      release.match(CANONICAL_REGEX)[:edition].to_sym
    else
      release.match(CUSTOM_GITLAB_IMAGE_REGEX)[:edition].to_sym
    end
end

#ee?Boolean

Returns:

  • (Boolean)


86
87
88
# File 'lib/gitlab/qa/release.rb', line 86

def ee?
  edition == :ee
end

#imageObject



96
97
98
99
100
101
102
103
# File 'lib/gitlab/qa/release.rb', line 96

def image
  @image ||=
    if canonical?
      "gitlab/gitlab-#{edition}"
    else
      release.match(CUSTOM_GITLAB_IMAGE_REGEX)[:image_without_tag]
    end
end

#previous_stableObject



71
72
73
74
75
# File 'lib/gitlab/qa/release.rb', line 71

def previous_stable
  # The previous stable is always gitlab/gitlab-ce:latest or
  # gitlab/gitlab-ee:latest
  self.class.new("#{canonical_image}:latest")
end

#project_nameObject



109
110
111
112
113
114
115
116
# File 'lib/gitlab/qa/release.rb', line 109

def project_name
  @project_name ||=
    if canonical?
      "gitlab-#{edition}"
    else
      "gitlab-#{release.match(CUSTOM_GITLAB_IMAGE_REGEX)[:edition]}"
    end
end

#qa_imageObject



105
106
107
# File 'lib/gitlab/qa/release.rb', line 105

def qa_image
  "#{image}-qa"
end

#qa_tagObject

Tag scheme for gitlab-ce,ee-qa images is like 11.1.0-rc12-ee



129
130
131
132
133
134
135
# File 'lib/gitlab/qa/release.rb', line 129

def qa_tag
  if dev_gitlab_org? && (match_data = tag.match(DEV_TAG_REGEX))
    "#{match_data[:version]}-#{match_data[:gitlab_ref]}"
  else
    tag.sub(/[-\.]([ce]e)(\.(\d+))?\z/, '-\1')
  end
end

#to_eeObject



90
91
92
93
94
# File 'lib/gitlab/qa/release.rb', line 90

def to_ee
  return self if ee?

  self.class.new(to_s.sub('ce:', 'ee:'))
end

#to_sObject



67
68
69
# File 'lib/gitlab/qa/release.rb', line 67

def to_s
  "#{image}:#{tag}"
end

#valid?Boolean

Returns:

  • (Boolean)


141
142
143
# File 'lib/gitlab/qa/release.rb', line 141

def valid?
  canonical? || release.match?(CUSTOM_GITLAB_IMAGE_REGEX)
end