change plugin (#1663)

* change plugin

* fix

* fix upload

e2e/e2e-config/utils/build-number.js

@@ -1,10 +0,0 @@
-const buildNumber = () => {
-    let buildNumber = process.env.TRAVIS_BUILD_NUMBER;
-    if (!buildNumber) {
-        process.env.TRAVIS_BUILD_NUMBER = Date.now();
-    }
-
-    return process.env.TRAVIS_BUILD_NUMBER;
-}
-
-module.exports = buildNumber;

e2e/e2e-config/utils/upload-output.js

@@ -1,69 +1,67 @@
-const path = require('path');
 const fs = require('fs');
+const path = require('path');
 const AlfrescoApi = require('@alfresco/js-api').AlfrescoApiCompatibility;
-const buildNumber = require('./build-number');
-const configScreenshotsPath = path.join(`${path.resolve(__dirname)}/../../../e2e-output/screenshots/`);
-const rimraf = require('rimraf');
 
-uploadOutput = async function() {
+function buildNumber() {
+  let buildNumber = process.env.TRAVIS_BUILD_NUMBER;
+  if (!buildNumber) {
+    process.env.TRAVIS_BUILD_NUMBER = Date.now();
+  }
 
-    let alfrescoJsApi = new AlfrescoApi({ provider: 'ECM', hostEcm: process.env.SCREENSHOT_URL });
+  return process.env.TRAVIS_BUILD_NUMBER;
-    alfrescoJsApi.login(process.env.SCREENSHOT_USERNAME, process.env.SCREENSHOT_PASSWORD);
-
-    await saveScreenshots(alfrescoJsApi);
-
-    rimraf(configScreenshotsPath, function () {
-        console.log('done delete screenshot');
-    });
 }
 
-async function saveScreenshots(alfrescoJsApi) {
+async function uploadScreenshot(retryCount, suffixFileName) {
-    let files = fs.readdirSync(configScreenshotsPath);
+  console.log(`Start uploading report ${retryCount}`);
 
-    if (files && files.length > 0) {
+  let alfrescoJsApi = new AlfrescoApi({
+    provider: 'ECM',
+    hostEcm: process.env.SCREENSHOT_URL
+  });
 
-        let folder;
+  await alfrescoJsApi.login(process.env.SCREENSHOT_USERNAME, process.env.SCREENSHOT_PASSWORD);
 
-        try {
+  let folderNode;
-            folder = await alfrescoJsApi.nodes.addNode('-my-', {
-                'name': `screenshot`,
-                'relativePath': `Builds/ACA-${buildNumber()}`,
-                'nodeType': 'cm:folder'
-            }, {}, {
-                'overwrite': true
-            });
-        } catch (error) {
-            folder = await alfrescoJsApi.nodes.getNode('-my-', {
-                'relativePath': `Builds/ACA-${buildNumber()}/screenshot`,
-                'nodeType': 'cm:folder'
-            }, {}, {
-                'overwrite': true
-            });
-        }
 
-        for (const fileName of files) {
+  try {
-            let pathFile = path.join(configScreenshotsPath, fileName);
+    folderNode = await alfrescoJsApi.nodes.addNode('-my-', {
-            let file = fs.createReadStream(pathFile);
+      'name': `retry-${retryCount}`,
+      'relativePath': `Builds/ACA/${buildNumber()}/`,
+      'nodeType': 'cm:folder'
+    }, {}, {
+      'overwrite': true
+    });
+  } catch (error) {
+    folderNode = await alfrescoJsApi.nodes.getNode('-my-', {
+      'relativePath': `Builds/ACA/${buildNumber()}/retry-${retryCount}`,
+      'nodeType': 'cm:folder'
+    }, {}, {
+      'overwrite': true
+    });
+  }
 
-            let safeFileName = fileName.replace(new RegExp('"', 'g'), '');
+  fs.renameSync(path.resolve(__dirname, '../../e2e-output/'), path.resolve(__dirname, `../../e2e-output-${retryCount}/`))
 
-            try {
+  const child_process = require("child_process");
-                await alfrescoJsApi.upload.uploadFile(
+  child_process.execSync(` tar -czvf ../e2e-result-${suffixFileName}-${retryCount}.tar .`, {
-                    file,
+    cwd: path.resolve(__dirname, `../../e2e-output-${retryCount}/`)
-                    '',
+  });
-                    folder.entry.id,
+
-                    null,
+  let pathFile = path.join(__dirname, `../../e2e-result-${suffixFileName}-${retryCount}.tar`);
-                    {
+  let file = fs.createReadStream(pathFile);
-                        'name': safeFileName,
+  await alfrescoJsApi.upload.uploadFile(
-                        'nodeType': 'cm:content',
+    file,
-                        'autoRename': true
+    '',
-                    }
+    folderNode.entry.id,
-                );
+    null,
-            }catch(error){
+    {
-                console.log(error);
+      'name': `e2e-result-${suffixFileName}-${retryCount}.tar`,
-            }
+      'nodeType': 'cm:content',
-        }
+      'autoRename': true
     }
-};
+  );
+}
 
-module.exports = uploadOutput;
+module.exports = {
+  uploadScreenshot: uploadScreenshot
+};

package-lock.json

@@ -4533,6 +4533,12 @@
       "integrity": "sha512-7p4Kn/gffhQaavNfyDFg7LS5S/UT1JAjyGd4UqR2+jzoYF02eDkj0Ec3+48TsIa4zghjLY87nQHIh/ecK9qLdw==",
       "dev": true
     },
+    "circular-json": {
+      "version": "0.5.9",
+      "resolved": "https://registry.npmjs.org/circular-json/-/circular-json-0.5.9.tgz",
+      "integrity": "sha512-4ivwqHpIFJZBuhN3g/pEcdbnGUywkBblloGbkglyloVjjR3uT6tieI89MVOfbP2tHX5sgb01FuLgAOzebNlJNQ==",
+      "dev": true
+    },
     "class-utils": {
       "version": "0.3.6",
       "resolved": "https://registry.npmjs.org/class-utils/-/class-utils-0.3.6.tgz",
@@ -9703,41 +9709,6 @@
         "colors": "1.4.0"
       }
     },
-    "jasmine2-protractor-utils": {
-      "version": "1.3.0",
-      "resolved": "https://registry.npmjs.org/jasmine2-protractor-utils/-/jasmine2-protractor-utils-1.3.0.tgz",
-      "integrity": "sha1-lARqq7x0rQpLdGvNTcMFB1h7Z+M=",
-      "dev": true,
-      "requires": {
-        "fs-extra": "^0.26.5",
-        "mkdirp": "^0.5.1",
-        "q": "^1.4.1"
-      },
-      "dependencies": {
-        "fs-extra": {
-          "version": "0.26.7",
-          "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-0.26.7.tgz",
-          "integrity": "sha1-muH92UiXeY7at20JGM9C0MMYT6k=",
-          "dev": true,
-          "requires": {
-            "graceful-fs": "^4.1.2",
-            "jsonfile": "^2.1.0",
-            "klaw": "^1.0.0",
-            "path-is-absolute": "^1.0.0",
-            "rimraf": "^2.2.8"
-          }
-        },
-        "jsonfile": {
-          "version": "2.4.0",
-          "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-2.4.0.tgz",
-          "integrity": "sha1-NzaitCi4e72gzIO1P6PWM6NcKug=",
-          "dev": true,
-          "requires": {
-            "graceful-fs": "^4.1.6"
-          }
-        }
-      }
-    },
     "jasminewd2": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/jasminewd2/-/jasminewd2-2.2.0.tgz",
@@ -10356,13 +10327,13 @@
       "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==",
       "dev": true
     },
