Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WSL E2E tests: add more new locators #5315

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

WSL E2E tests: add more new locators #5315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
982e439
Add more integration e2e tests using locators.
ericpromislow Jul 24, 2023
ded75fc
Split the update test into two parts.
ericpromislow Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions e2e/pages/preferences/wsl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ export class WslNav {
readonly tabIntegrations: Locator;
readonly tabNetwork: Locator;
readonly tabProxy: Locator;
readonly alpha: Locator;
readonly beta: Locator;
readonly gamma: Locator;

constructor(page: Page) {
this.page = page;
Expand All @@ -19,5 +22,8 @@ export class WslNav {
this.tabProxy = page.locator('.tab >> text=Proxy');
this.wslIntegrations = page.locator('[data-test="wslIntegrations"]');
this.addressTitle = page.locator('[data-test="addressTitle"]');
this.alpha = page.locator('[data-test="item-alpha"] input[type="checkbox"]');
this.beta = page.locator('[data-test="item-beta"] input[type="checkbox"]');
this.gamma = page.locator('[data-test="item-gamma"] input[type="checkbox"]');
}
}
119 changes: 65 additions & 54 deletions e2e/wsl-integrations.e2e.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,83 +210,94 @@ test.describe('WSL Integrations', () => {
expect(wslIntegrationList.getByText('alpha')).not.toBeNull();
expect(wslIntegrationList.getByText('beta')).not.toBeNull();
expect(wslIntegrationList.getByText('gamma')).not.toBeNull();
});

/*
test('should show checkbox states', (async() => {
const integrations = wslPage.wslIntegrations;
const alpha = integrations.find(item => item.name === 'alpha');
const beta = wslPage.getIntegration('beta');
const gamma = wslPage.getIntegration('gamma');

await expect(alpha.locator).toHaveCount(1);
await expect(alpha.checkbox).not.toBeChecked();
await expect(alpha.name).toHaveText('alpha');
await expect(alpha.error).not.toBeVisible();

await expect(beta.locator).toHaveCount(1);
await expect(beta.checkbox).toBeChecked();
await expect(beta.name).toHaveText('beta');
await expect(beta.error).not.toBeVisible();

await expect(gamma.locator).toHaveCount(1);
await expect(gamma.checkbox).not.toBeChecked();
await expect(gamma.name).toHaveText('gamma');
await expect(gamma.error).toHaveText('some error');
expect(await wslPage.alpha.isChecked()).toBeFalsy();
expect(await wslPage.beta.isChecked()).toBeTruthy();
expect(await wslPage.gamma.isChecked()).toBeFalsy();

const craftyErrorMessage = 'Error: some error';
let parent = wslPage.page.locator('[data-test="item-alpha-parent"]');

await expect(parent.filter({ hasText: craftyErrorMessage })).toHaveCount(0);
parent = wslPage.page.locator('[data-test="item-beta-parent"]');
await expect(parent.filter({ hasText: craftyErrorMessage })).toHaveCount(0);
parent = wslPage.page.locator('[data-test="item-gamma-parent"]');
await expect(parent.filter({ hasText: craftyErrorMessage })).toHaveCount(1);
});

test('should allow enabling integration', async() => {
// This is how we do a reload...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we're doing a reload here, just casting preferencesWindow (which is a Page) to a Page subclass that knows how to handle the specifics of that window, and then grabbing the wslPage off it.

const { wsl: wslPage } = new PreferencesPage(preferencesWindow);
await wslPage.reload();
const integrations = wslPage.integrations;

await expect(integrations).toHaveCount(1, { timeout: 10_000 });
await wslPage.tabIntegrations.click();
await expect(wslPage.wslIntegrations).toBeVisible();

const alpha = wslPage.getIntegration('alpha');
await expect(wslPage.wslIntegrations).toHaveCount(1, { timeout: 10_000 });
let alpha = wslPage.alpha;

await expect(alpha.checkbox).not.toBeChecked();
await alpha.assertEnabled();
await alpha.click();
await alpha.assertDisabled();
expect(await alpha.isChecked()).toBeFalsy();
expect(await alpha.isEnabled()).toBeTruthy();
// Don't know why force-true is necessary, playwright times out without it.
await alpha.click({ force: true });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this is forcing a click on the <input type="checkbox">, but normally we'd be interacting with the owning <Checkbox> Vue component instead… That's why we had WSLIntegrationsPage.getIntegration(): CheckboxLocator.

await writeConfig({ alpha: true });
await alpha.assertEnabled();
await expect(alpha.checkbox).toBeChecked();
// Now 'relocate' alpha
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is a bit too punny and obscures what it's actually trying to explain… It's probably better to rewrite it to be clearer.

Or maybe just drop the local variable and always use wslPage.alpha instead?

alpha = wslPage.alpha;
expect(await alpha.isChecked()).toBeTruthy();
expect(await alpha.isEnabled()).toBeTruthy();
});

test('should allow disabling integration', async() => {
await wslPage.reload();
const integrations = wslPage.integrations;
// This is how we do a reload...
const { wsl: wslPage } = new PreferencesPage(preferencesWindow);

await expect(integrations).toHaveCount(1, { timeout: 10_000 });
await wslPage.tabIntegrations.click();
await expect(wslPage.wslIntegrations).toBeVisible();
await expect(wslPage.wslIntegrations).toHaveCount(1, { timeout: 10_000 });

const beta = wslPage.getIntegration('beta');
let beta = wslPage.beta;

await expect(beta.checkbox).toBeChecked();
await beta.assertEnabled();
await beta.click();
await beta.assertDisabled();
expect(await beta.isChecked()).toBeTruthy();
expect(await beta.isEnabled()).toBeTruthy();
await beta.click({ force: true });
await writeConfig({ beta: false });
await beta.assertEnabled();
await expect(beta.checkbox).not.toBeChecked();
// Now 'relocate' beta
beta = wslPage.beta;
expect(await beta.isChecked()).toBeFalsy();
expect(await beta.isEnabled()).toBeTruthy();
});

test('should update invalid reason', async() => {
await wslPage.reload();
const integrations = wslPage.integrations;
const { wsl: wslPage } = new PreferencesPage(preferencesWindow);
const newErrorMessage = 'some other error';

await expect(integrations).toHaveCount(1, { timeout: 10_000 });
await wslPage.tabIntegrations.click();
await expect(wslPage.wslIntegrations).toBeVisible();
await expect(wslPage.wslIntegrations).toHaveCount(1, { timeout: 10_000 });

const gamma = wslPage.getIntegration('gamma');
const gamma = wslPage.gamma;

expect(await gamma.isChecked()).toBeFalsy();
await writeConfig({ gamma: newErrorMessage });
});

await gamma.assertDisabled();
await expect(gamma.error).toHaveText('some error');
await writeConfig({ gamma: 'some other error' });
test('should see new invalid reason', async() => {
const { wsl: wslPage } = new PreferencesPage(preferencesWindow);
const newErrorMessage = 'some other error';

await page.reload();
const newGamma = (await navPage.navigateTo('WSLIntegrations')).getIntegration('gamma');
await wslPage.tabIntegrations.click();
await expect(wslPage.wslIntegrations).toBeVisible();
await expect(wslPage.wslIntegrations).toHaveCount(1, { timeout: 10_000 });

await expect(newGamma.error).toHaveText('some other error');
await newGamma.assertDisabled();
// The `isDisabled` locator simply doesn't work -- possibly because the actual DOM is
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above re: WSLIntegrationsPage.getIntegration(): CheckboxLocator.

// div.checkbox-outer-container data-test=item-gamma
// label.checkbox-container disabled
// input type=checkbox value=true
// span.checkbox-custom role=checkbox
//
// and playwright doesn't give a way to get from `data-test=item-gamma` or the checkbox input elt to that label elt
// expect(await newGamma.isDisabled()).toBeTruthy();
const parent = wslPage.page.locator('[data-test="item-gamma-parent"]');

await expect(parent.filter({ hasText: newErrorMessage })).toHaveCount(0);
});
*/
});
3 changes: 2 additions & 1 deletion pkg/rancher-desktop/components/WSLIntegration.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
<div
v-for="item of integrationsList"
:key="item.name"
:data-test="`item-${item.name}`"
:data-test="`item-${item.name}-parent`"
>
<checkbox
:value="item.value"
:label="item.name"
:disabled="item.disabled"
:description="item.description"
:data-test="`item-${item.name}`"
@input="toggleIntegration(item.name, $event)"
/>
</div>
Expand Down