una/tests/units/modules/boonex/antispam/classes/BxAntispamModuleTest.php

<?php

/**
 * Test Antispam module
 */
class BxAntispamModuleTest extends BxDolTestCase
{
    protected $_sSampleEmail = 'some@example.com';
    protected $_sSampleIP = '0.0.0.0';

    protected $_oModule;

    protected $_oMockIP;
    protected $_oMockDNSBlacklists;
    protected $_oMockDNSURIBlacklists;
    protected $_oMockStopForumSpam;
    protected $_oMockAkismet;

    protected function setUp()
    {
        bx_import('BxDolModule');
        $this->_oModule = BxDolModule::getInstance('bx_antispam');

        $this->_oMockIP = $this->bxMockGet('BxAntispamIP', $this->_oModule->_aModule);
        $this->_oMockDNSBlacklists = $this->bxMockGet('BxAntispamDNSBlacklists', $this->_oModule->_aModule, true);
        $this->_oMockDNSURIBlacklists = $this->bxMockGet('BxAntispamDNSURIBlacklists', $this->_oModule->_aModule, true);
        $this->_oMockStopForumSpam = $this->bxMockGet('BxAntispamStopForumSpam', $this->_oModule->_aModule);
        $this->_oMockAkismet = $this->bxMockGet('BxAntispamAkismet', $this->_oModule->_aModule);
    }

    protected function tearDown()
    {
        // free all mock objects after each test call
        $this->bxMockFree($this->_oMockIP);
        $this->bxMockFree($this->_oMockDNSBlacklists);
        $this->bxMockFree($this->_oMockDNSURIBlacklists);
        $this->bxMockFree($this->_oMockStopForumSpam);
        $this->bxMockFree($this->_oMockAkismet);

        // restore options after each test call
        $this->_oModule->_oConfig->restoreAntispamOptions();
    }

    public function providerForServiceIsSpam()
    {
        $any = $this->anything();
        return array(
            array(true, $any, $any, $any, $any, $any, $any, false), // no spam detection for admin account 
            array(false, true, $any, $any, $any, $any, $any, false), // no spam detection for whitelisted IP

            array(false, false, 'on', false, $any, $any, 'on', false), // no spam detection if not listed in URIDNSBL (in "blocking" mode)
            array(false, false, 'on', true, $any, $any, 'on', true), // it is spam if listed in URIDNSBL (in "blocking" mode)

            array(false, false, '', $any, 'on', false, 'on', false), // no spam detection if not listed in Akismet (in "blocking" mode)
            array(false, false, '', $any, 'on', true, 'on', true), // it is spam if listed in Akismet (in "blocking" mode)

            array(false, false, 'on', true, 'on', true, '', false), // no spam detection in URIDNSBL nor Akismet if not in "blocking" mode
        );
    }

    /**
     * @dataProvider providerForServiceIsSpam
     */
    public function testServiceIsSpam($isAdmin, $bIpWhitelisted, $sUriDnsblEnable, $bUriDnsblBlacklisted, $sAkismetlEnable, $bAkismetBlacklisted, $sBlock, $bRes)
    {
        $this->_oModule->_oConfig->setAntispamOption('antispam_report', ''); // turn off reporting during testing
        $this->_oModule->_oConfig->setAntispamOption('uridnsbl_enable', $sUriDnsblEnable); 
        $this->_oModule->_oConfig->setAntispamOption('akismet_enable', $sAkismetlEnable);
        $this->_oModule->_oConfig->setAntispamOption('antispam_block', $sBlock);

        $GLOBALS['logged']['admin'] = $isAdmin;

        if ($isAdmin) { // if admin no futher call are performed
            $this->_oMockIP->expects($this->never())->method('isIpWhitelisted');
            $this->_oMockDNSURIBlacklists->expects($this->never())->method('isSpam');
            $this->_oMockAkismet->expects($this->never())->method('isSpam');
        } else { // if not admin then check for whitelisting
            $this->_oMockIP->expects($this->once())->method('isIpWhitelisted')
                ->will($this->returnValue($bIpWhitelisted));
        }

        if ('on' != $sUriDnsblEnable || $isAdmin || $bIpWhitelisted) { // don't check in DNDBL if anything is true
            $this->_oMockDNSURIBlacklists->expects($this->never())->method('isSpam');
        } else { // check in URIDNSBL if URIDNSBL is enabled, not admin and IP is not whitelisted
            $this->_oMockDNSURIBlacklists->expects($this->once())->method('isSpam')
                ->will($this->returnValue($bUriDnsblBlacklisted));
        }

        if ('on' != $sAkismetlEnable || $isAdmin || $bIpWhitelisted || ($bUriDnsblBlacklisted && $sUriDnsblEnable)) { // don't check in Akismet if anything is true
            $this->_oMockAkismet->expects($this->never())->method('isSpam');
        } else { // check in Akismet if Akismet is enabled, not admin, IP is not whitelisted and not previouslu detected in DNSBL
            $this->_oMockAkismet->expects($this->once())->method('isSpam')
                ->will($this->returnValue($bAkismetBlacklisted));
        }

        // check result boolean value
        $this->assertEquals($bRes, $this->_oModule->serviceIsSpam($this->anything(), $this->_sSampleIP));
    }

