Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REF][Test] Update loadMappingTest to use form flow #23286

Merged
merged 1 commit into from
Apr 25, 2022
Merged

[REF][Test] Update loadMappingTest to use form flow #23286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CRM/Contact/Import/Form/MapField.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,10 @@ public function preProcess() {
* Build the form object.
*
* @throws \CiviCRM_API3_Exception
* @throws \CRM_Core_Exception
*/
public function buildQuickForm() {
$savedMappingID = (int) $this->get('savedMapping');
$savedMappingID = (int) $this->getSubmittedValue('savedMapping');
$this->buildSavedMappingFields($savedMappingID);

$this->addFormRule(['CRM_Contact_Import_Form_MapField', 'formRule']);
Expand Down Expand Up @@ -329,13 +330,13 @@ public function buildQuickForm() {
$processor->setMappingID($savedMappingID);
$processor->setFormName($formName);
$processor->setMetadata($this->getContactImportMetadata());
$processor->setContactTypeByConstant($this->get('contactType'));
$processor->setContactTypeByConstant($this->getSubmittedValue('contactType'));
$processor->setContactSubType($this->get('contactSubType'));

for ($i = 0; $i < $this->_columnCount; $i++) {
$sel = &$this->addElement('hierselect', "mapper[$i]", ts('Mapper for Field %1', [1 => $i]), NULL);

if ($this->get('savedMapping') && $processor->getFieldName($i)) {
if ($this->getSubmittedValue('savedMapping') && $processor->getFieldName($i)) {
$defaults["mapper[$i]"] = $processor->getSavedQuickformDefaultsForColumn($i);
$js .= $processor->getQuickFormJSForField($i);
}
Expand Down
70 changes: 41 additions & 29 deletions tests/phpunit/CRM/Contact/Import/Form/MapFieldTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ class CRM_Contact_Import_Form_MapFieldTest extends CiviUnitTestCase {
*/
protected $form;

/**
* Delete any saved mapping config.
*/
public function tearDown(): void {
$this->quickCleanup(['civicrm_mapping', 'civicrm_mapping_field']);
parent::tearDown();
}

/**
* Test the form loads without error / notice and mappings are assigned.
*
Expand All @@ -49,11 +57,9 @@ class CRM_Contact_Import_Form_MapFieldTest extends CiviUnitTestCase {
* @throws \CRM_Core_Exception
* @throws \CiviCRM_API3_Exception
*/
public function testSubmit($params, $mapper, $expecteds = []): void {
public function testSubmit(array $params, array $mapper, array $expecteds = []): void {
$form = $this->getMapFieldFormObject();
/* @var CRM_Contact_Import_Form_MapField $form */
$form->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL);
$form->_columnNames = ['nada', 'first_name', 'last_name', 'address'];
$form->preProcess();
$form->submit($params, $mapper);

Expand All @@ -79,7 +85,7 @@ public function testSubmit($params, $mapper, $expecteds = []): void {
*
* @return array
*/
public function getSubmitData() {
public function getSubmitData(): array {
return [
'basic_data' => [
[
Expand Down Expand Up @@ -151,18 +157,19 @@ public function getMapFieldFormObject(array $submittedValues = []): CRM_Contact_
])->execute()->first()['id'];

$dataSource = new CRM_Import_DataSource_SQL($userJobID);
$params = ['sqlQuery' => 'SELECT * FROM civicrm_tmp_d_import_job_xxx'];
$null = NULL;
/* @var CRM_Contact_Import_Form_MapField $form */
$form = $this->getFormObject('CRM_Contact_Import_Form_MapField', $submittedValues);
$form->set('user_job_id', $userJobID);
$dataSource->postProcess($params, $null, $form);
$dataSource->postProcess($submittedValues, $null, $form);

$contactFields = CRM_Contact_BAO_Contact::importableFields();
$fields = [];
foreach ($contactFields as $name => $field) {
$fields[$name] = $field['title'];
}
$form->set('fields', $fields);
$form->buildForm();
return $form;
}

Expand All @@ -175,17 +182,18 @@ public function getMapFieldFormObject(array $submittedValues = []): CRM_Contact_
* @param string $expectedJS
* @param array $expectedDefaults
*
* @throws \API_Exception
* @throws \CRM_Core_Exception
* @throws \CiviCRM_API3_Exception
*/
public function testLoadSavedMapping($fieldSpec, $expectedJS, $expectedDefaults) {
$this->setUpMapFieldForm();

public function testLoadSavedMapping(array $fieldSpec, string $expectedJS, array $expectedDefaults): void {
$mapping = $this->callAPISuccess('Mapping', 'create', ['name' => 'my test']);
$this->callAPISuccess('MappingField', 'create', array_merge(['mapping_id' => $mapping['id']], $fieldSpec));
$result = $this->loadSavedMapping($mapping['id'], $fieldSpec['column_number']);
$this->assertEquals($expectedJS, $result['js']);
$this->assertEquals($expectedDefaults, $result['defaults']);
$this->form = $this->form = $this->getMapFieldFormObject(['savedMapping' => $mapping['id'], 'sqlQuery' => 'SELECT nada FROM civicrm_tmp_d_import_job_xxx']);
$expectedJS = "<script type='text/javascript'>
" . $expectedJS . '</script>';

$this->assertEquals($expectedJS, trim((string) CRM_Core_Smarty::singleton()->get_template_vars('initHideBoxes')));
$this->assertEquals($expectedDefaults, $this->form->_defaultValues);
}

/**
Expand Down Expand Up @@ -291,19 +299,19 @@ public function testLoadSavedMappingDirect(): void {
/**
* Get data for map field tests.
*/
public function mapFieldDataProvider() {
public function mapFieldDataProvider(): array {
return [
[
['name' => 'First Name', 'contact_type' => 'Individual', 'column_number' => 1],
"document.forms.MapField['mapper[1][1]'].style.display = 'none';
document.forms.MapField['mapper[1][2]'].style.display = 'none';
document.forms.MapField['mapper[1][3]'].style.display = 'none';\n",
['mapper[1]' => ['first_name', 0, NULL]],
['name' => 'First Name', 'contact_type' => 'Individual', 'column_number' => 0],
"document.forms.MapField['mapper[0][1]'].style.display = 'none';
document.forms.MapField['mapper[0][2]'].style.display = 'none';
document.forms.MapField['mapper[0][3]'].style.display = 'none';\n",
['mapper[0]' => ['first_name', 0, NULL]],
],
[
['name' => 'Phone', 'contact_type' => 'Individual', 'column_number' => 8, 'phone_type_id' => 1, 'location_type_id' => 2],
"document.forms.MapField['mapper[8][3]'].style.display = 'none';\n",
['mapper[8]' => ['phone', 2, 1]],
['name' => 'Phone', 'contact_type' => 'Individual', 'column_number' => 0, 'phone_type_id' => 1, 'location_type_id' => 2],
"document.forms.MapField['mapper[0][3]'].style.display = 'none';\n",
['mapper[0]' => ['phone', 2, 1]],
],
[
['name' => 'IM Screen Name', 'contact_type' => 'Individual', 'column_number' => 0, 'im_provider_id' => 1, 'location_type_id' => 2],
Expand Down Expand Up @@ -342,20 +350,23 @@ public function mapFieldDataProvider() {
*
* @dataProvider getHeaderMatchDataProvider
*
* @throws \CiviCRM_API3_Exception
* @param $columnHeader
* @param $mapsTo
*
* @throws \API_Exception
* @throws \CRM_Core_Exception
*/
public function testDefaultFromColumnNames($columnHeader, $mapsTo) {
public function testDefaultFromColumnNames($columnHeader, $mapsTo): void {
$this->setUpMapFieldForm();
$this->assertEquals($mapsTo, $this->form->defaultFromColumnName($columnHeader, $this->getHeaderPatterns()));
$this->assertEquals($mapsTo, $this->form->defaultFromColumnName($columnHeader));
}

/**
* Get data to use for default from column names.
*
* @return array
*/
public function getHeaderMatchDataProvider() {
public function getHeaderMatchDataProvider(): array {
return [
['Contact Id', 'id'],
['Contact ID', 'id'],
Expand All @@ -374,7 +385,7 @@ public function getHeaderMatchDataProvider() {
* The use of the metadataTrait came from a transitional refactor
* but it probably should be phased out again.
*/
protected function getContactType() {
protected function getContactType(): string {
return $this->_contactType ?? 'Individual';
}

Expand All @@ -390,7 +401,7 @@ protected function getContactType() {
*
* @throws \CiviCRM_API3_Exception
*/
protected function loadSavedMapping($mappingID, $columnNumber) {
protected function loadSavedMapping(int $mappingID, int $columnNumber): array {
$processor = new CRM_Import_ImportProcessor();
$processor->setMappingID($mappingID);
$processor->setFormName('document.forms.MapField');
Expand All @@ -407,9 +418,10 @@ protected function loadSavedMapping($mappingID, $columnNumber) {
/**
* Set up the mapping form.
*
* @throws \API_Exception
* @throws \CRM_Core_Exception
*/
private function setUpMapFieldForm() {
private function setUpMapFieldForm(): void {
$this->form = $this->getMapFieldFormObject();
$this->form->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL);
}
Expand Down