A local-first personal finance app
:white_check_mark: (e2e) adding e2e tests for schedules page (#694)
Matiss Janis Aboltinsfa28f2828900
diff --git a/packages/desktop-client/e2e/page-models/navigation.js b/packages/desktop-client/e2e/page-models/navigation.jsindex 839997652f..af5ba6acb3 100644--- a/packages/desktop-client/e2e/page-models/navigation.js+++ b/packages/desktop-client/e2e/page-models/navigation.js@@ -1,4 +1,5 @@import { AccountPage } from './account-page';+import { SchedulesPage } from './schedules-page';export class Navigation {constructor(page) {@@ -12,4 +13,10 @@ export class Navigation {return new AccountPage(this.page);}++ async goToSchedulesPage() {+ await this.page.getByRole('link', { name: 'Schedules' }).click();++ return new SchedulesPage(this.page);+ }}diff --git a/packages/desktop-client/e2e/page-models/schedules-page.js b/packages/desktop-client/e2e/page-models/schedules-page.jsnew file mode 100644index 0000000000..c61dbad381--- /dev/null+++ b/packages/desktop-client/e2e/page-models/schedules-page.js@@ -0,0 +1,93 @@+export class SchedulesPage {+ constructor(page) {+ this.page = page;++ this.addNewScheduleButton = this.page.getByRole('button', {+ name: 'Add new schedule',+ });+ this.schedulesTableRow = this.page.getByTestId('table').getByTestId('row');+ }++ /**+ * Add a new schedule+ */+ async addNewSchedule(data) {+ await this.addNewScheduleButton.click();++ await this._fillScheduleFields(data);++ await this.page.getByRole('button', { name: 'Add' }).click();+ }++ /**+ * Retrieve the row element for the nth-schedule.+ * 0-based index+ */+ getNthScheduleRow(index) {+ return this.schedulesTableRow.nth(index);+ }++ /**+ * Retrieve the data for the nth-schedule.+ * 0-based index+ */+ async getNthSchedule(index) {+ const row = this.getNthScheduleRow(index);++ return {+ payee: await row.getByTestId('payee').textContent(),+ account: await row.getByTestId('account').textContent(),+ date: await row.getByTestId('date').textContent(),+ status: await row.getByTestId('status').textContent(),+ amount: await row.getByTestId('amount').textContent(),+ };+ }++ /**+ * Create a transaction for the nth-schedule.+ * 0-based index+ */+ async postNthSchedule(index) {+ await this._performNthAction(index, 'Post transaction');+ await this.page.waitForTimeout(1000);+ }++ /**+ * Complete the nth-schedule.+ * 0-based index+ */+ async completeNthSchedule(index) {+ await this._performNthAction(index, 'Complete');+ await this.page.waitForTimeout(1000);+ }++ async _performNthAction(index, actionName) {+ const row = this.getNthScheduleRow(index);+ const actions = row.getByTestId('actions');++ await actions.getByRole('button').click();+ await this.page.getByRole('button', { name: actionName }).click();+ }++ async _fillScheduleFields(data) {+ if (data.payee) {+ await this.page.getByLabel('Payee').click();+ await this.page.keyboard.type(data.payee);+ await this.page.keyboard.press('Enter');+ }++ if (data.account) {+ await this.page.getByLabel('Account').click();+ await this.page.keyboard.type(data.account);+ await this.page.keyboard.press('Enter');+ }++ if (data.amount) {+ await this.page.getByLabel('Amount').click();+ await this.page.keyboard.press('Control+A');+ await this.page.keyboard.press('Delete');+ await this.page.keyboard.type(String(data.amount));+ await this.page.keyboard.press('Enter');+ }+ }+}diff --git a/packages/desktop-client/e2e/schedules.test.js b/packages/desktop-client/e2e/schedules.test.jsnew file mode 100644index 0000000000..3c194c3fb7--- /dev/null+++ b/packages/desktop-client/e2e/schedules.test.js@@ -0,0 +1,64 @@+import { test, expect } from '@playwright/test';++import { ConfigurationPage } from './page-models/configuration-page';+import { Navigation } from './page-models/navigation';++test.describe('Schedules', () => {+ let page;+ let navigation;+ let schedulesPage;+ let configurationPage;++ test.beforeAll(async ({ browser }) => {+ page = await browser.newPage();+ navigation = new Navigation(page);+ configurationPage = new ConfigurationPage(page);++ await page.goto('/');+ await configurationPage.createTestFile();+ });++ test.afterAll(async () => {+ await page.close();+ });++ test.beforeEach(async () => {+ schedulesPage = await navigation.goToSchedulesPage();+ });++ test('creates a new schedule, posts the transaction and later completes it', async () => {+ await schedulesPage.addNewSchedule({+ payee: 'Home Depot',+ account: 'HSBC',+ amount: 25,+ });++ expect(await schedulesPage.getNthSchedule(0)).toMatchObject({+ payee: 'Home Depot',+ account: 'HSBC',+ amount: '~25.00',+ status: 'Due',+ });++ await schedulesPage.postNthSchedule(0);+ expect(await schedulesPage.getNthSchedule(0)).toMatchObject({+ status: 'Paid',+ });++ // Go to transactions page+ const accountPage = await navigation.goToAccountPage('HSBC');+ expect(await accountPage.getNthTransaction(0)).toMatchObject({+ payee: 'Home Depot',+ category: 'Categorize',+ debit: '25.00',+ credit: '',+ });++ // Go back to schedules page+ await navigation.goToSchedulesPage();+ await schedulesPage.completeNthSchedule(0);+ expect(await schedulesPage.getNthScheduleRow(0)).toHaveText(+ 'Show completed schedules',+ );+ });+});diff --git a/packages/desktop-client/src/components/schedules/EditSchedule.js b/packages/desktop-client/src/components/schedules/EditSchedule.jsindex 7fe5ce68ab..5e61e2373f 100644--- a/packages/desktop-client/src/components/schedules/EditSchedule.js+++ b/packages/desktop-client/src/components/schedules/EditSchedule.js@@ -427,10 +427,10 @@ export default function ScheduleDetails() {><Stack direction="row" style={{ marginTop: 20 }}><FormField style={{ flex: 1 }}>- <FormLabel title="Payee" />+ <FormLabel title="Payee" htmlFor="payee-field" /><PayeeAutocompletevalue={state.fields.payee}- inputProps={{ placeholder: '(none)' }}+ inputProps={{ id: 'payee-field', placeholder: '(none)' }}onSelect={id =>dispatch({ type: 'set-field', field: 'payee', value: id })}@@ -438,11 +438,11 @@ export default function ScheduleDetails() {</FormField><FormField style={{ flex: 1 }}>- <FormLabel title="Account" />+ <FormLabel title="Account" htmlFor="account-field" /><AccountAutocompleteincludeClosedAccounts={false}value={state.fields.account}- inputProps={{ placeholder: '(none)' }}+ inputProps={{ id: 'account-field', placeholder: '(none)' }}onSelect={id =>dispatch({ type: 'set-field', field: 'account', value: id })}@@ -451,7 +451,11 @@ export default function ScheduleDetails() {<FormField style={{ flex: 1 }}><Stack direction="row" align="center" style={{ marginBottom: 3 }}>- <FormLabel title="Amount" style={{ margin: 0, flex: 1 }} />+ <FormLabel+ title="Amount"+ htmlFor="amount-field"+ style={{ margin: 0, flex: 1 }}+ /><OpSelectops={['is', 'isapprox', 'isbetween']}value={state.fields.amountOp}@@ -490,6 +494,7 @@ export default function ScheduleDetails() {/>) : (<AmountInput+ id="amount-field"defaultValue={state.fields.amount}onChange={value =>dispatch({diff --git a/packages/desktop-client/src/components/schedules/SchedulesTable.js b/packages/desktop-client/src/components/schedules/SchedulesTable.jsindex 9b02316cf1..770504e6c6 100644--- a/packages/desktop-client/src/components/schedules/SchedulesTable.js+++ b/packages/desktop-client/src/components/schedules/SchedulesTable.js@@ -95,6 +95,7 @@ export function ScheduleAmountCell({ amount, op }) {alignItems: 'center',padding: '0 5px',}}+ name="amount">{isApprox && (<View@@ -206,18 +207,18 @@ export function SchedulesTable({':hover': { backgroundColor: colors.hover },}}>- <Field width="flex">+ <Field width="flex" name="payee"><DisplayId type="payees" id={item._payee} /></Field>- <Field width="flex">+ <Field width="flex" name="account"><DisplayId type="accounts" id={item._account} /></Field>- <Field width={110}>+ <Field width={110} name="date">{item.next_date? monthUtils.format(item.next_date, dateFormat): null}</Field>- <Field width={120} style={{ alignItems: 'flex-start' }}>+ <Field width={120} name="status" style={{ alignItems: 'flex-start' }}><StatusBadge status={statuses.get(item.id)} /></Field><ScheduleAmountCell amount={item._amount} op={item._amountOp} />@@ -229,7 +230,7 @@ export function SchedulesTable({</Field>)}{!minimal && (- <Field width={40}>+ <Field width={40} name="actions"><OverflowMenuschedule={item}status={statuses.get(item.id)}diff --git a/packages/desktop-client/src/components/util/AmountInput.js b/packages/desktop-client/src/components/util/AmountInput.jsindex d21fe311af..d9849a78a7 100644--- a/packages/desktop-client/src/components/util/AmountInput.js+++ b/packages/desktop-client/src/components/util/AmountInput.js@@ -12,7 +12,7 @@ import {import Add from 'loot-design/src/svg/v1/Add';import Subtract from 'loot-design/src/svg/v1/Subtract';-export function AmountInput({ defaultValue = 0, onChange, style }) {+export function AmountInput({ id, defaultValue = 0, onChange, style }) {let [negative, setNegative] = useState(defaultValue <= 0);let [value, setValue] = useState(integerToCurrency(Math.abs(defaultValue)));@@ -30,6 +30,7 @@ export function AmountInput({ defaultValue = 0, onChange, style }) {return (<InputWithContent+ id={id}leftContent={<Button bare style={{ padding: '0 7px' }} onClick={onSwitch}>{negative ? (diff --git a/packages/loot-design/src/components/common.js b/packages/loot-design/src/components/common.jsindex 876bd6275c..cd98c800cb 100644--- a/packages/loot-design/src/components/common.js+++ b/packages/loot-design/src/components/common.js@@ -626,6 +626,7 @@ export function Menu({ header, footer, items: allItems, onMenuSelect }) {return (<View+ role="button"key={item.name}style={[{diff --git a/packages/loot-design/src/components/forms.js b/packages/loot-design/src/components/forms.jsindex 86d02bd8f6..50dbe703bf 100644--- a/packages/loot-design/src/components/forms.js+++ b/packages/loot-design/src/components/forms.js@@ -25,10 +25,10 @@ export function SectionLabel({ title, style }) {);}-export function FormLabel({ style, title }) {+export function FormLabel({ style, title, htmlFor }) {return (<Text style={[{ fontSize: 13, marginBottom: 3, color: colors.n3 }, style]}>- {title}+ <label htmlFor={htmlFor}>{title}</label></Text>);}