@hmcts/media-viewer 4.2.0 → 4.2.4-exui-3994-f

package/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '2'
+
+services:
+  media-viewer:
+    build:
+      context: .
+      args:
+        - http_proxy
+        - https_proxy
+        - no_proxy
+    ports:
+      - 1337:1337

package/e2e/ci.protractor.conf.js

@@ -0,0 +1,50 @@
+// Protractor configuration file, see link for more information
+// https://github.com/angular/protractor/blob/master/lib/config.ts
+const path = require('path');
+
+exports.config = {
+  SELENIUM_PROMISE_MANAGER: false,
+  allScriptsTimeout: 120000,
+  getPageTimeout: 120000,
+  framework: 'custom',
+  frameworkPath: require.resolve('protractor-cucumber-framework'),
+  capabilities: {
+    browserName: 'chrome',
+    chromeOptions: {
+      args: ['--headless', '--window-size=1920,1080']
+    }
+  },
+  directConnect: true,
+  baseUrl: "http://em-showcase-aat.service.core-compute-aat.internal/media-viewer",
+  // Change baseUrl to the following line to run functional tests locally:
+  //baseUrl: "http://localhost:3000/",
+  specs: [
+    './src/**/*.feature',
+  ],
+  onPrepare: function () {
+    require('ts-node').register({
+      project: path.join(__dirname, './tsconfig.e2e.json')
+    });
+  },
+  cucumberOpts: {
+    compiler: 'ts:ts-node/register',
+    strict: true,
+    plugin: ['pretty'],
+    format: ['node_modules/cucumber-pretty', 'json:./functional-output/reports/cucumber.json'],
+    require: ['../e2e/src/step_definitions/*.ts'],
+    tags: "@ci",
+  },
+  plugins: [
+    {
+      package: 'protractor-multiple-cucumber-html-reporter-plugin',
+      options: {
+        automaticallyGenerateReport: true,
+        removeExistingJsonReportFile: true,
+        reportName: 'MediaViewer Functional Tests',
+        jsonDir: './functional-output/reports',
+        reportPath: './functional-output/reports/html'
+      }
+    }
+  ]
+};
+

package/e2e/cucumber.conf.js

@@ -0,0 +1,2 @@
+const { setDefaultTimeout } = require('cucumber');
+setDefaultTimeout(240 * 1000);

package/e2e/local.protractor.conf.js

@@ -0,0 +1,45 @@
+exports.config = {
+  SELENIUM_PROMISE_MANAGER: false,
+  allScriptsTimeout: 120000,
+  getPageTimeout: 120000,
+  framework: 'custom',
+  frameworkPath: require.resolve('protractor-cucumber-framework'),
+  capabilities: {
+    browserName: 'chrome',
+    chromeOptions: {
+      // 'args': ['--no-sandbox', '--start-maximized', 'use-fake-ui-for-media-stream'],
+      args: ['--headless', '--window-size=1920,1080']
+    }
+  },
+  directConnect: true,
+  baseUrl: 'http://localhost:1337',
+  specs: [
+    './src/**/*.feature',
+  ],
+  onPrepare: function () {
+    require('ts-node').register({
+      project: require('path').join(__dirname, './tsconfig.e2e.json')
+    });
+  },
+  cucumberOpts: {
+    compiler: 'ts:ts-node/register',
+    strict: true,
+    plugin: ['pretty'],
+    format: ['node_modules/cucumber-pretty', 'json:./functional-output/reports/cucumber.json'],
+    require: ['../e2e/src/step_definitions/*.ts'],
+    tags: "@ci",
+  },
+
+  plugins: [
+    {
+      package: 'protractor-multiple-cucumber-html-reporter-plugin',
+      options: {
+        automaticallyGenerateReport: true,
+        removeExistingJsonReportFile: true,
+        reportName: 'MediaViewer Functional Tests',
+        jsonDir: './functional-output/reports',
+        reportPath: './functional-output/reports/html'
+      }
+    }
+  ]
+};

package/e2e/protractor.conf.js

