@inventreedb/ui 0.0.1

package/tests/pui_login.spec.ts

@@ -0,0 +1,74 @@
+import { expect, test } from './baseFixtures.js';
+import { logoutUrl } from './defaults.js';
+import { navigate } from './helpers.js';
+import { doLogin } from './login.js';
+
+/**
+ * Test various types of login failure
+ */
+test('Login - Failures', async ({ page }) => {
+  const loginWithError = async () => {
+    await page.getByRole('button', { name: 'Log In' }).click();
+    await page.getByText('Login failed').waitFor();
+    await page.getByText('Check your input and try again').waitFor();
+    await page.locator('#login').getByRole('button').click();
+  };
+
+  // Navigate to the 'login' page
+  await navigate(page, logoutUrl);
+  await expect(page).toHaveTitle(/^InvenTree.*$/);
+  await page.waitForURL('**/web/login');
+
+  // Attempt login with invalid credentials
+  await page.getByLabel('login-username').fill('invalid user');
+  await page.getByLabel('login-password').fill('invalid password');
+
+  await loginWithError();
+
+  // Attempt login with valid (but disabled) user
+  await page.getByLabel('login-username').fill('ian');
+  await page.getByLabel('login-password').fill('inactive');
+
+  await loginWithError();
+
+  // Attempt login with no username
+  await page.getByLabel('login-username').fill('');
+  await page.getByLabel('login-password').fill('hunter2');
+
+  await loginWithError();
+
+  // Attempt login with no password
+  await page.getByLabel('login-username').fill('ian');
+  await page.getByLabel('login-password').fill('');
+
+  await loginWithError();
+});
+
+test('Login - Change Password', async ({ page }) => {
+  await doLogin(page, 'noaccess', 'youshallnotpass');
+
+  // Navigate to the 'change password' page
+  await navigate(page, 'settings/user/account');
+  await page.getByLabel('action-menu-account-actions').click();
+  await page.getByLabel('action-menu-account-actions-change-password').click();
+
+  // First attempt with some errors
+  await page.getByLabel('password', { exact: true }).fill('youshallnotpass');
+  await page.getByLabel('input-password-1').fill('12345');
+  await page.getByLabel('input-password-2').fill('54321');
+  await page.getByRole('button', { name: 'Confirm' }).click();
+  await page.getByText('The two password fields didn’t match').waitFor();
+
+  await page.getByLabel('input-password-2').fill('12345');
+  await page.getByRole('button', { name: 'Confirm' }).click();
+
+  await page.getByText('This password is too short').waitFor();
+  await page.getByText('This password is entirely numeric').waitFor();
+
+  await page.getByLabel('input-password-1').fill('youshallnotpass');
+  await page.getByLabel('input-password-2').fill('youshallnotpass');
+  await page.getByRole('button', { name: 'Confirm' }).click();
+
+  await page.getByText('Password Changed').waitFor();
+  await page.getByText('The password was set successfully').waitFor();
+});

package/tests/pui_modals.spec.ts

