add a few remaining missing comment blocks (autogenerated)

[civicrm-core.git] / tests / phpunit / WebTest / Case / AddCaseTest.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.5                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2014                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License along with this program; if not, contact CiviCRM LLC       |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

require_once 'CiviTest/CiviSeleniumTestCase.php';
class WebTest_Case_AddCaseTest extends CiviSeleniumTestCase {

  protected function setUp() {
    parent::setUp();
  }

  function testStandaloneCaseAdd() {
    // Log in as admin first to verify permissions for CiviCase
    $this->webtestLogin('admin');

    // Enable CiviCase module if necessary
    $this->enableComponents("CiviCase");

    // let's give full CiviCase permissions to demo user (registered user).
    $permission = array('edit-2-access-all-cases-and-activities', 'edit-2-access-my-cases-and-activities', 'edit-2-administer-civicase', 'edit-2-delete-in-civicase');
    $this->changePermissions($permission);

    // Log in as normal user
    $this->webtestLogin();

    // Go to reserved New Individual Profile to set value for logged in user's contact name (we'll need that later)
    $this->openCiviPage('profile/edit', 'reset=1&gid=4', NULL);
    $testUserFirstName = "Testuserfirst";
    $testUserLastName = "Testuserlast";
    $this->waitForPageToLoad($this->getTimeoutMsec());
    $this->waitForElementPresent("_qf_Edit_next");
    $this->type("first_name", $testUserFirstName);
    $this->type("last_name", $testUserLastName);
    $this->clickLink("_qf_Edit_next", "profilewrap4");
    // Is status message correct?
    $this->assertElementContainsText('crm-container', "Thank you. Your information has been saved.", "Save successful status message didn't show up after saving profile to update testUserName!");

    $this->openCiviPage('case/add', 'reset=1&action=add&atype=13&context=standalone', '_qf_Case_upload-bottom');

    // Try submitting the form without creating or selecting a contact (test for CRM-7971)
    $this->clickLink("_qf_Case_upload-bottom", "css=span.crm-error");
    $this->assertElementContainsText('Case', "Client is a required field.", "Expected form rule error for submit without selecting contact did not show up after clicking Save.");

    // Adding contact with randomized first name (so we can then select that contact when creating case)
    // We're using pop-up New Contact dialog
    $firstName = substr(sha1(rand()), 0, 7);
    $lastName = "Fraser";
    $contactName = "{$lastName}, {$firstName}";
    $displayName = "{$firstName} {$lastName}";
    $email = "{$lastName}.{$firstName}@example.org";
    $this->webtestNewDialogContact($firstName, $lastName, $email, $type = 4, "s2id_client_id");

    // Fill in other form values. We'll use a case type which is included in CiviCase sample data / xml files.
    $caseTypeLabel = "Adult Day Care Referral";
    // activity types we expect for this case type
    $activityTypes = array("ADC referral", "Follow up", "Medical evaluation", "Mental health evaluation");
    $caseRoles = array("Senior Services Coordinator", "Health Services Coordinator", "Benefits Specialist", "Client");
    $caseStatusLabel = "Ongoing";
    $subject = "Safe daytime setting - senior female";
    $this->select("medium_id", "value=1");
    $location = "Main offices";
    $this->type("activity_location", $location);
    $details = "65 year old female needs safe location during the day for herself and her dog. She is in good health but somewhat disoriented.";
    $this->fireEvent('activity_details', 'focus');
    $this->fillRichTextField("activity_details", $details, 'CKEditor');
    $this->type("activity_subject", $subject);

    $this->select("case_type_id", "label={$caseTypeLabel}");
    $this->select("status_id", "label={$caseStatusLabel}");
    // Choose Case Start Date.
    // Using helper webtestFillDate function.
    $this->webtestFillDate('start_date', 'now');
    $today = date('F jS, Y', strtotime('now'));

    $this->type("duration", "20");
    $this->clickLink("_qf_Case_upload-bottom", "_qf_CaseView_cancel-bottom");

    // Is status message correct?
    $this->waitForText('crm-notification-container', "Case opened successfully.");

    $summaryStrings = array(
      "Summary",
      $displayName,
      "Type: {$caseTypeLabel}",
      "Open Date: {$today}",
      "Status: {$caseStatusLabel}",
    );

    $this->_testVerifyCaseSummary($summaryStrings, $activityTypes);
    $this->_testVerifyCaseRoles($caseRoles, "{$testUserLastName}, {$testUserFirstName}");
    $this->_testVerifyCaseActivities($activityTypes);

    $openCaseData = array(
      "Client" => $displayName,
      "Activity Type" => "Open Case",
      "Subject" => $subject,
      "Created By" => "{$testUserFirstName} {$testUserLastName}",
      "Reported By" => "{$testUserFirstName} {$testUserLastName}",
      "Medium" => "In Person",
      "Location" => $location,
      "Date and Time" => $today,
      "Details" => $details,
      "Status" => "Completed",
      "Priority" => "Normal",
    );

    $this->_testVerifyOpenCaseActivity($subject, $openCaseData);

    //change the case status to Resolved to get the end date
    $this->click("xpath=//form[@id='CaseView']/div[2]/table/tbody/tr/td[4]/a");
    $this->waitForElementPresent("_qf_Activity_cancel-bottom");
    $this->select("case_status_id","value=2");
    $this->click("_qf_Activity_upload-top");

    $this->_testSearchbyDate($firstName, $lastName, "this.quarter");
    $this->_testSearchbyDate($firstName, $lastName, "0");
    $this->_testSearchbyDate($firstName, $lastName, "this.year");
  }