@@ -0,0 +1,65 @@
+// Protractor configuration file, see link for more information
+// https://github.com/angular/protractor/blob/master/lib/config.ts
+
+const { SpecReporter } = require('jasmine-spec-reporter');
+const fs = require('fs');
+
+exports.config = {
+  allScriptsTimeout: 11000,
+  specs: [
+    './src/**/*.e2e-spec.ts'
+  ],
+// Firefox local setup
+  exclude: ['./src/**/download.e2e-spec.ts', "./src/**/print.e2e-spec.ts"],
+  capabilities: {
+    browserName: 'chrome',
+  },
+// // Chrome local setup
+//   capabilities: {
+//     browserName: 'chrome',
+//     chromeOptions: {
+//       prefs: {
+//         download: {
+//           'prompt_for_download': false,
+//           'default_directory': require('path').join(__dirname, 'src/downloads')
+//         }
+//       }
+//     }
+//   },
+  directConnect: true,
+  baseUrl: 'http://localhost:3000/',
+  framework: 'jasmine',
+  jasmineNodeOpts: {
+    showColors: true,
+    defaultTimeoutInterval: 30000,
+    print: function() {}
+  },
+  onPrepare() {
+    require('ts-node').register({
+      project: require('path').join(__dirname, './tsconfig.e2e.json')
+    });
+    jasmine.getEnv().addReporter(new SpecReporter({ spec: { displayStacktrace: true } }));
+    removePreviousDownloads();
+  },
+  onCleanUp() {
+    removePreviousDownloads();
+  }
+};
+
+function removePreviousDownloads() {
+  try {
+    const downloadsPath = 'e2e/src/downloads';
+    const files = fs.readdirSync(downloadsPath);
+    if (files.length > 0)
+      for (let i = 0; i < files.length; i++) {
+        let filePath = downloadsPath + '/' + files[i];
+        if (fs.statSync(filePath).isFile()) {
+          fs.unlinkSync(filePath);
+        }
+      }
+  }
+  catch(e) {
+    console.log('protractor.conf', e);
+    return e;
+  }
+}

package/e2e/reports.js

@@ -0,0 +1,15 @@
+const reporter = require('cucumberjs-allure-reporter');
+const fs = require('fs');
+const mkdirp = require('mkdirp');
+
+const xmlReports = `${process.cwd()}/reports/xml`;
+
+// var createXmlDir = (function() {
+//     if (!fs.existsSync(xmlReports)) {
+//         mkdirp.sync(xmlReports);
+//     }
+// })();
+
+reporter.config({ targetDir: xmlReports });
+
+module.exports = reporter;

package/e2e/saucelabs.conf.js

@@ -0,0 +1,91 @@
+const tsNode = require('ts-node');
+const path = require('path');
+const minimist = require('minimist');
+const argv = minimist(process.argv.slice(2));
+const supportedBrowsers = require('./supportedBrowsers');
+
+const config = {
+  framework: 'custom',
+  frameworkPath: require.resolve('protractor-cucumber-framework'),
+  cucumberOpts: {
+    require: [
+      './cucumber.conf.js',
+      './src/step_definitions/*.ts'
+    ],
+    compiler: 'ts:ts-node/register',
+    tags: ['@crossbrowser'],
+    keepAlive: false,
+    profile: false,
+    'fail-fast': false,
+    'no-source': true,
+    strict: true,
+    format: ['node_modules/cucumber-pretty', 'json:./cb_reports/saucelab_results.json'],
+  },
+
+  sauceSeleniumAddress: 'ondemand.eu-central-1.saucelabs.com:443/wd/hub',
+  host: 'ondemand.eu-central-1.saucelabs.com',
+  sauceRegion: 'eu',
+  port: 80,
+  processes:23,
+  sauceConnect: true,
+  // sauceProxy: 'http://proxyout.reform.hmcts.net:8080',  // Proxy for the REST API
+  sauceUser: process.env.SAUCE_USERNAME,
+  sauceKey: process.env.SAUCE_ACCESS_KEY,
+  SAUCE_REST_ENDPOINT: 'https://eu-central-1.saucelabs.com/rest/v1/',
+
+  specs: [
+    './src/features/comments.panel.feature',
+    './src/features/navigation.feature',
+    './src/features/search.feature',
+    './src/features/zoom.feature'
+  ],
+
+  baseUrl: (process.env.TEST_URL || 'http://localhost:3000/').replace('https', 'http'),
+  allScriptsTimeout: 220000,
+  useAllAngular2AppRoots: true,
+  multiCapabilities: supportedBrowsers.multiCapabilities,
+  maxSessions: 7,
+
+  plugins: [
+    {
+      package: 'protractor-multiple-cucumber-html-reporter-plugin',
+      options: {
+        automaticallyGenerateReport: true,
+        removeExistingJsonReportFile: true,
+        reportName: 'Media Viewer CrossBrowser Tests',
+        jsonDir: 'reports/tests/crossbrowser',
+        reportPath: 'reports/tests/crossbrowser',
+        displayDuration: true,
+        durationInMS: false
+      }
+    }
+  ],
+
+  onPrepare() {
+    // const caps = browser.getCapabilities();
+    // browser.manage()
+    //   .window()
+    //   .maximize();
+
+    browser.getCapabilities().then(function (caps) {
+      browser.browserName = caps.get('browserName');
+    });
+
+    browser.waitForAngularEnabled(false);
+
+    tsNode.register({
+      project: path.join(__dirname, './tsconfig.e2e.json')
+    });
+  },
+
+  onComplete() {
+    return browser.getProcessedConfig().then(function (c) {
+      return browser.getSession().then(function (session) {
+        // required to be here so saucelabs picks up reports to put in jenkins
+        console.log('SauceOnDemandSessionID=' + session.getId() + ' job-name=mv-xb-tests');
+      });
+    });
+  }
+};
+
+exports.config = config;

