zammad/spec/services/service/system/check_setup_spec.rb

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

require 'rails_helper'

RSpec.describe Service::System::CheckSetup, :aggregate_failures do

  describe '.new?' do
    context 'with fresh install' do
      before do
        Setting.set('system_init_done', false)
      end

      it 'returns true' do
        expect(described_class.new?).to be(true)
      end
    end

    context 'with in progress setup' do
      before do
        Setting.set('system_init_done', false)
        Setting.set('import_mode', true)
      end

      it 'returns false' do
        expect(described_class.new?).to be(false)
      end
    end

    context 'with finished setup' do
      before do
        Setting.set('system_init_done', true)
        create(:admin)
      end

      it 'returns false' do
        expect(described_class.new?).to be(false)
      end
    end
  end

  describe '.new!' do
    context 'with fresh install' do
      before do
        Setting.set('system_init_done', false)
      end

      it 'raises no error' do
        expect { described_class.new! }.not_to raise_error
      end
    end

    context 'with in progress setup' do
      before do
        Setting.set('system_init_done', false)
        Setting.set('import_mode', true)
      end

      it 'raises error' do
        expect { described_class.new! }.to raise_error(Service::System::CheckSetup::SystemSetupError)
      end
    end

    context 'with finished setup' do
      before do
        Setting.set('system_init_done', true)
        create(:admin)
      end

      it 'raises error' do
        expect { described_class.new! }.to raise_error(Service::System::CheckSetup::SystemSetupError)
      end
    end
  end

  describe '.done?' do
    context 'with fresh install' do
      before do
        Setting.set('system_init_done', false)
      end

      it 'returns false' do
        expect(described_class.done?).to be(false)
      end
    end

    context 'with in progress setup' do
      before do
        Setting.set('system_init_done', false)
        Setting.set('import_mode', true)
      end

      it 'returns false' do
        expect(described_class.done?).to be(false)
      end
    end

    context 'with finished setup' do
      before do
        Setting.set('system_init_done', true)
        create(:admin)
      end

      it 'returns true' do
        expect(described_class.done?).to be(true)
      end
    end
  end

  describe '.done!' do
    context 'with fresh install' do
      before do
        Setting.set('system_init_done', false)
      end

      it 'raises error' do
        expect { described_class.done! }.to raise_error(Service::System::CheckSetup::SystemSetupError)
      end
    end

    context 'with in progress setup' do
      before do
        Setting.set('system_init_done', false)
        Setting.set('import_mode', true)
      end

      it 'raises error' do
        expect { described_class.done! }.to raise_error(Service::System::CheckSetup::SystemSetupError)
      end
    end

    context 'with finished setup' do
      before do
        Setting.set('system_init_done', true)
        create(:admin)
      end

      it 'raises no error' do
        expect { described_class.done! }.not_to raise_error
      end
    end
  end

  describe '#execute' do
    subject(:service) { described_class.new }

    describe 'with fresh install' do
      before do
        Setting.set('system_init_done', false)
        service.execute
      end

      it 'returns new status' do
        expect(service.status).to eq('new')
        expect(service.type).to be_nil
      end

      context 'when auto wizard is enabled' do
        before do
          allow(AutoWizard).to receive(:enabled?).and_return(true)
          service.execute
        end

        it 'returns automated status' do
          expect(service.status).to eq('automated')
          expect(service.type).to be_nil
        end
      end
    end

    context 'with finished setup' do
      before do
        Setting.set('system_init_done', true)
        create(:admin)
      end

      context 'with manual setup' do
        before do
          Setting.set('import_mode', false)
          service.execute
        end

        it 'returns done status' do
          expect(service.status).to eq('done')
          expect(service.type).to be_nil
        end
      end

      context 'with auto setup' do
        before do
          Setting.set('import_mode', false)
          allow(AutoWizard).to receive(:enabled?).and_return(true)
          service.execute
        end

        it 'returns done status' do
          expect(service.status).to eq('done')
          expect(service.type).to be_nil
        end
      end

      context 'with import setup' do
        before do
          Setting.set('import_mode', true)
          service.execute
        end

        it 'returns done status' do
          expect(service.status).to eq('in_progress')
          expect(service.type).to eq('import')
        end
      end
    end

    describe 'with in progress setup' do
      before do
        Setting.set('system_init_done', false)
      end

      context 'with manual setup' do
        before do
          Setting.set('import_mode', false)

          Service::ExecuteLockedBlock.new('Zammad::System::Setup', 10_000).execute do
            service.execute
          end
        end

        it 'returns in_progress status' do
          expect(service.status).to eq('in_progress')
          expect(service.type).to eq('manual')
        end
      end

      context 'with auto setup' do
        before do
          Setting.set('import_mode', false)

          Service::ExecuteLockedBlock.new('Zammad::System::Setup', 10_000).execute do
            begin
              json = Rails.root.join('auto_wizard.json')
              FileUtils.touch(json)
              service.execute
            ensure
              FileUtils.rm(json)
            end
          end
        end

        it 'returns in_progress status' do
          expect(service.status).to eq('in_progress')
          expect(service.type).to eq('auto')
        end
      end

      context 'with import setup' do
        before do
          Setting.set('import_mode', true)

          service.execute
        end

        it 'returns in_progress status' do
          expect(service.status).to eq('in_progress')
          expect(service.type).to eq('import')
        end
      end
    end

    describe 'dubious setup' do
      context 'with finished setup and no admin user' do
        before do
          Setting.set('system_init_done', true)
        end

        it 'raises error' do
          expect { service.execute }.to raise_error(Service::System::CheckSetup::SystemSetupError)
        end
      end

      context 'with not finished setup and at least one admin users' do
        before do
          Setting.set('system_init_done', false)
          create(:admin)
        end

        it 'raises error' do
          allow(Rails.logger).to receive(:warn)
          service.execute
          expect(Rails.logger).to have_received(:warn).with('The system setup is not marked as done, but at least one admin user is existing. Marking system setup as done.')
        end
      end
    end
  end
end