    public function providerForServiceCheckJoin()
    {
        $any = $this->anything();
        return array(
            array(true, $any, $any, $any, $any, false), // join is NOT allowed for blocked IPs
            array(false, '', $any, $any, false, true), // join is allowed if IP isn't blocked, DNSBL checking disabled, not listed in StopForumSpam
            array(false, 'on', 'approval', false, false, true), // join is allowed if IP isn't blocked and DNSBL enabled in "approval" mode, but not listed
            array(false, 'on', 'block', false, false, true), // join is allowed if IP isn't blocked and DNSBL enabled in "block", but not listed
            array(false, 'on', 'approval', true, false, true), // join is allowed if IP isn't blocked and DNSBL enabled in "approval" and IP listed
            array(false, 'on', 'block', true, $any, false), // join is NOT allowed if IP isn't blocked and DNSBL enabled in "block" and IP listed
            array(false, '', $any, $any, true, false), // join is NOT allowed if IP isn't blocked but listed in StopForumSpam
        );
    }

    /**
     * @dataProvider providerForServiceCheckJoin
     */
    public function testServiceCheckJoin($bIpBlocked, $sDnsblEnable, $sDnsblBehaviour, $bDnsblIpBlacklisted, $bStopForumSpamSpammer, $bResultEmptyString)
    {
        // set different options
        $this->_oModule->_oConfig->setAntispamOption('dnsbl_enable', $sDnsblEnable);
        $this->_oModule->_oConfig->setAntispamOption('dnsbl_behaviour', $sDnsblBehaviour);

        // first IP address block checking is called
        $this->_oMockIP->expects($this->once())->method('isIpBlocked')
            ->with($this->equalTo($this->_sSampleIP))
            ->will($this->returnValue($bIpBlocked));

        if ($bIpBlocked) { // if ip is blocked no other methods should be called

            $this->_oMockDNSBlacklists->expects($this->never())->method('dnsbl_lookup_ip');
            $this->_oMockStopForumSpam->expects($this->never())->method('isSpammer');

        } elseif (!$bIpBlocked) { // if ip is NOT blocked - perform further checks

            if ('on' != $sDnsblEnable || 'block' != $sDnsblBehaviour) { // DNSBL shouldn't be called if it isn't enabled or set in 'approval' mode
                $this->_oMockDNSBlacklists->expects($this->never())->method('dnsbl_lookup_ip');
            } elseif ('on' == $sDnsblEnable && 'block' == $sDnsblBehaviour) {
                $this->_oMockDNSBlacklists->expects($this->at(0))->method('dnsbl_lookup_ip')
                    ->with($this->equalTo(BX_DOL_DNSBL_CHAIN_SPAMMERS), $this->equalTo($this->_sSampleIP))
                    ->will($this->returnValue($bDnsblIpBlacklisted ? BX_DOL_DNSBL_POSITIVE : BX_DOL_DNSBL_NEGATIVE));
            }

            if ('on' == $sDnsblEnable && $bDnsblIpBlacklisted && 'block' == $sDnsblBehaviour) { // StopForumSpam shouldn't be called if DNSBL detected spam
                $this->_oMockStopForumSpam->expects($this->never())->method('isSpammer');
            } else {
                $this->_oMockStopForumSpam->expects($this->once())->method('isSpammer')
                    ->will($this->returnValue($bStopForumSpamSpammer));
            }
        }

        // empty string - no spam detected
        $this->assertTrue($bResultEmptyString == ('' == $this->_oModule->serviceCheckJoin($this->_sSampleEmail, $this->_sSampleIP)));
    }

    public function providerForServiceCheckLogin()
    {
        return array(
            array(true, false, 'approval', false, false),
            array(false, false, 'approval', false, true),
            array(false, true, 'approval', false, true),
            array(false, true, 'block', false, true),
            array(false, true, 'approval', true, true),
            array(false, true, 'block', true, false),
        );
    }