package/e2e/src/app.e2e-spec.ts

@@ -0,0 +1,16 @@
+import { AppPage } from './pages/app.po';
+
+describe('media viewer app', () => {
+  let page: AppPage;
+
+  beforeEach(async () => {
+    page = new AppPage();
+    await page.preparePage();
+  });
+
+
+  it('should display header', async () => {
+    const headerText = await page.getHeaderText();
+    expect(headerText).toEqual('Media Viewer Demo');
+  });
+});

package/e2e/src/common/constants.js

@@ -0,0 +1,18 @@
+const BrowserType = {
+  CHROME: 'chrome',
+  SAFARI: 'Safari',
+  FIREFOX: 'firefox',
+  EDGE: 'edge'
+};
+
+const TestScenarioName = {
+  ZOOM_INOUT: 'PDF Viewer Zoom In/Out',
+  COLLATE_COMMENTS_OVERLAY_PANEL: 'Collate Comments Overlay Panel',
+  NAVIGATION: 'PDF Viewer Page Navigation',
+  SEARCH: 'Enable Search within a document'
+};
+
+module.exports = {
+  BrowserType,
+  TestScenarioName
+};

package/e2e/src/features/bookmarks.feature

@@ -0,0 +1,31 @@
+@MediaViewer @Bookmarks
+Feature: Bookmarks Features Create,Delete and Update
+
+  Background:
+    Given I am on Media Viewer Page
+    Then I expect the page header to be "MEDIA VIEWER DEMO"
+    And I expect no existing bookmarks present
+
+  @ci
+  Scenario: Delete a bookmark
+    When I highlight text to be bookmarked on the PDF document
+    Then I capture the text highlight popup
+    And  I am able to add a bookmark and verify it has been created 1 bookmark
+    And I expect bookmark to be added to the existing list
+    And I am able to delete a bookmark and verify it has been deleted
+
+  @ci
+  Scenario: Update a bookmark
+    When I highlight text to be bookmarked on the PDF document
+    Then I capture the text highlight popup
+    And  I am able to add a bookmark and verify it has been created 1 bookmark
+    And I expect bookmark to be added to the existing list
+    And I am able to update a bookmark with text 'bookmark_update' and verify it has been updated
+
+  @ci
+  Scenario: Add a bookmark to a highlighted phrase on the PDF
+    When I highlight text to be bookmarked on the PDF document
+    Then I capture the text highlight popup
+    And  I am able to add a bookmark and verify it has been created 1 bookmark
+    And I expect bookmark to be added to the existing list
+

package/e2e/src/features/comments.panel.feature

@@ -0,0 +1,35 @@
+@MediaViewer
+Feature: Comments Panel E2E
+
+  Background:
+    Given I am on Media Viewer Page
+    Then I expect the page header to be "MEDIA VIEWER DEMO"
+
+  @CommentsTab @crossbrowser
+  Scenario: Check whether the comments panel is disappearing or not?
+    When The user clicks on the show comments panel
+    Then I expect to see comments panel should appear
+    When I click the close button
+    Then I expect comments panel should disappear
+
+  @AddComment
+  Scenario: Add comment
+    When I click Annotate button
+    Then I expect Annotate button must be enabled
+    When I highlight text on a PDF document
+    Then I should be able to add comment for the highlight
+
+  @CommentsPanelSearch
+  Scenario: Show And Hide the Comments Panel
+    When The user clicks on the show comments panel
+    And  I expect to be able to click on the Filter Search And Comments Tab
+    When I Search for Comments
+    Then No matching results have been found
+
+  @CommentsPanelCollateComments @CommentsTab @ci
+  Scenario: Collate Comments Overlay Panel
+    When The user clicks on the show comments panel toggle icon
+    And The user clicks on Collate Comments
+    Then The comment summary is displayed
+
+

