*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\DomCrawler\Tests;
use Symfony\Component\DomCrawler\Form;
use Symfony\Component\DomCrawler\FormFieldRegistry;
use Symfony\Component\DomCrawler\Field;
class FormTest extends \PHPUnit_Framework_TestCase
{
public static function setUpBeforeClass()
{
// Ensure that the private helper class FormFieldRegistry is loaded
class_exists('Symfony\\Component\\DomCrawler\\Form');
}
public function testConstructorThrowsExceptionIfTheNodeHasNoFormAncestor()
{
$dom = new \DOMDocument();
$dom->loadHTML('
');
$nodes = $dom->getElementsByTagName('input');
try {
$form = new Form($nodes->item(0), 'http://example.com');
$this->fail('__construct() throws a \\LogicException if the node has no form ancestor');
} catch (\LogicException $e) {
$this->assertTrue(true, '__construct() throws a \\LogicException if the node has no form ancestor');
}
try {
$form = new Form($nodes->item(1), 'http://example.com');
$this->fail('__construct() throws a \\LogicException if the input type is not submit, button, or image');
} catch (\LogicException $e) {
$this->assertTrue(true, '__construct() throws a \\LogicException if the input type is not submit, button, or image');
}
$nodes = $dom->getElementsByTagName('button');
try {
$form = new Form($nodes->item(0), 'http://example.com');
$this->fail('__construct() throws a \\LogicException if the node has no form ancestor');
} catch (\LogicException $e) {
$this->assertTrue(true, '__construct() throws a \\LogicException if the node has no form ancestor');
}
}
/**
* __construct() should throw \\LogicException if the form attribute is invalid
* @expectedException \LogicException
*/
public function testConstructorThrowsExceptionIfNoRelatedForm()
{
$dom = new \DOMDocument();
$dom->loadHTML('
');
$nodes = $dom->getElementsByTagName('input');
$form = new Form($nodes->item(0), 'http://example.com');
$form = new Form($nodes->item(1), 'http://example.com');
}
public function testConstructorHandlesFormAttribute()
{
$dom = new \DOMDocument();
$dom->loadHTML('
');
$nodes = $dom->getElementsByTagName('input');
$form = new Form($nodes->item(0), 'http://example.com');
$this->assertSame($dom->getElementsByTagName('form')->item(0), $form->getFormNode(), 'HTML5-compliant form attribute handled incorrectly');
$form = new Form($nodes->item(1), 'http://example.com');
$this->assertSame($dom->getElementsByTagName('form')->item(0), $form->getFormNode(), 'HTML5-compliant form attribute handled incorrectly');
}
public function testMultiValuedFields()
{
$form = $this->createForm('
');
$this->assertEquals(
array_keys($form->all()),
array('foo[2]', 'foo[3]', 'bar[foo][0]', 'bar[foo][foobar]')
);
$this->assertEquals($form->get('foo[2]')->getValue(), 'foo');
$this->assertEquals($form->get('foo[3]')->getValue(), 'foo');
$this->assertEquals($form->get('bar[foo][0]')->getValue(), 'foo');
$this->assertEquals($form->get('bar[foo][foobar]')->getValue(), 'foo');
$form['foo[2]'] = 'bar';
$form['foo[3]'] = 'bar';
$this->assertEquals($form->get('foo[2]')->getValue(), 'bar');
$this->assertEquals($form->get('foo[3]')->getValue(), 'bar');
$form['bar'] = array('foo' => array('0' => 'bar', 'foobar' => 'foobar'));
$this->assertEquals($form->get('bar[foo][0]')->getValue(), 'bar');
$this->assertEquals($form->get('bar[foo][foobar]')->getValue(), 'foobar');
}
/**
* @dataProvider provideInitializeValues
*/
public function testConstructor($message, $form, $values)
{
$form = $this->createForm('');
$this->assertEquals(
$values,
array_map(function ($field) {
$class = get_class($field);
return array(substr($class, strrpos($class, '\\') + 1), $field->getValue());
},
$form->all()
),
'->getDefaultValues() '.$message
);
}
public function provideInitializeValues()
{
return array(
array(
'does not take into account input fields without a name attribute',
'
',
array(),
),
array(
'does not take into account input fields with an empty name attribute value',
'
',
array(),
),
array(
'takes into account disabled input fields',
'
',
array('foo' => array('InputFormField', 'foo')),
),
array(
'appends the submitted button value',
'',
array('bar' => array('InputFormField', 'bar')),
),
array(
'appends the submitted button value for Button element',
'',
array('bar' => array('InputFormField', 'bar')),
),
array(
'appends the submitted button value but not other submit buttons',
'
',
array('foobar' => array('InputFormField', 'foobar')),
),
array(
'returns textareas',
'
',
array('foo' => array('TextareaFormField', 'foo')),
),
array(
'returns inputs',
'
',
array('foo' => array('InputFormField', 'foo')),
),
array(
'returns checkboxes',
'
',
array('foo' => array('ChoiceFormField', 'foo')),
),
array(
'returns not-checked checkboxes',
'
',
array('foo' => array('ChoiceFormField', false)),
),
array(
'returns radio buttons',
'
',
array('foo' => array('ChoiceFormField', 'bar')),
),
array(
'returns file inputs',
'
',
array('foo' => array('FileFormField', array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0))),
),
);
}
public function testGetFormNode()
{
$dom = new \DOMDocument();
$dom->loadHTML('');
$form = new Form($dom->getElementsByTagName('input')->item(0), 'http://example.com');
$this->assertSame($dom->getElementsByTagName('form')->item(0), $form->getFormNode(), '->getFormNode() returns the form node associated with this form');
}
public function testGetMethod()
{
$form = $this->createForm('');
$this->assertEquals('GET', $form->getMethod(), '->getMethod() returns get if no method is defined');
$form = $this->createForm('');
$this->assertEquals('POST', $form->getMethod(), '->getMethod() returns the method attribute value of the form');
$form = $this->createForm('', 'put');
$this->assertEquals('PUT', $form->getMethod(), '->getMethod() returns the method defined in the constructor if provided');
$form = $this->createForm('', 'delete');
$this->assertEquals('DELETE', $form->getMethod(), '->getMethod() returns the method defined in the constructor if provided');
$form = $this->createForm('', 'patch');
$this->assertEquals('PATCH', $form->getMethod(), '->getMethod() returns the method defined in the constructor if provided');
}
public function testGetSetValue()
{
$form = $this->createForm('');
$this->assertEquals('foo', $form['foo']->getValue(), '->offsetGet() returns the value of a form field');
$form['foo'] = 'bar';
$this->assertEquals('bar', $form['foo']->getValue(), '->offsetSet() changes the value of a form field');
try {
$form['foobar'] = 'bar';
$this->fail('->offsetSet() throws an \InvalidArgumentException exception if the field does not exist');
} catch (\InvalidArgumentException $e) {
$this->assertTrue(true, '->offsetSet() throws an \InvalidArgumentException exception if the field does not exist');
}
try {
$form['foobar'];
$this->fail('->offsetSet() throws an \InvalidArgumentException exception if the field does not exist');
} catch (\InvalidArgumentException $e) {
$this->assertTrue(true, '->offsetSet() throws an \InvalidArgumentException exception if the field does not exist');
}
}
public function testSetValueOnMultiValuedFieldsWithMalformedName()
{
$form = $this->createForm('');
try {
$form['foo[bar'] = 'bar';
$this->fail('->offsetSet() throws an \InvalidArgumentException exception if the name is malformed.');
} catch (\InvalidArgumentException $e) {
$this->assertTrue(true, '->offsetSet() throws an \InvalidArgumentException exception if the name is malformed.');
}
}
public function testOffsetUnset()
{
$form = $this->createForm('');
unset($form['foo']);
$this->assertFalse(isset($form['foo']), '->offsetUnset() removes a field');
}
public function testOffsetExists()
{
$form = $this->createForm('');
$this->assertTrue(isset($form['foo']), '->offsetExists() return true if the field exists');
$this->assertFalse(isset($form['bar']), '->offsetExists() return false if the field does not exist');
}
public function testGetValues()
{
$form = $this->createForm('');
$this->assertEquals(array('foo[bar]' => 'foo', 'bar' => 'bar'), $form->getValues(), '->getValues() returns all form field values');
$form = $this->createForm('');
$this->assertEquals(array('bar' => 'bar'), $form->getValues(), '->getValues() does not include not-checked checkboxes');
$form = $this->createForm('');
$this->assertEquals(array('bar' => 'bar'), $form->getValues(), '->getValues() does not include file input fields');
$form = $this->createForm('');
$this->assertEquals(array('bar' => 'bar'), $form->getValues(), '->getValues() does not include disabled fields');
}
public function testSetValues()
{
$form = $this->createForm('');
$form->setValues(array('foo' => false, 'bar' => 'foo'));
$this->assertEquals(array('bar' => 'foo'), $form->getValues(), '->setValues() sets the values of fields');
}
public function testMultiselectSetValues()
{
$form = $this->createForm('');
$form->setValues(array('multi' => array("foo", "bar")));
$this->assertEquals(array('multi' => array('foo', 'bar')), $form->getValues(), '->setValue() sets the values of select');
}
public function testGetPhpValues()
{
$form = $this->createForm('');
$this->assertEquals(array('foo' => array('bar' => 'foo'), 'bar' => 'bar'), $form->getPhpValues(), '->getPhpValues() converts keys with [] to arrays');
}
public function testGetFiles()
{
$form = $this->createForm('');
$this->assertEquals(array(), $form->getFiles(), '->getFiles() returns an empty array if method is get');
$form = $this->createForm('');
$this->assertEquals(array('foo[bar]' => array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0)), $form->getFiles(), '->getFiles() only returns file fields for POST');
$form = $this->createForm('', 'put');
$this->assertEquals(array('foo[bar]' => array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0)), $form->getFiles(), '->getFiles() only returns file fields for PUT');
$form = $this->createForm('', 'delete');
$this->assertEquals(array('foo[bar]' => array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0)), $form->getFiles(), '->getFiles() only returns file fields for DELETE');
$form = $this->createForm('', 'patch');
$this->assertEquals(array('foo[bar]' => array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0)), $form->getFiles(), '->getFiles() only returns file fields for PATCH');
$form = $this->createForm('');
$this->assertEquals(array(), $form->getFiles(), '->getFiles() does not include disabled file fields');
}
public function testGetPhpFiles()
{
$form = $this->createForm('');
$this->assertEquals(array('foo' => array('bar' => array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0))), $form->getPhpFiles(), '->getPhpFiles() converts keys with [] to arrays');
}
/**
* @dataProvider provideGetUriValues
*/
public function testGetUri($message, $form, $values, $uri, $method = null)
{
$form = $this->createForm($form, $method);
$form->setValues($values);
$this->assertEquals('http://example.com'.$uri, $form->getUri(), '->getUri() '.$message);
}
public function testGetBaseUri()
{
$dom = new \DOMDocument();
$dom->loadHTML('');
$nodes = $dom->getElementsByTagName('input');
$form = new Form($nodes->item($nodes->length - 1), 'http://www.foo.com/');
$this->assertEquals('http://www.foo.com/foo.php', $form->getUri());
}
public function testGetUriWithAnchor()
{
$form = $this->createForm('', null, 'http://example.com/id/123');
$this->assertEquals('http://example.com/id/123#foo', $form->getUri());
}
public function testGetUriActionAbsolute()
{
$formHtml='';
$form = $this->createForm($formHtml);
$this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
$form = $this->createForm($formHtml, null, 'https://login.foo.com');
$this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
$form = $this->createForm($formHtml, null, 'https://login.foo.com/bar/');
$this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
// The action URI haven't the same domain Host have an another domain as Host
$form = $this->createForm($formHtml, null, 'https://www.foo.com');
$this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
$form = $this->createForm($formHtml, null, 'https://www.foo.com/bar/');
$this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
}
public function testGetUriAbsolute()
{
$form = $this->createForm('', null, 'http://localhost/foo/');
$this->assertEquals('http://localhost/foo/foo', $form->getUri(), '->getUri() returns absolute URIs');
$form = $this->createForm('', null, 'http://localhost/foo/');
$this->assertEquals('http://localhost/foo', $form->getUri(), '->getUri() returns absolute URIs');
}
public function testGetUriWithOnlyQueryString()
{
$form = $this->createForm('', null, 'http://localhost/foo/bar');
$this->assertEquals('http://localhost/foo/bar?get=param', $form->getUri(), '->getUri() returns absolute URIs only if the host has been defined in the constructor');
}
public function testGetUriWithoutAction()
{
$form = $this->createForm('', null, 'http://localhost/foo/bar');
$this->assertEquals('http://localhost/foo/bar', $form->getUri(), '->getUri() returns path if no action defined');
}
public function provideGetUriValues()
{
return array(
array(
'returns the URI of the form',
'',
array(),
'/foo'
),
array(
'appends the form values if the method is get',
'',
array(),
'/foo?foo=foo'
),
array(
'appends the form values and merges the submitted values',
'',
array('foo' => 'bar'),
'/foo?foo=bar'
),
array(
'does not append values if the method is post',
'',
array(),
'/foo'
),
array(
'does not append values if the method is patch',
'',
array(),
'/foo',
'PUT'
),
array(
'does not append values if the method is delete',
'',
array(),
'/foo',
'DELETE'
),
array(
'does not append values if the method is put',
'',
array(),
'/foo',
'PATCH'
),
array(
'appends the form values to an existing query string',
'',
array(),
'/foo?bar=bar&foo=foo'
),
array(
'returns an empty URI if the action is empty',
'',
array(),
'/',
),
array(
'appends the form values even if the action is empty',
'',
array(),
'/?foo=foo',
),
array(
'chooses the path if the action attribute value is a sharp (#)',
'',
array(),
'/#',
),
);
}
public function testHas()
{
$form = $this->createForm('');
$this->assertFalse($form->has('foo'), '->has() returns false if a field is not in the form');
$this->assertTrue($form->has('bar'), '->has() returns true if a field is in the form');
}
public function testRemove()
{
$form = $this->createForm('');
$form->remove('bar');
$this->assertFalse($form->has('bar'), '->remove() removes a field');
}
public function testGet()
{
$form = $this->createForm('');
$this->assertEquals('Symfony\\Component\\DomCrawler\\Field\\InputFormField', get_class($form->get('bar')), '->get() returns the field object associated with the given name');
try {
$form->get('foo');
$this->fail('->get() throws an \InvalidArgumentException if the field does not exist');
} catch (\InvalidArgumentException $e) {
$this->assertTrue(true, '->get() throws an \InvalidArgumentException if the field does not exist');
}
}
public function testAll()
{
$form = $this->createForm('');
$fields = $form->all();
$this->assertEquals(1, count($fields), '->all() return an array of form field objects');
$this->assertEquals('Symfony\\Component\\DomCrawler\\Field\\InputFormField', get_class($fields['bar']), '->all() return an array of form field objects');
}
public function testSubmitWithoutAFormButton()
{
$dom = new \DOMDocument();
$dom->loadHTML('
');
$nodes = $dom->getElementsByTagName('form');
$form = new Form($nodes->item(0), 'http://example.com');
$this->assertSame($nodes->item(0), $form->getFormNode(), '->getFormNode() returns the form node associated with this form');
}
/**
* @expectedException \InvalidArgumentException
*/
public function testFormFieldRegistryAddThrowAnExceptionWhenTheNameIsMalformed()
{
$registry = new FormFieldRegistry();
$registry->add($this->getFormFieldMock('[foo]'));
}
/**
* @expectedException \InvalidArgumentException
*/
public function testFormFieldRegistryRemoveThrowAnExceptionWhenTheNameIsMalformed()
{
$registry = new FormFieldRegistry();
$registry->remove('[foo]');
}
/**
* @expectedException \InvalidArgumentException
*/
public function testFormFieldRegistryGetThrowAnExceptionWhenTheNameIsMalformed()
{
$registry = new FormFieldRegistry();
$registry->get('[foo]');
}
/**
* @expectedException \InvalidArgumentException
*/
public function testFormFieldRegistryGetThrowAnExceptionWhenTheFieldDoesNotExist()
{
$registry = new FormFieldRegistry();
$registry->get('foo');
}
/**
* @expectedException \InvalidArgumentException
*/
public function testFormFieldRegistrySetThrowAnExceptionWhenTheNameIsMalformed()
{
$registry = new FormFieldRegistry();
$registry->set('[foo]', null);
}
/**
* @expectedException \InvalidArgumentException
*/
public function testFormFieldRegistrySetThrowAnExceptionWhenTheFieldDoesNotExist()
{
$registry = new FormFieldRegistry();
$registry->set('foo', null);
}
public function testFormFieldRegistryHasReturnsTrueWhenTheFQNExists()
{
$registry = new FormFieldRegistry();
$registry->add($this->getFormFieldMock('foo[bar]'));
$this->assertTrue($registry->has('foo'));
$this->assertTrue($registry->has('foo[bar]'));
$this->assertFalse($registry->has('bar'));
$this->assertFalse($registry->has('foo[foo]'));
}
public function testFormRegistryFieldsCanBeRemoved()
{
$registry = new FormFieldRegistry();
$registry->add($this->getFormFieldMock('foo'));
$registry->remove('foo');
$this->assertFalse($registry->has('foo'));
}
public function testFormRegistrySupportsMultivaluedFields()
{
$registry = new FormFieldRegistry();
$registry->add($this->getFormFieldMock('foo[]'));
$registry->add($this->getFormFieldMock('foo[]'));
$registry->add($this->getFormFieldMock('bar[5]'));
$registry->add($this->getFormFieldMock('bar[]'));
$registry->add($this->getFormFieldMock('bar[baz]'));
$this->assertEquals(
array('foo[0]', 'foo[1]', 'bar[5]', 'bar[6]', 'bar[baz]'),
array_keys($registry->all())
);
}
public function testFormRegistrySetValues()
{
$registry = new FormFieldRegistry();
$registry->add($f2 = $this->getFormFieldMock('foo[2]'));
$registry->add($f3 = $this->getFormFieldMock('foo[3]'));
$registry->add($fbb = $this->getFormFieldMock('foo[bar][baz]'));
$f2
->expects($this->exactly(2))
->method('setValue')
->with(2)
;
$f3
->expects($this->exactly(2))
->method('setValue')
->with(3)
;
$fbb
->expects($this->exactly(2))
->method('setValue')
->with('fbb')
;
$registry->set('foo[2]', 2);
$registry->set('foo[3]', 3);
$registry->set('foo[bar][baz]', 'fbb');
$registry->set('foo', array(
2 => 2,
3 => 3,
'bar' => array(
'baz' => 'fbb'
)
));
}
protected function getFormFieldMock($name, $value = null)
{
$field = $this
->getMockBuilder('Symfony\\Component\\DomCrawler\\Field\\FormField')
->setMethods(array('getName', 'getValue', 'setValue', 'initialize'))
->disableOriginalConstructor()
->getMock()
;
$field
->expects($this->any())
->method('getName')
->will($this->returnValue($name))
;
$field
->expects($this->any())
->method('getValue')
->will($this->returnValue($value))
;
return $field;
}
protected function createForm($form, $method = null, $currentUri = null)
{
$dom = new \DOMDocument();
$dom->loadHTML(''.$form.'');
$nodes = $dom->getElementsByTagName('input');
$xPath = new \DOMXPath($dom);
$nodes = $xPath->query('//input | //button');
if (null === $currentUri) {
$currentUri = 'http://example.com/';
}
return new Form($nodes->item($nodes->length - 1), $currentUri, $method);
}
}