zammad/test/integration/slack_test.rb

# Copyright (C) 2012-2022 Zammad Foundation, https://zammad-foundation.org/

require 'integration_test_helper'
require 'slack-ruby-client' # Only load this gem when it is really used.

class SlackTest < ActiveSupport::TestCase

  # needed to check correct behavior
  slack_group = Group.create_if_not_exists(
    name:          'Slack',
    updated_by_id: 1,
    created_by_id: 1
  )

  # check
  test 'base' do

    if !ENV['SLACK_CI_CHANNEL']
      raise "ERROR: Need SLACK_CI_CHANNEL - hint SLACK_CI_CHANNEL='ci-zammad'"
    end
    if !ENV['SLACK_CI_WEBHOOK']
      raise "ERROR: Need SLACK_CI_WEBHOOK - hint SLACK_CI_WEBHOOK='https://hooks.slack.com/services/...'"
    end
    if !ENV['SLACK_CI_CHECKER_TOKEN']
      raise "ERROR: Need SLACK_CI_CHECKER_TOKEN - hint SLACK_CI_CHECKER_TOKEN='...'"
    end

    channel = ENV['SLACK_CI_CHANNEL']
    webhook = ENV['SLACK_CI_WEBHOOK']

    # set system mode to done / to activate
    Setting.set('system_init_done', true)
    Setting.set('slack_integration', true)

    items = [
      {
        group_ids: [slack_group.id],
        types:     %w[create update reminder_reached],
        webhook:   webhook,
        channel:   channel,
        username:  'zammad bot',
        expand:    false,
      }
    ]
    Setting.set('slack_config', { items: items })

    # case 1
    customer = User.find(2)
    hash     = hash_gen
    text     = "#{rand_word}... #{hash}"

    default_group = Group.first
    ticket1 = Ticket.create(
      title:         text,
      customer_id:   customer.id,
      group_id:      default_group.id,
      state:         Ticket::State.find_by(name: 'new'),
      priority:      Ticket::Priority.find_by(name: '2 normal'),
      updated_by_id: 1,
      created_by_id: 1,
    )
    Ticket::Article.create(
      ticket_id:     ticket1.id,
      body:          text,
      type:          Ticket::Article::Type.find_by(name: 'note'),
      sender:        Ticket::Article::Sender.find_by(name: 'Customer'),
      internal:      false,
      updated_by_id: 1,
      created_by_id: 1,
    )

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(0, slack_check(channel, hash))

    ticket1.state = Ticket::State.find_by(name: 'open')
    ticket1.save

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(0, slack_check(channel, hash))

    # case 2
    hash = hash_gen
    text = "#{rand_word}... #{hash}"

    ticket2 = Ticket.create(
      title:         text,
      customer_id:   customer.id,
      group_id:      slack_group.id,
      state:         Ticket::State.find_by(name: 'new'),
      priority:      Ticket::Priority.find_by(name: '2 normal'),
      updated_by_id: 1,
      created_by_id: 1,
    )
    Ticket::Article.create(
      ticket_id:     ticket2.id,
      body:          text,
      type:          Ticket::Article::Type.find_by(name: 'note'),
      sender:        Ticket::Article::Sender.find_by(name: 'Customer'),
      internal:      false,
      updated_by_id: 1,
      created_by_id: 1,
    )

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(1, slack_check(channel, hash))

    hash = hash_gen
    text = "#{rand_word}... #{hash}"

    ticket2.title = text
    ticket2.save

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(1, slack_check(channel, hash))

    ticket2.state = Ticket::State.find_by(name: 'pending reminder')
    ticket2.pending_time = 2.days.ago
    ticket2.save

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(2, slack_check(channel, hash))

    Ticket.process_pending

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(3, slack_check(channel, hash))

    Ticket.process_pending

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(3, slack_check(channel, hash))

    items = [
      {
        group_ids: slack_group.id.to_s,
        types:     'create',
        webhook:   webhook,
        channel:   channel,
        username:  'zammad bot',
        expand:    false,
      }
    ]
    Setting.set('slack_config', { items: items })

    # case 3
    customer = User.find(2)
    hash     = hash_gen
    text     = "#{rand_word}... #{hash}"

    default_group = Group.first
    ticket3 = Ticket.create(
      title:         text,
      customer_id:   customer.id,
      group_id:      default_group.id,
      state:         Ticket::State.find_by(name: 'new'),
      priority:      Ticket::Priority.find_by(name: '2 normal'),
      updated_by_id: 1,
      created_by_id: 1,
    )
    Ticket::Article.create(
      ticket_id:     ticket3.id,
      body:          text,
      type:          Ticket::Article::Type.find_by(name: 'note'),
      sender:        Ticket::Article::Sender.find_by(name: 'Customer'),
      internal:      false,
      updated_by_id: 1,
      created_by_id: 1,
    )

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(0, slack_check(channel, hash))

    ticket3.state = Ticket::State.find_by(name: 'open')
    ticket3.save

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(0, slack_check(channel, hash))

    # case 4
    hash = hash_gen
    text = "#{rand_word}... #{hash}"

    ticket4 = Ticket.create(
      title:         text,
      customer_id:   customer.id,
      group_id:      slack_group.id,
      state:         Ticket::State.find_by(name: 'new'),
      priority:      Ticket::Priority.find_by(name: '2 normal'),
      updated_by_id: 1,
      created_by_id: 1,
    )
    Ticket::Article.create(
      ticket_id:     ticket4.id,
      body:          text,
      type:          Ticket::Article::Type.find_by(name: 'note'),
      sender:        Ticket::Article::Sender.find_by(name: 'Customer'),
      internal:      false,
      updated_by_id: 1,
      created_by_id: 1,
    )

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(1, slack_check(channel, hash))

    hash = hash_gen
    text = "#{rand_word}... #{hash}"

    ticket4.title = text
    ticket4.save

    TransactionDispatcher.commit
    Scheduler.worker(true)

    # check if message exists
    assert_equal(0, slack_check(channel, hash))

  end

  def hash_gen
    SecureRandom.hex(10)
  end

  def rand_word
    words = [
      'dog',
      'cat',
      'house',
      'home',
      'yesterday',
      'tomorrow',
      'new york',
      'berlin',
      'coffee script',
      'java script',
      'bob smith',
      'be open',
      'really nice',
      'stay tuned',
      'be a good boy',
      'invent new things',
    ]
    words.sample
  end

  def slack_check(channel_name, search_for)

    Slack.configure do |config|
      config.token = ENV['SLACK_CI_CHECKER_TOKEN']
    end

    client = Slack::Web::Client.new
    client.auth_test

    channels = client.conversations_list['channels']
    channel_id = nil
    channels.each do |channel|
      next if channel['name'] != channel_name

      channel_id = channel['id']
    end
    if !channel_id
      raise "ERROR: No such channel '#{channel_name}'"
    end

    channel_history = client.conversations_history(channel: channel_id)
    if !channel_history
      raise "ERROR: No history for channel #{channel_name}/#{channel_id}"
    end
    if !channel_history['messages']
      raise "ERROR: No history messages for channel #{channel_name}/#{channel_id}"
    end

    message_count = 0
    channel_history['messages'].each do |message|
      next if !message['text']

      if message['text'].match?(%r{#{search_for}}i)
        message_count += 1
        p "SUCCESS: message with #{search_for} found #{message_count} time(s)!"
      end
    end
    message_count
  end

end