package/e2e/src/features/custom.toolbar.feature

@@ -0,0 +1,87 @@
+@Custom_Toolbar
+Feature: Custom Toolbar Feature
+
+  Background:
+    Given I am on Media Viewer Page
+    Then I expect the page header to be "MEDIA VIEWER DEMO"
+    When I enable custom toolbar
+    Then I expect custom toolbar should be enabled
+
+  @Custom_Toolbar_Step_Navigation
+  Scenario Outline: Navigate to the next page using custom toolbar
+    When I click next button on the pdf
+    Then I should see next page number should be '<page_number>'
+
+    When I click previous button on the pdf
+    Then I expect the page navigation should take me to the expected "<page_number2>"
+#    Then I should see previous page number should be '<page_number2>'
+
+    Examples:
+      | page_number | page_number2 |
+      | 2           | 1            |
+
+  @Custom_Toolbar_Input_Navigation
+  Scenario Outline: Enable page navigation within a file
+    When I enter valid page number in page navigation text box:"<page_number>"
+    Then I expect the page navigation should take me to the expected "<page_number>"
+
+    Examples:
+      | page_number |
+      | 7           |
+
+  @Custom_Toolbar_Rotation
+  Scenario Outline: PDF Rotation
+    When I use the custom toolbar "<PDF_Or_Image>" viewer rotate feature
+    Then I must rotate the "<PDF/Image>" document
+
+    Examples:
+      | PDF/Image | PDF_Or_Image |
+      | pdf       | pdf          |
+
+  @Custom_Toolbar_Rotation_Image
+  Scenario Outline: Image Rotation
+    When I use the custom toolbar "<PDF_Or_Image>" viewer rotate feature
+    Then I must rotate the "<PDF/Image>" document
+
+    Examples:
+      | PDF/Image | PDF_Or_Image |
+      | image     | image        |
+
+  @Custom_Toolbar_Zoom
+  Scenario Outline: PDF Viewer Zoom In/Out
+    When I use zoom feature for "<pdf_or_image>" viewer
+    Then I must able to zoom by defined zoom_option:<zoom_option>, <pdf_or_image>
+
+    Examples:
+      | pdf_or_image | zoom_option |
+      | pdf          | 150%        |
+      | image        | 150%        |
+
+  @Custom_Toolbar_MultipleWords_Search
+  Scenario Outline: Enable Search within a document
+    When the user populate the content search field with a '<keyword_search>'
+    Then the "<search_results_count>" are displayed and highlighted to the user
+    And the section of the document is viewable to the user
+
+    Examples:
+      | keyword_search | search_results_count |
+      | family court    | 1 of 5 matches      |
+
+  @Custom_Toolbar_SingleWord_Search
+  Scenario Outline: Enable Search within a document
+    When the user populate the content search field with a '<search_word>'
+    Then the "<search_results_count>" are displayed and highlighted to the user
+    And the section of the document is viewable to the user
+
+    Examples:
+      | search_word  | search_results_count |
+      | children | 1 of 88 matches       |
+
+  @Custom_Toolbar_No_Search_Results
+  Scenario Outline: Enable Search within a document
+    When the user populate the content search field with a '<search_word>'
+    Then the "<search_results_count>" are displayed and highlighted to the user
+
+    Examples:
+      | search_word | search_results_count |
+      | Phani Perla | Phrase not found     |

package/e2e/src/features/download.feature

@@ -0,0 +1,11 @@
+@MediaViewer
+Feature: Document Download
+
+  Background:
+    Given I am on Media Viewer Page
+    Then I expect the page header to be "MEDIA VIEWER DEMO"
+
+  @EM-3566 @Download
+  Scenario: Verify whether the user able to download the document or not?
+    When the user selects the download option
+    Then I expect to see the document should be downloaded

package/e2e/src/features/image.viewer.annotations.feature

