You are here

Home » API reference » Build Hooks 8.2 » CircleBuildHookTest.php

class CircleBuildHookTest in Build Hooks 8.2

Same name and namespace in other branches
  1. 3.x modules/build_hooks_circleci/tests/src/Kernel/CircleBuildHookTest.php \Drupal\Tests\build_hooks_circleci\Kernel\CircleBuildHookTest

Defines a class for testing circle CI build hooks module.

@group build_hooks_circleci

Hierarchy

Expanded class hierarchy of CircleBuildHookTest

File

modules/build_hooks_circleci/tests/src/Kernel/CircleBuildHookTest.php, line 17

Namespace

Drupal\Tests\build_hooks_circleci\Kernel
View source 
class CircleBuildHookTest extends BuildHooksKernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'build_hooks_circleci',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig('system');
    $this
      ->installConfig('build_hooks_circleci');
  }

  /**
   * Tests default settings.
   */
  public function testDefaultSettings() {
    $this
      ->assertSame('', $this
      ->config('build_hooks_circleci.settings')
      ->get('circleci_api_key'));
  }

  /**
   * Tests deployment hooks.
   */
  public function testDeploymentHooks() {
    $api_key = $this
      ->randomMachineName();
    $this
      ->config('build_hooks_circleci.settings')
      ->set('circleci_api_key', $api_key)
      ->save();
    $project = $this
      ->randomMachineName();
    $branch = $this
      ->randomMachineName();
    $expected_url = 'https://circleci.com/api/v1.1/project/github/' . $project . '/build?circle-token=' . $api_key;
    $request = $this
      ->assertFrontendEnvironmentBuildHook('circleci', TriggerInterface::DEPLOYMENT_STRATEGY_ENTITYSAVE, $expected_url, [
      'project' => $project,
      'branch' => $branch,
    ]);
    $this
      ->assertEquals(json_encode([
      'branch' => $branch,
    ]), (string) $request
      ->getBody());
  }

  /**
   * Tests deployment hooks for version 2.
   */
  public function testDeploymentHooksV2() {
    $project = $this
      ->randomMachineName();
    $branch = $this
      ->randomMachineName();
    $parameter_name = $this
      ->randomMachineName();
    $parameter_value = $this
      ->randomMachineName();
    $api_key = $this
      ->randomMachineName();
    $expected_url = 'https://circleci.com/api/v2/project/gh/' . $project . '/pipeline';
    $request = $this
      ->assertFrontendEnvironmentBuildHook('circleciv2', Trigger::DEPLOYMENT_STRATEGY_ENTITYSAVE, $expected_url, [
      'project' => $project,
      'type' => 'branch',
      'reference' => $branch,
      'parameters' => [
        [
          'name' => $parameter_name,
          'value' => $parameter_value,
          'type' => 'string',
        ],
        [
          'name' => 'param2',
          'value' => '2',
          'type' => 'integer',
        ],
        [
          'name' => 'param3',
          'value' => '0',
          'type' => 'boolean',
        ],
        [
          'name' => 'param4',
          'value' => 'true',
          'type' => 'boolean',
        ],
      ],
      'token' => $api_key,
    ]);
    $this
      ->assertEquals(json_encode([
      'branch' => $branch,
      'parameters' => [
        $parameter_name => $parameter_value,
        'param2' => 2,
        'param3' => FALSE,
        'param4' => TRUE,
      ],
    ]), (string) $request
      ->getBody());
    $this
      ->assertEquals([
      'application/json',
    ], $request
      ->getHeader('Content-Type'));
    $this
      ->assertEquals([
      'Basic ' . base64_encode($api_key . ':'),
    ], $request
      ->getHeader('Authorization'));
    $this
      ->assertEquals('POST', $request
      ->getMethod());
  }

  /**
   * Tests deployment info.
   */
  public function testDeploymentInfo() {
    $directory = dirname(__FILE__, 3) . '/fixtures';
    $this
      ->mockClient(new Response('200', [], file_get_contents($directory . '/builds.json')), new Response('200', [], file_get_contents($directory . '/workflow-1.json')), new Response('200', [], file_get_contents($directory . '/workflow-2.json')), new Response('200', [], file_get_contents($directory . '/workflow-3.json')), new Response('200', [], file_get_contents($directory . '/workflow-4.json')), new Response('200', [], file_get_contents($directory . '/workflow-5.json')), new Response('200', [], file_get_contents($directory . '/builds.json')), new Response('500', [], json_encode([])), new Response('500', [], json_encode([])), new Response('500', [], json_encode([])), new Response('500', [], json_encode([])), new Response('500', [], json_encode([])), new Response('500', [], json_encode([])));
    $title = $this
      ->randomMachineName();

    /** @var \Drupal\build_hooks\Entity\FrontendEnvironment $environment */
    $project = 'foo/bar';
    $environment = FrontendEnvironment::create([
      'id' => 'foo',
      'label' => $title,
      'settings' => [
        'provider' => 'build_hooks_circleci',
        'project' => $project,
        'type' => 'branch',
        'reference' => 'master',
        'parameters' => [],
        'token' => '12345678910',
      ],
      'plugin' => 'circleciv2',
      'deployment_strategy' => Trigger::DEPLOYMENT_STRATEGY_CRON,
    ]);
    $environment
      ->save();

    /** @var \Drupal\build_hooks\Plugin\FrontendEnvironmentInterface $plugin */
    $plugin = $environment
      ->getPlugin();
    $extra = $plugin
      ->getAdditionalDeployFormElements(new FormState())['builds'];
    $expected_url = 'https://circleci.com/api/v2/project/gh/' . $project . '/pipeline/mine?branch=master';
    $request = reset($this->history)['request'];
    $this
      ->assertEquals($expected_url, (string) $request
      ->getUri());
    $this
      ->assertEquals('table', $extra['#type']);
    $this
      ->assertCount(5, $extra['#rows']);
    $row = reset($extra['#rows']);
    $this
      ->assertEquals('https://app.circleci.com/pipelines/github/foo/bar/57/workflows/1be799d9-4607-4a48-8bc4-27b9dbcb0958', $row[3]['data']['#url']
      ->toString());
    $this
      ->assertEquals('Success', $row[2]);
    $this
      ->assertEquals('Canceled', end($extra['#rows'])[2]);

    // Now with error handling - workflows fail.
    $extra = $plugin
      ->getAdditionalDeployFormElements(new FormState())['builds'];
    foreach ($extra['#rows'] as $row) {
      $this
        ->assertEquals('Could not get workflows', $row[2]);
    }

    // Now with error handling - jobs fail.
    $extra = $plugin
      ->getAdditionalDeployFormElements(new FormState());
    $this
      ->assertEquals('Could not get list of recent builds', (string) $extra['error']['#markup']);
  }

}

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
BuildHooksKernelTestBase::$history protected property History of requests.
BuildHooksKernelTestBase::$mockClient protected property Mock client.
BuildHooksKernelTestBase::assertFrontendEnvironmentBuildHook protected function Assert a front-end environment build hook fires.
BuildHooksKernelTestBase::mockClient protected function Mocks the http-client.
CircleBuildHookTest::$modules protected static property Modules to enable. Overrides BuildHooksKernelTestBase::$modules
CircleBuildHookTest::setUp protected function Overrides BuildHooksKernelTestBase::setUp
CircleBuildHookTest::testDefaultSettings public function Tests default settings.
CircleBuildHookTest::testDeploymentHooks public function Tests deployment hooks.
CircleBuildHookTest::testDeploymentHooksV2 public function Tests deployment hooks for version 2.
CircleBuildHookTest::testDeploymentInfo public function Tests deployment info.
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.
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::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
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.
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.
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.