ResourceLocatorFieldTest::testSaveIntoWithNoNameReturnsEarly() - Code Metrics - silverstripe/silverstripe-ckan-registry - Measure and Improve Code Quality continuously with Scrutinizer

testSaveIntoWithNoNameReturnsEarly() A
last analyzed 2021-05-13 00:58 UTC

↳ Parent: ResourceLocatorFieldTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10

<?php

namespace SilverStripe\CKANRegistry\Tests\Forms;

use InvalidArgumentException;
use SilverStripe\CKANRegistry\Forms\ResourceLocatorField;
use SilverStripe\CKANRegistry\Model\Resource;
use SilverStripe\CKANRegistry\Page\CKANRegistryPage;
use SilverStripe\CKANRegistry\Service\ResourcePopulatorInterface;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use stdClass;

class ResourceLocatorFieldTest extends SapphireTest
{
    protected $usesDatabase = true;

    /**
     * @var ResourceLocatorField
     */
    protected $field;

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

        $this->field = new ResourceLocatorField('my-field');

        $this->field
            ->setEndpointFieldName('Endpoint')
            ->setDatasetFieldName('DataSet')
            ->setResourceFieldName('Identifier');

        // Mock the field populator, in case an action we perform in a unit test tries to contact the mock API
        $populator = $this->createMock(ResourcePopulatorInterface::class);
        Injector::inst()->registerService($populator, ResourcePopulatorInterface::class);
    }

    public function testConstruct()
    {
        $field = new ResourceLocatorField('my-field', 'My field', null, 'http://example.com');

        $this->assertSame('http://example.com', $field->getDefaultEndpoint());
        $this->assertContains('Connect to a data source from', $field->getDescription());
    }

    public function testSetValueWithArray()
    {
        $this->field->setValue(['foo' => 'bar']);
        $this->assertSame(['foo' => 'bar'], $this->field->Value(), 'Array values should pass through');
    }

    public function testSetValueWithNonDataObject()
    {
        $value = new stdClass();
        $value->foo = 'bar';
        $this->field->setValue($value);

        $this->assertNull($this->field->Value(), 'Non DataObject instances should set a null value');
    }

    public function testSetValueWithNoDataSet()
    {
        $this->field
            ->setDatasetFieldName('NonExistentField')
            ->setValue($this->getResource());

        $this->assertNull($this->field->Value(), 'Missing data sets should set a null value');
    }

    public function testSetValueWithNoEndpointFallsBackToDefaultEndpoint()
    {
        $this->field
            ->setEndpointFieldName('NonExistentField')
            ->setDefaultEndpoint('http://example.com')
            ->setValue($this->getResource());

        $this->assertContains(
            'http://example.com',
            $this->field->Value(),
            'Missing endpoint data on the model should fall back to the configured default endpoint'
        );
    }

    public function testSetValueWithNoEndpointAndNoDefaultReturnsNull()
    {
        ResourceLocatorField::config()->set('default_endpoint', '');

        $this->field
            ->setEndpointFieldName('NonExistentField')
            ->setDefaultEndpoint(null)
            ->setValue($this->getResource());

        $this->assertNull(
            $this->field->Value(),
            'Missing endpoint data on the model, and missing default endpoint should return null'
        );
    }

    public function testSetValueWithExpectedDataStructure()
    {
        $this->field->setValue($this->getResource());
        $result = $this->field->Value();

        $this->assertContains('http://example.com', $result);
        $this->assertContains('foo-bar', $result);
        $this->assertContains('123-456', $result);
    }

    public function testSetSubmittedValue()
    {
        $value = json_encode([
            'endpoint' => 'https://www.silverstripe.org',
            'dataset' => 'monkeys',
            'resource' => 'feeding',
        ]);
        $this->field->setSubmittedValue($value);

        $this->assertContains('https://www.silverstripe.org', $this->field->Value());
    }

    public function testDataValue()
    {
        $this->field->setValue($this->getResource());
        $result = $this->field->dataValue();

        $this->assertJson($result, 'dataValue() should return JSON');
        $this->assertContains('foo-bar', $result, 'Serialised result should contain value');
    }

    public function testSaveIntoWithNoNameReturnsEarly()
    {
        $this->field->setName(null);
        $this->assertNull($this->field->saveInto($this->getPage()));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * @expectedException InvalidArgumentException
     * @expectedExceptionMessageRegExp /Could not determine where to save the value of/
     */
    public function testSaveIntoWithInvalidRelationshipNameThrowsException()
    {
        $this->field->setName('UnicornRelationship');
        $this->field->saveInto($this->getPage());
    }

    public function testSaveIntoSetsRelationshipFields()
    {
        $page = $this->getPage();
        $this->field->setName('DataResource');
        $this->field->setValue($this->getResource());
        $this->field->saveInto($page);

        $this->assertNotEmpty($page->DataResourceID);
        $this->assertSame('http://example.com', $page->DataResource()->Endpoint);
        $this->assertSame('foo-bar', $page->DataResource()->DataSet);
        $this->assertSame('123-456', $page->DataResource()->Identifier);
    }

    public function testDefaultEndpointUsesConfigIfNotProvided()
    {
        $this->field->setDefaultEndpoint('foo');
        $this->assertSame('foo', $this->field->getDefaultEndpoint());

        $this->field->setDefaultEndpoint(null);
        ResourceLocatorField::config()->set('default_endpoint', 'bar');
        $this->assertSame('bar', $this->field->getDefaultEndpoint());
    }

    public function testSiteNameUsesTranslatedDefaultIfNotProvided()
    {
        $this->field->setSiteName('My cool website');
        $this->assertSame('My cool website', $this->field->getSiteName());

        $this->field->setSiteName(null);
        $this->assertSame('a CKAN website', $this->field->getSiteName());
    }

    /**
     * Returns a Resource object for testing values in the field
     *
     * @return Resource
     */
    protected function getResource()
    {
        $resource = new Resource();
        $resource->Endpoint = 'http://example.com';
        $resource->DataSet = 'foo-bar';
        $resource->Identifier = '123-456';
        return $resource;
    }

    /**
     * Returns a CKAN Page object for testing values in the field
     *
     * @return CKANRegistryPage
     */
    protected function getPage()
    {
        $page = new CKANRegistryPage();
        $page->Title = 'My CKAN Page';
        return $page;
    }
}


