Merge pull request #1 from digitalutsc/feat/add-ci-and-linting

feat/add-ci-and-linting

Author: kylehuynh205

.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  islandora-module-ci:
+    uses: digitalutsc/reusable_workflows/.github/workflows/islandora-module-ci.yml@main
+    with:
+      module_name: serve_iiif_file
+      install_chromedriver: true

composer.json

@@ -2,5 +2,6 @@
   "name": "islandora_lite/serve_iiif_file",
   "type": "drupal-module",
   "description": "Gets static IIIF files for the Islandora mirador viewer",
-  "keywords": ["Drupal"]
+  "keywords": ["Drupal"],
+  "require": {}
 }

serve_iiif_file.info.yml

@@ -1,4 +1,4 @@
 type: module
 name: Serve IIIF File
 description: Serve iiif files which can be configured in the backend.
-core_version_requirement: ^8 || ^9 || ^10
+core_version_requirement: ^8 || ^9 || ^10 || ^11

serve_iiif_file.routing.yml

@@ -8,4 +8,4 @@ serve_iiif_file.content:
   options:
     parameters:
       book_node:
-        type: entity:node
+        type: entity:node

src/Controller/ServeIIIFFileController.php

@@ -9,12 +9,12 @@
 use Symfony\Component\HttpFoundation\Response;
 
 /**
- *
+ * Controller for serving IIIF manifest files.
  */
 class ServeIIIFFileController {
 
   /**
-   *
+   * Serves IIIF manifest files.
    */
   public function content(NodeInterface $book_node) {
 

tests/src/Functional/LoadTest.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Drupal\Tests\serve_iiif_file\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
+
+/**
+ * Simple test to ensure that main page loads with module enabled.
+ *
+ * @group serve_iiif_file
+ */
+#[RunTestsInSeparateProcesses]
+class LoadTest extends BrowserTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected $defaultTheme = 'stark';
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  protected static $modules = ['serve_iiif_file'];
+
+  /**
+   * A user with permissions required to access the configuration form.
+   *
+   * @var \Drupal\user\UserInterface
+   */
+  protected $user;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp(): void {
+    parent::setUp();
+    $this->user = $this->drupalCreateUser([
+      'access administration pages',
+      'administer site configuration',
+    ]);
+    $this->drupalLogin($this->user);
+  }
+
+  /**
+   * Tests that the home page loads with a 200 response.
+   */
+  public function testLoad(): void {
+    $this->drupalGet('<front>');
+    $this->assertSession()->statusCodeEquals(200);
+  }
+
+}