alfresco-ng2-components/protractor.conf.js

const path = require('path');
const {SpecReporter} = require('jasmine-spec-reporter');
const jasmineReporters = require('jasmine-reporters');
const htmlReporter = require('protractor-html-reporter-2');
const retry = require('protractor-retry').retry;
const tsConfig = require("./e2e/tsconfig.e2e.json");

const AlfrescoApi = require('@alfresco/js-api').AlfrescoApiCompatibility;
const TestConfig = require('./e2e/test.config');
let argv = require('yargs').argv;

const fs = require('fs');
const rimraf = require('rimraf');
require('dotenv').config( { path: './e2e/.env.cloud' });

const projectRoot = path.resolve(__dirname);

const width = 1366;
const height = 768;

let HOST = process.env.URL_HOST_ADF;
let BROWSER_RUN = process.env.BROWSER_RUN;
let FOLDER = process.env.FOLDER || '';
let SELENIUM_SERVER = process.env.SELENIUM_SERVER || '';
let DIRECT_CONNECCT = SELENIUM_SERVER ? false : true;
let SELENIUM_PROMISE_MANAGER = parseInt(process.env.SELENIUM_PROMISE_MANAGER);
let MAXINSTANCES = process.env.MAXINSTANCES || 1;
let TIMEOUT = parseInt(process.env.TIMEOUT, 10);
let SAVE_SCREENSHOT = (process.env.SAVE_SCREENSHOT == 'true');
let LIST_SPECS = process.env.LIST_SPECS || [];

const BPM_HOST = process.env.URL_HOST_BPM_ADF || "bpm";
const OAUTH_HOST = process.env.URL_HOST_SSO_ADF || "keycloak";
const OAUTH_CLIENDID = process.env.OAUTH_CLIENDID || "activiti";
const IDENTITY_HOST = process.env.URL_HOST_IDENTITY || "identity";
const IDENTITY_ADMIN_EMAIL = process.env.IDENTITY_ADMIN_EMAIL || "defaultadmin";
const IDENTITY_ADMIN_PASSWORD = process.env.IDENTITY_ADMIN_PASSWORD || "defaultadminpassword";
const USERNAME_ADF = process.env.USERNAME_ADF || process.env.IDENTITY_USERNAME_ADF || "defaultuser";
const PASSWORD_ADF = process.env.PASSWORD_ADF || process.env.IDENTITY_PASSWORD_ADF || "defaultuserpassword";

const appConfig = {
    "bpmHost": BPM_HOST,
    "identityHost": IDENTITY_HOST,
    "providers": "BPM",
    "authType": "OAUTH",
    "oauth2": {
        "host": OAUTH_HOST,
        "clientId": OAUTH_CLIENDID,
        "scope": "openid",
        "secret": "",
        "implicitFlow": true,
        "silentLogin": true,
        "redirectUri": "/",
        "redirectUriLogout": "/logout"
    }
};

let specsToRun = './**/e2e/' + FOLDER + '/**/*.e2e.ts';

let args_options = [];

if (BROWSER_RUN === 'true') {
    args_options = ['--incognito', `--window-size=${width},${height}`, '--disable-gpu', '--disable-web-security', '--disable-browser-side-navigation' ];
} else {
    args_options = ['--incognito', '--headless', `--window-size=${width},${height}`, '--disable-gpu', '--disable-web-security', '--disable-browser-side-navigation' ];
}

let downloadFolder = path.join(__dirname, 'e2e/downloads');

let buildNumber = () => {
    let buildNumber = process.env.TRAVIS_BUILD_NUMBER;
    if (!buildNumber) {
        process.env.TRAVIS_BUILD_NUMBER = Date.now();
    }

    return process.env.TRAVIS_BUILD_NUMBER;
};


