PolicyTestCase.inc.php

<?php
 
import('lib.pkp.tests.PKPTestCase');
import('lib.pkp.classes.security.UserGroup');
import('lib.pkp.classes.core.PKPRequest');
 
define('ROLE_ID_TEST', 0x9999);
 
abstract class PolicyTestCase extends PKPTestCase {
   private $contextObjects;
 
   private $authorizationContextManipulationPolicy;
 
   protected function getMockedRegistryKeys() {
      return array('user');
   }
 
   private function getContextObjects() {
      return $this->contextObjects;
   }
 
   private function setContextObjects($contextObjects) {
      $this->contextObjects = $contextObjects;
   }
 
   protected function getAuthorizationContextManipulationPolicy() {
      if (is_null($this->authorizationContextManipulationPolicy)) {
         // Use a policy to prepare an authorized context
         // with a user group.
         $policy = $this->getMockBuilder(AuthorizationPolicy::class)
            ->setMethods(array('effect'))
            ->getMock();
         $policy->expects($this->any())
                ->method('effect')
                ->will($this->returnCallback(array($this, 'mockEffect')));
         $this->authorizationContextManipulationPolicy = $policy;
      }
      return $this->authorizationContextManipulationPolicy;
   }
 
   public function mockEffect() {
      // Add a user group to the authorized context
      // of the authorization context manipulation policy.
      $policy = $this->getAuthorizationContextManipulationPolicy();
      $userGroup = new UserGroup();
      $userGroup->setRoleId(ROLE_ID_TEST);
      $policy->addAuthorizedContextObject(ASSOC_TYPE_USER_GROUP, $userGroup);
 
      // Add user roles array to the authorized context.
      $userRoles = array(ROLE_ID_TEST, ROLE_ID_SITE_ADMIN);
      $policy->addAuthorizedContextObject(ASSOC_TYPE_USER_ROLES, $userRoles);
      return AUTHORIZATION_PERMIT;
   }
 
   protected function getMockRequest($requestedOp, $context = null, $user = null) {
      // Mock a request to the permitted operation.
      $request = new PKPRequest();
 
      $this->setContextObjects($context);
 
      // Mock a router.
      $router = $this->getMockBuilder(PKPRouter::class)
         ->setMethods(array('getHandler', 'getRequestedOp', 'getContext'))
         ->getMock();
 
      $router->expects($this->any())
             ->method('getHandler')
             ->will($this->returnValue(new PKPHandler()));
 
      // Mock the getRequestedOp() method.
      $router->expects($this->any())
             ->method('getRequestedOp')
             ->will($this->returnValue($requestedOp));
 
      // Mock the getContext() method.
      $router->expects($this->any())
             ->method('getContext')
             ->will($this->returnCallback(array($this, 'mockGetContext')));
 
      // Put a user into the registry if one has been
      // passed in.
      if ($user instanceof User) {
         Registry::set('user', $user);
      }
 
      $request->setRouter($router);
      return $request;
   }
 
   public function mockGetContext() {
      $functionArgs = func_get_args();
      $contextLevel = $functionArgs[1];
 
      $contextObjects = $this->getContextObjects();
      if (!empty($contextObjects[$contextLevel - 1])) {
         return $contextObjects[$contextLevel - 1];
      }
      return null;
   }
}