core#1158: Unit Test to ensure primary addresses are printed on maili…

…ng label if searchPrimaryDetailsOnly is disabled

CRM/Contact/Form/Task/Label.php

@@ -91,9 +91,11 @@ public function setDefaultValues() {
 
   /**
    * Process the form after the input has been submitted and validated.
+   *
+   * @param array|NULL $params
    */
-  public function postProcess() {
-    $fv = $this->controller->exportValues($this->_name);
+  public function postProcess($params = NULL) {
+    $fv = $params ?: $this->controller->exportValues($this->_name);
     $config = CRM_Core_Config::singleton();
     $locName = NULL;
     //get the address format sequence from the config file
@@ -171,7 +173,6 @@ public function postProcess() {
     }
 
     $rows = [];
-
     foreach ($this->_contactIds as $key => $contactID) {
       $params[] = [
         CRM_Core_Form::CB_PREFIX . $contactID,
@@ -201,7 +202,6 @@ public function postProcess() {
     $numberofContacts = count($this->_contactIds);
     $query = new CRM_Contact_BAO_Query($params, $returnProperties);
     $details = $query->apiQuery($params, $returnProperties, NULL, NULL, 0, $numberofContacts, TRUE, FALSE, TRUE, CRM_Contact_BAO_Query::MODE_CONTACTS, NULL, $primaryLocationOnly);
-
     $messageToken = CRM_Utils_Token::getTokens($mailingFormat);
 
     // also get all token values
@@ -335,6 +335,10 @@ public function postProcess() {
       $rows[$id] = [$formatted];
     }
 
+    if (!empty($fv['is_unit_testing'])) {
+      return $rows;
+    }
+
     //call function to create labels
     self::createLabel($rows, $fv['label_name']);
     CRM_Utils_System::civiExit();

tests/phpunit/CRM/Contact/Form/Task/PrintMailingLabelTest.php

@@ -0,0 +1,83 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+ /**
+  * Test class for CRM_Contact_Form_Task_Label.
+  * @group headless
+  */
+class CRM_Contact_Form_Task_PrintMailingLabelTest extends CiviUnitTestCase {
+
+  protected $_contactIds = NULL;
+
+  protected function setUp() {
+    parent::setUp();
+    $this->_contactIds = [
+      $this->individualCreate(['first_name' => 'Antonia', 'last_name' => 'D`souza']),
+      $this->individualCreate(['first_name' => 'Anthony', 'last_name' => 'Collins']),
+    ];
+  }
+
+  /**
+   * core/issue-1158: Test the mailing label rows contain the primary addresses when location_type_id = none (as primary) is chosen in form
+   */
+  public function testMailingLabel() {
+    // Disable searchPrimaryDetailsOnly civi settings so we could test the functionality without it.
+    Civi::settings()->set('searchPrimaryDetailsOnly', '0');
+
+    $addresses = [];
+    // create non-primary and primary addresses of each contact
+    foreach ($this->_contactIds as $contactID) {
+      // create the non-primary address first
+      foreach (['non-primary', 'primary'] as $flag) {
+        $isPrimary = ($flag == 'primary'); // @TODO: bug - this doesn't affect as if its the first and only address created for a contact then it always consider it as primary
+        $streetName = substr(sha1(rand()), 0, 7);
+        $addresses[$contactID][$flag] = $this->callAPISuccess('Address', 'create', [
+          'street_name' => $streetName,
+          'street_number' => '23',
+          'street_address' => "$streetName 23",
+          'postal_code' => '6971 BN',
+          'country_id' => '1152',
+          'city' => 'Brummen',
+          'is_primary' => $isPrimary, // this doesn't affect for non-primary address
+          'contact_id' => $contactID,
+          'sequential' => 1,
+        ])['values'][0];
+
+        if ($flag == 'non-primary') {
+          $addresses[$contactID][$flag] = $this->callAPISuccess('Address', 'create', [
+            'is_primary' => $isPrimary,
+            'id' => $addresses[$contactID][$flag]['id'],
+            'sequential' => 1,
+          ])['values'][0];
+        }
+      }
+    }
+
+    $form = new CRM_Contact_Form_Task_Label();
+    $form->_contactIds = $this->_contactIds;
+    $params = [
+      'label_name' => 3475,
+      'location_type_id' => NULL,
+      'do_not_mail' => 1,
+      'is_unit_testing' => 1,
+    ];
+    $rows = $form->postProcess($params);
+
+    foreach ($this->_contactIds as $contactID) {
+      // ensure that the address printed in the mailing labe is always primary if 'location_type_id' - none (as Primary) is chosen
+      $this->assertContains($addresses[$contactID]['primary']['street_address'], $rows[$contactID][0]);
+    }
+
+    // restore setting
+    Civi::settings()->set('searchPrimaryDetailsOnly', '1');
+  }
+
+}