class WarpEngine::CI::Gitlab::Adapter

The CI adapter for GitLab CI. It talks to the GitLab REST API (v4) through a CI::Gitlab::Client, accepts config requests carrying the webhook secret (CI::Gitlab::SignatureVerifier) and renders pipelines with CI::Gitlab::PipelineConfig. A GitLab project counts as a repository and its CI/CD variables as secrets.

Attributes

update_server [R]

The GitLab URL and the catalog URL the generated pipelines upload to (each nil when unset).

url [R]

The GitLab URL and the catalog URL the generated pipelines upload to (each nil when unset).

Public Class Methods

new (url: ENV["GITLAB_URL"], api_token: ENV["GITLAB_API_TOKEN"], webhook_secret: ENV["GITLAB_WEBHOOK_SECRET"], platforms: {}, update_server: nil)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 23
def initialize(url: ENV["GITLAB_URL"],
               api_token: ENV["GITLAB_API_TOKEN"],
               webhook_secret: ENV["GITLAB_WEBHOOK_SECRET"],
               platforms: {},
               update_server: nil)
  @url            = url.presence
  @api_token      = api_token.presence
  @webhook_secret = webhook_secret.presence
  @update_server  = update_server.presence
  @config         = PipelineConfig.new(platforms: platforms || {})
end

Creates the adapter. Blank values count as unset.

url: the GitLab URL (GITLAB_URL)
api_token: the GitLab API token (GITLAB_API_TOKEN)
webhook_secret: the secret config requests must carry (GITLAB_WEBHOOK_SECRET)
platforms: the platforms to build, see CI::PipelineConfig.new
update_server: the catalog URL the pipelines upload to

Public Instance Methods

activate_repo (project_id)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 65
def activate_repo(project_id)
  client.activate_repo(project_id)
  nil
end

Does nothing on GitLab, where CI needs no activation. Returns nil.

built_kinds (platform)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 46
def built_kinds(platform) = @config.built_kinds(platform)

Returns the release file kinds the pipeline of platform builds, or nil (see CI::PipelineConfig#built_kinds).

client ()

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 49
def client
  @client ||= Client.new(url: @url, token: @api_token)
end

Returns the memoized CI::Gitlab::Client for the configured URL and token.

config_marker (params)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 135
def config_marker(params)
  configs = params[:configuration].presence || params[:configs].presence || []
  configs = Array(configs)
  configs.each_with_index do |config, index|
    parsed = parse_marker(config[:data].to_s)
    next unless parsed

    marker = { platform: parsed["platform"].to_s,
               name:     parsed["name"].presence || params.dig(:repo, :name).to_s }
    options = parsed.except("platform", "name")
    marker[:options] = options if options.any?
    others = configs.reject.with_index { |_, other| other == index }
                    .map { |other| { name: other[:name].to_s, data: other[:data].to_s } }
    marker[:others] = others if others.any?
    return marker
  end
  nil
end

Finds the marker among the repository’s configs in a config request.

params: the request parameters: configuration (or configs), an Array of Hashes with the config file’s name and data, and repo with its name

Returns nil when no config is a YAML mapping with a platform key. Otherwise returns a Hash with platform, name (the marker’s, else the repository’s), options (the marker’s other keys, when any) and others (the remaining configs as name/data Hashes, when any).

config_response (platform:, config:, others: [])

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 161
def config_response(platform:, config:, others: [])
  { configs: [ { name: platform, data: config } ] + others }
end

Returns the body of the config response: the generated config named after platform, followed by the repository’s others configs unchanged.

configured? ()

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 39
def configured? = @url.present? && @api_token.present?

Returns true when both the server URL and the API token are set.

deactivate_repo (project_id)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 71
def deactivate_repo(project_id)
  client.deactivate_repo(project_id)
  nil
end

Does nothing on GitLab, where CI needs no activation. Returns nil.

name ()

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 36
def name = "GitLab"

Returns the display name, "GitLab".

pipeline_config (platform:, name:, update_server:, options: {})

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 155
def pipeline_config(platform:, name:, update_server:, options: {})
  @config.render(platform: platform, name: name, update_server: update_server, options: options)
end

Renders the pipeline of platform. Returns the YAML String or nil (see CI::PipelineConfig#render).

platforms ()

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 42
def platforms = @config.platforms

Returns the configured platforms (see CI::PipelineConfig#platforms).

repo (project_id)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 60
def repo(project_id)
  to_repo(client.get_repo(project_id))
end

Returns the CI::Repo of project_id (the GitLab project id). Raises CI::ApiError when it is not found.

repos ()

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 55
def repos
  Array(client.list_repos).map { |remote| to_repo(remote) }
end

Returns every repository the API token can see, as an Array of CI::Repo. Raises CI::ConnectionError or CI::ApiError.

run (project_id, number)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 84
def run(project_id, number)
  remote = if number.to_s == "latest"
    client.latest_pipeline(project_id)
  else
    client.get_pipeline(project_id, number)
  end
  remote && to_run(remote)
end

Returns the CI::Run numbered number of project_id, or the latest run when number is "latest"; nil when there is no latest run. Raises CI::ApiError when the run is not found.

runs (project_id, page: 1)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 77
def runs(project_id, page: 1)
  Array(client.list_pipelines(project_id, page: page)).map { |run| to_run(run) }
end

Returns one page (25 runs, newest first) of the pipeline runs of project_id as an Array of CI::Run.

secret_delete (project_id, name)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 116
def secret_delete(project_id, name)
  client.delete_secret(project_id, name)
  nil
end

Deletes the secret name of project_id. Returns nil. Raises CI::ApiError when it does not exist.

secret_names (project_id)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 100
def secret_names(project_id)
  Array(client.list_secrets(project_id)).map { |var| var["key"] }
end

Returns the names of the secrets of project_id as an Array of Strings: the project’s CI/CD variable keys.

secret_set (project_id, name:, value:)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 106
def secret_set(project_id, name:, value:)
  if secret_names(project_id).include?(name)
    client.update_secret(project_id, name, value: value)
  else
    client.create_secret(project_id, name: name, value: value)
  end
  nil
end

Creates or updates the CI/CD variable name of project_id with value (a new one is masked and unprotected). Returns nil.

trigger (project_id, branch: "main")

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 94
def trigger(project_id, branch: "main")
  to_run(client.trigger_pipeline(project_id, branch: branch || "main"))
end

Starts a pipeline of project_id on branch (main when nil). Returns the new CI::Run.

verify_config_request (request)

Source

# File lib/warp_engine/ci/gitlab/adapter.rb, line 122
def verify_config_request(request)
  SignatureVerifier.new(request, webhook_secret: @webhook_secret).valid?
end

Returns true when the config request carries the configured webhook secret in X-Gitlab-Token.