Merge pull request #204 from reportportal/develop

Release 5.3.4

.github/workflows/CI-pipeline.yml

@@ -37,5 +37,5 @@ jobs:
         run: npm install
       - name: Run lint
         run: npm run lint
-#      - name: Run tests and check coverage
-#        run: npm run test:coverage
+      - name: Run tests and check coverage
+        run: npm run test:coverage

.github/workflows/publish.yml

@@ -31,8 +31,8 @@ jobs:
         run: npm install
       - name: Run lint
         run: npm run lint
-#      - name: Run tests and check coverage
-#        run: npm run test:coverage
+      - name: Run tests and check coverage
+        run: npm run test:coverage
 
   publish-to-npm-and-gpr:
     needs: build

CHANGELOG.md

@@ -1,3 +1,5 @@
+### Fixed
+- Video attachment won't play after downloading, resolves [#202](https://github.com/reportportal/agent-js-cypress/issues/202). Thanks to [ashvinjaiswal](https://github.com/ashvinjaiswal).
 
 ## [5.3.3] - 2024-08-15
 ### Added

VERSION

@@ -1 +1 @@
-5.3.3
+5.3.4-SNAPSHOT

jest.config.js

@@ -28,6 +28,7 @@ module.exports = {
     '!lib/ipcServer.js',
     '!lib/testStatuses.js',
     '!lib/worker.js',
+    '!lib/utils/attachments.js',
   ],
   coverageThreshold: {
     global: {

lib/reporter.js

@@ -175,11 +175,11 @@ class Reporter {
   }
 
   finishSuiteWithVideo(suiteInfo, suiteFinishObj) {
-    const uploadVideoOnPasses = this.config.uploadVideoOnPasses || false;
+    const uploadVideoForNonFailedSpec = this.config.uploadVideoForNonFailedSpec || false;
     const suiteFailed = suiteFinishObj.status === testItemStatuses.FAILED;
 
-    // do not upload video if root suite passes and uploadVideoOnPasses is false
-    if ((!suiteFailed && !uploadVideoOnPasses) || !suiteInfo.testFileName) {
+    // do not upload video if root suite not failed and uploadVideoForNonFailedSpec is false
+    if ((!suiteFailed && !uploadVideoForNonFailedSpec) || !suiteInfo.testFileName) {
       this.finishSuite(suiteFinishObj, suiteInfo.tempId);
     } else {
       const sendVideoPromise = this.sendVideo(suiteInfo).finally(() => {

lib/utils/attachments.js

@@ -0,0 +1,134 @@
+/*
+ *  Copyright 2024 EPAM Systems
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+const fs = require('fs');
+const glob = require('glob');
+const path = require('path');
+
+const fsPromises = fs.promises;
+
+const DEFAULT_WAIT_FOR_FILE_TIMEOUT = 10000;
+const DEFAULT_WAIT_FOR_FILE_INTERVAL = 500;
+
+const getScreenshotAttachment = async (absolutePath) => {
+  if (!absolutePath) return absolutePath;
+  const name = absolutePath.split(path.sep).pop();
+  return {
+    name,
+    type: 'image/png',
+    content: await fsPromises.readFile(absolutePath, { encoding: 'base64' }),
+  };
+};
+
+async function getFilePathByGlobPattern(globFilePattern) {
+  const files = await glob.glob(globFilePattern);
+
+  if (files.length) {
+    return files[0];
+  }
+
+  return null;
+}
+/*
+ * The moov atom in an MP4 file is a crucial part of the file’s structure. It contains metadata about the video, such as the duration, display characteristics, and timing information.
+ * Function check for the moov atom in file content and ensure is video file ready.
+ */
+const checkVideoFileReady = async (videoFilePath) => {
+  try {
+    const fileData = await fsPromises.readFile(videoFilePath);
+
+    if (fileData.includes('moov')) {
+      return true;
+    }
+  } catch (e) {
+    throw new Error(`Error reading file: ${e.message}`);
+  }
+
+  return false;
+};
+
+const waitForVideoFile = (
+  globFilePattern,
+  timeout = DEFAULT_WAIT_FOR_FILE_TIMEOUT,
+  interval = DEFAULT_WAIT_FOR_FILE_INTERVAL,
+) =>
+  new Promise((resolve, reject) => {
+    let filePath = null;
+    let totalFileWaitingTime = 0;
+
+    async function checkFileExistsAndReady() {
+      if (!filePath) {
+        filePath = await getFilePathByGlobPattern(globFilePattern);
+      }
+      let isVideoFileReady = false;
+
+      if (filePath) {
+        isVideoFileReady = await checkVideoFileReady(filePath);
+      }
+
+      if (isVideoFileReady) {
+        resolve(filePath);
+      } else if (totalFileWaitingTime >= timeout) {
+        reject(
+          new Error(
+            `Timeout of ${timeout}ms reached, file ${globFilePattern} not found or not ready yet.`,
+          ),
+        );
+      } else {
+        totalFileWaitingTime += interval;
+        setTimeout(checkFileExistsAndReady, interval);
+      }
+    }
+
+    checkFileExistsAndReady().catch(reject);
+  });
+
+const getVideoFile = async (
+  specFileName,
+  videosFolder = '**',
+  timeout = DEFAULT_WAIT_FOR_FILE_TIMEOUT,
+  interval = DEFAULT_WAIT_FOR_FILE_INTERVAL,
+) => {
+  if (!specFileName) {
+    return null;
+  }
+  const fileName = specFileName.toLowerCase().endsWith('.mp4')
+    ? specFileName
+    : `${specFileName}.mp4`;
+  const globFilePath = `**/${videosFolder}/${fileName}`;
+  let videoFilePath;
+
+  try {
+    videoFilePath = await waitForVideoFile(globFilePath, timeout, interval);
+  } catch (e) {
+    console.warn(e.message);
+    return null;
+  }
+
+  return {
+    name: fileName,
+    type: 'video/mp4',
+    content: await fsPromises.readFile(videoFilePath, { encoding: 'base64' }),
+  };
+};
+
+module.exports = {
+  getScreenshotAttachment,
+  getVideoFile,
+  waitForVideoFile,
+  getFilePathByGlobPattern,
+  checkVideoFileReady,
+};

lib/utils/common.js

@@ -0,0 +1,22 @@
+/*
+ *  Copyright 2024 EPAM Systems
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+const getCodeRef = (testItemPath, testFileName) =>
+  `${testFileName.replace(/\\/g, '/')}/${testItemPath.join('/')}`;
+
+module.exports = {
+  getCodeRef,
+};

lib/utils/index.js

@@ -0,0 +1,27 @@
+/*
+ *  Copyright 2024 EPAM Systems
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+const attachmentUtils = require('./attachments');
+const commonUtils = require('./common');
+const objectCreators = require('./objectCreators');
+const specCountCalculation = require('./specCountCalculation');
+
+module.exports = {
+  ...attachmentUtils,
+  ...commonUtils,
+  ...objectCreators,
+  ...specCountCalculation,
+};