@@ -0,0 +1,144 @@
+import { systemKey, test } from './baseFixtures.js';
+import { doCachedLogin } from './login.js';
+
+test('Modals - Admin', async ({ browser }) => {
+  const page = await doCachedLogin(browser, {
+    username: 'admin',
+    password: 'inventree'
+  });
+
+  // use server info
+  await page.getByLabel('open-spotlight').click();
+  await page
+    .getByRole('button', {
+      name: 'Server Information About this InvenTree instance'
+    })
+    .click();
+  await page.getByRole('cell', { name: 'Instance Name' }).waitFor();
+  await page.getByRole('button', { name: 'Close' }).click();
+
+  // use license info
+  await page.getByLabel('open-spotlight').click();
+  await page
+    .getByRole('button', {
+      name: 'License Information Licenses for dependencies of the service'
+    })
+    .click();
+  await page.getByText('License Information').first().waitFor();
+  await page.getByRole('tab', { name: 'backend Packages' }).click();
+  await page.getByRole('button', { name: 'Babel BSD License' }).click();
+  await page
+    .getByText('by the Babel Team, see AUTHORS for more information')
+    .waitFor();
+
+  await page.getByRole('tab', { name: 'frontend Packages' }).click();
+  await page.getByRole('button', { name: '@sentry/core MIT' }).click();
+  await page
+    .getByLabel('@sentry/coreMIT')
+    .getByText('Copyright (c) 2019')
+    .waitFor();
+
+  await page
+    .getByLabel('License Information')
+    .getByRole('button')
+    .first()
+    .click();
+
+  // use about
+  await page.getByLabel('open-spotlight').click();
+  await page
+    .getByRole('button', { name: 'About InvenTree About the InvenTree org' })
+    .click();
+  await page.getByRole('cell', { name: 'InvenTree Version' }).click();
+});
+
+test('Quick Command', async ({ browser }) => {
+  const page = await doCachedLogin(browser);
+
+  await page.waitForLoadState('networkidle');
+
+  // Open Spotlight with Keyboard Shortcut and Search
+  await page.locator('body').press(`${systemKey}+k`);
+  await page.waitForTimeout(200);
+  await page.getByPlaceholder('Search...').fill('Dashboard');
+  await page.getByPlaceholder('Search...').press('Tab');
+  await page.getByPlaceholder('Search...').press('Enter');
+});
+
+test('Quick Command - No Keys', async ({ browser }) => {
+  const page = await doCachedLogin(browser);
+
+  await page.waitForLoadState('networkidle');
+
+  // Open Spotlight with Button
+  await page.getByLabel('open-spotlight').click();
+  await page
+    .getByRole('button', { name: 'Dashboard Go to the InvenTree' })
+    .click();
+
+  await page.getByText('InvenTree Demo Server - ').waitFor();
+
+  // Use navigation menu
+  await page.getByLabel('open-spotlight').click();
+
+  await page.waitForLoadState('networkidle');
+
+  await page.getByRole('button', { name: 'Open Navigation' }).click();
+
+  await page.waitForTimeout(250);
+
+  // assert the nav headers are visible
+  await page.getByText('Navigation').waitFor();
+  await page.getByText('Documentation').waitFor();
+  await page.getByText('About').first().waitFor();
+  await page
+    .getByRole('button', { name: 'Notifications', exact: true })
+    .waitFor();
+  await page.getByRole('button', { name: 'Dashboard', exact: true }).waitFor();
+
+  // close the nav
+  await page.keyboard.press('Escape');
+
+  // use server info
+  await page.getByLabel('open-spotlight').click();
+  await page
+    .getByRole('button', {
+      name: 'Server Information About this InvenTree instance'
+    })
+    .click();
+  await page.getByRole('cell', { name: 'Instance Name' }).waitFor();
+  await page.getByRole('button', { name: 'Close' }).click();
+
+  // use license info
+  await page.getByLabel('open-spotlight').click();
+  await page
+    .getByRole('button', {
+      name: 'License Information Licenses for dependencies of the service'
+    })
+    .click();
+  await page.getByText('License Information').first().waitFor();
+  await page.getByRole('tab', { name: 'backend Packages' }).waitFor();
+  await page.getByRole('button', { name: 'Django BSD License' }).click();
+
+  await page.keyboard.press('Escape');
+
+  // use about
+  await page.getByLabel('open-spotlight').click();
+  await page
+    .getByRole('button', { name: 'About InvenTree About the InvenTree org' })
+    .click();
+  await page.getByText('This information is only').waitFor();
+
+  await page.getByLabel('About InvenTree').getByRole('button').click();
+
+  // use documentation
+  await page.getByLabel('open-spotlight').click();
+  await page
+    .getByRole('button', {
+      name: 'Documentation Visit the documentation to learn more about InvenTree'
+    })
+    .click();
+  await page.waitForURL('https://docs.inventree.org/**');
+
+  // TODO: Test addition of new actions
+});

package/tests/pui_plugins.spec.ts