saveScreenshots = async function (alfrescoJsApi, retryCount) {
    let files = fs.readdirSync(path.join(__dirname, './e2e-output/screenshots'));

    if (files && files.length > 0) {

        let folder;

        try {
            folder = await alfrescoJsApi.nodes.addNode('-my-', {
                'name': `retry-${retryCount}`,
                'relativePath': `Builds/${buildNumber()}/screenshot`,
                'nodeType': 'cm:folder'
            }, {}, {
                'overwrite': true
            });
        } catch (error) {
            folder = await alfrescoJsApi.nodes.getNode('-my-', {
                'relativePath': `Builds/${buildNumber()}/screenshot/retry-${retryCount}`,
                'nodeType': 'cm:folder'
            }, {}, {
                'overwrite': true
            });
        }

        for (const fileName of files) {
            let pathFile = path.join(__dirname, './e2e-output/screenshots', fileName);
            let file = fs.createReadStream(pathFile);

            let safeFileName = fileName.replace(new RegExp('"', 'g'), '');

            try {
                await alfrescoJsApi.upload.uploadFile(
                    file,
                    '',
                    folder.entry.id,
                    null,
                    {
                        'name': safeFileName,
                        'nodeType': 'cm:content',
                        'autoRename': true
                    }
                );
            } catch (error) {
                console.log(error);
            }
        }
    }
};

saveReport = async function (filenameReport, alfrescoJsApi) {
    let pathFile = path.join(__dirname, './e2e-output/junit-report/html', filenameReport + '.html');
    let reportFile = fs.createReadStream(pathFile);

    let reportFolder;

    try {
        reportFolder = await alfrescoJsApi.nodes.addNode('-my-', {
            'name': 'report',
            'relativePath': `Builds/${buildNumber()}`,
            'nodeType': 'cm:folder'
        }, {}, {
            'overwrite': true
        });
    } catch (error) {
        reportFolder = await alfrescoJsApi.nodes.getNode('-my-', {
            'relativePath': `Builds/${buildNumber()}/report`,
            'nodeType': 'cm:folder'
        }, {}, {
            'overwrite': true
        });

    }

    try {
        await
            alfrescoJsApi.upload.uploadFile(
                reportFile,
                '',
                reportFolder.entry.id,
                null,
                {
                    'name': reportFile.name,
                    'nodeType': 'cm:content',
                    'autoRename': true
                }
            );

    } catch (error) {
        console.log('error' + error);

    }
};

if (LIST_SPECS.length==0) {
    arraySpecs = [specsToRun];
} else {
    arraySpecs = LIST_SPECS.split(',');
    arraySpecs = arraySpecs.map( (el) => './'+el);
}

