debian-mirror-gitlab/app/models/integrations/jenkins.rb

# frozen_string_literal: true

module Integrations
  class Jenkins < BaseCi
    include HasWebHook

    prepend EnableSslVerification
    extend Gitlab::Utils::Override

    prop_accessor :jenkins_url, :project_name, :username, :password

    before_validation :reset_password

    validates :jenkins_url, presence: true, addressable_url: true, if: :activated?
    validates :project_name, presence: true, if: :activated?
    validates :username, presence: true, if: ->(service) { service.activated? && service.password_touched? && service.password.present? }

    default_value_for :push_events, true
    default_value_for :merge_requests_events, false
    default_value_for :tag_push_events, false

    def reset_password
      # don't reset the password if a new one is provided
      if (jenkins_url_changed? || username.blank?) && !password_touched?
        self.password = nil
      end
    end

    def execute(data)
      return unless supported_events.include?(data[:object_kind])

      execute_web_hook!(data, "#{data[:object_kind]}_hook")
    end

    def test(data)
      begin
        result = execute(data)
        return { success: false, result: result[:message] } if result[:http_status] != 200
      rescue StandardError => error
        return { success: false, result: error }
      end

      { success: true, result: result[:message] }
    end

    override :hook_url
    def hook_url
      url = URI.parse(jenkins_url)
      url.path = File.join(url.path || '/', "project/#{project_name}")
      url.user = ERB::Util.url_encode(username) unless username.blank?
      url.password = ERB::Util.url_encode(password) unless password.blank?
      url.to_s
    end

    def self.supported_events
      %w(push merge_request tag_push)
    end

    def title
      'Jenkins'
    end

    def description
      s_('Run CI/CD pipelines with Jenkins.')
    end

    def help
      docs_link = ActionController::Base.helpers.link_to _('Learn more.'), Rails.application.routes.url_helpers.help_page_url('integration/jenkins'), target: '_blank', rel: 'noopener noreferrer'
      s_('Run CI/CD pipelines with Jenkins when you push to a repository, or when a merge request is created, updated, or merged. %{docs_link}').html_safe % { docs_link: docs_link.html_safe }
    end

    def self.to_param
      'jenkins'
    end

    def fields
      [
        {
          type: 'text',
          name: 'jenkins_url',
          title: s_('ProjectService|Jenkins server URL'),
          required: true,
          placeholder: 'http://jenkins.example.com',
          help: s_('The URL of the Jenkins server.')
        },
        {
          type: 'text',
          name: 'project_name',
          required: true,
          placeholder: 'my_project_name',
          help: s_('The name of the Jenkins project. Copy the name from the end of the URL to the project.')
        },
        {
          type: 'text',
          name: 'username',
          help: s_('The username for the Jenkins server.')
        },
        {
          type: 'password',
          name: 'password',
          help: s_('The password for the Jenkins server.'),
          non_empty_password_title: s_('ProjectService|Enter new password.'),
          non_empty_password_help: s_('ProjectService|Leave blank to use your current password.')
        }
      ]
    end
  end
end