@@ -0,0 +1,216 @@
+import test from 'playwright/test';
+
+import {
+  clearTableFilters,
+  clickOnRowMenu,
+  loadTab,
+  navigate
+} from './helpers.js';
+import { doCachedLogin } from './login.js';
+import { setPluginState, setSettingState } from './settings.js';
+
+// Unit test for plugin settings
+test('Plugins - Settings', async ({ browser, request }) => {
+  const page = await doCachedLogin(browser, {
+    username: 'admin',
+    password: 'inventree'
+  });
+
+  // Ensure that the SampleIntegration plugin is enabled
+  await setPluginState({
+    request,
+    plugin: 'sample',
+    state: true
+  });
+
+  // Navigate and select the plugin
+  await navigate(page, 'settings/admin/plugin/');
+  await clearTableFilters(page);
+  await page.getByLabel('table-search-input').fill('integration');
+
+  await page
+    .getByRole('row', { name: 'SampleIntegrationPlugin' })
+    .getByRole('paragraph')
+    .click();
+  await page.getByRole('button', { name: 'Plugin Information' }).click();
+  await page
+    .getByLabel('Plugin Detail -')
+    .getByRole('button', { name: 'Plugin Settings' })
+    .waitFor();
+
+  // Edit numerical value
+  await page.getByLabel('edit-setting-NUMERICAL_SETTING').click();
+  const originalValue = await page.getByLabel('number-field-value').innerText();
+  await page
+    .getByLabel('number-field-value')
+    .fill(originalValue == '999' ? '1000' : '999');
+  await page.getByRole('button', { name: 'Submit' }).click();
+
+  await page.waitForTimeout(500);
+
+  // Change it back
+  await page.getByLabel('edit-setting-NUMERICAL_SETTING').click();
+  await page.getByLabel('number-field-value').fill(originalValue);
+  await page.getByRole('button', { name: 'Submit' }).click();
+
+  // Select supplier
+  await page.getByLabel('edit-setting-SELECT_COMPANY').click();
+  await page.getByLabel('related-field-value').fill('mouser');
+  await page.getByText('Mouser Electronics').click();
+});
+
+// Test base plugin functionality
+test('Plugins - Functionality', async ({ browser }) => {
+  // Navigate and select the plugin
+  const page = await doCachedLogin(browser, {
+    username: 'admin',
+    password: 'inventree',
+    url: 'settings/admin/plugin/'
+  });
+
+  await clearTableFilters(page);
+  await page.getByPlaceholder('Search').fill('sample');
+  await page.waitForLoadState('networkidle');
+
+  // Activate the plugin
+  const cell = await page.getByText('Sample API Caller', { exact: true });
+  await clickOnRowMenu(cell);
+  await page.getByRole('menuitem', { name: 'Activate' }).click();
+  await page.getByRole('button', { name: 'Submit' }).click();
+  await page.getByText('The plugin was activated').waitFor();
+
+  // Deactivate the plugin again
+  await clickOnRowMenu(cell);
+  await page.getByRole('menuitem', { name: 'Deactivate' }).click();
+  await page.getByRole('button', { name: 'Submit' }).click();
+  await page.getByText('The plugin was deactivated').waitFor();
+});
+
+test('Plugins - Panels', async ({ browser, request }) => {
+  const page = await doCachedLogin(browser, {
+    username: 'admin',
+    password: 'inventree'
+  });
+
+  // Ensure that UI plugins are enabled
+  await setSettingState({
+    request,
+    setting: 'ENABLE_PLUGINS_INTERFACE',
+    value: true
+  });
+
+  await page.waitForTimeout(500);
+
+  // Ensure that the SampleUI plugin is enabled
+  await setPluginState({
+    request,
+    plugin: 'sampleui',
+    state: true
+  });
+
+  await page.waitForTimeout(500);
+
+  // Navigate to the "part" page
+  await navigate(page, 'part/69/');
+
+  // Ensure basic part tab is available
+  await loadTab(page, 'Part Details');
+
+  // Allow time for the plugin panels to load (they are loaded asynchronously)
+  await page.waitForLoadState('networkidle');
+
+  // Check out each of the plugin panels
+  await loadTab(page, 'Broken Panel');
+  await page.waitForTimeout(500);
+
+  await page.getByText('Error occurred while loading plugin content').waitFor();
+
+  await loadTab(page, 'Dynamic Panel');
+  await page.waitForTimeout(500);
+
+  await page.getByText('Instance ID: 69');
+  await page
+    .getByText('This panel has been dynamically rendered by the plugin system')
+    .waitFor();
+
+  await loadTab(page, 'Part Panel');
+  await page.waitForTimeout(500);
+  await page.getByText('This content has been rendered by a custom plugin');
+
+  // Disable the plugin, and ensure it is no longer visible
+  await setPluginState({
+    request,
+    plugin: 'sampleui',
+    state: false
+  });
+});
+
+/**
+ * Unit test for custom admin integration for plugins
+ */
+test('Plugins - Custom Admin', async ({ browser, request }) => {
+  const page = await doCachedLogin(browser, {
+    username: 'admin',
+    password: 'inventree'
+  });
+
+  // Ensure that the SampleUI plugin is enabled
+  await setPluginState({
+    request,
+    plugin: 'sampleui',
+    state: true
+  });
+
+  // Navigate to the "admin" page
+  await navigate(page, 'settings/admin/plugin/');
+
+  // Open the plugin drawer, and ensure that the custom admin elements are visible
+  await page.getByText('SampleUI').click();
+  await page.getByRole('button', { name: 'Plugin Information' }).click();
+  await page
+    .getByLabel('Plugin Detail')
+    .getByRole('button', { name: 'Plugin Settings' })
+    .click();
+  await page.getByRole('button', { name: 'Plugin Configuration' }).click();
+
+  // Check for expected custom elements
+  await page
+    .getByRole('heading', { name: 'Custom Plugin Configuration Content' })
+    .waitFor();
+  await page.getByText('apple: banana').waitFor();
+  await page.getByText('foo: bar').waitFor();
+  await page.getByText('hello: world').waitFor();
+});
+
+test('Plugins - Locate Item', async ({ browser, request }) => {
+  const page = await doCachedLogin(browser, {
+    username: 'admin',
+    password: 'inventree'
+  });
+
+  // Ensure that the sample location plugin is enabled
+  await setPluginState({
+    request,
+    plugin: 'samplelocate',
+    state: true
+  });
+
+  await page.waitForTimeout(500);
+
+  // Navigate to the "stock item" page
+  await navigate(page, 'stock/item/287/');
+  await page.waitForLoadState('networkidle');
+
+  // "Locate" this item
+  await page.getByLabel('action-button-locate-item').click();
+  await page.getByRole('button', { name: 'Submit' }).click();
+  await page.getByText('Item location requested').waitFor();
+
+  // Show the location
+  await page.getByLabel('breadcrumb-1-factory').click();
+  await page.waitForTimeout(500);
+
+  await page.getByLabel('action-button-locate-item').click();
+  await page.getByRole('button', { name: 'Submit' }).click();
+  await page.getByText('Item location requested').waitFor();
+});

