CheckUsedServicesTest::usedServicesDataProvider() - Code Metrics - Inspection of "Prepare ProductClonerBundle to be used with Akeneo..." - Flagbit/akeneo-product-cloner - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#33)

by Pascal

created 2021-09-07 15:24 UTC

CheckUsedServicesTest::usedServicesDataProvider() A

↳ Parent: CheckUsedServicesTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	68
Code Lines	49

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	49
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	68
rs	9.1127

How to fix Long Method

<?php

declare(strict_types=1);

namespace Flagbit\Bundle\ProductClonerBundle\Test\Service;

use Akeneo\Pim\Enrichment\Component\Product\Builder\ProductBuilderInterface;
use Akeneo\Pim\Enrichment\Component\Product\Comparator\Filter\FilterInterface;
use Akeneo\Pim\Enrichment\Component\Product\Converter\ConverterInterface;
use Akeneo\Pim\Enrichment\Component\Product\Localization\Localizer\AttributeConverterInterface;
use Akeneo\Pim\Enrichment\Component\Product\Repository\ProductModelRepositoryInterface;
use Akeneo\Pim\Structure\Component\Repository\AttributeRepositoryInterface;
use Akeneo\Tool\Component\StorageUtils\Factory\SimpleFactoryInterface;
use Akeneo\Tool\Component\StorageUtils\Saver\SaverInterface;
use Akeneo\Tool\Component\StorageUtils\Updater\ObjectUpdaterInterface;
use Akeneo\UserManagement\Bundle\Context\UserContext;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Akeneo\Pim\Enrichment\Component\Product\Repository\ProductRepositoryInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * Test to ensure the services used by the bundle are available in the currently
 * used Akeneo version. This makes future updates easier, as this test can provide
 * a first indication if something critical may have changed. It does not replace manual
 * testing, as it only checks for service availability and not if the services undergone
 * a significant change.
 */
class CheckUsedServicesTest extends KernelTestCase
{
    /**
     * Boot symfony kernel before executing any tests
     */
    protected function setUp(): void
    {
        self::bootKernel();
    }

    /**
     * @dataProvider usedServicesDataProvider
     *
     * @param string $serviceName
     * @param string $expectedType
     */
    public function testUsedServiceIsAvailable(string $serviceName, string $expectedType): void {
        self::assertTrue(
            static::$container->has($serviceName),
            sprintf('Service %s seems to not exist but is required by the bundle!', $serviceName)
        );
        self::assertInstanceOf(
            $expectedType,
            static::$container->get($serviceName),
            sprintf('Service %s must be an instance of %s!', $serviceName, $expectedType)
        );
    }