    /**
     * @dataProvider providerForServiceCheckLogin
     */
    public function testServiceCheckLogin($bIpBlocked, $sDnsblEnable, $sDnsblBehaviour, $bDnsblIpBlacklisted, $bResultEmptyString)
    {
        // set different options
        $this->_oModule->_oConfig->setAntispamOption('dnsbl_enable', $sDnsblEnable);
        $this->_oModule->_oConfig->setAntispamOption('dnsbl_behaviour', $sDnsblBehaviour);

        // first IP address block checking is called
        $this->_oMockIP->expects($this->once())->method('isIpBlocked')
            ->will($this->returnValue($bIpBlocked));

        if ($bIpBlocked || 'on' != $sDnsblEnable || 'block' != $sDnsblBehaviour) { // if ip is blocked, or DNSBL isn't enabled, or set in 'approval' mode - DNSBL checking shouldn't be called

            $this->_oMockDNSBlacklists->expects($this->never())->method('dnsbl_lookup_ip');

        } elseif (!$bIpBlocked && 'on' == $sDnsblEnable && 'block' == $sDnsblBehaviour) { // call DNSBL checking only if enabled, and set in 'block' mode, and IP isn;t already blocked

            $this->_oMockDNSBlacklists->expects($this->at(0))->method('dnsbl_lookup_ip')
                ->with($this->equalTo(BX_DOL_DNSBL_CHAIN_SPAMMERS), $this->_sSampleIP)
                ->will($this->returnValue($bDnsblIpBlacklisted ? BX_DOL_DNSBL_POSITIVE : BX_DOL_DNSBL_NEGATIVE));

        }

        // empty string - no spam detected
        $this->assertTrue($bResultEmptyString == ('' == $this->_oModule->serviceCheckLogin($this->_sSampleIP)));
    }

    public function providerForServiceIsIpDnsBlacklisted()
    {
        return array(
            array(false, false, false),
            array(true, false, true),
            array(true, true, false),
            array(false, true, false),
        );
    }

    /**
     * @dataProvider providerForServiceIsIpDnsBlacklisted
     */
    public function testServiceIsIpDnsBlacklisted($bDnsblSpammer, $bDnsblWhitelisted, $bRes)
    {
        // check of whitelisting should be called once
        $this->_oMockIP->expects($this->once())->method('isIpWhitelisted')
            ->with($this->equalTo($this->_sSampleIP))
            ->will($this->returnValue(false));

        // check in 'spammers' chain
        $this->_oMockDNSBlacklists->expects($this->at(0))->method('dnsbl_lookup_ip')
            ->with($this->equalTo(BX_DOL_DNSBL_CHAIN_SPAMMERS), $this->equalTo($this->_sSampleIP))
            ->will($this->returnValue($bDnsblSpammer ? BX_DOL_DNSBL_POSITIVE : BX_DOL_DNSBL_NEGATIVE));

        if ($bDnsblSpammer) { // if found in 'spammers' chain, then check if it is whitelisted in 'whitelist' chain
            $this->_oMockDNSBlacklists->expects($this->at(1))->method('dnsbl_lookup_ip')
                ->with($this->equalTo(BX_DOL_DNSBL_CHAIN_WHITELIST), $this->equalTo($this->_sSampleIP))
                ->will($this->returnValue($bDnsblWhitelisted ? BX_DOL_DNSBL_POSITIVE : BX_DOL_DNSBL_NEGATIVE));
        }

        // check result boolean value
        $this->assertEquals($bRes, $this->_oModule->serviceIsIpDnsBlacklisted($this->_sSampleIP));
    }

    public function testServiceIsIpDnsBlacklistedWhenIpIsWhiletisted()
    {
        $this->_oMockIP->expects($this->once())->method('isIpWhitelisted')
            ->will($this->returnValue(true));
        $this->_oMockDNSBlacklists->expects($this->never())->method('dnsbl_lookup_ip');

        $this->assertEquals(false, $this->_oModule->serviceIsIpDnsBlacklisted($this->_sSampleIP));
    }

    public function testServiceIsIpWhitelisted()
    {
        $this->_oMockIP->expects($this->once())->method('isIpWhitelisted');

        $this->_oModule->serviceIsIpWhitelisted($this->_sSampleIP);
    }

    public function testServiceIsIpBlocked()
    {
        $this->_oMockIP->expects($this->once())->method('isIpBlocked');

        $this->_oModule->serviceIsIpBlocked($this->_sSampleIP);
    }

    public function testServiceBlockIp()
    {
        $this->_oMockIP->expects($this->once())->method('blockIp');

        $this->_oModule->serviceBlockIp($this->_sSampleIP);
    }
}