WorkflowTest.php

<?php

namespace Drupal\Tests\jsonapi\Functional;

use Drupal\Core\Url;
use Drupal\workflows\Entity\Workflow;

/**
 * JSON:API integration test for the "Workflow" config entity type.
 *
 * @group jsonapi
 */
class WorkflowTest extends ConfigEntityResourceTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'workflows',
        'workflow_type_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $entityTypeId = 'workflow';
    
    /**
     * {@inheritdoc}
     */
    protected static $resourceTypeName = 'workflow--workflow';
    
    /**
     * {@inheritdoc}
     *
     * @var \Drupal\shortcut\ShortcutSetInterface
     */
    protected $entity;
    
    /**
     * {@inheritdoc}
     */
    protected function setUpAuthorization($method) {
        $this->grantPermissionsToTestedRole([
            'administer workflows',
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createEntity() {
        $workflow = Workflow::create([
            'id' => 'rest_workflow',
            'label' => 'REST Workflow',
            'type' => 'workflow_type_complex_test',
        ]);
        $workflow->getTypePlugin()
            ->addState('draft', 'Draft')
            ->addState('published', 'Published');
        $configuration = $workflow->getTypePlugin()
            ->getConfiguration();
        $configuration['example_setting'] = 'foo';
        $configuration['states']['draft']['extra'] = 'bar';
        $workflow->getTypePlugin()
            ->setConfiguration($configuration);
        $workflow->save();
        return $workflow;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedDocument() {
        $self_url = Url::fromUri('base:/jsonapi/workflow/workflow/' . $this->entity
            ->uuid())
            ->setAbsolute()
            ->toString(TRUE)
            ->getGeneratedUrl();
        return [
            'jsonapi' => [
                'meta' => [
                    'links' => [
                        'self' => [
                            'href' => 'http://jsonapi.org/format/1.0/',
                        ],
                    ],
                ],
                'version' => '1.0',
            ],
            'links' => [
                'self' => [
                    'href' => $self_url,
                ],
            ],
            'data' => [
                'id' => $this->entity
                    ->uuid(),
                'type' => 'workflow--workflow',
                'links' => [
                    'self' => [
                        'href' => $self_url,
                    ],
                ],
                'attributes' => [
                    'dependencies' => [
                        'module' => [
                            'workflow_type_test',
                        ],
                    ],
                    'label' => 'REST Workflow',
                    'langcode' => 'en',
                    'status' => TRUE,
                    'workflow_type' => 'workflow_type_complex_test',
                    'type_settings' => [
                        'states' => [
                            'draft' => [
                                'extra' => 'bar',
                                'label' => 'Draft',
                                'weight' => 0,
                            ],
                            'published' => [
                                'label' => 'Published',
                                'weight' => 1,
                            ],
                        ],
                        'transitions' => [],
                        'example_setting' => 'foo',
                    ],
                    'drupal_internal__id' => 'rest_workflow',
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getPostDocument() {
        // @todo Update in https://www.drupal.org/node/2300677.
        return [];
    }

}