1			<?php
2
3			namespace SilverStripe\CKANRegistry\Tests\Forms;
4
5			use InvalidArgumentException;
6			use SilverStripe\CKANRegistry\Forms\ResourceLocatorField;
7			use SilverStripe\CKANRegistry\Model\Resource;
8			use SilverStripe\CKANRegistry\Page\CKANRegistryPage;
9			use SilverStripe\CKANRegistry\Service\ResourcePopulatorInterface;
10			use SilverStripe\Core\Injector\Injector;
11			use SilverStripe\Dev\SapphireTest;
12			use stdClass;
13
14			class ResourceLocatorFieldTest extends SapphireTest
15			{
16			protected $usesDatabase = true;
17
18			/**
19			* @var ResourceLocatorField
20			*/
21			protected $field;
22
23			protected function setUp()
24			{
25			parent::setUp();
26
27			$this->field = new ResourceLocatorField('my-field');
28
29			$this->field
30			->setEndpointFieldName('Endpoint')
31			->setDatasetFieldName('DataSet')
32			->setResourceFieldName('Identifier');
33
34			// Mock the field populator, in case an action we perform in a unit test tries to contact the mock API
35			$populator = $this->createMock(ResourcePopulatorInterface::class);
36			Injector::inst()->registerService($populator, ResourcePopulatorInterface::class);
37			}
38
39			public function testConstruct()
40			{
41			$field = new ResourceLocatorField('my-field', 'My field', null, 'http://example.com');
42
43			$this->assertSame('http://example.com', $field->getDefaultEndpoint());
44			$this->assertContains('Connect to a data source from', $field->getDescription());
45			}
46
47			public function testSetValueWithArray()
48			{
49			$this->field->setValue(['foo' => 'bar']);
50			$this->assertSame(['foo' => 'bar'], $this->field->Value(), 'Array values should pass through');
51			}
52
53			public function testSetValueWithNonDataObject()
54			{
55			$value = new stdClass();
56			$value->foo = 'bar';
57			$this->field->setValue($value);
58
59			$this->assertNull($this->field->Value(), 'Non DataObject instances should set a null value');
60			}
61
62			public function testSetValueWithNoDataSet()
63			{
64			$this->field
65			->setDatasetFieldName('NonExistentField')
66			->setValue($this->getResource());
67
68			$this->assertNull($this->field->Value(), 'Missing data sets should set a null value');
69			}
70
71			public function testSetValueWithNoEndpointFallsBackToDefaultEndpoint()
72			{
73			$this->field
74			->setEndpointFieldName('NonExistentField')
75			->setDefaultEndpoint('http://example.com')
76			->setValue($this->getResource());
77
78			$this->assertContains(
79			'http://example.com',
80			$this->field->Value(),
81			'Missing endpoint data on the model should fall back to the configured default endpoint'
82			);
83			}
84
85			public function testSetValueWithNoEndpointAndNoDefaultReturnsNull()
86			{
87			ResourceLocatorField::config()->set('default_endpoint', '');
88
89			$this->field
90			->setEndpointFieldName('NonExistentField')
91			->setDefaultEndpoint(null)
92			->setValue($this->getResource());
93
94			$this->assertNull(
95			$this->field->Value(),
96			'Missing endpoint data on the model, and missing default endpoint should return null'
97			);
98			}
99
100			public function testSetValueWithExpectedDataStructure()
101			{
102			$this->field->setValue($this->getResource());
103			$result = $this->field->Value();
104
105			$this->assertContains('http://example.com', $result);
106			$this->assertContains('foo-bar', $result);
107			$this->assertContains('123-456', $result);
108			}
109
110			public function testSetSubmittedValue()
111			{
112			$value = json_encode([
113			'endpoint' => 'https://www.silverstripe.org',
114			'dataset' => 'monkeys',
115			'resource' => 'feeding',
116			]);
117			$this->field->setSubmittedValue($value);
118
119			$this->assertContains('https://www.silverstripe.org', $this->field->Value());
120			}
121
122			public function testDataValue()
123			{
124			$this->field->setValue($this->getResource());
125			$result = $this->field->dataValue();
126
127			$this->assertJson($result, 'dataValue() should return JSON');
128			$this->assertContains('foo-bar', $result, 'Serialised result should contain value');
129			}
130
131			public function testSaveIntoWithNoNameReturnsEarly()
132			{
133			$this->field->setName(null);
134			$this->assertNull($this->field->saveInto($this->getPage()));
			0 ignored issues – show Bug introduced 2018-12-18 13:06 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->field->saveInto($this->getPage())` targeting `SilverStripe\CKANRegistr...ocatorField::saveInto()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
135			}
136
137			/**
138			* @expectedException InvalidArgumentException
139			* @expectedExceptionMessageRegExp /Could not determine where to save the value of/
140			*/
141			public function testSaveIntoWithInvalidRelationshipNameThrowsException()
142			{
143			$this->field->setName('UnicornRelationship');
144			$this->field->saveInto($this->getPage());
145			}
146
147			public function testSaveIntoSetsRelationshipFields()
148			{
149			$page = $this->getPage();
150			$this->field->setName('DataResource');
151			$this->field->setValue($this->getResource());
152			$this->field->saveInto($page);
153
154			$this->assertNotEmpty($page->DataResourceID);
155			$this->assertSame('http://example.com', $page->DataResource()->Endpoint);
156			$this->assertSame('foo-bar', $page->DataResource()->DataSet);
157			$this->assertSame('123-456', $page->DataResource()->Identifier);
158			}
159
160			public function testDefaultEndpointUsesConfigIfNotProvided()
161			{
162			$this->field->setDefaultEndpoint('foo');
163			$this->assertSame('foo', $this->field->getDefaultEndpoint());
164
165			$this->field->setDefaultEndpoint(null);
166			ResourceLocatorField::config()->set('default_endpoint', 'bar');
167			$this->assertSame('bar', $this->field->getDefaultEndpoint());
168			}
169
170			public function testSiteNameUsesTranslatedDefaultIfNotProvided()
171			{
172			$this->field->setSiteName('My cool website');
173			$this->assertSame('My cool website', $this->field->getSiteName());
174
175			$this->field->setSiteName(null);
176			$this->assertSame('a CKAN website', $this->field->getSiteName());
177			}
178
179			/**
180			* Returns a Resource object for testing values in the field
181			*
182			* @return Resource
183			*/
184			protected function getResource()
185			{
186			$resource = new Resource();
187			$resource->Endpoint = 'http://example.com';
188			$resource->DataSet = 'foo-bar';
189			$resource->Identifier = '123-456';
190			return $resource;
191			}
192
193			/**
194			* Returns a CKAN Page object for testing values in the field
195			*
196			* @return CKANRegistryPage
197			*/
198			protected function getPage()
199			{
200			$page = new CKANRegistryPage();
201			$page->Title = 'My CKAN Page';
202			return $page;
203			}
204			}
205

silverstripe / silverstripe-ckan-registry

testSaveIntoWithNoNameReturnsEarly() A last analyzed 2021-05-13 00:58 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

testSaveIntoWithNoNameReturnsEarly() A
last analyzed 2021-05-13 00:58 UTC