-    "klaw": {
+    "klaw-sync": {
-      "version": "1.3.1",
+      "version": "6.0.0",
-      "resolved": "https://registry.npmjs.org/klaw/-/klaw-1.3.1.tgz",
+      "resolved": "https://registry.npmjs.org/klaw-sync/-/klaw-sync-6.0.0.tgz",
-      "integrity": "sha1-QIhDO0azsbolnXh4XY6W9zugJDk=",
+      "integrity": "sha512-nIeuVSzdCCs6TDPTqI8w1Yre34sSq7AkZ4B3sfOBbI2CgVSB4Du4aLQijFU2+lhAFCwt9+42Hel6lQNIv6AntQ==",
       "dev": true,
       "requires": {
-        "graceful-fs": "^4.1.9"
+        "graceful-fs": "^4.1.11"
       }
     },
     "kleur": {
@@ -13695,6 +13666,45 @@
         }
       }
     },
+    "protractor-screenshoter-plugin": {
+      "version": "0.10.3",
+      "resolved": "https://registry.npmjs.org/protractor-screenshoter-plugin/-/protractor-screenshoter-plugin-0.10.3.tgz",
+      "integrity": "sha512-OF9kGe1rMxBQY4uXzXQUFT14EB83rz8DlDcxmH5HcOHPBpUhGh+Nwo7+K87w1LoLcTuGdG7Bz+/hGwoGguDfsA==",
+      "dev": true,
+      "requires": {
+        "circular-json": "^0.5.1",
+        "fs-extra": "^7.0.0",
+        "klaw-sync": "^6.0.0",
+        "lodash": "^4.17.11",
+        "mkdirp": "^0.5.1",
+        "moment": "^2.20.1",
+        "q": "^1.5.1",
+        "screenshoter-report-analyzer": "^0.6",
+        "uuid": "^3.1.0"
+      },
+      "dependencies": {
+        "fs-extra": {
+          "version": "7.0.1",
+          "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz",
+          "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==",
+          "dev": true,
+          "requires": {
+            "graceful-fs": "^4.1.2",
+            "jsonfile": "^4.0.0",
+            "universalify": "^0.1.0"
+          }
+        },
+        "jsonfile": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
+          "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=",
+          "dev": true,
+          "requires": {
+            "graceful-fs": "^4.1.6"
+          }
+        }
+      }
+    },
     "protractor-smartrunner": {
       "version": "0.1.1",
       "resolved": "https://registry.npmjs.org/protractor-smartrunner/-/protractor-smartrunner-0.1.1.tgz",
@@ -14795,6 +14805,12 @@
         "ajv-keywords": "^3.4.1"
       }
     },
