zammad/spec/factories/external_credential.rb

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

FactoryBot.define do
  factory :external_credential do
    factory :facebook_credential do
      name        { 'facebook' }
      credentials { { application_id: 123, application_secret: 123 } }
    end

    factory :twitter_credential do
      name { 'twitter' }

      credentials do
        {
          consumer_key:       consumer_key,
          consumer_secret:    consumer_secret,
          oauth_token:        oauth_token,
          oauth_token_secret: oauth_token_secret,
          env:                'zammad',
          controller:         'external_credentials',
          action:             'app_verify',
          provider:           'twitter',
          webhook_id:         Faker::Number.unique.number(digits: 19),
        }
      end

      # When recording a new VCR cassette,
      # Twitter API tests need valid credentials--
      # but storing them in this file is a security no-no.
      #
      # Instead, store your twitter API credentials in env vars to utilize this factory.
      # (Try https://github.com/direnv/direnv to set env vars automatically.)
      transient do
        consumer_key       { ENV.fetch('TWITTER_CONSUMER_KEY') { 'REDACTED' } }
        consumer_secret    { ENV.fetch('TWITTER_CONSUMER_SECRET') { 'REDACTED' } }
        oauth_token        { ENV.fetch('TWITTER_OAUTH_TOKEN') { 'REDACTED' } }
        oauth_token_secret { ENV.fetch('TWITTER_OAUTH_TOKEN_SECRET') { 'REDACTED' } }
      end

      trait :invalid do
        # If these credentials are fake/invalid,
        # why don't we use Faker to generate them dynamically?
        #
        # Our Twitter API tests use VCR to cache HTTP traffic.
        # If the values change each time you run the test,
        # VCR gets confused and raises errors.
        transient do
          consumer_key       { 'q7K8GEkhyCHs9jHLtkmD9Kod4' }
          consumer_secret    { 'LIDrpO6lRukO0PSicv00x9n8qMPvqvMq9mNInsby5sIkwN2J81' }
          oauth_token        { '7783712304-H9s75r2d532diPmJYK6JrvUWxu9gTDZ6ocjfToL' }
          oauth_token_secret { 'XFhmXR1J17zaI3bEikHKG5zNUVHVnjpzPuQc0vNmb4z2y' }
        end
      end
    end

    factory :sms_message_bird_credential do
      name        { 'message_bird' }
      credentials { { token: Faker::Alphanumeric.alphanumeric(number: 25) } }
    end

    factory :telegram_credential do
      name        { 'telegram' }
      credentials { { api_token: "#{Faker::Alphanumeric.alphanumeric(number: 7)}-#{Faker::Alphanumeric.alphanumeric(number: 13)}_#{Faker::Alphanumeric.alphanumeric(number: 7)}_#{Faker::Alphanumeric.alphanumeric(number: 5)}" } }
    end

    factory :microsoft_graph_credential do
      name { 'microsoft_graph' }

      transient do
        client_id     { SecureRandom.uuid }
        client_secret { SecureRandom.urlsafe_base64(40) }
        client_tenant { SecureRandom.uuid }
      end

      credentials do
        {
          'client_id'     => client_id,
          'client_secret' => client_secret,
          'client_tenant' => client_tenant,
          'controller'    => 'external_credentials',
          'action'        => 'app_verify',
          'provider'      => 'microsoft_graph',
        }
      end
    end

    factory :microsoft365_credential do
      name { 'microsoft365' }

      transient do
        client_id     { SecureRandom.uuid }
        client_secret { SecureRandom.urlsafe_base64(40) }
        client_tenant { SecureRandom.uuid }
      end

      credentials do
        {
          'client_id'     => client_id,
          'client_secret' => client_secret,
          'client_tenant' => client_tenant,
          'controller'    => 'external_credentials',
          'action'        => 'app_verify',
          'provider'      => 'microsoft365',
        }
      end
    end

    factory :google_credential do
      name { 'google' }

      transient do
        client_id     { SecureRandom.uuid }
        client_secret { SecureRandom.urlsafe_base64(40) }
      end

      credentials do
        {
          'client_id'     => client_id,
          'client_secret' => client_secret,
          'controller'    => 'external_credentials',
          'action'        => 'app_verify',
          'provider'      => 'google',
        }
      end
    end
  end
end