You are here

Home » API reference » Commerce Core 8.2 » ProductVariationAttributeMapperTest.php

class ProductVariationAttributeMapperTest in Commerce Core 8.2

Tests the product variation attribute mapper.

@coversDefaultClass \Drupal\commerce_product\ProductVariationAttributeMapper

@group commerce

Hierarchy

Expanded class hierarchy of ProductVariationAttributeMapperTest

File

modules/product/tests/src/Kernel/ProductVariationAttributeMapperTest.php, line 21

Namespace

Drupal\Tests\commerce_product\Kernel
View source 
class ProductVariationAttributeMapperTest extends CommerceKernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'path',
    'commerce_product',
  ];

  /**
   * The attribute field manager.
   *
   * @var \Drupal\commerce_product\ProductAttributeFieldManagerInterface
   */
  protected $attributeFieldManager;

  /**
   * The variation attribute value mapper.
   *
   * @var \Drupal\commerce_product\ProductVariationAttributeMapperInterface
   */
  protected $mapper;

  /**
   * The color attributes values.
   *
   * @var \Drupal\commerce_product\Entity\ProductAttributeValue[]
   */
  protected $colorAttributes;

  /**
   * The size attribute values.
   *
   * @var \Drupal\commerce_product\Entity\ProductAttributeValue[]
   */
  protected $sizeAttributes;

  /**
   * The RAM attribute values.
   *
   * @var \Drupal\commerce_product\Entity\ProductAttributeValue[]
   */
  protected $ramAttributes;

  /**
   * The Disk 1 attribute values.
   *
   * @var \Drupal\commerce_product\Entity\ProductAttributeValue[]
   */
  protected $disk1Attributes;

  /**
   * The Disk 2 attribute values.
   *
   * @var \Drupal\commerce_product\Entity\ProductAttributeValue[]
   */
  protected $disk2Attributes;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('commerce_product_variation');
    $this
      ->installEntitySchema('commerce_product');
    $this
      ->installEntitySchema('commerce_product_attribute');
    $this
      ->installEntitySchema('commerce_product_attribute_value');
    $this
      ->installConfig([
      'commerce_product',
    ]);
    $this->attributeFieldManager = $this->container
      ->get('commerce_product.attribute_field_manager');
    $this->mapper = $this->container
      ->get('commerce_product.variation_attribute_mapper');
    $variation_type = ProductVariationType::load('default');
    $this->colorAttributes = $this
      ->createAttributeSet($variation_type, 'color', [
      'black' => 'Black',
      'blue' => 'Blue',
      'green' => 'Green',
      'red' => 'Red',
      'white' => 'White',
      'yellow' => 'Yellow',
    ]);
    $this->sizeAttributes = $this
      ->createAttributeSet($variation_type, 'size', [
      'small' => 'Small',
      'medium' => 'Medium',
      'large' => 'Large',
    ]);
    $this->ramAttributes = $this
      ->createAttributeSet($variation_type, 'ram', [
      '4gb' => '4GB',
      '8gb' => '8GB',
      '16gb' => '16GB',
      '32gb' => '32GB',
    ]);
    $this->disk1Attributes = $this
      ->createAttributeSet($variation_type, 'disk1', [
      '1tb' => '1TB',
      '2tb' => '2TB',
      '3tb' => '3TB',
    ]);
    $this->disk2Attributes = $this
      ->createAttributeSet($variation_type, 'disk2', [
      '1tb' => '1TB',
      '2tb' => '2TB',
      '3tb' => '3TB',
    ], FALSE);
    $user = $this
      ->createUser([], [
      'administer commerce_product',
    ]);
    $this->container
      ->get('current_user')
      ->setAccount($user);
  }

  /**
   * Tests selecting a variation.
   *
   * @covers ::selectVariation
   */
  public function testSelect() {
    $product = $this
      ->generateThreeByTwoScenario();
    $variations = $product
      ->getVariations();

    // No attribute values.
    $selected_variation = $this->mapper
      ->selectVariation($product
      ->getVariations());
    $this
      ->assertNull($selected_variation);

    // Empty attribute values.
    $selected_variation = $this->mapper
      ->selectVariation($product
      ->getVariations(), [
      'attribute_color' => '',
      'attribute_size' => '',
    ]);
    $this
      ->assertNull($selected_variation);

    // Missing first attribute.
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_color' => '',
      'attribute_size' => $this->sizeAttributes['large']
        ->id(),
    ]);
    $this
      ->assertNull($selected_variation);

    // Single attribute value.
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_color' => $this->colorAttributes['blue']
        ->id(),
    ]);
    $this
      ->assertEquals($variations[3]
      ->id(), $selected_variation
      ->id());
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_size' => $this->sizeAttributes['large']
        ->id(),
    ]);
    $this
      ->assertEquals($variations[2]
      ->id(), $selected_variation
      ->id());

    // Two attribute values.
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_color' => $this->colorAttributes['red']
        ->id(),
      'attribute_size' => $this->sizeAttributes['large']
        ->id(),
    ]);
    $this
      ->assertEquals($variations[2]
      ->id(), $selected_variation
      ->id());

    // Invalid attribute combination.
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_color' => $this->colorAttributes['blue']
        ->id(),
      'attribute_size' => $this->sizeAttributes['large']
        ->id(),
    ]);
    $this
      ->assertEquals($variations[3]
      ->id(), $selected_variation
      ->id());
    $this
      ->assertEquals('Blue', $selected_variation
      ->getAttributeValue('attribute_color')
      ->label());
    $this
      ->assertEquals('Small', $selected_variation
      ->getAttributeValue('attribute_size')
      ->label());
  }

  /**
   * Tests selecting a variation when there are optional attributes.
   *
   * @covers ::selectVariation
   */
  public function testSelectWithOptionalAttributes() {
    $product = $this
      ->generateThreeByTwoOptionalScenario();
    $variations = $product
      ->getVariations();
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_ram' => $this->ramAttributes['16gb']
        ->id(),
    ]);
    $this
      ->assertEquals($variations[1]
      ->id(), $selected_variation
      ->id());
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_ram' => $this->ramAttributes['16gb']
        ->id(),
      'attribute_disk1' => $this->disk1Attributes['1tb']
        ->id(),
      'attribute_disk2' => $this->disk2Attributes['1tb']
        ->id(),
    ]);
    $this
      ->assertEquals($variations[2]
      ->id(), $selected_variation
      ->id());
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_ram' => $this->ramAttributes['16gb']
        ->id(),
      'attribute_disk1' => $this->disk1Attributes['1tb']
        ->id(),
      'attribute_disk2' => $this->disk2Attributes['2tb']
        ->id(),
    ]);

    // Falls back to 16GBx1TB, 16GBx1TBx2TB is invalid.
    $this
      ->assertEquals($variations[1]
      ->id(), $selected_variation
      ->id());
  }

  /**
   * Tests preparing attributes.
   *
   * @covers ::prepareAttributes
   */
  public function testPrepareAttributes() {
    $product = $this
      ->generateThreeByTwoScenario();
    $variations = $product
      ->getVariations();

    // Test from the initial variation.
    $attributes = $this->mapper
      ->prepareAttributes(reset($variations), $variations);
    $color_attribute = $attributes['attribute_color'];
    $this
      ->assertEquals('color', $color_attribute
      ->getId());
    $this
      ->assertEquals('Color', $color_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $color_attribute
      ->getElementType());
    $this
      ->assertTrue($color_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '2' => 'Blue',
      '4' => 'Red',
    ], $color_attribute
      ->getValues());
    $size_attribute = $attributes['attribute_size'];
    $this
      ->assertEquals('size', $size_attribute
      ->getId());
    $this
      ->assertEquals('Size', $size_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $size_attribute
      ->getElementType());
    $this
      ->assertTrue($size_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '7' => 'Small',
      '8' => 'Medium',
      '9' => 'Large',
    ], $size_attribute
      ->getValues());

    // Test Blue Medium.
    $attributes = $this->mapper
      ->prepareAttributes($variations[4], $variations);
    $color_attribute = $attributes['attribute_color'];
    $this
      ->assertEquals('color', $color_attribute
      ->getId());
    $this
      ->assertEquals('Color', $color_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $color_attribute
      ->getElementType());
    $this
      ->assertTrue($color_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '2' => 'Blue',
      '4' => 'Red',
    ], $color_attribute
      ->getValues());
    $size_attribute = $attributes['attribute_size'];
    $this
      ->assertEquals('size', $size_attribute
      ->getId());
    $this
      ->assertEquals('Size', $size_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $size_attribute
      ->getElementType());
    $this
      ->assertTrue($size_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '7' => 'Small',
      '8' => 'Medium',
    ], $size_attribute
      ->getValues());
  }

  /**
   * Tests preparing attributes when there are optional attributes.
   *
   * @covers ::prepareAttributes
   */
  public function testPrepareAttributesOptional() {
    $product = $this
      ->generateThreeByTwoOptionalScenario();
    $variations = $product
      ->getVariations();

    // Test from the initial variation.
    $attributes = $this->mapper
      ->prepareAttributes(reset($variations), $variations);
    $ram_attribute = $attributes['attribute_ram'];
    $this
      ->assertEquals('ram', $ram_attribute
      ->getId());
    $this
      ->assertEquals('Ram', $ram_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $ram_attribute
      ->getElementType());
    $this
      ->assertTrue($ram_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '11' => '8GB',
      '12' => '16GB',
    ], $ram_attribute
      ->getValues());
    $disk1_attribute = $attributes['attribute_disk1'];
    $this
      ->assertEquals('disk1', $disk1_attribute
      ->getId());
    $this
      ->assertEquals('Disk1', $disk1_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk1_attribute
      ->getElementType());
    $this
      ->assertTrue($disk1_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '14' => '1TB',
    ], $disk1_attribute
      ->getValues());

    // The Disk 2 1TB option should not show. Only "none".
    // The default variation is 8GB x 1TB, which does not have the Disk 2 value
    // so it should only return "_none". The Disk 2 option should have only have
    // this option is the 16GB RAM option is chosen.
    $disk2_attribute = $attributes['attribute_disk2'];
    $this
      ->assertEquals('disk2', $disk2_attribute
      ->getId());
    $this
      ->assertEquals('Disk2', $disk2_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk2_attribute
      ->getElementType());
    $this
      ->assertFalse($disk2_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '_none' => '',
    ], $disk2_attribute
      ->getValues());

    // Test from the 16GB x 1TB x None variation.
    $attributes = $this->mapper
      ->prepareAttributes($variations[1], $variations);
    $ram_attribute = $attributes['attribute_ram'];
    $this
      ->assertEquals('ram', $ram_attribute
      ->getId());
    $this
      ->assertEquals('Ram', $ram_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $ram_attribute
      ->getElementType());
    $this
      ->assertTrue($ram_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '11' => '8GB',
      '12' => '16GB',
    ], $ram_attribute
      ->getValues());
    $disk1_attribute = $attributes['attribute_disk1'];
    $this
      ->assertEquals('disk1', $disk1_attribute
      ->getId());
    $this
      ->assertEquals('Disk1', $disk1_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk1_attribute
      ->getElementType());
    $this
      ->assertTrue($disk1_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '14' => '1TB',
    ], $disk1_attribute
      ->getValues());
    $disk2_attribute = $attributes['attribute_disk2'];
    $this
      ->assertEquals('disk2', $disk2_attribute
      ->getId());
    $this
      ->assertEquals('Disk2', $disk2_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk2_attribute
      ->getElementType());
    $this
      ->assertFalse($disk2_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '_none' => '',
      '17' => '1TB',
    ], $disk2_attribute
      ->getValues());
  }

  /**
   * Tests preparing attributes when the values are mutually exclusive.
   *
   * @covers ::prepareAttributes
   */
  public function testMutuallyExclusiveAttributeMatrixTwoByTwoByTwo() {
    $product = Product::create([
      'type' => 'default',
      'title' => $this
        ->randomMachineName(),
      'stores' => [
        $this->store,
      ],
      'variations' => [],
    ]);
    $attribute_values_matrix = [
      [
        '4gb',
        '2tb',
        '2tb',
      ],
      [
        '8gb',
        '1tb',
        '2tb',
      ],
      [
        '8gb',
        '2tb',
        '1tb',
      ],
    ];
    $variations = [];
    foreach ($attribute_values_matrix as $key => $value) {
      $variation = ProductVariation::create([
        'type' => 'default',
        'sku' => $this
          ->randomMachineName(),
        'price' => [
          'number' => 999,
          'currency_code' => 'USD',
        ],
        'attribute_ram' => $this->ramAttributes[$value[0]],
        'attribute_disk1' => $this->disk1Attributes[$value[1]],
        'attribute_disk2' => isset($this->disk2Attributes[$value[2]]) ? $this->disk2Attributes[$value[2]] : NULL,
      ]);
      $variation
        ->save();
      $variations[] = $variation;
      $product
        ->addVariation($variation);
    }
    $product
      ->save();

    // Test from the initial variation.
    $attributes = $this->mapper
      ->prepareAttributes(reset($variations), $variations);
    $ram_attribute = $attributes['attribute_ram'];
    $this
      ->assertEquals('ram', $ram_attribute
      ->getId());
    $this
      ->assertEquals('Ram', $ram_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $ram_attribute
      ->getElementType());
    $this
      ->assertTrue($ram_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '11' => '8GB',
      '10' => '4GB',
    ], $ram_attribute
      ->getValues());
    $disk1_attribute = $attributes['attribute_disk1'];
    $this
      ->assertEquals('disk1', $disk1_attribute
      ->getId());
    $this
      ->assertEquals('Disk1', $disk1_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk1_attribute
      ->getElementType());
    $this
      ->assertTrue($disk1_attribute
      ->isRequired());
    $this
      ->assertNotCount(3, $disk1_attribute
      ->getValues(), 'Out of the three available attribute values, only the one used is returned.');
    $this
      ->assertCount(1, $disk1_attribute
      ->getValues());
    $this
      ->assertEquals([
      '15' => '2TB',
    ], $disk1_attribute
      ->getValues());
    $disk2_attribute = $attributes['attribute_disk2'];
    $this
      ->assertEquals('disk2', $disk2_attribute
      ->getId());
    $this
      ->assertEquals('Disk2', $disk2_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk2_attribute
      ->getElementType());
    $this
      ->assertFalse($disk2_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '18' => '2TB',
    ], $disk2_attribute
      ->getValues());

    // Test 8GB x 1TB x 2TB.
    $attributes = $this->mapper
      ->prepareAttributes($variations[1], $variations);
    $ram_attribute = $attributes['attribute_ram'];
    $this
      ->assertEquals('ram', $ram_attribute
      ->getId());
    $this
      ->assertEquals('Ram', $ram_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $ram_attribute
      ->getElementType());
    $this
      ->assertTrue($ram_attribute
      ->isRequired());
    $this
      ->assertNotCount(4, $ram_attribute
      ->getValues(), 'Out of the four available attribute values, only the two used are returned.');
    $this
      ->assertCount(2, $ram_attribute
      ->getValues());
    $this
      ->assertEquals([
      '11' => '8GB',
      '10' => '4GB',
    ], $ram_attribute
      ->getValues());
    $disk1_attribute = $attributes['attribute_disk1'];
    $this
      ->assertEquals('disk1', $disk1_attribute
      ->getId());
    $this
      ->assertEquals('Disk1', $disk1_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk1_attribute
      ->getElementType());
    $this
      ->assertTrue($disk1_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '15' => '2TB',
      '14' => '1TB',
    ], $disk1_attribute
      ->getValues());
    $disk2_attribute = $attributes['attribute_disk2'];
    $this
      ->assertEquals('disk2', $disk2_attribute
      ->getId());
    $this
      ->assertEquals('Disk2', $disk2_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk2_attribute
      ->getElementType());
    $this
      ->assertFalse($disk2_attribute
      ->isRequired());

    // There should only be one Disk 2 option, since the other 8GB RAM option
    // has a Disk 1 value of 2TB.
    $this
      ->assertEquals([
      '18' => '2TB',
    ], $disk2_attribute
      ->getValues());

    // Test 8GB x 2TB x 1TB.
    $attributes = $this->mapper
      ->prepareAttributes($variations[2], $variations);
    $ram_attribute = $attributes['attribute_ram'];
    $this
      ->assertEquals('ram', $ram_attribute
      ->getId());
    $this
      ->assertEquals('Ram', $ram_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $ram_attribute
      ->getElementType());
    $this
      ->assertTrue($ram_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '11' => '8GB',
      '10' => '4GB',
    ], $ram_attribute
      ->getValues());
    $disk1_attribute = $attributes['attribute_disk1'];
    $this
      ->assertEquals('disk1', $disk1_attribute
      ->getId());
    $this
      ->assertEquals('Disk1', $disk1_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk1_attribute
      ->getElementType());
    $this
      ->assertTrue($disk1_attribute
      ->isRequired());
    $this
      ->assertEquals([
      '15' => '2TB',
      '14' => '1TB',
    ], $disk1_attribute
      ->getValues());
    $disk2_attribute = $attributes['attribute_disk2'];
    $this
      ->assertEquals('disk2', $disk2_attribute
      ->getId());
    $this
      ->assertEquals('Disk2', $disk2_attribute
      ->getLabel());
    $this
      ->assertEquals('select', $disk2_attribute
      ->getElementType());
    $this
      ->assertFalse($disk2_attribute
      ->isRequired());

    // There should only be one Disk 2 option, since the other 8GB RAM option
    // has a Disk 1 value of 2TB.
    $this
      ->assertEquals([
      '17' => '1TB',
    ], $disk2_attribute
      ->getValues());
  }

  /**
   * Tests having three attributes and six variations.
   *
   * @covers ::selectVariation
   * @covers ::prepareAttributes
   */
  public function testThreeAttributesSixVariations() {
    $variation_type = ProductVariationType::load('default');
    $pack = $this
      ->createAttributeSet($variation_type, 'pack', [
      'one' => '1',
      'twenty' => '20',
      'hundred' => '100',
      'twohundred' => '200',
    ]);
    $product = Product::create([
      'type' => 'default',
      'title' => $this
        ->randomMachineName(),
      'stores' => [
        $this->store,
      ],
      'variations' => [],
    ]);
    $product
      ->save();

    // The Size attribute needs a lighter weight than Color for this scenario.
    // @todo This is an undocumented item, where the order of the attributes on
    // the form display correlate to how they display in the widget / returned
    // values.
    $form_display = commerce_get_entity_display('commerce_product_variation', $variation_type
      ->id(), 'form');
    $form_display
      ->setComponent('attribute_size', [
      'weight' => 0,
    ] + $form_display
      ->getComponent('attribute_size'));
    $form_display
      ->setComponent('attribute_color', [
      'weight' => 1,
    ] + $form_display
      ->getComponent('attribute_color'));
    $form_display
      ->setComponent('attribute_pack', [
      'weight' => 2,
    ] + $form_display
      ->getComponent('attribute_pack'));
    $form_display
      ->save();
    $attribute_values_matrix = [
      [
        'small',
        'black',
        'one',
      ],
      [
        'small',
        'blue',
        'twenty',
      ],
      [
        'medium',
        'green',
        'hundred',
      ],
      [
        'medium',
        'red',
        'twohundred',
      ],
      [
        'large',
        'white',
        'hundred',
      ],
      [
        'large',
        'yellow',
        'twenty',
      ],
    ];
    $variations = [];
    foreach ($attribute_values_matrix as $key => $value) {
      $variation = ProductVariation::create([
        'type' => 'default',
        'sku' => $this
          ->randomMachineName(),
        'price' => [
          'number' => 999,
          'currency_code' => 'USD',
        ],
        'attribute_size' => $this->sizeAttributes[$value[0]],
        'attribute_color' => $this->colorAttributes[$value[1]],
        'attribute_pack' => $pack[$value[2]],
      ]);
      $variation
        ->save();
      $variations[] = $variation;
      $product
        ->addVariation($variation);
    }
    $product
      ->save();

    // Verify available attribute selections for the default variation.
    $selected_variation = $product
      ->getDefaultVariation();
    $attributes = $this->mapper
      ->prepareAttributes($selected_variation, $product
      ->getVariations());
    $size_attribute = $attributes['attribute_size'];
    $this
      ->assertEquals([
      '7' => 'Small',
      '8' => 'Medium',
      '9' => 'Large',
    ], $size_attribute
      ->getValues());
    $color_attribute = $attributes['attribute_color'];
    $this
      ->assertEquals([
      '2' => 'Blue',
      '1' => 'Black',
    ], $color_attribute
      ->getValues());
    $pack_attribute = $attributes['attribute_pack'];

    // The resolved variation is Small -> Black -> 1, cannot choose 20 for the
    // pack size, since that is Small -> Blue -> 20.
    $this
      ->assertEquals([
      '20' => '1',
    ], $pack_attribute
      ->getValues());
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_size' => $this->sizeAttributes['small']
        ->id(),
      'attribute_color' => $this->colorAttributes['blue']
        ->id(),
    ]);
    $this
      ->assertEquals($variations[1]
      ->id(), $selected_variation
      ->id());

    // Medium only has Green & Red as color, so selecting this size should
    // cause the color to reset.
    $selected_variation = $this->mapper
      ->selectVariation($variations, [
      'attribute_size' => $this->sizeAttributes['medium']
        ->id(),
      'attribute_color' => $this->colorAttributes['blue']
        ->id(),
    ]);
    $this
      ->assertEquals($variations[2]
      ->id(), $selected_variation
      ->id());
    $this
      ->assertEquals('Medium', $selected_variation
      ->getAttributeValue('attribute_size')
      ->label());
    $this
      ->assertEquals('Green', $selected_variation
      ->getAttributeValue('attribute_color')
      ->label());
    $this
      ->assertEquals('100', $selected_variation
      ->getAttributeValue('attribute_pack')
      ->label());

    // Verify available attribute selections.
    $attributes = $this->mapper
      ->prepareAttributes($selected_variation, $product
      ->getVariations());
    $size_attribute = $attributes['attribute_size'];
    $this
      ->assertEquals([
      '7' => 'Small',
      '8' => 'Medium',
      '9' => 'Large',
    ], $size_attribute
      ->getValues());
    $color_attribute = $attributes['attribute_color'];
    $this
      ->assertEquals([
      '3' => 'Green',
      '4' => 'Red',
    ], $color_attribute
      ->getValues());
    $pack_attribute = $attributes['attribute_pack'];

    // The resolved variation is Medium -> Green -> 100, cannot choose 200 for
    // the pack size, since that is Medium -> Red -> 200.
    $this
      ->assertEquals([
      '22' => '100',
    ], $pack_attribute
      ->getValues());
  }

  /**
   * Generates a three by two scenario.
   *
   * There are three sizes and two colors. Missing one color option.
   * Generated product variations:
   *   [ RS, RM, RL ]
   *   [ BS, BM, X  ]
   *
   * @return \Drupal\commerce_product\Entity\ProductInterface
   *   The product.
   */
  protected function generateThreeByTwoScenario() {
    $product = Product::create([
      'type' => 'default',
      'title' => $this
        ->randomMachineName(),
      'stores' => [
        $this->store,
      ],
      'variations' => [],
    ]);
    $attribute_values_matrix = [
      [
        'red',
        'small',
      ],
      [
        'red',
        'medium',
      ],
      [
        'red',
        'large',
      ],
      [
        'blue',
        'small',
      ],
      [
        'blue',
        'medium',
      ],
    ];
    $variations = [];
    foreach ($attribute_values_matrix as $key => $value) {
      $variation = ProductVariation::create([
        'type' => 'default',
        'sku' => $this
          ->randomMachineName(),
        'price' => [
          'number' => 999,
          'currency_code' => 'USD',
        ],
        'attribute_color' => $this->colorAttributes[$value[0]],
        'attribute_size' => $this->sizeAttributes[$value[1]],
      ]);
      $variation
        ->save();
      $variations[] = $variation;
      $product
        ->addVariation($variation);
    }
    $product
      ->save();
    return $product;
  }

  /**
   * Generates a three by two (optional) scenario.
   *
   * Generated product variations:
   *   [ 8GBx1TB,    X        , X ]
   *   [    X   , 16GBx1TB    , X ]
   *   [    X   , 16GBx1TBx1TB, X ]
   *
   * @return \Drupal\commerce_product\Entity\ProductInterface
   *   The product.
   */
  protected function generateThreeByTwoOptionalScenario() {
    $product = Product::create([
      'type' => 'default',
      'title' => $this
        ->randomMachineName(),
      'stores' => [
        $this->store,
      ],
      'variations' => [],
    ]);
    $attribute_values_matrix = [
      [
        '8gb',
        '1tb',
        '',
      ],
      [
        '16gb',
        '1tb',
        '',
      ],
      [
        '16gb',
        '1tb',
        '1tb',
      ],
    ];
    $variations = [];
    foreach ($attribute_values_matrix as $key => $value) {
      $variation = ProductVariation::create([
        'type' => 'default',
        'sku' => $this
          ->randomMachineName(),
        'price' => [
          'number' => 999,
          'currency_code' => 'USD',
        ],
        'attribute_ram' => $this->ramAttributes[$value[0]],
        'attribute_disk1' => $this->disk1Attributes[$value[1]],
        'attribute_disk2' => isset($this->disk2Attributes[$value[2]]) ? $this->disk2Attributes[$value[2]] : NULL,
      ]);
      $variation
        ->save();
      $variations[] = $variation;
      $product
        ->addVariation($variation);
    }
    $product
      ->save();
    return $product;
  }

  /**
   * Creates an attribute field and set of attribute values.
   *
   * @param \Drupal\commerce_product\Entity\ProductVariationTypeInterface $variation_type
   *   The variation type.
   * @param string $name
   *   The attribute field name.
   * @param array $options
   *   Associative array of key name values. [red => Red].
   * @param bool $required
   *   Whether the created attribute should be required.
   *
   * @return \Drupal\commerce_product\Entity\ProductAttributeValueInterface[]
   *   Array of attribute entities.
   */
  protected function createAttributeSet(ProductVariationTypeInterface $variation_type, $name, array $options, $required = TRUE) {
    $attribute = ProductAttribute::create([
      'id' => $name,
      'label' => ucfirst($name),
    ]);
    $attribute
      ->save();
    $this->attributeFieldManager
      ->createField($attribute, $variation_type
      ->id());

    // The field is always created as required by default.
    if (!$required) {
      $field = FieldConfig::loadByName('commerce_product_variation', $variation_type
        ->id(), 'attribute_' . $name);
      $field
        ->setRequired(FALSE);
      $field
        ->save();
    }
    $attribute_set = [];
    foreach ($options as $key => $value) {
      $attribute_set[$key] = $this
        ->createAttributeValue($name, $value);
    }
    return $attribute_set;
  }

  /**
   * Creates an attribute value.
   *
   * @param string $attribute
   *   The attribute ID.
   * @param string $name
   *   The attribute value name.
   *
   * @return \Drupal\commerce_product\Entity\ProductAttributeValueInterface
   *   The attribute value entity.
   */
  protected function createAttributeValue($attribute, $name) {
    $attribute_value = ProductAttributeValue::create([
      'attribute' => $attribute,
      'name' => $name,
    ]);
    $attribute_value
      ->save();
    return $attribute_value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
CommerceKernelTestBase::$store protected property The default store. 1
CommerceKernelTestBase::tearDown protected function Overrides KernelTestBase::tearDown
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
DeprecationSuppressionTrait::restoreErrorHandler protected function Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler protected function Sets an error handler to suppress specified deprecation messages.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
ProductVariationAttributeMapperTest::$attributeFieldManager protected property The attribute field manager.
ProductVariationAttributeMapperTest::$colorAttributes protected property The color attributes values.
ProductVariationAttributeMapperTest::$disk1Attributes protected property The Disk 1 attribute values.
ProductVariationAttributeMapperTest::$disk2Attributes protected property The Disk 2 attribute values.
ProductVariationAttributeMapperTest::$mapper protected property The variation attribute value mapper.
ProductVariationAttributeMapperTest::$modules public static property Modules to enable. Overrides CommerceKernelTestBase::$modules
ProductVariationAttributeMapperTest::$ramAttributes protected property The RAM attribute values.
ProductVariationAttributeMapperTest::$sizeAttributes protected property The size attribute values.
ProductVariationAttributeMapperTest::createAttributeSet protected function Creates an attribute field and set of attribute values.
ProductVariationAttributeMapperTest::createAttributeValue protected function Creates an attribute value.
ProductVariationAttributeMapperTest::generateThreeByTwoOptionalScenario protected function Generates a three by two (optional) scenario.
ProductVariationAttributeMapperTest::generateThreeByTwoScenario protected function Generates a three by two scenario.
ProductVariationAttributeMapperTest::setUp protected function Overrides CommerceKernelTestBase::setUp
ProductVariationAttributeMapperTest::testMutuallyExclusiveAttributeMatrixTwoByTwoByTwo public function Tests preparing attributes when the values are mutually exclusive.
ProductVariationAttributeMapperTest::testPrepareAttributes public function Tests preparing attributes.
ProductVariationAttributeMapperTest::testPrepareAttributesOptional public function Tests preparing attributes when there are optional attributes.
ProductVariationAttributeMapperTest::testSelect public function Tests selecting a variation.
ProductVariationAttributeMapperTest::testSelectWithOptionalAttributes public function Tests selecting a variation when there are optional attributes.
ProductVariationAttributeMapperTest::testThreeAttributesSixVariations public function Tests having three attributes and six variations.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
StoreCreationTrait::createStore protected function Creates a store for the test.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser