mastodon-app/test/test.js

#!/usr/bin/env node

/* jshint esversion: 8 */
/* global describe */
/* global before */
/* global after */
/* global afterEach */
/* global it */
/* global xit */

'use strict';

require('chromedriver');

const execSync = require('child_process').execSync,
    expect = require('expect.js'),
    fs = require('fs'),
    path = require('path'),
    { Builder, By, until } = require('selenium-webdriver'),
    { Options } = require('selenium-webdriver/chrome');

if (!process.env.USERNAME || !process.env.PASSWORD) {
    console.log('USERNAME and PASSWORD env vars need to be set');
    process.exit(1);
}

describe('Application life cycle test', function () {
    this.timeout(0);

    const LOCATION = process.env.LOCATION || 'test';
    const TEST_TIMEOUT = parseInt(process.env.TIMEOUT) || 10000;
    const EXEC_ARGS = { cwd: path.resolve(__dirname, '..'), stdio: 'inherit' };

    let browser, app;
    var athenticated_by_oidc = false;
    let username = process.env.USERNAME;
    let password = process.env.PASSWORD;
    let manifest = require('../CloudronManifest.json');

    before(function () {
        const chromeOptions = new Options().windowSize({ width: 1280, height: 1024 });
        if (process.env.CI) chromeOptions.addArguments('no-sandbox', 'disable-dev-shm-usage', 'headless');
        browser = new Builder().forBrowser('chrome').setChromeOptions(chromeOptions).build();
        if (!fs.existsSync('./screenshots')) fs.mkdirSync('./screenshots');
    });

    after(function () {
        browser.quit();
    });

    afterEach(async function () {
        if (!process.env.CI || !app) return;

        const currentUrl = await browser.getCurrentUrl();
        if (!currentUrl.includes(app.domain)) return;
        expect(this.currentTest.title).to.be.a('string');

        const screenshotData = await browser.takeScreenshot();
        fs.writeFileSync(`./screenshots/${new Date().getTime()}-${this.currentTest.title.replaceAll(' ', '_')}.png`, screenshotData, 'base64');
    });

    function sleep(millis) {
        return new Promise(resolve => setTimeout(resolve, millis));
    }

    async function waitForElement(elem) {
        await browser.wait(until.elementLocated(elem), TEST_TIMEOUT);
        await browser.wait(until.elementIsVisible(browser.findElement(elem)), TEST_TIMEOUT);
    }

    async function exists(selector) {
        await browser.wait(until.elementLocated(selector), TEST_TIMEOUT);
    }

    async function visible(selector) {
        await exists(selector);
        await browser.wait(until.elementIsVisible(browser.findElement(selector)), TEST_TIMEOUT);
    }

    async function checkRegistration(mode) {
        if (mode === 'none') {
            await browser.get('https://' + app.fqdn);
            await browser.sleep(2000);
            await browser.findElement(By.xpath('//div[@class="sign-in-banner"]/descendant::button/span[contains(text(), "Create account")] | //div[@class="sign-in-banner"]/descendant::a/span[contains(text(), "Create account")]')).click();
            await visible(By.xpath('//span[contains(text()[2], "is currently not possible")]'));
        } else if (mode === 'open') {
            await browser.get('https://' + app.fqdn + '/auth/sign_up');
            await visible(By.xpath('//button[contains(text(), "Sign up")]'));
        }
    }

    async function login(username, password) {
        await browser.get('https://' + app.fqdn + '/auth/sign_in'); // there is also separate login page at /users/sign_in
        await visible(By.xpath('//button[contains(text(), "Log in")]'));
        await browser.findElement(By.id('user_email')).sendKeys(username);
        await browser.findElement(By.id('user_password')).sendKeys(password);
        await browser.findElement(By.xpath('//button[contains(text(), "Log in")]')).click();
        await browser.sleep(3000); // can be wizard or timeline at this point
    }

    async function loginOIDC(username, password) {
        browser.manage().deleteAllCookies();
        await browser.get(`https://${app.fqdn}/auth/sign_in`);
        await browser.sleep(4000);

        await browser.findElement(By.xpath('//a[contains(@class, "button") and text()="Cloudron"]')).click();
        await browser.sleep(4000);

        if (!athenticated_by_oidc) {
            await waitForElement(By.xpath('//input[@name="username"]'));
            await browser.findElement(By.xpath('//input[@name="username"]')).sendKeys(username); 
            await browser.findElement(By.xpath('//input[@name="password"]')).sendKeys(password);
            await browser.sleep(2000);
            await browser.findElement(By.id('loginSubmitButton')).click();
            await browser.sleep(2000);

            athenticated_by_oidc = true;
        }

        await waitForElement(By.xpath('//a[contains(., "Edit profile")] | //strong[text()="Successfully authenticated from Cloudron account."]'));
    }

    async function logout() {
        await browser.get('https://' + app.fqdn + '/settings/preferences/appearance'); // there is also separate login page at /users/sign_in
        await browser.wait(until.elementLocated(By.id('logout')), TEST_TIMEOUT);
        await browser.findElement(By.id('logout')).click();
        await visible(By.id('user_email'));
    }

    async function dismissHelp() {
        await browser.get('https://' + app.fqdn + '/home');
        await visible(By.xpath('//button[@title = "Dismiss"]'));
        await browser.findElement(By.xpath('//button[@title ="Dismiss"]')).click();
    }

    async function checkTimeline() {
        await browser.get('https://' + app.fqdn + '/home');
        await visible(By.xpath('//span[contains(text(), "Your home timeline is empty")]'));
    }

    function getAppInfo() {
        const inspect = JSON.parse(execSync('cloudron inspect'));
        app = inspect.apps.filter(function (a) { return a.location === LOCATION || a.location === LOCATION + '2'; })[0];
        expect(app).to.be.an('object');
    }

    xit('build app', function () { execSync('cloudron build', EXEC_ARGS); });

    // No SSO
    it('install app (no sso)', function () { execSync('cloudron install --no-sso --location ' + LOCATION, EXEC_ARGS); });
    it('can get app information', getAppInfo);

    it('has registration open', checkRegistration.bind(null, 'none'));
    let testPassword;
    it('create a user with CLI', function () {
        let output = execSync('cloudron exec --app ' + LOCATION + ' -- bin/tootctl accounts create test --email=test@cloudron.io', { cwd: path.resolve(__dirname, '..'), encoding: 'utf8' });
        console.log(output);
        testPassword = output.slice(output.indexOf('New password: ') + 'New password: '.length).trim();
        console.log(testPassword);
    });

    it('can login (no sso)', async function () {
        await login('test@cloudron.io', testPassword);
    });

    it('shows confirmation page', function () {
        return browser.wait(until.elementLocated(By.xpath('//div[contains(text(), "Waiting for e-mail confirmation to be completed")]')), TEST_TIMEOUT);
    });

    it('uninstall app (no sso)', async function () {
        await browser.get('about:blank');
        execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS);
    });

    // SSO
    it('install app (sso)', function () { execSync('cloudron install --location ' + LOCATION, EXEC_ARGS); });

    it('can get app information', getAppInfo);
    it('registration is disabled', checkRegistration.bind(null, 'none'));
    it('can OIDC login', loginOIDC.bind(null, username, password));
    it('can dismiss help', dismissHelp);
    it('can see timeline', checkTimeline);
    it('can logout', logout);

    it('backup app', function () { execSync('cloudron backup create --app ' + app.id, EXEC_ARGS); });
    it('restore app', function () {
        const backups = JSON.parse(execSync('cloudron backup list --raw'));
        execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS);
        execSync('cloudron install --location ' + LOCATION, EXEC_ARGS);
        getAppInfo();
        execSync(`cloudron restore --backup ${backups[0].id} --app ${app.id}`, EXEC_ARGS);
    });

    it('can OIDC login', loginOIDC.bind(null, username, password));
    it('can see timeline', checkTimeline);

    it('can restart app', function () { execSync('cloudron restart --app ' + app.id, EXEC_ARGS); });
    it('can see timeline', checkTimeline);

    it('move to different location', async function () {
        await browser.get('about:blank');
        execSync('cloudron configure --location ' + LOCATION + '2 --app ' + app.id, EXEC_ARGS);
    });
    it('can get app information', getAppInfo);

    it('can OIDC login', loginOIDC.bind(null, username, password));
    it('can see timeline', checkTimeline);

    it('uninstall app', async function () {
        await browser.get('about:blank');
        execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS);
    });

    // test update
    it('can install app', function () { execSync('cloudron install --appstore-id ' + manifest.id + ' --location ' + LOCATION, EXEC_ARGS); });
    it('can get app information', getAppInfo);
    // needs to be changed to loginOIDC on the next release
    it('can OIDC login', loginOIDC.bind(null, username, password));
    it('can logout', logout);

    it('can update', async function () {
        await browser.get('about:blank');
        execSync('cloudron update --app ' + LOCATION, EXEC_ARGS);
    });

    it('can OIDC login', loginOIDC.bind(null, username, password));

    it('uninstall app', function () { execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS); });
});