Merge pull request #7841 from JMAConsulting/CRM-16526-2

CRM-16526 [fantastic PR that adds tests] Unit tests for Financial Type ACL test

diff --git a/tests/phpunit/CRM/Financial/BAO/FinancialTypeTest.php b/tests/phpunit/CRM/Financial/BAO/FinancialTypeTest.php
index 05ea8be0ed6c71f944b373ccb2666d704cbcb76c..3f3b07a48e26d6378c5b22e31b4a7b4de13a05db 100644 (file)
--- a/tests/phpunit/CRM/Financial/BAO/FinancialTypeTest.php
+++ b/tests/phpunit/CRM/Financial/BAO/FinancialTypeTest.php
@@ -33,6 +33,7 @@ class CRM_Financial_BAO_FinancialTypeTest extends CiviUnitTestCase {
 
   public function setUp() {
     parent::setUp();
+    $this->_orgContactID = $this->organizationCreate();
   }
 
   public function teardown() {
@@ -121,4 +122,218 @@ class CRM_Financial_BAO_FinancialTypeTest extends CiviUnitTestCase {
     $this->assertEquals(empty($result), TRUE, 'Verify financial types record deletion.');
   }
 
+  /**
+   * Set ACLs for Financial Types()
+   */
+  public function setACL() {
+    CRM_Core_BAO_Setting::setItem(array('acl_financial_type' => 1), NULL, 'contribution_invoice_settings');
+  }
+
+  /**
+   * Check method testgetAvailableFinancialTypes()
+   */
+  public function testgetAvailableFinancialTypes() {
+    $this->setACL();
+    $config = &CRM_Core_Config::singleton();
+    $config->userPermissionClass->permissions = array(
+      'view contributions of type Donation',
+      'view contributions of type Member Dues',
+    );
+    CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types);
+    $expectedResult = array(
+      1 => "Donation",
+      2 => "Member Dues",
+    );
+    $this->assertEquals($expectedResult, $types, 'Verify that only certain financial types can be retrieved');
+    CRM_Financial_BAO_FinancialType::$_availableFinancialTypes = NULL;
+    $config->userPermissionClass->permissions = array(
+      'view contributions of type Donation',
+    );
+    unset($expectedResult[2]);
+    CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types);
+    $this->assertEquals($expectedResult, $types, 'Verify that removing permission for a financial type restricts the available financial types');
+  }
+
+  /**
+   * Check method testgetAvailableMembershipTypes()
+   */
+  public function testgetAvailableMembershipTypes() {
+    // Create Membership types
+    $ids = array();
+    $params = array(
+      'name' => 'Type One',
+      'domain_id' => 1,
+      'minimum_fee' => 10,
+      'duration_unit' => 'year',
+      'member_of_contact_id' => $this->_orgContactID,
+      'period_type' => 'fixed',
+      'duration_interval' => 1,
+      'financial_type_id' => 1,
+      'visibility' => 'Public',
+      'is_active' => 1,
+    );
+
+    $membershipType = CRM_Member_BAO_MembershipType::add($params, $ids);
+    // Add another
+    $params['name'] = 'Type Two';
+    $params['financial_type_id'] = 2;
+    $membershipType = CRM_Member_BAO_MembershipType::add($params, $ids);
+
+    $this->setACL();
+    $config = &CRM_Core_Config::singleton();
+    $config->userPermissionClass->permissions = array(
+      'view contributions of type Donation',
+      'view contributions of type Member Dues',
+    );
+    CRM_Financial_BAO_FinancialType::getAvailableMembershipTypes($types);
+    $expectedResult = array(
+      1 => "Type One",
+      2 => "Type Two",
+    );
+    $this->assertEquals($expectedResult, $types, 'Verify that only certain membership types can be retrieved');
+    $config->userPermissionClass->permissions = array(
+      'view contributions of type Donation',
+    );
+    unset($expectedResult[2]);
+    CRM_Financial_BAO_FinancialType::getAvailableMembershipTypes($types);
+    $this->assertEquals($expectedResult, $types, 'Verify that removing permission for a financial type restricts the available membership types');
+  }
+
+  /**
+   * Check method testpermissionedFinancialTypes()
+   */
+  public function testpermissionedFinancialTypes() {
+    // First get all core permissions
+    $permissions = $checkPerms = CRM_Core_Permission::getCorePermissions();
+    $this->setACL();
+    CRM_Financial_BAO_FinancialType::permissionedFinancialTypes($permissions, TRUE);
+    $financialTypes = CRM_Contribute_PseudoConstant::financialType();
+    $prefix = ts('CiviCRM') . ': ';
+    $actions = array('add', 'view', 'edit', 'delete');
+    foreach ($financialTypes as $id => $type) {
+      foreach ($actions as $action) {
+        $checkPerms[$action . ' contributions of type ' . $type] = array(
+          $prefix . ts($action . ' contributions of type ') . $type,
+          ts(ucfirst($action) . ' contributions of type ') . $type,
+        );
+      }
+    }
+    $checkPerms['administer CiviCRM Financial Types'] = array(
+      $prefix . ts('administer CiviCRM Financial Types'),
+      ts('Administer access to Financial Types'),
+    );
+    $this->assertEquals($permissions, $checkPerms, 'Verify that permissions for each financial type have been added');
+  }
+
+  /**
+   * Check method testcheckPermissionedLineItems()
+   */
+  public function testcheckPermissionedLineItems() {
+    $contactId = Contact::createIndividual();
+    $paramsSet['title'] = 'Price Set' . substr(sha1(rand()), 0, 4);
+    $paramsSet['name'] = CRM_Utils_String::titleToVar($paramsSet['title']);
+    $paramsSet['is_active'] = TRUE;
+    $paramsSet['financial_type_id'] = 1;
+    $paramsSet['extends'] = 1;
+
+    $priceset = CRM_Price_BAO_PriceSet::create($paramsSet);
+    $priceSetId = $priceset->id;
+
+    //Checking for priceset added in the table.
+    $this->assertDBCompareValue('CRM_Price_BAO_PriceSet', $priceSetId, 'title',
+      'id', $paramsSet['title'], 'Check DB for created priceset'
+    );
+    $paramsField = array(
+      'label' => 'Price Field',
+      'name' => CRM_Utils_String::titleToVar('Price Field'),
+      'html_type' => 'CheckBox',
+      'option_label' => array('1' => 'Price Field 1', '2' => 'Price Field 2'),
+      'option_value' => array('1' => 100, '2' => 200),
+      'option_name' => array('1' => 'Price Field 1', '2' => 'Price Field 2'),
+      'option_weight' => array('1' => 1, '2' => 2),
+      'option_amount' => array('1' => 100, '2' => 200),
+      'is_display_amounts' => 1,
+      'weight' => 1,
+      'options_per_line' => 1,
+      'is_active' => array('1' => 1, '2' => 1),
+      'price_set_id' => $priceset->id,
+      'is_enter_qty' => 1,
+      'financial_type_id' => 1,
+    );
+    $priceField = CRM_Price_BAO_PriceField::create($paramsField);
+    $priceFields = $this->callAPISuccess('PriceFieldValue', 'get', array('price_field_id' => $priceField->id));
+    $contributionParams = array(
+      'total_amount' => 300,
+      'currency' => 'USD',
+      'contact_id' => $contactId,
+      'financial_type_id' => 1,
+      'contribution_status_id' => 1,
+    );
+
+    foreach ($priceFields['values'] as $key => $priceField) {
+      $lineItems[1][$key] = array(
+        'price_field_id' => $priceField['price_field_id'],
+        'price_field_value_id' => $priceField['id'],
+        'label' => $priceField['label'],
+        'field_title' => $priceField['label'],
+        'qty' => 1,
+        'unit_price' => $priceField['amount'],
+        'line_total' => $priceField['amount'],
+        'financial_type_id' => $priceField['financial_type_id'],
+      );
+    }
+    $contributionParams['line_item'] = $lineItems;
+    $contributions = CRM_Contribute_BAO_Contribution::create($contributionParams);
+    CRM_Financial_BAO_FinancialType::$_statusACLFt = array();
+    $this->setACL();
+    $config = &CRM_Core_Config::singleton();
+    $config->userPermissionClass->permissions = array(
+      'view contributions of type Member Dues',
+    );
+
+    try {
+      $error = CRM_Financial_BAO_FinancialType::checkPermissionedLineItems($contributions->id, 'view');
+      $this->fail("Missed expected exception");
+    }
+    catch (Exception $e) {
+      $this->assertEquals("A fatal error was triggered: You do not have permission to access this page.", $e->getMessage());
+    }
+    $config = &CRM_Core_Config::singleton();
+    $config->userPermissionClass->permissions = array(
+      'view contributions of type Donation',
+    );
+    $perm = CRM_Financial_BAO_FinancialType::checkPermissionedLineItems($contributions->id, 'view');
+    $this->assertEquals($perm, TRUE, 'Verify that lineitems now have permission.');
+  }
+
+  /**
+   * Check method testisACLFinancialTypeStatus()
+   */
+  public function testisACLFinancialTypeStatus() {
+    $isACL = CRM_Core_BAO_Setting::getItem(NULL, 'contribution_invoice_settings');
+    $this->assertEquals(array_search('acl_financial_type', $isACL), NULL);
+    $this->setACL();
+    $isACL = CRM_Core_BAO_Setting::getItem(NULL, 'contribution_invoice_settings');
+    $this->assertEquals($isACL, array('acl_financial_type' => 1));
+  }
+
+  /**
+   * Check method testisACLFinancialTypeStatus()
+   */
+  public function testbuildPermissionedClause() {
+    $this->setACL();
+    $config = &CRM_Core_Config::singleton();
+    $config->userPermissionClass->permissions = array(
+      'view contributions of type Donation',
+      'view contributions of type Member Dues',
+    );
+    CRM_Financial_BAO_FinancialType::buildPermissionedClause($whereClause, 'contribution');
+    $this->assertEquals($whereClause, ' civicrm_contribution.financial_type_id IN (1,2)');
+    $config->userPermissionClass->permissions[] = 'view contributions of type Event Fee';
+    $whereClause = NULL;
+    CRM_Financial_BAO_FinancialType::$_availableFinancialTypes = array();
+    CRM_Financial_BAO_FinancialType::buildPermissionedClause($whereClause, 'contribution');
+    $this->assertEquals($whereClause, ' civicrm_contribution.financial_type_id IN (1,4,2)');
+  }
+
 }