fix example module

acquia · Aug 3, 2023 · ea3bc73 · ea3bc73
1 parent 7f7fc15
commit ea3bc73
Show file tree

Hide file tree

Showing 7 changed files with 108 additions and 95 deletions.
diff --git a/.phpunit.cache/test-results b/.phpunit.cache/test-results
diff --git a/example/src/ExampleComplexity.php b/example/src/ExampleComplexity.php
@@ -3,25 +3,27 @@
 /**
  * An example class to provide some cyclomatic complexity for PHPLOC to report.
  */
-class ExampleComplexity {
+class ExampleComplexity
+{
 
-  /**
-   * Creates some cyclomatic complexity.
-   *
-   * @return int
-   *   An arbitrary number.
-   */
-  public function createComplexity(): int {
-    $x = 0;
-    for ($y = 0; $y < 10; $y++) {
-      try {
-        $x += random_int(0, 10);
-      }
-      catch (Exception $e) {
-        $x++;
-      }
+    /**
+     * Creates some cyclomatic complexity.
+     *
+     * @return int
+     *   An arbitrary number.
+     */
+    public function createComplexity(): int
+    {
+        $x = 0;
+        for ($y = 0; $y < 10; $y++) {
+            try {
+                $x += random_int(0, 10);
+            }
+            catch (Exception $e) {
+                $x++;
+            }
+        }
+        return $x;
     }
-    return $x;
-  }
 
 }
diff --git a/example/tests/Drupal/Nightwatch/Tests/exampleTest.js b/example/tests/Drupal/Nightwatch/Tests/exampleTest.js
@@ -1,17 +1,17 @@
 // noinspection JSUnusedGlobalSymbols
 module.exports = {
-  '@tags': ['example'],
-  before(browser) {
-    browser.drupalInstall();
-  },
-  after(browser) {
-    browser.drupalUninstall();
-  },
-  'Test page': browser => {
-    browser
-      .drupalRelativeURL('/')
-      .waitForElementVisible('body', 1000)
-      .assert.containsText('body', 'Log in')
-      .drupalLogAndEnd({ onlyOnError: "FALSE" });
-  },
+    '@tags': ['example'],
+    before(browser) {
+        browser.drupalInstall();
+    },
+    after(browser) {
+        browser.drupalUninstall();
+    },
+    'Test page': browser => {
+        browser
+        .drupalRelativeURL('/')
+        .waitForElementVisible('body', 1000)
+        .assert.containsText('body', 'Log in')
+        .drupalLogAndEnd({ onlyOnError: "FALSE" });
+    },
 };
diff --git a/example/tests/src/Functional/ExampleLoginTest.php b/example/tests/src/Functional/ExampleLoginTest.php
@@ -4,19 +4,21 @@
 
 use Drupal\Tests\BrowserTestBase;
 
-class ExampleLoginTest extends BrowserTestBase {
+class ExampleLoginTest extends BrowserTestBase
+{
 
-  protected $defaultTheme = 'claro';
+    protected $defaultTheme = 'claro';
 
-  private $privilegedUser;
+    private $privilegedUser;
 
-  public function testExampleLogin(): void {
-    $this->privilegedUser = $this->drupalCreateUser();
-    $this->drupalLogin($this->privilegedUser);
+    public function testExampleLogin(): void
+    {
+        $this->privilegedUser = $this->drupalCreateUser();
+        $this->drupalLogin($this->privilegedUser);
 
-    $this->drupalGet('user');
-    $this->assertSession()->statusCodeEquals(200);
+        $this->drupalGet('user');
+        $this->assertSession()->statusCodeEquals(200);
 
-  }
+    }
 
 }
diff --git a/example/tests/src/FunctionalJavascript/ExampleHomeLinkTest.php b/example/tests/src/FunctionalJavascript/ExampleHomeLinkTest.php
@@ -4,14 +4,16 @@
 
 use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
 
-class ExampleHomeLinkTest extends WebDriverTestBase {
+class ExampleHomeLinkTest extends WebDriverTestBase
+{
 
-  protected $defaultTheme = 'claro';
+    protected $defaultTheme = 'claro';
 
-  public function testHomePageLink(): void {
-    $page = $this->getSession()->getPage();
-    $content = $page->findLink('Log in');
-    $this->assertTrue($content->isVisible());
-  }
+    public function testHomePageLink(): void
+    {
+        $page = $this->getSession()->getPage();
+        $content = $page->findLink('Log in');
+        $this->assertTrue($content->isVisible());
+    }
 
 }
diff --git a/example/tests/src/Unit/ExampleUnitTest.php b/example/tests/src/Unit/ExampleUnitTest.php
@@ -7,44 +7,49 @@
 /**
  * Provides an example PHPUnit test for ORCA.
  */
-class ExampleUnitTest extends TestCase {
-
-  /**
-   * Demonstrates designating a test to run only during own builds.
-   */
-  public function testPrivatePseudoGroup(): void {
-    self::assertTrue(TRUE, 'Performed private test.');
-  }
-
-  /**
-   * Demonstrates designating a test to run during OTHER packages' builds.
-   *
-   * @group orca_public
-   */
-  public function testPublicGroup(): void {
-    self::assertTrue(TRUE, 'Performed public test.');
-  }
-
-  /**
-   * Demonstrates designating a test to never run by ORCA.
-   *
-   * @group orca_ignore
-   */
-  public function testIgnoreGroup(): void {
-    self::fail('Ran ignored test.');
-  }
-
-  /**
-   * Demonstrates ignoring deprecated code in test files.
-   *
-   * This function is private so that it will not be run by PHPUnit
-   * because this is only for static analysis.
-   *
-   * phpcs:disable DrupalPractice.Objects.UnusedPrivateMethod.UnusedMethod
-   */
-  private function testDeprecateCodeInTestFiles(): void {
-    // This is a deprecated function which should not be caught by drupal-check.
-    file_create_url("https://example.com");
-  }
+class ExampleUnitTest extends TestCase
+{
+
+    /**
+     * Demonstrates designating a test to run only during own builds.
+     */
+    public function testPrivatePseudoGroup(): void
+    {
+        self::assertTrue(true, 'Performed private test.');
+    }
+
+    /**
+     * Demonstrates designating a test to run during OTHER packages' builds.
+     *
+     * @group orca_public
+     */
+    public function testPublicGroup(): void
+    {
+        self::assertTrue(true, 'Performed public test.');
+    }
+
+    /**
+     * Demonstrates designating a test to never run by ORCA.
+     *
+     * @group orca_ignore
+     */
+    public function testIgnoreGroup(): void
+    {
+        self::fail('Ran ignored test.');
+    }
+
+    /**
+     * Demonstrates ignoring deprecated code in test files.
+     *
+     * This function is private so that it will not be run by PHPUnit
+     * because this is only for static analysis.
+     *
+     * phpcs:disable DrupalPractice.Objects.UnusedPrivateMethod.UnusedMethod
+     */
+    private function testDeprecateCodeInTestFiles(): void
+    {
+        // This is a deprecated function which should not be caught by drupal-check.
+        file_create_url("https://example.com");
+    }
 
 }
diff --git a/example/vendor/ExampleFailingTest.php b/example/vendor/ExampleFailingTest.php
@@ -9,13 +9,15 @@
  * run by ORCA. This failing test is used to verify that ORCA excludes the
  * vendor directory as expected.
  */
-class ExampleFailingTest extends TestCase {
+class ExampleFailingTest extends TestCase
+{
 
-  /**
-   * ORCA should never run this test.
-   */
-  public function testExcludeVendorDirectory(): void {
-    self::assertTrue(FALSE);
-  }
+    /**
+     * ORCA should never run this test.
+     */
+    public function testExcludeVendorDirectory(): void
+    {
+        self::assertTrue(false);
+    }
 
 }