    /**
     * @return string[][]
     */
    public function usedServicesDataProvider(): array {
        return  [
            // Used in both places
            'Attribute Repository' => [
                'pim_catalog.repository.attribute',
                AttributeRepositoryInterface::class
            ],
            'External API Serializer' => [
                'pim_external_api_serializer',
                NormalizerInterface::class
            ],
            'Product Validator' => [
                'pim_catalog.validator.product',
                ValidatorInterface::class
            ],
            'Normalizer Violation' => [
                'pim_enrich.normalizer.violation',
                NormalizerInterface::class
            ],
            'Product Builder' => [
                'pim_catalog.builder.product',
                ProductBuilderInterface::class
            ],
            // Only used for product models
            'Product Model Repository' => [
                'pim_catalog.repository.product_model',
                ProductModelRepositoryInterface::class
            ],
            'Product Model Factory' => [
                'pim_catalog.factory.product_model',
                SimpleFactoryInterface::class
            ],
            'Product Model Updater' => [
                'pim_catalog.updater.product_model',
                ObjectUpdaterInterface::class
            ],
            'Product Model Saver' => [
                'pim_catalog.saver.product_model',
                SaverInterface::class
            ],
            // Only used for products
            'Product Repository' => [
                'pim_catalog.repository.product',
                ProductRepositoryInterface::class
            ],
            'Product Updater' => [
                'pim_catalog.updater.product',
                ObjectUpdaterInterface::class
            ],
            'Product Saver' => [
                'pim_catalog.saver.product',
                SaverInterface::class
            ],
            'User Context' => [
                'pim_user.context.user',
                UserContext::class
            ],
            'Localizer Converter' => [
                'pim_catalog.localization.localizer.converter',
                AttributeConverterInterface::class
            ],
            'Comparator Product Filter ' => [
                'pim_catalog.comparator.filter.product',
                FilterInterface::class
            ],
            'Enrich to Standard product Value Converter' => [
                'pim_enrich.converter.enrich_to_standard.product_value',
                ConverterInterface::class
            ],

        ];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Flagbit\Bundle\ProductClonerBundle\Test\Service;
6
7			use Akeneo\Pim\Enrichment\Component\Product\Builder\ProductBuilderInterface;
8			use Akeneo\Pim\Enrichment\Component\Product\Comparator\Filter\FilterInterface;
9			use Akeneo\Pim\Enrichment\Component\Product\Converter\ConverterInterface;
10			use Akeneo\Pim\Enrichment\Component\Product\Localization\Localizer\AttributeConverterInterface;
11			use Akeneo\Pim\Enrichment\Component\Product\Repository\ProductModelRepositoryInterface;
12			use Akeneo\Pim\Structure\Component\Repository\AttributeRepositoryInterface;
13			use Akeneo\Tool\Component\StorageUtils\Factory\SimpleFactoryInterface;
14			use Akeneo\Tool\Component\StorageUtils\Saver\SaverInterface;
15			use Akeneo\Tool\Component\StorageUtils\Updater\ObjectUpdaterInterface;
16			use Akeneo\UserManagement\Bundle\Context\UserContext;
17			use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
18			use Akeneo\Pim\Enrichment\Component\Product\Repository\ProductRepositoryInterface;
19			use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
20			use Symfony\Component\Validator\Validator\ValidatorInterface;
21
22			/**
23			* Test to ensure the services used by the bundle are available in the currently
24			* used Akeneo version. This makes future updates easier, as this test can provide
25			* a first indication if something critical may have changed. It does not replace manual
26			* testing, as it only checks for service availability and not if the services undergone
27			* a significant change.
28			*/
29			class CheckUsedServicesTest extends KernelTestCase
30			{
31			/**
32			* Boot symfony kernel before executing any tests
33			*/
34			protected function setUp(): void
35			{
36			self::bootKernel();
37			}
38
39			/**
40			* @dataProvider usedServicesDataProvider
41			*
42			* @param string $serviceName
43			* @param string $expectedType
44			*/
45			public function testUsedServiceIsAvailable(string $serviceName, string $expectedType): void {
46			self::assertTrue(
47			static::$container->has($serviceName),
48			sprintf('Service %s seems to not exist but is required by the bundle!', $serviceName)
49			);
50			self::assertInstanceOf(
51			$expectedType,
52			static::$container->get($serviceName),
53			sprintf('Service %s must be an instance of %s!', $serviceName, $expectedType)
54			);
55			}
56
57			/**
58			* @return string[][]
59			*/
60			public function usedServicesDataProvider(): array {
61			return [
62			// Used in both places
63			'Attribute Repository' => [
64			'pim_catalog.repository.attribute',
65			AttributeRepositoryInterface::class
66			],
67			'External API Serializer' => [
68			'pim_external_api_serializer',
69			NormalizerInterface::class
70			],
71			'Product Validator' => [
72			'pim_catalog.validator.product',
73			ValidatorInterface::class
74			],
75			'Normalizer Violation' => [
76			'pim_enrich.normalizer.violation',
77			NormalizerInterface::class
78			],
79			'Product Builder' => [
80			'pim_catalog.builder.product',
81			ProductBuilderInterface::class
82			],
83			// Only used for product models
84			'Product Model Repository' => [
85			'pim_catalog.repository.product_model',
86			ProductModelRepositoryInterface::class
87			],
88			'Product Model Factory' => [
89			'pim_catalog.factory.product_model',
90			SimpleFactoryInterface::class
91			],
92			'Product Model Updater' => [
93			'pim_catalog.updater.product_model',
94			ObjectUpdaterInterface::class
95			],
96			'Product Model Saver' => [
97			'pim_catalog.saver.product_model',
98			SaverInterface::class
99			],
100			// Only used for products
101			'Product Repository' => [
102			'pim_catalog.repository.product',
103			ProductRepositoryInterface::class
104			],
105			'Product Updater' => [
106			'pim_catalog.updater.product',
107			ObjectUpdaterInterface::class
108			],
109			'Product Saver' => [
110			'pim_catalog.saver.product',
111			SaverInterface::class
112			],
113			'User Context' => [
114			'pim_user.context.user',
115			UserContext::class
116			],
117			'Localizer Converter' => [
118			'pim_catalog.localization.localizer.converter',
119			AttributeConverterInterface::class
120			],
121			'Comparator Product Filter ' => [
122			'pim_catalog.comparator.filter.product',
123			FilterInterface::class
124			],
125			'Enrich to Standard product Value Converter' => [
126			'pim_enrich.converter.enrich_to_standard.product_value',
127			ConverterInterface::class
128			],
129
130			];
131			}
132			}
133

Flagbit / akeneo-product-cloner

Pull Request — master (#33)

CheckUsedServicesTest::usedServicesDataProvider() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like