@@ -0,0 +1,24 @@
+@MediaViewer @Annotations
+Feature: Image Viewer Annotations
+
+  Background:
+    Given I am on Media Viewer Page
+    And I change to Image Viewer tab
+
+  @EM-1964 @Image_Add_Comment
+  Scenario: Add Non Textual Highlight and add comment in image viewer
+    When I highlight a portion of image
+    Then I should be able to add comment for the highlight
+#    Then The context toolbar should disappear
+
+  @EM-1968 @EM-1348 @Image_Delete_Comment
+  Scenario: Delete Non Textual comment in image viewer
+    Given The image has atleast one non-textual comment
+    When I select a non-textual comment and delete
+    Then The comment should be deleted
+
+  @EM-1347 @Image_Update_Comment
+  Scenario: Update Non Textual comment in image viewer
+    Given The image has atleast one non-textual comment
+    When I update a non-textual comment and save
+    Then The old comment should be replaced with new comment

package/e2e/src/features/multimedia.audio.feature

@@ -0,0 +1,22 @@
+@MediaViewer
+Feature: Multimedia Audio E2E
+
+  Background:
+    Given I am on Media Viewer Page
+    Then I expect the page header to be "MEDIA VIEWER DEMO"
+    When I select the multimedia option
+
+  @EM-4018 @play @ci
+  Scenario: Check whether the audio player is working or not?
+    And I click "play" option
+    Then I should see "audio" in play mode
+
+  @EM-4018 @pause @ci
+  Scenario: Pause Video
+    And I click "pause" option
+    Then I should see "audio" in "pause" mode
+
+  @rewind @ci
+  Scenario: Rewind Audio
+    And I click "rewind" option
+    Then I should see "audio" in "rewind" mode

package/e2e/src/features/multimedia.feature

@@ -0,0 +1,24 @@
+@MediaViewer
+Feature: Multimedia Video E2E Scenarios
+
+  As a user I want to see multi-media video functionality should work as expected
+
+  Background:
+    Given I am on Media Viewer Page
+    Then I expect the page header to be "MEDIA VIEWER DEMO"
+    When I select the multimedia option
+
+  @EM-4000 @play @ci
+  Scenario: Check whether the video player is working or not?
+    And I click "play" option
+    Then I should see "video" in play mode
+
+  @EM-4000 @pause
+  Scenario: Pause Video
+    And I click "pause" option
+    Then I should see "video" in "pause" mode
+
+  @rewind @ci
+  Scenario: Rewind Video
+    And I click "rewind" option
+    Then I should see "video" in "rewind" mode

package/e2e/src/features/navigation.feature

@@ -0,0 +1,33 @@
+@MediaViewer @Navigation
+Feature: Navigation
+
+  Background:
+    Given I am on Media Viewer Page
+    Then I expect the page header to be "MEDIA VIEWER DEMO"
+
+  @Toggle_Buttons
+  Scenario: Enable Toolbar Toggle buttons
+    When I enable toggle buttons
+    Then I expect toolbar buttons should be enabled
+
+  @PDF_Page_Navigation @ci @crossbrowser
+  Scenario Outline: PDF Viewer Page Navigation
+    When I click next button on the pdf
+    Then I should see next page number should be '<page_number>'
+
+    When I click previous button on the pdf
+    Then I expect the page navigation should take me to the expected "<page_number2>"
+#    Then I should see previous page number should be '<page_number2>'
+
+    Examples:
+      | page_number | page_number2 |
+      | 2           | 1            |
+
+  @EM-1245 @crossbrowser
+  Scenario Outline: Enable page navigation within a file
+    When I enter valid page number in page navigation text box:"<page_number>"
+    Then I expect the page navigation should take me to the expected "<page_number>"
+
+    Examples:
+      | page_number |
+      | 7           |

package/e2e/src/features/outline.feature

@@ -0,0 +1,28 @@
+@MediaViewer @Outline
+Feature: PDF Viewer outline and bookmark
+
+  Background:
+    Given I am on Media Viewer Page
+
+  @EM-2090 @ci
+  Scenario: Navigate through outline and bookmark
+    When I open document outline sidebar
+    Then I should be able to see bundle node and expand
+
+  @EM-2090
+  Scenario Outline: Navigate through outline and bookmark
+    When I open document outline sidebar
+    And I choose to navigate to "<link>"
+    Then I expect the page navigation should take me to the expected "<page_number>"
+
+    Examples:
+      |link|page_number|
+      |Bundle>A. Section A - Chronology>Prepared Discharge Final Order|4|
+      |Bundle>E. Section D - Care Plans>Prepared Discharge Final Order|20|
+
+  @ci
+  Scenario: Navigate through show bookmarks
+    When I clear existing bookmarks
+    And add a new bookmark
+    And I open document outline sidebar and click show bookmarks
+    Then I expect 1 bookmark is present in bookmarks list