diff --git a/test/test.js b/test/test.js index 2829313..e5065e7 100644 --- a/test/test.js +++ b/test/test.js @@ -1,147 +1,78 @@ #!/usr/bin/env node -import { execSync } from 'node:child_process'; import assert from 'node:assert/strict'; -import fs from 'node:fs'; -import path from 'node:path'; import superagent from '@cloudron/superagent'; -import { Builder, By, Key, until } from 'selenium-webdriver'; -import { Options } from 'selenium-webdriver/chrome'; -/* global it, xit, describe, before, after, afterEach */ +import { app, clearCache, click, cloudronCli, goto, loginOIDC, password, sendKeys, setupBrowser, takeScreenshot, teardownBrowser, username, waitFor } from '@cloudron/charlie'; -const admin_username = 'admin', admin_password = 'changeme'; - -if (!process.env.USERNAME || !process.env.PASSWORD) { - console.log('USERNAME and PASSWORD env vars need to be set'); - process.exit(1); -} +/* global it, describe, before, after, afterEach */ describe('Application life cycle test', function () { - this.timeout(0); + const admin_username = 'admin'; + const admin_password = 'changeme'; - const LOCATION = process.env.LOCATION || 'test'; - const TEST_TIMEOUT = parseInt(process.env.TIMEOUT, 10) || 10000; - const EXEC_ARGS = { cwd: path.resolve(import.meta.dirname, '..'), stdio: 'inherit' }; - - const USERNAME = process.env.USERNAME; - const PASSWORD = process.env.PASSWORD; - - let browser, app; - let athenticated_by_oidc = false; - - 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(); - }); + before(setupBrowser); + after(teardownBrowser); afterEach(async function () { - if (!process.env.CI || !app) return; - - const currentUrl = await browser.getCurrentUrl(); - if (!currentUrl.includes(app.domain)) return; - assert.strictEqual(typeof this.currentTest.title, 'string'); - - const screenshotData = await browser.takeScreenshot(); - fs.writeFileSync(`./screenshots/${new Date().getTime()}-${this.currentTest.title.replaceAll(' ', '_')}.png`, screenshotData, 'base64'); + await takeScreenshot(this.currentTest.title); }); - function getAppInfo() { - var inspect = JSON.parse(execSync('cloudron inspect')); - app = inspect.apps.filter(function (a) { return a.location.indexOf(LOCATION) === 0; })[0]; - assert.ok(app && typeof app === 'object'); - } - function baseUrl() { if (app.manifest.version === '1.4.0') return `https://${app.fqdn}/p`; return `https://${app.fqdn}`; } - async function waitForElement(elem) { - await browser.wait(until.elementLocated(elem), TEST_TIMEOUT); - await browser.wait(until.elementIsVisible(browser.findElement(elem)), TEST_TIMEOUT); + async function login(uname, pass) { + await goto(`https://${app.fqdn}`, 'css=#loginButton'); + await sendKeys('css=#username', uname); + await sendKeys('css=#passwordPlain', pass); + await click('css=#loginButton'); + await waitFor('css=#btn-subscription'); } - async function login(username, password) { - await browser.get('https://' + app.fqdn); - await waitForElement(By.id('loginButton')); - await browser.findElement(By.id('username')).sendKeys(username); - await browser.findElement(By.id('passwordPlain')).sendKeys(password); - await browser.findElement(By.id('loginButton')).click(); - await waitForElement(By.id('btn-subscription')); - } - - async function loginOIDC(username, password) { - browser.manage().deleteAllCookies(); - await browser.get(`https://${app.fqdn}/i/`); - - if (!athenticated_by_oidc) { - await waitForElement(By.id('inputUsername')); - await browser.findElement(By.id('inputUsername')).sendKeys(username); - await browser.findElement(By.id('inputPassword')).sendKeys(password); - await browser.findElement(By.id('loginSubmitButton')).click(); - - athenticated_by_oidc = true; - } - - await waitForElement(By.id('btn-subscription')); + async function loginViaOIDC() { + await clearCache(); + await goto(`https://${app.fqdn}/i/`); + await loginOIDC('css=#btn-subscription'); } async function logout() { - var logout_btn = By.xpath('//li/*[contains(@class,"signout")]'); - - await browser.get('https://' + app.fqdn); - await waitForElement(By.id('stream')); - await browser.findElement(By.className('dropdown-toggle')).click(); - await waitForElement(logout_btn); - await browser.findElement(logout_btn).click(); - await waitForElement(By.id('loginButton')); + await goto(`https://${app.fqdn}`, 'css=#stream'); + await click('css=.dropdown-toggle'); + await click('xpath=//li/*[contains(@class,"signout")]'); + await waitFor('css=#loginButton'); } async function addSubscription() { - var url = 'https://blog.cloudron.io/rss/'; + const url = 'https://blog.cloudron.io/rss/'; const addUrl = app.manifest.version === '1.10.0' ? `${baseUrl()}/i/?c=subscription` : `${baseUrl()}/i/?c=subscription&a=add`; - await browser.get(addUrl); - await waitForElement(By.xpath('//input[@name="url_rss"]')); - await browser.findElement(By.xpath('//input[@name="url_rss"]')).sendKeys(url); - await browser.findElement(By.xpath('//form[@id="add_rss"]//button[text()="Add"]')).click(); - await waitForElement(By.xpath('//div[@id="notification" and contains(@class, "good")]')); + await goto(addUrl, 'xpath=//input[@name="url_rss"]'); + await sendKeys('xpath=//input[@name="url_rss"]', url); + await click('xpath=//form[@id="add_rss"]//button[text()="Add"]'); + await waitFor('xpath=//div[@id="notification" and contains(@class, "good")]'); } async function enableApi(relogin = true) { - await browser.get(`${baseUrl()}/i/?c=auth`); + await goto(`${baseUrl()}/i/?c=auth`); if (relogin) { - // needs a relogin for admin confirmation - await waitForElement(By.id('passwordPlain')); - await browser.findElement(By.id('passwordPlain')).sendKeys(admin_password); - await browser.sleep(3000); - console.log('Clicking the login button'); - await browser.findElement(By.xpath('//button[contains(.,"Login")]')).click(); + await sendKeys('css=#passwordPlain', admin_password); + await click('xpath=//button[contains(.,"Login")]'); } - await waitForElement(By.id('api_enabled')); - await browser.findElement(By.id('api_enabled')).click(); - await browser.findElement(By.xpath('//button[text()="Submit"]')).click(); - await browser.sleep(5000); + await click('css=#api_enabled'); + await click('xpath=//button[text()="Submit"]'); } async function checkApiConfiguration() { - await browser.get(`${baseUrl()}/api/`); - await waitForElement(By.xpath('//dd[@id="greaderOutput" and contains(text(), "PASS")]')); - await waitForElement(By.xpath('//dd[@id="feverOutput" and contains(text(), "PASS")]')); + await goto(`${baseUrl()}/api/`, 'xpath=//dd[@id="greaderOutput" and contains(text(), "PASS")]'); + await waitFor('xpath=//dd[@id="feverOutput" and contains(text(), "PASS")]'); } async function subscriptionExists() { - await browser.get(`${baseUrl()}/i/?get=c_1`); - return waitForElement(By.xpath('//span[text()="Cloudron"]')); + await goto(`${baseUrl()}/i/?get=c_1`, 'Cloudron'); } async function getStaticExtensionFile() { @@ -149,14 +80,11 @@ describe('Application life cycle test', function () { .buffer(true) .ok(() => true); assert.strictEqual(response.status, 200); - assert.ok(response.text.includes('sticky_feeds')); // relies on the buffer flag above + assert.ok(response.text.includes('sticky_feeds')); } - 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('install app (no sso)', () => cloudronCli.install({ noSso: true })); it('can login', login.bind(null, admin_username, admin_password)); it('can subscribe', addSubscription); @@ -165,68 +93,47 @@ describe('Application life cycle test', function () { it('subscription exists', subscriptionExists); it('can get static extension file', getStaticExtensionFile); it('can logout', logout); - it('uninstall app', function () { execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS); }); + it('uninstall app', cloudronCli.uninstall); // SSO - it('install app (sso)', function () { execSync('cloudron install --location ' + LOCATION, EXEC_ARGS); }); + it('install app (sso)', cloudronCli.install); - it('can get app information', getAppInfo); - - it('can make user Administrator', function () { execSync(`cloudron exec --app ${app.id} -- bash -c "php cli/reconfigure.php --default-user ${USERNAME}"`); }); - it('can login OIDC', loginOIDC.bind(null, USERNAME, PASSWORD)); + it('can make user Administrator', () => cloudronCli.exec(`bash -c "php cli/reconfigure.php --default-user ${username}"`)); + it('can login OIDC', () => loginViaOIDC(username, password)); it('can subscribe', addSubscription); it('can enable API', enableApi.bind(null, false /* relogin */)); it('can check configuration', checkApiConfiguration); it('subscription exists', subscriptionExists); it('can get static extension file', getStaticExtensionFile); - it('backup app', function () { execSync('cloudron backup create --app ' + app.id, EXEC_ARGS); }); + it('backup app', cloudronCli.createBackup); + it('restore app', cloudronCli.restoreFromLatestBackup); - it('restore app', function () { - const backups = JSON.parse(execSync(`cloudron backup list --raw --app ${app.id}`)); - 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 login OIDC', loginOIDC.bind(null, USERNAME, PASSWORD)); + it('can login OIDC', loginViaOIDC); it('can check configuration', checkApiConfiguration); it('subscription exists', subscriptionExists); it('can get static extension file', getStaticExtensionFile); - it('move to different location', function () { - browser.manage().deleteAllCookies(); - execSync('cloudron configure --location ' + LOCATION + '2 --app ' + app.id, EXEC_ARGS); - var inspect = JSON.parse(execSync('cloudron inspect')); - app = inspect.apps.filter(function (a) { return a.location === LOCATION + '2'; })[0]; - assert.ok(app && typeof app === 'object'); - }); + it('move to different location', cloudronCli.changeLocation); - it('can login OIDC', loginOIDC.bind(null, USERNAME, PASSWORD)); + it('can login OIDC', loginViaOIDC); it('can check configuration', checkApiConfiguration); it('subscription exists', subscriptionExists); it('can get static extension file', getStaticExtensionFile); - it('uninstall app', function () { execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS); }); + it('uninstall app', cloudronCli.uninstall); // test update - it('can install app for update', function () { execSync('cloudron install --appstore-id org.freshrss.cloudronapp --location ' + LOCATION, EXEC_ARGS); }); + it('can install app for update', cloudronCli.appstoreInstall); - it('can get app information', getAppInfo); - it('can login OIDC', loginOIDC.bind(null, USERNAME, PASSWORD)); - it('can make user Administrator', function () { execSync(`cloudron exec --app ${app.id} -- bash -c "php cli/reconfigure.php --default-user ${USERNAME}"`); }); + it('can login OIDC', loginViaOIDC); + it('can make user Administrator', () => cloudronCli.exec(`bash -c "php cli/reconfigure.php --default-user ${username}"`)); it('can subscribe', addSubscription); - it('can update', function () { - execSync('cloudron update --app ' + app.id, EXEC_ARGS); - var inspect = JSON.parse(execSync('cloudron inspect')); - app = inspect.apps.filter(function (a) { return a.location === LOCATION; })[0]; - assert.ok(app && typeof app === 'object'); - }); + it('can update', cloudronCli.update); it('subscription exists', subscriptionExists); it('can get static extension file', getStaticExtensionFile); - it('uninstall app', function () { execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS); }); + it('uninstall app', cloudronCli.uninstall); });