AssetSourcesTest::setMockSchematicFields() - Code Metrics - Inspection of "Added force option to Asset Sources" - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#91)

by Bob Olde

created 2017-04-12 12:06 UTC

AssetSourcesTest::setMockSchematicFields() A

↳ Parent: AssetSourcesTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	20
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	14
nc	1
nop	0

<?php

namespace NerdsAndCompany\Schematic\Services;

use Craft\BaseTest;
use Craft\AssetSourcesService;
use Craft\AssetSourceModel;
use Craft\Craft;
use Craft\DbCommand;
use Craft\DbConnection;
use Craft\FieldLayoutModel;
use Craft\FieldsService;
use NerdsAndCompany\Schematic\Models\Result;
use PHPUnit_Framework_MockObject_MockObject as Mock;

/**
 * Class AssetSourcesTest.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2017, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 *
 * @coversDefaultClass \NerdsAndCompany\Schematic\Services\AssetSources
 * @covers ::__construct
 * @covers ::<!public>
 */
class AssetSourcesTest extends BaseTest
{
    //==============================================================================================================
    //=================================================  TESTS  ====================================================
    //==============================================================================================================

    /**
     * @covers ::export
     * @dataProvider provideValidAssetSources
     *
     * @param AssetSourceModel[] $assetSources
     * @param array              $expectedResult
     */
    public function testSuccessfulExport(array $assetSources, array $expectedResult = [])
    {
        $this->setMockFieldsService();
        $this->setMockSchematicFields();

        $schematicAssetSourcesService = new AssetSources();

        $actualResult = $schematicAssetSourcesService->export($assetSources);

        $this->assertSame($expectedResult, $actualResult);
    }

    /**
     * @covers ::import
     * @dataProvider provideValidAssetSourceDefinitions
     *
     * @param array $assetSourceDefinitions
     */
    public function testSuccessfulImport(array $assetSourceDefinitions)
    {
        $this->setMockAssetSourcesService();
        $this->setMockDbConnection();
        $this->setMockSchematicFields();

        $schematicAssetSourcesService = new AssetSources();

        $import = $schematicAssetSourcesService->import($assetSourceDefinitions);

        $this->assertInstanceOf(Result::class, $import);
        $this->assertFalse($import->hasErrors());
    }

      /**
       * @covers ::import
       * @dataProvider provideValidAssetSourceDefinitions
       *
       * @param array $assetSourceDefinitions
       */
      public function testImportWithForceOption(array $assetSourceDefinitions)
      {
          $this->setMockAssetSourcesService();
          $this->setMockDbConnection();
          $this->setMockSchematicFields();

          $schematicAssetSourcesService = new AssetSources();

          $import = $schematicAssetSourcesService->import($assetSourceDefinitions, true);

          $this->assertInstanceOf(Result::class, $import);
          $this->assertFalse($import->hasErrors());
      }

    //==============================================================================================================
    //==============================================  PROVIDERS  ===================================================
    //==============================================================================================================

    /**
     * @return array
     */
    public function provideValidAssetSources()
    {
        return [
            'emptyArray' => [
                'AssetSources' => [],
                'expectedResult' => [],
            ],
            'single asset source' => [
                'AssetSources' => [
                    'assetSource1' => $this->getMockAssetSource(1),
                ],
                'expectedResult' => [
                    'assetSourceHandle1' => [
                        'type' => null,
                        'name' => 'assetSourceName1',
                        'sortOrder' => null,
                        'settings' => null,
                        'fieldLayout' => [
                            'fields' => [],
                        ],
                    ],
                ],
            ],
            'multiple asset sources' => [
                'AssetSources' => [
                    'assetSource1' => $this->getMockAssetSource(1),
                    'assetSource2' => $this->getMockAssetSource(2),
                ],
                'expectedResult' => [
                    'assetSourceHandle1' => [
                        'type' => null,
                        'name' => 'assetSourceName1',
                        'sortOrder' => null,
                        'settings' => null,
                        'fieldLayout' => [
                            'fields' => [],
                        ],
                    ],
                    'assetSourceHandle2' => [
                        'type' => null,
                        'name' => 'assetSourceName2',
                        'sortOrder' => null,
                        'settings' => null,
                        'fieldLayout' => [
                            'fields' => [],
                        ],
                    ],
                ],
            ],
        ];
    }

    /**
     * @return array
     */
    public function provideValidAssetSourceDefinitions()
    {
        return [
            'emptyArray' => [
                'assetSourceDefinitions' => [],
            ],
            'single group' => [
                'assetSourceDefinitions' => [
                    'assetSourceHandle1' => [
                        'type' => 'Local',
                        'name' => 'assetSourceName1',
                        'sortOrder' => 1,
                        'settings' => array(),
                        'fieldLayout' => [
                            'fields' => [],
                        ],
                    ],
                ],
            ],
        ];
    }

