php_spec.rb

# frozen_string_literal: true

require 'spec_helper'

describe 'apache::mod::php', type: :class do
  on_supported_os.each do |os, facts|
    context "on #{os}" do
      let :facts do
        facts
      end
      let :pre_condition do
        'class { "apache": mpm_module => prefork, }'
      end

      case facts[:os]['family']
      when 'Debian'
        describe 'on a Debian OS' do
          context 'with mpm_module => prefork' do
            it { is_expected.to contain_class('apache::params') }
            it { is_expected.to contain_class('apache::mod::prefork') }
          end

          case facts[:os]['release']['major']
          when '9'
            context 'on stretch' do
              it { is_expected.to contain_apache__mod('php7.0') }
              it { is_expected.to contain_package('libapache2-mod-php7.0') }

              it {
                expect(subject).to contain_file('php7.0.load').with(
                  content: "LoadModule php7_module /usr/lib/apache2/modules/libphp7.0.so\n",
                )
              }
            end
          when '10'
            context 'on buster' do
              it { is_expected.to contain_apache__mod('php7.3') }
              it { is_expected.to contain_package('libapache2-mod-php7.3') }

              it {
                expect(subject).to contain_file('php7.3.load').with(
                  content: "LoadModule php7_module /usr/lib/apache2/modules/libphp7.3.so\n",
                )
              }

              context 'with php8.0' do
                let :params do
                  { php_version: '8.0' }
                end

                it { is_expected.to contain_apache__mod('php8.0') }
                it { is_expected.to contain_package('libapache2-mod-php8.0') }

                it {
                  expect(subject).to contain_file('php8.0.load').with(
                    content: "LoadModule php_module /usr/lib/apache2/modules/libphp8.0.so\n",
                  )
                }
              end
            end
          when '11'
            context 'on bullseye' do
              it { is_expected.to contain_apache__mod('php7.4') }
              it { is_expected.to contain_package('libapache2-mod-php7.4') }

              it {
                expect(subject).to contain_file('php7.4.load').with(
                  content: "LoadModule php7_module /usr/lib/apache2/modules/libphp7.4.so\n",
                )
              }

              context 'with php8.0' do
                let :params do
                  { php_version: '8.0' }
                end

                it { is_expected.to contain_apache__mod('php8.0') }
                it { is_expected.to contain_package('libapache2-mod-php8.0') }

                it {
                  expect(subject).to contain_file('php8.0.load').with(
                    content: "LoadModule php_module /usr/lib/apache2/modules/libphp8.0.so\n",
                  )
                }
              end
            end
          when '12'
            context 'on bookworm' do
              it { is_expected.to contain_apache__mod('php8.2') }
              it { is_expected.to contain_package('libapache2-mod-php8.2') }

              it {
                expect(subject).to contain_file('php8.2.load').with(
                  content: "LoadModule php8_module /usr/lib/apache2/modules/libphp8.2.so\n",
                )
              }
            end
          when '18.04'
            context 'on bionic' do
              let :params do
                { content: 'somecontent' }
              end

              it {
                expect(subject).to contain_file('php7.2.conf').with(
                  content: 'somecontent',
                )
              }
            end
          end
        end
      when 'RedHat'
        case facts[:os]['release']['major']
        when '9'
          it { is_expected.to compile.and_raise_error(%r{RedHat 9 does not support mod_php}) }
        else
          describe 'on a RedHat OS' do
            context 'with default params' do
              let :pre_condition do
                'class { "apache": }'
              end

              it { is_expected.to contain_class('apache::params') }
              it { is_expected.to contain_package('php') }

              if facts[:os]['release']['major'].to_i < 8
                it { is_expected.to contain_apache__mod('php5') }
                it { is_expected.to contain_file('php5.load').with(content: "LoadModule php5_module modules/libphp5.so\n") }
              elsif facts[:os]['release']['major'].to_i == 8
                it { is_expected.to contain_apache__mod('php7') }
                it { is_expected.to contain_file('php7.load').with(content: "LoadModule php7_module modules/libphp7.so\n") }

                context 'with php8.0' do
                  let :params do
                    { php_version: '8.0' }
                  end

                  it { is_expected.to contain_apache__mod('php') }
                  it { is_expected.to contain_file('php.load').with(content: "LoadModule php_module modules/libphp.so\n") }
                end
              elsif facts[:os]['release']['major'].to_i >= 9
                it { is_expected.to contain_apache__mod('php') }
                it { is_expected.to contain_file('php.load').with(content: "LoadModule php_module modules/libphp.so\n") }
              end
            end

            context 'with alternative package name' do
              let :pre_condition do
                'class { "apache": }'
              end
              let :params do
                { package_name: 'php54' }
              end

              it { is_expected.to contain_package('php54') }
            end

            context 'with alternative path' do
              let :pre_condition do
                'class { "apache": }'
              end
              let :params do
                { path: 'alternative-path' }
              end

              it { is_expected.to contain_package('php') }

              if facts[:os]['release']['major'].to_i < 8
                it { is_expected.to contain_apache__mod('php5') }
                it { is_expected.to contain_file('php5.load').with(content: "LoadModule php5_module alternative-path\n") }
              elsif facts[:os]['release']['major'].to_i == 8
                it { is_expected.to contain_apache__mod('php7') }
                it { is_expected.to contain_file('php7.load').with(content: "LoadModule php7_module alternative-path\n") }
              elsif facts[:os]['release']['major'].to_i >= 9
                it { is_expected.to contain_apache__mod('php') }
                it { is_expected.to contain_file('php.load').with(content: "LoadModule php_module alternative-path\n") }
              end
            end

            context 'with alternative extensions' do
              let :pre_condition do
                'class { "apache": }'
              end
              let :params do
                {
                  extensions: ['.php', '.php5']
                }
              end

              it { is_expected.to contain_file('php5.conf').with_content(Regexp.new(Regexp.escape('<FilesMatch ".+(\.php|\.php5)$">'))) } if facts[:os]['release']['major'].to_i < 8
            end

            if facts[:os]['release']['major'].to_i > 5
              context 'with specific version' do
                let :pre_condition do
                  'class { "apache": }'
                end
                let :params do
                  { package_ensure: '5.3.13' }
                end

                it {
                  expect(subject).to contain_package('php').with(
                    ensure: '5.3.13',
                  )
                }
              end
            end
            context 'with mpm_module => prefork' do
              it { is_expected.to contain_class('apache::params') }
              it { is_expected.to contain_class('apache::mod::prefork') }
              it { is_expected.to contain_package('php') }

              if facts[:os]['release']['major'].to_i < 8
                it { is_expected.to contain_apache__mod('php5') }
                it { is_expected.to contain_file('php5.load').with(content: "LoadModule php5_module modules/libphp5.so\n") }
              elsif facts[:os]['release']['major'].to_i == 8
                it { is_expected.to contain_apache__mod('php7') }
                it { is_expected.to contain_file('php7.load').with(content: "LoadModule php7_module modules/libphp7.so\n") }
              elsif facts[:os]['release']['major'].to_i >= 9
                it { is_expected.to contain_apache__mod('php') }
                it { is_expected.to contain_file('php.load').with(content: "LoadModule php_module modules/libphp.so\n") }
              end
            end

            context 'with mpm_module => itk' do
              let :pre_condition do
                'class { "apache": mpm_module => itk, }'
              end

              it { is_expected.to contain_class('apache::params') }
              it { is_expected.to contain_class('apache::mod::itk') }
              it { is_expected.to contain_package('php') }

              if facts[:os]['release']['major'].to_i < 8
                it { is_expected.to contain_apache__mod('php5') }
                it { is_expected.to contain_file('php5.load').with(content: "LoadModule php5_module modules/libphp5.so\n") }
              elsif facts[:os]['release']['major'].to_i == 8
                it { is_expected.to contain_apache__mod('php7') }
                it { is_expected.to contain_file('php7.load').with(content: "LoadModule php7_module modules/libphp7.so\n") }
              elsif facts[:os]['release']['major'].to_i >= 9
                it { is_expected.to contain_apache__mod('php') }
                it { is_expected.to contain_file('php.load').with(content: "LoadModule php_module modules/libphp.so\n") }
              end
            end
          end
        end
      when 'FreeBSD'
        describe 'on a FreeBSD OS' do
          context 'with mpm_module => prefork' do
            it { is_expected.to contain_class('apache::params') }
            it { is_expected.to contain_apache__mod('php5') }
            it { is_expected.to contain_package('www/mod_php5') }
            it { is_expected.to contain_file('php5.load') }
          end

          context 'with mpm_module => itk' do
            let :pre_condition do
              'class { "apache": mpm_module => itk, }'
            end

            it { is_expected.to contain_class('apache::params') }
            it { is_expected.to contain_class('apache::mod::itk') }
            it { is_expected.to contain_apache__mod('php5') }
            it { is_expected.to contain_package('www/mod_php5') }
            it { is_expected.to contain_file('php5.load') }
          end
        end
      when 'Gentoo'
        describe 'on a Gentoo OS' do
          context 'with mpm_module => prefork' do
            it { is_expected.to contain_class('apache::params') }
            it { is_expected.to contain_apache__mod('php5') }
            it { is_expected.to contain_package('dev-lang/php') }
            it { is_expected.to contain_file('php5.load') }
          end

          context 'with mpm_module => itk' do
            let :pre_condition do
              'class { "apache": mpm_module => itk, }'
            end

            it { is_expected.to contain_class('apache::params') }
            it { is_expected.to contain_class('apache::mod::itk') }
            it { is_expected.to contain_apache__mod('php5') }
            it { is_expected.to contain_package('dev-lang/php') }
            it { is_expected.to contain_file('php5.load') }
          end
        end
      end

      # all the following tests are for legacy php/apache versions. They don't work on modern ubuntu and redhat 8
      next if (facts[:os]['release']['major'].to_i >= 15 && facts[:os]['name'] == 'SLES')  ||
              (facts[:os]['family'] == 'Debian')                                           ||
              (facts[:os]['release']['major'].to_i >= 8 && (facts[:os]['name'] == 'RedHat' || facts[:os]['name'] == 'CentOS' ||
                                                            facts[:os]['name'] == 'Rocky'  || facts[:os]['name'] == 'AlmaLinux'))

      describe 'OS independent tests' do
        context 'with content param' do
          let :params do
            { content: 'somecontent' }
          end

          it {
            expect(subject).to contain_file('php5.conf').with(
              content: 'somecontent',
            )
          }
        end

        context 'with template param' do
          let :params do
            { template: 'apache/mod/php.conf.erb' }
          end

          it {
            expect(subject).to contain_file('php5.conf').with(
              content: %r{^# PHP is an HTML-embedded scripting language which attempts to make it},
            )
          }
        end

        context 'with source param' do
          let :params do
            { source: 'some-path' }
          end

          it {
            expect(subject).to contain_file('php5.conf').with(
              source: 'some-path',
            )
          }
        end

        context 'content has priority over template' do
          let :params do
            {
              template: 'apache/mod/php5.conf.erb',
              content: 'somecontent'
            }
          end

          it {
            expect(subject).to contain_file('php5.conf').with(
              content: 'somecontent',
            )
          }
        end

        context 'source has priority over template' do
          let :params do
            {
              template: 'apache/mod/php5.conf.erb',
              source: 'some-path'
            }
          end

          it {
            expect(subject).to contain_file('php5.conf').with(
              source: 'some-path',
            )
          }
        end

        context 'source has priority over content' do
          let :params do
            {
              content: 'somecontent',
              source: 'some-path'
            }
          end

          it {
            expect(subject).to contain_file('php5.conf').with(
              source: 'some-path',
            )
          }
        end

        context 'with mpm_module => worker' do
          let :pre_condition do
            'class { "apache": mpm_module => worker, }'
          end

          it 'raises an error' do
            expect(subject).to compile.and_raise_error(%r{mpm_module => 'prefork' or mpm_module => 'itk'})
          end
        end
      end
    end
  end
end