package/tests/pui_printing.spec.ts

@@ -0,0 +1,149 @@
+import { expect, test } from './baseFixtures.js';
+import { activateTableView, loadTab } from './helpers.js';
+import { doCachedLogin } from './login.js';
+import { setPluginState } from './settings.js';
+
+/*
+ * Test for label printing.
+ * Select a number of stock items from the table,
+ * and print labels against them
+ */
+test('Label Printing', async ({ browser }) => {
+  const page = await doCachedLogin(browser, { url: 'stock/location/index/' });
+
+  await page.waitForURL('**/web/stock/location/**');
+
+  await loadTab(page, 'Stock Items');
+
+  // Select some labels
+  await page.getByLabel('Select record 1', { exact: true }).click();
+  await page.getByLabel('Select record 2', { exact: true }).click();
+  await page.getByLabel('Select record 3', { exact: true }).click();
+
+  await page
+    .getByLabel('Stock Items')
+    .getByLabel('action-menu-printing-actions')
+    .click();
+  await page.getByLabel('action-menu-printing-actions-print-labels').click();
+
+  // Select plugin
+  await page.getByLabel('related-field-plugin').click();
+  await page.getByText('InvenTreeLabelSheet').click();
+
+  // Select label template
+  await page.getByLabel('related-field-template').click();
+  await page.getByText('InvenTree Stock Item Label (').click();
+
+  await page.waitForTimeout(100);
+
+  // Submit the print form (second time should result in success)
+  await page.getByRole('button', { name: 'Print', exact: true }).isEnabled();
+  await page.getByRole('button', { name: 'Print', exact: true }).click();
+
+  await page.getByText('Process completed successfully').first().waitFor();
+  await page.context().close();
+});
+
+/*
+ * Test for report printing
+ * Navigate to a PurchaseOrder detail page,
+ * and print a report against it.
+ */
+test('Report Printing', async ({ browser }) => {
+  const page = await doCachedLogin(browser, { url: 'stock/location/index/' });
+
+  await page.waitForURL('**/web/stock/location/**');
+
+  // Navigate to a specific PurchaseOrder
+  await page.getByRole('tab', { name: 'Purchasing' }).click();
+  await loadTab(page, 'Purchase Orders');
+  await activateTableView(page);
+
+  await page.getByRole('cell', { name: 'PO0009' }).click();
+
+  // Select "print report"
+  await page.getByLabel('action-menu-printing-actions').click();
+  await page.getByLabel('action-menu-printing-actions-print-reports').click();
+
+  // Select template
+  await page.getByLabel('related-field-template').click();
+  await page.getByText('InvenTree Purchase Order').click();
+
+  await page.waitForTimeout(100);
+
+  // Submit the print form (should result in success)
+  await page.getByRole('button', { name: 'Print', exact: true }).isEnabled();
+  await page.getByRole('button', { name: 'Print', exact: true }).click();
+
+  await page.getByText('Process completed successfully').first().waitFor();
+  await page.context().close();
+});
+
+test('Report Editing', async ({ browser, request }) => {
+  const page = await doCachedLogin(browser, {
+    username: 'admin',
+    password: 'inventree'
+  });
+
+  // activate the sample plugin for this test
+  await setPluginState({
+    request,
+    plugin: 'sampleui',
+    state: true
+  });
+
+  // Navigate to the admin center
+  await page.getByRole('button', { name: 'admin' }).click();
+  await page.getByRole('menuitem', { name: 'Admin Center' }).click();
+  await loadTab(page, 'Label Templates');
+  await page
+    .getByRole('cell', { name: 'InvenTree Stock Item Label (' })
+    .click();
+
+  // Generate preview
+  await page.getByLabel('split-button-preview-options-action').click();
+  await page
+    .getByLabel('split-button-preview-options-item-preview-save', {
+      exact: true
+    })
+    .click();
+
+  await page.getByRole('button', { name: 'Save & Reload' }).click();
+
+  await page.getByText('The preview has been updated').waitFor();
+
+  // Test plugin provided editors
+  await page.getByRole('tab', { name: 'Sample Template Editor' }).click();
+  const textarea = page.locator('#sample-template-editor-textarea');
+  const textareaValue = await textarea.inputValue();
+  expect(textareaValue).toContain(
+    `<img class='qr' alt="{% trans 'QR Code' %}" src='{% qrcode qr_data %}'>`
+  );
+  textarea.fill(`${textareaValue}\nHello world`);
+
+  // Switch back and forth to see if the changed contents get correctly passed between the hooks
+  await page.getByRole('tab', { name: 'Code', exact: true }).click();
+  await page.getByRole('tab', { name: 'Sample Template Editor' }).click();
+  const newTextareaValue = await page
+    .locator('#sample-template-editor-textarea')
+    .inputValue();
+  expect(newTextareaValue).toMatch(/\nHello world$/);
+
+  // Test plugin provided previews
+  await page.getByRole('tab', { name: 'Sample Template Preview' }).click();
+  await page.getByRole('heading', { name: 'Hello world' }).waitFor();
+  const consoleLogPromise = page.waitForEvent('console');
+  await page
+    .getByLabel('split-button-preview-options', { exact: true })
+    .click();
+  const msg = (await consoleLogPromise).args();
+  expect(await msg[0].jsonValue()).toBe('updatePreview');
+  expect(await msg[1].jsonValue()).toBe(newTextareaValue);
+
+  // deactivate the sample plugin again after the test
+  await setPluginState({
+    request,
+    plugin: 'sampleui',
+    state: false
+  });
+});