    //==============================================================================================================
    //=================================================  MOCKS  ====================================================
    //==============================================================================================================

    /**
     * @param string $assetSourceId
     *
     * @return Mock|AssetSourceModel
     */
    private function getMockAssetSource($assetSourceId)
    {
        $mockAssetSource = $this->getMockBuilder(AssetSourceModel::class)
            ->disableOriginalConstructor()
            ->getMock();

        $mockAssetSource->expects($this->any())
            ->method('__get')
            ->willReturnMap([
                ['id', $assetSourceId],
                ['fieldLayoutId', $assetSourceId],
                ['handle', 'assetSourceHandle'.$assetSourceId],
                ['name', 'assetSourceName'.$assetSourceId],
            ]);

        $mockAssetSource->expects($this->any())
            ->method('getAllErrors')
            ->willReturn([
                'ohnoes' => 'horrible error',
            ]);

        return $mockAssetSource;
    }

    /**
     * @return Mock|CraftFieldsService
     */
    private function setMockFieldsService()
    {
        $mockFieldsService = $this->getMockBuilder(FieldsService::class)
            ->disableOriginalConstructor()
            ->getMock();

        $mockFieldsService->expects($this->any())
            ->method('getLayoutById')
            ->with($this->isType('integer'))
            ->willReturn($this->getMockFieldLayout());

        $this->setComponent(Craft::app(), 'fields', $mockFieldsService);

        return $mockFieldsService;
    }

    /**
     * @return Mock|fields
     */
    private function setMockSchematicFields()
    {
        $mockSchematicFields = $this->getMockBuilder(Fields::class)
            ->disableOriginalConstructor()
            ->getMock();

        $mockSchematicFields->expects($this->any())
            ->method('getFieldLayoutDefinition')
            ->with($this->isInstanceOf(FieldLayoutModel::class))
            ->willReturn(['fields' => []]);

        $mockSchematicFields->expects($this->any())
            ->method('getFieldLayout')
            ->with($this->isType('array'))
            ->willReturn($this->getMockFieldLayout());

        $this->setComponent(Craft::app(), 'schematic_fields', $mockSchematicFields);

        return $mockSchematicFields;
    }

    /**
     * @return Mock|AssetSourcesService
     */
    private function setMockAssetSourcesService()
    {
        $mockAssetSourcesService = $this->getMockBuilder(AssetSourcesService::class)
            ->disableOriginalConstructor()
            ->setMethods(['getAllSources', 'saveSource', 'deleteSourceById'])
            ->getMock();

        $mockAssetSourcesService->expects($this->any())
            ->method('getAllSources')
            ->with('handle')
            ->willReturn([]);

        $this->setComponent(Craft::app(), 'assetSources', $mockAssetSourcesService);

        return $mockAssetSourcesService;
    }

    /**
     * @return Mock|FieldLayoutModel
     */
    private function getMockFieldLayout()
    {
        $mockFieldLayout = $this->getMockBuilder(FieldLayoutModel::class)
            ->disableOriginalConstructor()
            ->getMock();

        return $mockFieldLayout;
    }

    /**
     * @return Mock|DbConnection
     */
    private function setMockDbConnection()
    {
        $mockDbConnection = $this->getMockBuilder(DbConnection::class)
            ->disableOriginalConstructor()
            ->setMethods(['createCommand'])
            ->getMock();
        $mockDbConnection->autoConnect = false; // Do not auto connect

        $mockDbCommand = $this->getMockDbCommand();
        $mockDbConnection->expects($this->any())->method('createCommand')->willReturn($mockDbCommand);

        Craft::app()->setComponent('db', $mockDbConnection);

        return $mockDbConnection;
    }

    /**
     * @return Mock|DbCommand
     */
    private function getMockDbCommand()
    {
        $mockDbCommand = $this->getMockBuilder(DbCommand::class)
            ->disableOriginalConstructor()
            ->setMethods(['insertOrUpdate'])
            ->getMock();

        return $mockDbCommand;
    }
}


