set some fields visibility as configurable

Some fields can now be hidden through configuration
2025-08-24 00:23:50 +00:00 · 2016-02-05 23:05:53 +01:00
parent d70be5ea85
commit d419be2af1
13 changed files with 551 additions and 48 deletions
--- a/Tests/Controller/PersonControllerUpdateTest.php
+++ b/Tests/Controller/PersonControllerUpdateTest.php
@@ -96,6 +96,24 @@ class PersonControllerUpdateTest extends WebTestCase
            "The person edit form is accessible");
    }
    
+    /**
+     * Test the configurable fields are present
+     * 
+     * @group configurable_fields
+     */
+    public function testHiddenFielsArePresent()
+    {
+        $crawler = $this->client->request('GET', $this->editUrl);
+        
+        $configurables = array('placeOfBirth', 'phonenumber', 'email',
+            'countryOfBirth', 'nationality', 'spokenLanguages', 'maritalStatus');
+        $form = $crawler->selectButton('Submit')->form(); //;
+        
+        foreach($configurables as $key) {
+            $this->assertTrue($form->has('chill_personbundle_person['.$key.']'));
+        }
+    }
+    
    /**
     * Test if the edit page of a given person is not accessible for a user
     * of another center of the person
--- a/Tests/Controller/PersonControllerUpdateWithHiddenFieldsTest.php
+++ b/Tests/Controller/PersonControllerUpdateWithHiddenFieldsTest.php
@@ -0,0 +1,211 @@
+<?php
+
+/*
+ * Chill is a suite of a modules, Chill is a software for social workers
+ * Copyright (C) 2014, Champs Libres Cooperative SCRLFS, <http://www.champs-libres.coop>
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ * 
+ * This program 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, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Chill\PersonBundle\Tests\Controller;
+
+//ini_set('memory_limit', '-1');
+
+use Chill\PersonBundle\Entity\Person;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+/**
+ * Test the edition of persons
+ * 
+ * As I am logged in as "center a_social"
+ *
+ * @author Julien Fastré <julien.fastre@champs-libres.coop>
+ */
+class PersonControllerUpdateWithHiddenFieldsTest extends WebTestCase
+{
+    /** @var \Doctrine\ORM\EntityManagerInterface The entity manager */
+    private $em;
+    
+    /** @var Person The person on which the test is executed */
+    private $person;
+    
+    /** @var string The url using for editing the person's information */
+    private $editUrl;
+
+    /** @var string The url using for seeing the person's information */
+    private $viewUrl;
+    
+    /**
+     * Prepare client and create a random person
+     */
+    public function setUp()
+    {
+        static::bootKernel(array('environment' => 'test_with_hidden_fields'));
+        
+        $this->em = static::$kernel->getContainer()
+            ->get('doctrine.orm.entity_manager');
+        
+        $center = $this->em->getRepository('ChillMainBundle:Center')
+            ->findOneBy(array('name' => 'Center A'));
+       
+        $this->person = (new Person())
+            ->setLastName("My Beloved")
+            ->setFirstName("Jesus")
+            ->setCenter($center)
+            ->setGender(Person::MALE_GENDER);
+        
+        $this->em->persist($this->person);
+        $this->em->flush();
+        
+        $this->editUrl = '/en/person/'.$this->person->getId().'/general/edit';
+        $this->viewUrl  = '/en/person/'.$this->person->getId().'/general';
+        
+        $this->client = static::createClient(
+                array(
+                    'environment' => 'test_with_hidden_fields'
+                ), 
+                array(
+                    'PHP_AUTH_USER' => 'center a_social',
+                    'PHP_AUTH_PW'   => 'password',
+                )
+            );
+    }
+    
+    /**
+     * Reload the person from the db
+     */
+    protected function refreshPerson() 
+    {
+        $this->person = $this->em->getRepository('ChillPersonBundle:Person')
+            ->find($this->person->getId());
+    }
+    
+    /**
+     * Test the edit page are accessible
+     */
+    public function testEditPageIsSuccessful()
+    {
+        $this->client->request('GET', $this->editUrl);
+        $this->assertTrue($this->client->getResponse()->isSuccessful(), 
+            "The person edit form is accessible");
+    }
+    
+    /**
+     * Test the configurable fields are absent
+     * 
+     * @group configurable_fields
+     */
+    public function testHiddenFielsAreAbsent()
+    {
+        $crawler = $this->client->request('GET', $this->editUrl);
+        
+        $configurables = array('placeOfBirth', 'phonenumber', 'email',
+            'countryOfBirth', 'nationality', 'spokenLanguages', 'maritalStatus');
+        $form = $crawler->selectButton('Submit')->form(); //;
+        
+        foreach($configurables as $key) {
+            $this->assertFalse($form->has('chill_personbundle_person['.$key.']'));
+        }
+    }
+    
+    /**
+     * Test the edition of a field
+     * 
+     * Given I fill the field with $value
+     * And I submit the form
+     * Then I am redirected to the 'general' page
+     * And the person is updated in the db
+     * 
+     * @dataProvider validTextFieldsProvider
+     * @param string $field
+     * @param string $value
+     * @param \Closure $callback
+     */
+    public function testEditTextField($field, $value, \Closure $callback)
+    {
+        $crawler = $this->client->request('GET', $this->editUrl);
+        
+        $form = $crawler->selectButton('Submit')
+            ->form();
+        //transform countries into value if needed
+        switch ($field) {
+            case 'nationality':
+            case 'countryOfBirth':
+                if ($value !== NULL) {
+                    $country = $this->em->getRepository('ChillMainBundle:Country')
+                        ->findOneByCountryCode($value);
+                    $transformedValue = $country->getId();
+                } else {
+                    $transformedValue = NULL;
+                }
+                break;
+            default:
+                $transformedValue = $value;
+        }
+        
+        $form->get('chill_personbundle_person['.$field. ']')
+            ->setValue($transformedValue);
+        
+        $this->client->submit($form);
+        $this->refreshPerson();
+        
+        $this->assertTrue($this->client->getResponse()->isRedirect($this->viewUrl),
+            'the page is redirected to general view');
+        $this->assertEquals($value, $callback($this->person),
+            'the value '.$field.' is updated in db');
+
+        $crawler = $this->client->followRedirect();
+        $this->assertGreaterThan(0, $crawler->filter('.success')->count(),
+            'a element .success is shown');
+
+        if($field == 'birthdate' or $field == 'memo' or $field == 'countryOfBirth' or $field == 'nationality'
+                or $field == 'gender') {
+            // we do not perform test on the web page contents.
+        } else {
+            $this->assertGreaterThan(0, $crawler->filter('html:contains("'.$value.'")')->count());
+        }
+    }
+    
+    /**
+     * provide valid values to test, with field name and 
+     * a function to find the value back from person entity
+     * 
+     * @return mixed[]
+     */
+    public function validTextFieldsProvider()
+    { 
+        return array(
+            ['firstName', 'random Value', function(Person $person) { return $person->getFirstName(); } ],
+            ['lastName' , 'random Value', function(Person $person) { return $person->getLastName(); }  ],
+            ['birthdate', '15-12-1980', function(Person $person) { return $person->getBirthdate()->format('d-m-Y'); }],
+            ['memo', 'jfkdlmq jkfldmsq jkmfdsq', function(Person $person) { return $person->getMemo(); }],
+            ['birthdate', '', function(Person $person) { return $person->getBirthdate(); }],
+            ['gender', Person::FEMALE_GENDER, function(Person $person) { return $person->getGender(); }],
+        );
+    }
+    
+    public function tearDown()
+    {
+        $this->refreshPerson();
+        $this->em->remove($this->person);
+        $this->em->flush();
+    }
+    
+    private function getVeryLongText()
+    {
+        return <<<EOT
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse molestie at enim id auctor. Vivamus malesuada elit ipsum, ac mollis ex facilisis sit amet. Phasellus accumsan, quam ut aliquet accumsan, augue ligula consequat erat, condimentum iaculis orci magna egestas eros. In vel blandit sapien. Duis ut dui vitae tortor iaculis malesuada vitae vitae lorem. Morbi efficitur dolor orci, a rhoncus urna blandit quis. Aenean at placerat dui, ut tincidunt nulla. In ultricies tempus ligula ac rutrum. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Fusce urna nibh, placerat vel auctor sed, maximus quis magna. Vivamus quam ante, consectetur vel feugiat quis, aliquet id ante. Integer gravida erat dignissim ante commodo mollis. Donec imperdiet mauris elit, nec blandit dolor feugiat ut. Proin iaculis enim ut tortor pretium commodo. Etiam aliquet hendrerit dolor sed fringilla. Vestibulum facilisis nibh tincidunt dui egestas, vitae congue mi imperdiet. Duis vulputate ultricies lectus id cursus. Fusce bibendum sem dignissim, bibendum purus quis, mollis ex. Cras ac est justo. Duis congue mattis ipsum, vitae sagittis justo dictum sit amet. Duis aliquam pharetra sem, non laoreet ante laoreet ac. Mauris ornare mi tempus rutrum consequat. 
+EOT;
+    }
+}
--- a/Tests/Controller/PersonControllerViewTest.php
+++ b/Tests/Controller/PersonControllerViewTest.php
@@ -61,6 +61,8 @@ class PersonControllerViewTest extends WebTestCase
    
    /**
     * Test if the  view page is accessible
+     * 
+     * @group configurable_fields
     */
    public function testViewPerson()
    {
@@ -76,6 +78,10 @@ class PersonControllerViewTest extends WebTestCase

        $this->assertGreaterThan(0, $crawler->filter('html:contains("Tested Person")')->count());
        $this->assertGreaterThan(0, $crawler->filter('html:contains("Réginald")')->count());
+        $this->assertContains('Email addresses', $crawler->text());
+        $this->assertContains('Phonenumber', $crawler->text());
+        $this->assertContains('Langues parlées', $crawler->text());
+        $this->assertContains(/* Etat */ 'civil', $crawler->text());
    }
    
    /**
--- a/Tests/Controller/PersonControllerViewWithHiddenFieldsTest.php
+++ b/Tests/Controller/PersonControllerViewWithHiddenFieldsTest.php
@@ -0,0 +1,107 @@
+<?php
+
+/*
+ * Copyright (C) 2015 Julien Fastré <julien.fastre@champs-libres.coop>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Chill\PersonBundle\Tests\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+use Chill\PersonBundle\Entity\Person;
+
+/**
+ * @author Julien Fastré <julien.fastre@champs-libres.coop>
+ * @author Marc Ducobu <marc.ducobu@champs-libres.coop>
+ */
+class PersonControllerViewTestWithHiddenFields extends WebTestCase
+{
+    /** @var \Doctrine\ORM\EntityManagerInterface The entity manager */
+    private $em;
+    
+    /** @var Person A person used on which to run the test */
+    private $person;
+
+    /** @var String The url to view the person details */
+    private $viewUrl;
+    
+    public function setUp()
+    {
+        static::bootKernel(array('environment' => 'test_with_hidden_fields'));
+        
+        $this->em = static::$kernel->getContainer()
+            ->get('doctrine.orm.entity_manager');
+        
+        $center = $this->em->getRepository('ChillMainBundle:Center')
+            ->findOneBy(array('name' => 'Center A'));
+       
+        $this->person = (new Person())
+            ->setLastName("Tested Person")
+            ->setFirstName("Réginald")
+            ->setCenter($center)
+            ->setGender(Person::MALE_GENDER);
+        
+        $this->em->persist($this->person);
+        $this->em->flush();
+        
+        $this->viewUrl  = '/en/person/'.$this->person->getId().'/general';
+    }
+    
+    /**
+     * Test if the  view page is accessible
+     * 
+     * @group configurable_fields
+     */
+    public function testViewPerson()
+    {
+        $client = static::createClient(
+                array('environment' => 'test_with_hidden_fields'), 
+                array(
+                    'PHP_AUTH_USER' => 'center a_social',
+                    'PHP_AUTH_PW'   => 'password',
+                    'HTTP_ACCEPT_LANGUAGE' => 'fr'
+                )
+            );
+        
+        $crawler = $client->request('GET', $this->viewUrl);
+        $response = $client->getResponse();
+        
+        $this->assertTrue($response->isSuccessful());
+
+        $this->assertGreaterThan(0, $crawler->filter('html:contains("Tested Person")')->count());
+        $this->assertGreaterThan(0, $crawler->filter('html:contains("Réginald")')->count());
+        $this->assertNotContains('Email addresses', $crawler->text());
+        $this->assertNotContains('Phonenumber', $crawler->text());
+        $this->assertNotContains('Langues parlées', $crawler->text());
+        $this->assertNotContains(/* Etat */ 'civil', $crawler->text());
+    }
+    
+    /**
+     * Reload the person from the db
+     */
+    protected function refreshPerson() 
+    {
+        $this->person = $this->em->getRepository('ChillPersonBundle:Person')
+            ->find($this->person->getId());
+    }
+    
+    public function tearDown()
+    {
+        $this->refreshPerson();
+        $this->em->remove($this->person);
+        $this->em->flush();
+    }
+    
+}
--- a/Tests/Fixtures/App/app/config/config_test_with_hidden_fields.yml
+++ b/Tests/Fixtures/App/app/config/config_test_with_hidden_fields.yml
@@ -0,0 +1,18 @@
+# config/config_test.yml
+imports:
+    - { resource: config.yml } #here we import a config.yml file, this is not required
+
+framework:
+    test: ~
+    session:
+        storage_id: session.storage.filesystem
+
+chill_person:
+    person_fields:
+        nationality: hidden
+        email: hidden
+        place_of_birth: hidden
+        phonenumber: hidden
+        country_of_birth: hidden
+        marital_status: hidden
+        spoken_languages: hidden