exports.config = {
    allScriptsTimeout: TIMEOUT,

    specs: arraySpecs,

    useAllAngular2AppRoots: true,

    capabilities: {
        browserName: 'chrome',

        shardTestFiles: true,
        maxInstances: MAXINSTANCES,
        chromeOptions: {
            prefs: {
                'credentials_enable_service': false,
                'download': {
                    'prompt_for_download': false,
                    'default_directory': downloadFolder
                }
            },
            args: args_options
        }
    },

    directConnect: DIRECT_CONNECCT,

    baseUrl: HOST,

    params: {
        config: appConfig,
        identityAdmin: {
            email: IDENTITY_ADMIN_EMAIL,
            password: IDENTITY_ADMIN_PASSWORD
        },
        identityUser: {
            email: USERNAME_ADF,
            password: PASSWORD_ADF
        }
    },

    framework: 'jasmine2',

    getPageTimeout: 90000,

    jasmineNodeOpts: {
        showColors: true,
        defaultTimeoutInterval: 30000,
        print: function () {
        }
    },

    /**
     * The address of a running selenium server (must be manually start before running the tests). If this is specified seleniumServerJar and seleniumPort will be ignored.
     * @config {String} seleniumAddress
     */
    seleniumAddress: SELENIUM_SERVER,

    SELENIUM_PROMISE_MANAGER: SELENIUM_PROMISE_MANAGER,

    plugins: [{
        package: 'jasmine2-protractor-utils',
        disableScreenshot: false,
        screenshotOnExpectFailure: true,
        screenshotOnSpecFailure: false,
        clearFoldersBeforeTest: true,
        screenshotPath: `${projectRoot}/e2e-output/screenshots/`
    }],

    onCleanUp(results) {
        retry.onCleanUp(results);
    },

    onPrepare() {

        retry.onPrepare();

        jasmine.DEFAULT_TIMEOUT_INTERVAL = TIMEOUT;
        let failFast = require('jasmine-fail-fast');
        jasmine.getEnv().addReporter(failFast.init());

        global.TestConfig = TestConfig;
        require('ts-node').register({
            project: 'e2e/tsconfig.e2e.json'
        });
        require("tsconfig-paths").register({
            project: 'e2e/tsconfig.e2e.json',
            baseUrl: 'e2e/',
            paths: tsConfig.compilerOptions.paths
        });

        browser.manage().window().setSize(width, height);

        jasmine.getEnv().addReporter(
            new SpecReporter({
                spec: {
                    displayStacktrace: true,
                    displayDuration: true
                }
            })
        );

        let generatedSuiteName = Math.random().toString(36).substr(2, 5);
        let junitReporter = new jasmineReporters.JUnitXmlReporter({
            consolidateAll: true,
            savePath: `${projectRoot}/e2e-output/junit-report`,
            filePrefix: 'results.xml-' + generatedSuiteName,
        });
        jasmine.getEnv().addReporter(junitReporter);

        return browser.driver.executeScript(disableCSSAnimation);

        function disableCSSAnimation() {
            let css = '* {' +
                '-webkit-transition-duration: 0s !important;' +
                'transition-duration: 0s !important;' +
                '-webkit-animation-duration: 0s !important;' +
                'animation-duration: 0s !important;' +
                '}',
                head = document.head || document.getElementsByTagName('head')[0],
                style = document.createElement('style');

            style.type = 'text/css';
            style.appendChild(document.createTextNode(css));
            head.appendChild(style);
        }

    },

    beforeLaunch: function () {
        let reportsFolder = `${projectRoot}/e2e-output/junit-report/`;

        fs.exists(reportsFolder, function (exists, error) {
            if (exists) {
                rimraf(reportsFolder, function (err) {
                });
            }

            if (error) {
                console.error('[ERROR] fs', error);
            }
        });
    },

    afterLaunch: async function () {

        if (SAVE_SCREENSHOT) {
            let retryCount = 1;
            if (argv.retry) {
                retryCount = ++argv.retry;
            }

            let filenameReport = `ProtractorTestReport-${FOLDER}-${retryCount}`;

            let output = '';
            let savePath = `${projectRoot}/e2e-output/junit-report/`;
            let temporaryHtmlPath = savePath + 'html/temporaryHtml/';
            let lastFileName = '';

            let files = fs.readdirSync(savePath);

            if (files && files.length > 0) {
                for (const fileName of files) {
                    testConfigReport = {
                        reportTitle: 'Protractor Test Execution Report',
                        outputPath: temporaryHtmlPath,
                        outputFilename: Math.random().toString(36).substr(2, 5) + filenameReport,
                    };

                    let filePath = `${projectRoot}/e2e-output/junit-report/` + fileName;

                    new htmlReporter().from(filePath, testConfigReport);
                    lastFileName = testConfigReport.outputFilename;
                }
            }

            let lastHtmlFile = temporaryHtmlPath + lastFileName + '.html';

            if (!(fs.lstatSync(lastHtmlFile).isDirectory())) {
                output = output + fs.readFileSync(lastHtmlFile);
            }

            let fileName = savePath + 'html/' + filenameReport + '.html';

            fs.writeFileSync(fileName, output, 'utf8');

            let alfrescoJsApi = new AlfrescoApi({
                provider: 'ECM',
                hostEcm: TestConfig.adf.url
            });
            alfrescoJsApi.login(TestConfig.adf.adminEmail, TestConfig.adf.adminPassword);

            await saveScreenshots(alfrescoJsApi, retryCount);

            await saveReport(filenameReport, alfrescoJsApi);

            rimraf(`${projectRoot}/e2e-output/screenshots/`, function () {
                console.log('done delete screenshot');
            });

        }

        return retry.afterLaunch(4);
    }

};