egroupware/infolog/tests/SetProjectManagerTest.php

<?php


namespace EGroupware\Infolog;

require_once realpath(__DIR__.'/../../api/tests/AppTest.php');	// Application test base

use Egroupware\Api;
use Egroupware\Api\Link;
use Egroupware\Api\Etemplate;

/**
 * Test setting a project manager project on an infolog entry
 *
 * Tests adding, loading, clearing the project to make sure field is set
 * correctly, and checks to make sure the infolog entry is properly added / removed
 * from the project.
 *
 * Since projectmanager is involved, there are frequent calls to Api\Link::run_notifies()
 * to keep its elements up to date.  Normally this is not needed, as it is run
 * at the end of every execution.
 */
class SetProjectManagerTest extends \EGroupware\Api\AppTest
{

	protected $ui;
	protected $bo;
	protected $pm_bo;

	// Infolog under test
	protected $info_id = null;

	// Project used to test
	protected $pm_id = null;


	public function setUp()
	{
		$this->ui = new \infolog_ui();

		$this->ui->tmpl = $this->createPartialMock(Etemplate::class, array('exec', 'read'));

		$this->bo = $this->ui->bo;
		$this->pm_bo = new \projectmanager_bo();

		$this->mockTracking($this->bo, 'infolog_tracking');

		$this->makeProject();
	}

	public function tearDown()
	{
		// Remove infolog under test
		if($this->info_id)
		{
			$this->bo->delete($this->info_id, False, False, True);
			// One more time for history
			$this->bo->delete($this->info_id, False, False, True);
		}

		// Remove the test project
		$this->deleteProject();

		$this->bo = null;
		$this->pm_bo = null;
	}

