Class: Integrations::BaseCi

Inherits:
Integration show all
Defined in:
app/models/integrations/base_ci.rb

Direct Known Subclasses

Bamboo, Buildkite, DroneCi, Jenkins, MockCi, Teamcity

Constant Summary

Constants inherited from Integration

Integration::BASE_CLASSES, Integration::DEV_INTEGRATION_NAMES, Integration::INTEGRATION_NAMES, Integration::PROJECT_SPECIFIC_INTEGRATION_NAMES, Integration::SECTION_TYPE_CONFIGURATION, Integration::SECTION_TYPE_CONNECTION, Integration::SECTION_TYPE_TRIGGER, Integration::UnknownType

Constants inherited from ApplicationRecord

ApplicationRecord::MAX_PLUCK

Instance Attribute Summary

Attributes included from Importable

#imported, #importing

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Integration

#activate_disabled_reason, #activated?, #api_field_names, #async_execute, #attributes, available_integration_names, available_integration_types, boolean_accessor, build_from_integration, #category, #configurable_events, create_from_active_default_integrations, default_integration, #default_test_event, default_test_event, #description, dev_integration_names, #dup, #editable?, #event_channel_names, event_description, #event_names, event_names, #execute, field, fields, #fields, find_or_initialize_all_non_project_specific, find_or_initialize_non_project_specific_integration, #form_fields, #group_level?, #help, #inheritable?, inherited_descendants_from_self_or_ancestors_from, #initialize_properties, instance_exists_for?, #instance_level?, integration_name_to_model, integration_name_to_type, integration_names, #json_fields, #operating?, #parent, #project_level?, project_specific_integration_names, prop_accessor, #properties=, #reencrypt_properties, #reset_updated_properties, #secret_fields, #sections, #show_active_box?, #supported_events, #supports_data_fields?, #test, #testable?, #title, #to_database_hash, to_param, #to_param, #updated_properties

Methods included from Gitlab::Utils::Override

#extended, extensions, #included, #method_added, #override, #prepended, #queue_verification, verify!

Methods included from ResetSecretFields

#exposing_secrets_fields

Methods included from Loggable

#build_message, #log_error, #log_exception, #log_info, #logger

Methods inherited from ApplicationRecord

cached_column_list, #create_or_load_association, declarative_enum, default_select_columns, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, #readable_by?, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, #to_ability_name, underscore, where_exists, where_not_exists, with_fast_read_statement_timeout, without_order

Methods included from SensitiveSerializableHash

#serializable_hash

Class Method Details

.supported_eventsObject


14
15
16
# File 'app/models/integrations/base_ci.rb', line 14

def self.supported_events
  %w[push]
end

Instance Method Details

#build_page(sha, ref) ⇒ Object

Return complete url to build page

Ex.

http://jenkins.example.com:8888/job/test1/scm/bySHA1/12d65c

23
24
25
# File 'app/models/integrations/base_ci.rb', line 23

def build_page(sha, ref)
  # implement inside child
end

#commit_status(sha, ref) ⇒ Object

Return string with build status or :error symbol

Allowed states: 'success', 'failed', 'running', 'pending', 'skipped'

Ex.

@integration.commit_status('13be4ac', 'master')
# => 'success'

@integration.commit_status('2abe4ac', 'dev')
# => 'running'

40
41
42
# File 'app/models/integrations/base_ci.rb', line 40

def commit_status(sha, ref)
  # implement inside child
end

#valid_token?(token) ⇒ Boolean

Returns:

  • (Boolean)

10
11
12
# File 'app/models/integrations/base_ci.rb', line 10

def valid_token?(token)
  self.respond_to?(:token) && self.token.present? && ActiveSupport::SecurityUtils.secure_compare(token, self.token)
end