zammad/spec/factories/user.rb

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

FactoryBot.define do
  factory :user do
    transient do
      hide_clues  { true }
      slug        { "#{firstname}.#{lastname}".parameterize }
    end

    login            { slug }
    firstname        { Faker::Name.unique.first_name }
    lastname         { Faker::Name.unique.last_name }
    sequence(:email) { |n| "#{slug}.#{n}@zammad.org" }
    password         { nil }
    active           { true }
    login_failed     { 0 }
    updated_by_id    { 1 }
    created_by_id    { 1 }

    callback(:after_stub, :before_create) do |object, context|
      next if !context.hide_clues

      object.preferences ||= {}
      object.preferences[:intro]                    = true
      object.preferences[:keyboard_shortcuts_clues] = true
    end

    factory :customer do
      role_ids { Role.signup_role_ids.sort }
    end

    factory :agent_and_customer do
      role_ids { Role.signup_role_ids.push(Role.find_by(name: 'Agent').id).sort }
    end

    factory :agent do
      roles { Role.where(name: 'Agent') }
    end

    factory :admin do
      roles { Role.where(name: %w[Admin Agent]) }
    end

    factory :admin_only do
      roles { Role.where(name: %w[Admin]) }
    end

    trait :with_valid_password do
      password { generate(:password_valid) }
    end

    trait :without_email do
      sequence(:login) { |n| "login_#{slug}.#{n}" }
      sequence(:email) { nil }
    end

    # make given password accessible for e.g. authentication logic
    before(:create) do |user|
      password_plain = user.password
      user.define_singleton_method(:password_plain, -> { password_plain })
    end

    trait :groupable do
      transient do
        group { nil }
      end

      after(:create) do |user, context|
        Array(context.group).each do |group|
          user.groups << group
        end
      end
    end

    trait :preferencable do
      transient do
        notification_group_ids { [] }
      end

      preferences do
        {
          'notification_config' => {
            'matrix'    => {
              'create'           => { 'criteria' => { 'owned_by_me' => true, 'owned_by_nobody' => true }, 'channel' => { 'email' => true, 'online' => true } },
              'update'           => { 'criteria' => { 'owned_by_me' => true, 'owned_by_nobody' => true }, 'channel' => { 'email' => true, 'online' => true } },
              'reminder_reached' => { 'criteria' => { 'owned_by_me' => true, 'owned_by_nobody' => true }, 'channel' => { 'email' => true, 'online' => true } },
              'escalation'       => { 'criteria' => { 'owned_by_me' => true, 'owned_by_nobody' => true }, 'channel' => { 'email' => true, 'online' => true } },
            },
            'group_ids' => notification_group_ids
          }
        }
      end
    end

    trait :ooo do
      transient do
        ooo_agent { nil }
      end

      out_of_office { true }
      out_of_office_start_at { 1.day.ago }
      out_of_office_end_at { 1.day.from_now }
      out_of_office_replacement_id { ooo_agent&.id }
    end

    trait :with_org do
      organization
    end
  end

  sequence(:password_valid) do |n|
    "SOme-pass#{n}"
  end
end