+    "screenshoter-report-analyzer": {
+      "version": "0.6.0",
+      "resolved": "https://registry.npmjs.org/screenshoter-report-analyzer/-/screenshoter-report-analyzer-0.6.0.tgz",
+      "integrity": "sha1-Cm+I1fXRrBa2z3Ji7/ujH+5I7RI=",
+      "dev": true
+    },
     "select-hose": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/select-hose/-/select-hose-2.0.0.tgz",

package.json

@@ -95,7 +95,7 @@
     "husky": "^4.2.5",
     "jasmine-core": "~3.6.0",
     "jasmine-spec-reporter": "~5.0.2",
-    "jasmine2-protractor-utils": "1.3.0",
+    "protractor-screenshoter-plugin": "0.10.3",
     "karma": "^5.1.1",
     "karma-chrome-launcher": "^3.1.0",
     "karma-coverage-istanbul-reporter": "^3.0.3",

protractor.conf.js

@@ -7,7 +7,7 @@ const fs = require('fs');
 const resolve = require('path').resolve;
 const logger = require('./tools/helpers/logger');
 const retry = require('protractor-retry').retry;
-const uploadOutput = require('./e2e/e2e-config/utils/upload-output');
+const { uploadScreenshot } = require('./e2e/e2e-config/utils/upload-output');
 
 require('dotenv').config({path: process.env.ENV_FILE});
 
@@ -163,16 +163,16 @@ exports.config = {
     ...(process.env.CI ? SmartRunner.withOptionalExclusions(resolve(__dirname, './e2e/protractor.excludes.json')) : {})
   },
 
-  plugins: [
+  plugins: [{
-    {
+    package: 'protractor-screenshoter-plugin',
-      package: 'jasmine2-protractor-utils',
+    screenshotPath: path.resolve(__dirname, '../e2e-output/'),
-      disableScreenshot: false,
+    screenshotOnExpect: 'failure',
-      screenshotOnExpectFailure: true,
+    withLogs: true,
-      screenshotOnSpecFailure: false,
+    writeReportFreq: 'end',
-      clearFoldersBeforeTest: true,
+    imageToAscii: 'none',
-      screenshotPath: path.resolve(__dirname, 'e2e-output/screenshots/')
+    htmlOnExpect: 'none',
-    }
+    htmlOnSpec: 'none'
-  ],
+  }],
 
   onCleanUp(results) {
     if (process.env.CI) {
@@ -230,7 +230,7 @@ exports.config = {
       console.log(`Save screenshot is ${SAVE_SCREENSHOT}, trying to save screenshots.`);
 
       try {
-        await uploadOutput();
+        await uploadScreenshot(1, 'ACA');
         console.log('Screenshots saved successfully.');
       } catch (e) {
         console.log('Error happened while trying to upload screenshots and test reports: ', e);