1			<?php
2
3			namespace NerdsAndCompany\Schematic\Services;
4
5			use Craft\BaseTest;
6			use Craft\AssetSourcesService;
7			use Craft\AssetSourceModel;
8			use Craft\Craft;
9			use Craft\DbCommand;
10			use Craft\DbConnection;
11			use Craft\FieldLayoutModel;
12			use Craft\FieldsService;
13			use NerdsAndCompany\Schematic\Models\Result;
14			use PHPUnit_Framework_MockObject_MockObject as Mock;
15
16			/**
17			* Class AssetSourcesTest.
18			*
19			* @author Nerds & Company
20			* @copyright Copyright (c) 2015-2017, Nerds & Company
21			* @license MIT
22			*
23			* @see http://www.nerds.company
24			*
25			* @coversDefaultClass \NerdsAndCompany\Schematic\Services\AssetSources
26			* @covers ::__construct
27			* @covers ::<!public>
28			*/
29			class AssetSourcesTest extends BaseTest
30			{
31			//==============================================================================================================
32			//================================================= TESTS ====================================================
33			//==============================================================================================================
34
35			/**
36			* @covers ::export
37			* @dataProvider provideValidAssetSources
38			*
39			* @param AssetSourceModel[] $assetSources
40			* @param array $expectedResult
41			*/
42			public function testSuccessfulExport(array $assetSources, array $expectedResult = [])
43			{
44			$this->setMockFieldsService();
45			$this->setMockSchematicFields();
46
47			$schematicAssetSourcesService = new AssetSources();
48
49			$actualResult = $schematicAssetSourcesService->export($assetSources);
50
51			$this->assertSame($expectedResult, $actualResult);
52			}
53
54			/**
55			* @covers ::import
56			* @dataProvider provideValidAssetSourceDefinitions
57			*
58			* @param array $assetSourceDefinitions
59			*/
60			public function testSuccessfulImport(array $assetSourceDefinitions)
61			{
62			$this->setMockAssetSourcesService();
63			$this->setMockDbConnection();
64			$this->setMockSchematicFields();
65
66			$schematicAssetSourcesService = new AssetSources();
67
68			$import = $schematicAssetSourcesService->import($assetSourceDefinitions);
69
70			$this->assertInstanceOf(Result::class, $import);
71			$this->assertFalse($import->hasErrors());
72			}
73
74			/**
75			* @covers ::import
76			* @dataProvider provideValidAssetSourceDefinitions
77			*
78			* @param array $assetSourceDefinitions
79			*/
80			public function testImportWithForceOption(array $assetSourceDefinitions)
81			{
82			$this->setMockAssetSourcesService();
83			$this->setMockDbConnection();
84			$this->setMockSchematicFields();
85
86			$schematicAssetSourcesService = new AssetSources();
87
88			$import = $schematicAssetSourcesService->import($assetSourceDefinitions, true);
89
90			$this->assertInstanceOf(Result::class, $import);
91			$this->assertFalse($import->hasErrors());
92			}
93
94			//==============================================================================================================
95			//============================================== PROVIDERS ===================================================
96			//==============================================================================================================
97
98			/**
99			* @return array
100			*/
101			public function provideValidAssetSources()
102			{
103			return [
104			'emptyArray' => [
105			'AssetSources' => [],
106			'expectedResult' => [],
107			],
108			'single asset source' => [
109			'AssetSources' => [
110			'assetSource1' => $this->getMockAssetSource(1),
111			],
112			'expectedResult' => [
113			'assetSourceHandle1' => [
114			'type' => null,
115			'name' => 'assetSourceName1',
116			'sortOrder' => null,
117			'settings' => null,
118			'fieldLayout' => [
119			'fields' => [],
120			],
121			],
122			],
123			],
124			'multiple asset sources' => [
125			'AssetSources' => [
126			'assetSource1' => $this->getMockAssetSource(1),
127			'assetSource2' => $this->getMockAssetSource(2),
128			],
129			'expectedResult' => [
130			'assetSourceHandle1' => [
131			'type' => null,
132			'name' => 'assetSourceName1',
133			'sortOrder' => null,
134			'settings' => null,
135			'fieldLayout' => [
136			'fields' => [],
137			],
138			],
139			'assetSourceHandle2' => [
140			'type' => null,
141			'name' => 'assetSourceName2',
142			'sortOrder' => null,
143			'settings' => null,
144			'fieldLayout' => [
145			'fields' => [],
146			],
147			],
148			],
149			],
150			];
151			}
152
153			/**
154			* @return array
155			*/
156			public function provideValidAssetSourceDefinitions()
157			{
158			return [
159			'emptyArray' => [
160			'assetSourceDefinitions' => [],
161			],
162			'single group' => [
163			'assetSourceDefinitions' => [
164			'assetSourceHandle1' => [
165			'type' => 'Local',
166			'name' => 'assetSourceName1',
167			'sortOrder' => 1,
168			'settings' => array(),
169			'fieldLayout' => [
170			'fields' => [],
171			],
172			],
173			],
174			],
175			];
176			}
177
178			//==============================================================================================================
179			//================================================= MOCKS ====================================================
180			//==============================================================================================================
181
182			/**
183			* @param string $assetSourceId
184			*
185			* @return Mock\|AssetSourceModel
186			*/
187			private function getMockAssetSource($assetSourceId)
188			{
189			$mockAssetSource = $this->getMockBuilder(AssetSourceModel::class)
190			->disableOriginalConstructor()
191			->getMock();
192
193			$mockAssetSource->expects($this->any())
194			->method('__get')
195			->willReturnMap([
196			['id', $assetSourceId],
197			['fieldLayoutId', $assetSourceId],
198			['handle', 'assetSourceHandle'.$assetSourceId],
199			['name', 'assetSourceName'.$assetSourceId],
200			]);
201
202			$mockAssetSource->expects($this->any())
203			->method('getAllErrors')
204			->willReturn([
205			'ohnoes' => 'horrible error',
206			]);
207
208			return $mockAssetSource;
209			}
210
211			/**
212			* @return Mock\|CraftFieldsService
213			*/
214			private function setMockFieldsService()
215			{
216			$mockFieldsService = $this->getMockBuilder(FieldsService::class)
217			->disableOriginalConstructor()
218			->getMock();
219
220			$mockFieldsService->expects($this->any())
221			->method('getLayoutById')
222			->with($this->isType('integer'))
223			->willReturn($this->getMockFieldLayout());
224
225			$this->setComponent(Craft::app(), 'fields', $mockFieldsService);
226
227			return $mockFieldsService;
228			}
229
230			/**
231			* @return Mock\|fields
232			*/
233			private function setMockSchematicFields()
234			{
235			$mockSchematicFields = $this->getMockBuilder(Fields::class)
236			->disableOriginalConstructor()
237			->getMock();
238
239			$mockSchematicFields->expects($this->any())
240			->method('getFieldLayoutDefinition')
241			->with($this->isInstanceOf(FieldLayoutModel::class))
242			->willReturn(['fields' => []]);
243
244			$mockSchematicFields->expects($this->any())
245			->method('getFieldLayout')
246			->with($this->isType('array'))
247			->willReturn($this->getMockFieldLayout());
248
249			$this->setComponent(Craft::app(), 'schematic_fields', $mockSchematicFields);
250
251			return $mockSchematicFields;
252			}
253
254			/**
255			* @return Mock\|AssetSourcesService
256			*/
257			private function setMockAssetSourcesService()
258			{
259			$mockAssetSourcesService = $this->getMockBuilder(AssetSourcesService::class)
260			->disableOriginalConstructor()
261			->setMethods(['getAllSources', 'saveSource', 'deleteSourceById'])
262			->getMock();
263
264			$mockAssetSourcesService->expects($this->any())
265			->method('getAllSources')
266			->with('handle')
267			->willReturn([]);
268
269			$this->setComponent(Craft::app(), 'assetSources', $mockAssetSourcesService);
270
271			return $mockAssetSourcesService;
272			}
273
274			/**
275			* @return Mock\|FieldLayoutModel
276			*/
277			private function getMockFieldLayout()
278			{
279			$mockFieldLayout = $this->getMockBuilder(FieldLayoutModel::class)
280			->disableOriginalConstructor()
281			->getMock();
282
283			return $mockFieldLayout;
284			}
285
286			/**
287			* @return Mock\|DbConnection
288			*/
289			private function setMockDbConnection()
290			{
291			$mockDbConnection = $this->getMockBuilder(DbConnection::class)
292			->disableOriginalConstructor()
293			->setMethods(['createCommand'])
294			->getMock();
295			$mockDbConnection->autoConnect = false; // Do not auto connect
296
297			$mockDbCommand = $this->getMockDbCommand();
298			$mockDbConnection->expects($this->any())->method('createCommand')->willReturn($mockDbCommand);
299
300			Craft::app()->setComponent('db', $mockDbConnection);
301
302			return $mockDbConnection;
303			}
304
305			/**
306			* @return Mock\|DbCommand
307			*/
308			private function getMockDbCommand()
309			{
310			$mockDbCommand = $this->getMockBuilder(DbCommand::class)
311			->disableOriginalConstructor()
312			->setMethods(['insertOrUpdate'])
313			->getMock();
314
315			return $mockDbCommand;
316			}
317			}
318

nerds-and-company / schematic

Pull Request — master (#91)

AssetSourcesTest::setMockSchematicFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like