	/**
	 * Create a new infolog entry, with project set
	 *
	 * This one goes via the ui, mostly to see how it would work
	 */
	public function testAddProjectToNew()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->atLeastOnce())
                ->method('track')
				->with($this->callback(function($subject) { return $subject['pm_id'] == $this->pm_id;}));

		// Mock the etemplate call to check the results
		$this->ui->tmpl->expects($this->once())
				->method('exec')
				->with($this->stringContains('infolog.infolog_ui.edit'),
					$this->callback(function($info) {
						$this->assertNotNull($info['info_id']);
						$this->info_id = $info['info_id'];
						return $info['pm_id'] == $this->pm_id;
					})
				);

		$info = $this->getTestInfolog();

		// Set up the test - just set pm_id
		$info['pm_id'] = $this->pm_id;

		// Set button 'apply' to save, but not try to close the window since
		// that would fail
		$info['button'] = array('apply' => true);

		// Make a call to edit, looks like user set pm_id and clicked Apply
		$this->ui->edit($info);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Check project
		$this->checkElements();
	}

	public function testAddProjectToExisting()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->exactly(2))
                ->method('track')
				->withConsecutive(
					// First call - creation
					[$this->callback(function($subject) { return is_null($subject['pm_status']);})],
					// Second call - after setting project
					[$this->callback(function($subject) { return $subject['pm_id'] == $this->pm_id;})]
				);

		$info = $this->getTestInfolog();

		$this->info_id = $this->bo->write($info);
		$this->assertInternalType('integer', $this->info_id);
		$this->assertGreaterThan(0, $this->info_id);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Set project by pm_id
		$info['pm_id'] = $this->pm_id;
		$this->bo->write($info);

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Check pm_id is there
		$this->assertNotNull($info['pm_id'], 'Project was not set');

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Check project
		$this->checkElements();
	}

	/**
	 * Add a project by only adding it as a link.  First linked project gets
	 * taken as _the_ project.
	 */
	public function testAddProjectViaLink()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->exactly(2))
                ->method('track')
				->withConsecutive(
					// First call - creation
					[$this->callback(function($subject) { return is_null($subject['pm_status']);})],
					// Second call - after setting project
					[$this->callback(function($subject) { return $subject['pm_id'] == $this->pm_id;})]
				);

		$info = $this->getTestInfolog();

		$this->info_id = $this->bo->write($info);
		$this->assertInternalType('integer', $this->info_id);
		$this->assertGreaterThan(0, $this->info_id);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Set project by link
		Link::link('infolog', $this->info_id, 'projectmanager', $this->pm_id);
		Api\Link::run_notifies();

		$this->bo->write($info);

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Check pm_id is there
		$this->assertNotNull($info['pm_id'], 'Project was not set');

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Check project
		$this->checkElements();
	}

	/**
	 * Create a new infolog entry, set project via info_contact
	 */
	public function testContact()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->once())
                ->method('track')
				->with($this->callback(function($subject) { return $subject['pm_id'] == $this->pm_id;}));

		$info = $this->getTestInfolog();

		// Set up the test - just set info_contact
		$info['info_contact'] = 'projectmanager:'.$this->pm_id;

		$this->info_id = $this->bo->write($info);
		$this->assertArrayHasKey('info_id', $info, 'Could not make test project');
		$this->assertThat($this->info_id,
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);

		// Check infolog has pm_id properly set
		$this->assertEquals($this->pm_id, $info['pm_id']);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Check project
		$this->checkElements();
	}

	/**
	 * Test adding a project to an infolog that has a contact (link to addressbook) set
	 */
	public function testLinkContact()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->once())
                ->method('track')
				->with($this->callback(function($subject) { return $subject['pm_id'] == $this->pm_id;}));

		$info = $this->getTestInfolog();

		// Set up the test - just set info_contact
		$info['info_contact'] = array(
			'app'    =>	'addressbook',
			// Linking to current user's contact
			'id'     =>	$GLOBALS['egw_info']['user']['person_id'],
		);

		// Set project by pm_id
		$info['pm_id'] = $this->pm_id;

		$this->info_id = $this->bo->write($info);
		$this->assertArrayHasKey('info_id', $info, 'Could not make test entry');
		$this->assertThat($this->info_id,
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Check infolog still has pm_id
		$this->assertEquals($this->pm_id, $info['pm_id'], 'Project went missing');

		// Check that infolog still has contact
		$this->assertArraySubset(
				array('app' => 'addressbook', 'id' =>$GLOBALS['egw_info']['user']['person_id']),
				$info['info_contact']
		);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Check project
		$this->checkElements();
	}

	/**
	 * Test free text in the contact field
	 */
	public function testFreeContact()
	{
		$info = $this->getTestInfolog();

		// Set up the test - just set info_contact
		$info['info_contact'] = array(
			'app'     =>	null,
			'id'      =>	null,
			'search'  =>	'Free text'
		);
		// Set project by pm_id
		$info['pm_id'] = $this->pm_id;

		$this->info_id = $this->bo->write($info);
		$this->assertArrayHasKey('info_id', $info, 'Could not make test infolog');
		$this->assertThat($this->info_id,
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);

		// Check infolog has pm_id properly set
		$this->assertEquals($this->pm_id, $info['pm_id']);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Check project
		$this->checkElements();
	}

	/**
	 * Test that loading a project set in the contact gets loaded with pm_id
	 * set.
	 */
	public function testLoadWithProject()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->once())
                ->method('track')
				->will($this->returnCallback(function($subject) { return $subject['pm_id'] == $this->pm_id;}));

		$info = $this->getTestInfolog();

		// Set up the test - just set info_contact
		$info['info_contact'] = 'projectmanager:'.$this->pm_id;

		$this->info_id = $this->bo->write($info);
		$this->assertThat($this->info_id,
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);

		// Check infolog has pm_id properly set
		$this->assertEquals($this->pm_id, $info['pm_id']);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Check infolog still has pm_id
		$this->assertEquals($this->pm_id, $info['pm_id'], 'Project went missing');

		// Check project
		$this->checkElements();
	}

	/**
	 * Test that you can change from one project to another without overwriting
	 * the set info_contact.
	 */
	public function testChangeProjectWithContactSet()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->exactly(2))
                ->method('track')
				->will($this->returnCallback(function($subject) { return $subject['pm_id'] == $this->pm_id;}));

		$info = $this->getTestInfolog();

		// Set up the test - set info_contact
		$info['info_contact'] = array(
			'app'    =>	'addressbook',
			// Linking to current user's contact
			'id'     =>	$GLOBALS['egw_info']['user']['person_id'],
		);
		// Set up the test - set pm_id
		$info['pm_id'] = $this->pm_id;

		$this->info_id = $this->bo->write($info);
		$this->assertThat($this->info_id,
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);

		// Check infolog has pm_id properly set
		$this->assertEquals($this->pm_id, $info['pm_id']);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Check infolog still has pm_id
		$this->assertEquals($this->pm_id, $info['pm_id'], 'Project went missing');

		// Now create a new project
		$first_pm_id = $this->pm_id;
		$this->pm_bo->data = array();
		$this->makeProject('2');
		$info['old_pm_id'] = $first_pm_id;
		$info['pm_id'] = $this->pm_id;
		$this->bo->write($info);

		// Check infolog has pm_id properly set
		$this->assertEquals($this->pm_id, $info['pm_id']);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Now load it again
		$info = $this->bo->read($this->info_id);

		try {
			// Check infolog has pm_id properly set
			$this->assertEquals($this->pm_id, $info['pm_id'], 'Project did not change');

			// Check project
			$this->checkElements();

			// Check links (should be only 1)
			$pm_links = Api\Link::get_links('infolog',$this->info_id,'projectmanager');
			$this->assertEquals(1, count($pm_links));
		}
		finally
		{
			// Delete new
			$this->deleteProject();

			// Reset for cleanup
			$this->pm_id = $first_pm_id;
		}
	}

	/**
	 * Test free text in the contact field
	 */
	public function testChangeContactWithProjectStillSet()
	{
		$info = $this->getTestInfolog();

		// Set up the test - just set info_contact to the project
		$info['info_contact'] = array(
			'app'     =>	'projectmanager',
			'id'      =>	$this->pm_id
		);

		$this->info_id = $this->bo->write($info);
		$this->assertArrayHasKey('info_id', $info, 'Could not make test infolog');
		$this->assertThat($this->info_id,
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);

		// Check infolog has pm_id properly set
		$this->assertEquals($this->pm_id, $info['pm_id']);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		$info = $this->bo->read($this->info_id);
		// Check project
		$this->checkElements();

		// Now set info_contact to be a contact
		$info['info_contact'] = array(
			'app'    =>	'addressbook',
			// Linking to current user's contact
			'id'     =>	$GLOBALS['egw_info']['user']['person_id'],
		);
		$this->bo->write($info);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Check infolog still has pm_id properly set
		$this->assertNotNull($info['pm_id'], 'Project got lost');
		$this->assertEquals($this->pm_id, $info['pm_id'], 'Project got changed');

		// Check project
		$this->checkElements();

		// Check pm links (should be only 1)
		$pm_links = Api\Link::get_links('infolog',$this->info_id,'projectmanager');
		$this->assertEquals(1, count($pm_links));

		// Check all links (should be contact & project)
		$links = Api\Link::get_links('infolog',$this->info_id);
		$this->assertEquals(2, count($links));

	}

	public function testClearProject()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->exactly(2))
                ->method('track')
				->withConsecutive(
					// First call - set the project
					[$this->callback(function($subject) { return $subject['pm_id'] == $this->pm_id;})],
					// Second call - clear the project
					[$this->callback(function($subject) { return is_null($subject['pm_status']);})]
				);

		$info = $this->getTestInfolog();

		// Set up the test - just set info_contact
		$info['info_contact'] = 'projectmanager:'.$this->pm_id;

		$this->info_id = $this->bo->write($info);
		$this->assertThat($this->info_id,
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Clear it
		unset($info['pm_id']);
		$this->bo->write($info);

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Check pm_id is gone
		$this->assertNull($info['pm_id'], 'Project was not removed');

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Check project
		$this->checkElements(0);
	}

	public function testSetProjectViaURL()
	{
		// Mock the etemplate call to check the results
		$this->ui->tmpl->expects($this->once())
				->method('exec')
				->with($this->stringContains('infolog.infolog_ui.edit'),
					$this->callback(function($info) {
						$this->assertEquals($this->pm_id, $info['pm_id']);
						return $info['pm_id'] == $this->pm_id;
					})
				);

		// Set up the test - set pm_id vi URL
		$_REQUEST['action'] = 'projectmanager';
		$_REQUEST['action_id'] = $this->pm_id;

		// Make a call to edit, looks like pm_id was set, this is initial load
		$this->ui->edit();
	}

	/**
	 * If the contact is set to a project, and the contact is cleared, that
	 * will also clear the project
	 */
	public function testClearContact()
	{
		// Saving the infolog should try to send a notification
		$this->bo->tracking->expects($this->exactly(2))
                ->method('track')
				->withConsecutive(
					// First call - set the project
					[$this->callback(function($subject) { return $subject['pm_id'] == $this->pm_id;})],
					// Second call - clear the project
					[$this->callback(function($subject) { return is_null($subject['pm_status']);})]
				);

		$info = $this->getTestInfolog();

		// Set up the test - just set info_contact
		$info['info_contact'] = 'projectmanager:'.$this->pm_id;

		$this->info_id = $this->bo->write($info);
		$this->assertThat($this->info_id,
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Clear it
		unset($info['info_contact']);
		$this->bo->write($info);

		// Now load it again
		$info = $this->bo->read($this->info_id);

		// Check contact was cleared
		$this->assertTrue(is_null($info['info_contact']) || (
				$info['info_contact']['id'] == 'none' && !$info['info_contact']['search']),
				'Contact was not cleared'
		);

		// Check pm_id is gone
		$this->assertNull($info['pm_id'], 'Project was not removed');

		// Force links to run notification now so we get valid testing - it
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Check project
		$this->checkElements(0);
	}

	protected function getTestInfolog()
	{
		return array(
			'info_subject'     =>	'Test Infolog Entry for ' . $this->getName()
		);
	}

	/**
	 * Make a project so we can test deleting it
	 */
	protected function makeProject($pm_number = '')
	{
		$project = array(
			'pm_number'         =>	'TEST' . ($pm_number ? " $pm_number" : ''),
			'pm_title'          =>	'Auto-test for ' . $this->getName(),
			'pm_status'         =>	'active',
			'pm_description'    =>	'Test project for ' . $this->getName()
		);

		// Save & set modifier, no notifications
		try
		{
			$result = true;
			$result = $this->pm_bo->save($project, true, false);
		}
		catch (\Exception $e)
		{
			// Something went wrong, we'll just fail
			$this->fail($e);
		}

		$this->assertFalse((boolean)$result, 'Error making test project');
		$this->assertArrayHasKey('pm_id', $this->pm_bo->data, 'Could not make test project');
		$this->assertThat($this->pm_bo->data['pm_id'],
			$this->logicalAnd(
				$this->isType('integer'),
				$this->greaterThan(0)
			)
		);
		$this->pm_id = $this->pm_bo->data['pm_id'];
	}

	/**
	 * Check that the project element is present
	 *
	 */
	protected function checkElements($expected_count = 1)
	{
		$element_bo = new \projectmanager_elements_bo();
		$element_count = 0;

		foreach($element_bo->search(array('pm_id' => $this->pm_id), false) as $element)
		{
			$element_count++;
			$this->assertEquals($this->info_id, $element['pe_app_id']);
		}

		$this->assertEquals($expected_count, $element_count, "Incorrect number of elements");
	}

	/**
	 * Fully delete a project and its elements, no matter what state or settings
	 */
	protected function deleteProject()
	{
		// Force links to run notification now, or elements might stay
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();

		// Force to ignore setting
		$this->pm_bo->history = '';
		$this->pm_bo->delete($this->pm_id, true);

		// Force links to run notification now, or elements might stay
		// usually waits until Egw::on_shutdown();
		Api\Link::run_notifies();
	}

}