  function testAjaxCustomGroupLoad() {
    $this->webtestLogin();

    // Enable CiviCase module if necessary
    $this->enableComponents("CiviCase");

    $triggerElement = array('name' => 'case_type_id', 'type' => 'select');
    $customSets = array(
      array('entity' => 'Case', 'subEntity' => 'Housing Support', 'triggerElement' => $triggerElement),
    );

    $pageUrl = array('url' => 'case/add', 'args' => "reset=1&action=add&atype=13&context=standalone");
    $this->customFieldSetLoadOnTheFlyCheck($customSets, $pageUrl);
  }

  /**
   * @param $validateStrings
   * @param $activityTypes
   */
  function _testVerifyCaseSummary($validateStrings, $activityTypes) {
    $this->assertStringsPresent($validateStrings);
    foreach ($activityTypes as $aType) {
      $this->assertText("add_activity_type_id", $aType);
    }
    $this->assertElementPresent("link=Assign to Another Client", "Assign to Another Client link is missing.");
    $this->assertElementPresent("xpath=//a[text()=' Print Report']", "Print Case Summary button is missing.");
  }

  /**
   * @param $caseRoles
   * @param $creatorName
   */
  function _testVerifyCaseRoles($caseRoles, $creatorName) {
    $this->waitForElementPresent("xpath=//table[@id='caseRoles-selector']/tbody/tr[4]/td[2]/a");
    // check that expected roles are listed in the Case Roles pane
    foreach ($caseRoles as $role) {
      $this->assertText("css=div.crm-case-roles-block", $role);
    }
    // check that case creator role has been assigned to logged in user
    $this->verifyText("xpath=//table[@id='caseRoles-selector']/tbody/tr[4]/td[2]", $creatorName);
  }

  /**
   * @param $activityTypes
   */
  function _testVerifyCaseActivities($activityTypes) {
    $id = $this->urlArg('id');
    // check that expected auto-created activities are listed in the Case Activities table
    foreach ($activityTypes as $aType) {
      $this->assertText("case_id_$id", $aType);
    }
  }

  /**
   * @param $subject
   * @param $openCaseData
   */
  function _testVerifyOpenCaseActivity($subject, $openCaseData) {
    $id = $this->urlArg('id');
    // check that open case subject is present
    $this->assertText("case_id_$id", $subject);
    // click open case activity pop-up dialog
    $this->click("link=$subject");
    $this->waitForElementPresent("ActivityView");
    $this->waitForElementPresent("css=tr.crm-case-activity-view-Activity");
    // set page location of table containing activity view data
    $activityViewPrefix = "//*[@id='ActivityView']";
    $activityViewTableId = "crm-activity-view-table";
    // Probably don't need both tableId and prefix - but good examples for other situations where only one can be used

    $this->webtestVerifyTabularData($openCaseData, '', $activityViewTableId);
    $this->click("xpath=//span[@class='ui-button-icon-primary ui-icon ui-icon-closethick']");
  }

  /**
   * @param $firstName
   * @param $lastName
   * @param $action
   */
  function _testSearchbyDate($firstName, $lastName, $action) {
    // Find Cases
    if ($action != "0") {
      $this->openCiviPage('case/search', 'reset=1');
      $this->select("case_from_relative", "value=$action");
      $this->select("case_to_relative", "value=$action");
      $this->click("_qf_Search_refresh");
      $this->waitForPageToLoad($this->getTimeoutMsec());
      $this->assertElementContainsText('Search', "$lastName, $firstName");
    }
    else {
      //select date range
      $this->openCiviPage('case/search', 'reset=1', '_qf_Search_refresh-bottom');
      $this->select("case_from_relative", "value=$action");
      $this->webtestFillDate("case_from_start_date_low", "-1 month");
      $this->webtestFillDate("case_from_start_date_high", "+1 month");
      $this->select("case_to_relative", "value=$action");
      $this->webtestFillDate("case_to_end_date_low", "-1 month");
      $this->webtestFillDate("case_to_end_date_high", "+1 month");
      $this->click("_qf_Search_refresh-bottom");
      $this->waitForPageToLoad($this->getTimeoutMsec());
      $this->assertElementContainsText('Search', "$lastName, $firstName");
    }

    //Advanced Search
    $this->openCiviPage('contact/search/advanced', 'reset=1', '_qf_Advanced_refresh');
    $this->click("CiviCase");
    $this->waitForElementPresent("xpath=//div[@id='case-search']/table/tbody/tr[3]/td[2]/input[3]");
    if ($action != "0") {
      $this->select("case_from_relative", "value=$action");
      $this->select("case_to_relative", "value=$action");
    }
    else {
      $this->select("case_from_relative", "value=$action");
      $this->webtestFillDate("case_from_start_date_low", "-1 month");
      $this->webtestFillDate("case_from_start_date_high", "+1 month");
      $this->select("case_to_relative", "value=$action");
      $this->webtestFillDate("case_to_end_date_low", "-1 month");
      $this->webtestFillDate("case_to_end_date_high", "+1 month");
    }
    $this->click("_qf_Advanced_refresh");
    $this->waitForPageToLoad($this->getTimeoutMsec());
    $this->assertElementContainsText('Advanced', "$lastName, $firstName");
  }
}