@salesforcedevs/sfdocs-e2e 0.6.132-linkfix-alpha

package/src/portal/pageobjects/docs.apis.page.ts

@@ -0,0 +1,23 @@
+import Page from '../../shared/pageobjects/page';
+
+/**
+ * sub page containing specific selectors and methods for a specific page
+ */
+export default class DocsApisPage extends Page {
+    constructor(url?: string) {
+        if (url) {
+            super(url);
+        } else {
+            super('/docs/apis');
+        }
+    }
+
+    async getSidebarContent(): Promise<WebdriverIO.Element> {
+        return $('>>>div.tile-selected');
+    }
+
+    async waitPageLoad(): Promise<void> {
+        const mainContent = await $('>>>#maincontent');
+        mainContent.waitForDisplayed({ timeout: 10000 });
+    }
+}

package/src/portal/pageobjects/docs.page.ts

@@ -0,0 +1,18 @@
+import Page from '../../shared/pageobjects/page';
+
+/**
+ * sub page containing specific selectors and methods for a specific page
+ */
+export default class DocsPage extends Page {
+    constructor(url?: string) {
+        if (url) {
+            super(url);
+        } else {
+            super('/docs');
+        }
+    }
+
+    async waitPageLoad(): Promise<void> {
+        await (await $('>>>#maincontent')).waitForDisplayed();
+    }
+}

package/src/portal/pageobjects/help-page/ScopeSeachTest.page.ts

@@ -0,0 +1,20 @@
+import Page from '../../../shared/pageobjects/page';
+
+/**
+ * ScopeSeachTestPage https://developer.salesforce.com/docs/platform/graphql/guide/graphql-about.html
+ */
+class ScopeSeachTestPage extends Page {
+    constructor(url: string) {
+        super(url);
+    }
+
+    async getTitle(): Promise<WebdriverIO.Element> {
+        return $('>>>h2.dx-text-heading-2');
+    }
+
+    async waitPageLoad(): Promise<void> {
+        await (await $('>>>doc-content-layout')).waitForDisplayed();
+    }
+}
+
+export default ScopeSeachTestPage;

package/src/portal/specs/docs.api.test.ts

@@ -0,0 +1,68 @@
+import DocsApisPage from '../pageobjects/docs.apis.page';
+import layoutTest from '../../shared/specs/layout-tests';
+import DocsContentLayout from '../../shared/pageobjects/docs-content-layout';
+
+let page: DocsApisPage;
+describe('/docs page basic display', () => {
+    beforeEach(async () => {
+        page = new DocsApisPage('/docs/apis');
+        page.open();
+        return await page.waitPageLoad();
+    });
+
+    layoutTest(page);
+
+    it('should have the right title', () => {
+        expect(browser).toHaveTitle('Salesforce Developers');
+    });
+
+    it('should display project cards', async () => {
+        const cards = $('dx-section.api-landing-section_list')
+            .then((section) => section.$('dx-grid'))
+            .then((grid) => grid.$$('dx-card-docs'));
+
+        expect((await cards).length).not.toBe(0);
+    });
+
+    it('should display project cards click on overview - test first overview card', async () => {
+        const projectCards = await page.projectCardsWithGuides;
+        projectCards.forEach(async (cardElem, index) => {
+            if (index === 1) {
+                const guideButton = await cardElem.$('dx-button[href*=overview]');
+                await guideButton.click();
+                await DocsContentLayout.waitForContentLayoutSidebar();
+                const heading = await DocsContentLayout.getSidebarHeading();
+
+                expect(heading).toBe('Overview');
+            }
+        });
+    });
+
+    it('should display project cards click on guides - test first guide card', async () => {
+        const projectCards = await page.projectCardsWithGuides;
+        projectCards.forEach(async (cardElem, index) => {
+            if (index === 1) {
+                const guideButton = await cardElem.$('dx-button[href*=guide]');
+                await guideButton.click();
+                await DocsContentLayout.waitForContentLayoutSidebar();
+                const heading = await DocsContentLayout.getSidebarHeading();
+
+                expect(heading).toBe('Guides');
+            }
+        });
+    });
+
+    it('should display project cards click on references - test first references card', async () => {
+        const projectCards = await page.projectCardsWithReferences;
+        projectCards.forEach(async (cardElem, index) => {
+            if (index === 1) {
+                const refButton = await cardElem.$('dx-button[href*=references]');
+                await refButton.click();
+                await DocsContentLayout.waitForContentLayoutSidebar();
+                const heading = await DocsContentLayout.getSidebarHeading();
+
+                expect(heading).toBe('References');
+            }
+        });
+    });
+});

package/src/portal/specs/docs.test.ts

@@ -0,0 +1,84 @@
+import OpenPage from '../pageobjects/docs.page';
+import layoutTest from '../../shared/specs/layout-tests';
+
+let page: OpenPage;
+
+describe('/docs page basic display > ', () => {
+    beforeEach(async () => {
+        page = new OpenPage('/docs');
+        page.open();
+        await page.waitPageLoad();
+    });
+
+    layoutTest(page);
+
+    it('should have the right title', () => {
+        expect(browser).toHaveTitle('Salesforce Developers');
+    });
+
+    it('Should display tabs ', async () => {
+        const tabSection = await $('#maincontent div dx-section:nth-child(2)');
+
+        expect(await tabSection.isDisplayed()).toBeTruthy();
+        expect(await tabSection.getText()).toContain('FEATURED');
+        expect(await tabSection.getText()).toContain('ALL');
+    });
+
+    it('Should display Release notes and Browse APIS tabs ', async () => {
+        const tabSection = await $('>>>#maincontent div dx-section:nth-child(3)');
+
+        expect(await tabSection.isDisplayed()).toBeTruthy();
+        expect(await tabSection).toHaveLinkContaining('/docs/apis');
+        expect(await tabSection.getText()).toContain('Read Release Notes');
+        expect(await tabSection.getText()).toContain('Browse APIs');
+    });
+
+    it('Tab : FEATURED should present and also clickable', async () => {
+        const selectedTab = await $('dx-button.docs-tab-link.selected');
+
+        expect(await selectedTab.isClickable()).toBeTruthy();
+        expect(await selectedTab.getText()).toEqual('FEATURED');
+        expect(await selectedTab).toHaveLinkContaining('/docs');
+    });
+
+    it('Tab : ALL should present and also clickable', async () => {
+        const nonselectedTab = await $('dx-button.docs-tab-link:nth-child(2)');
+
+        expect(await nonselectedTab.isClickable()).toBeTruthy();
+        expect(await nonselectedTab.getText()).toEqual('ALL');
+        expect(await nonselectedTab).toHaveLinkContaining('/docs/list');
+    });
+
+    it('Docs list : Check if docs cards are getting added', async () => {
+        // Selecting 'All' in /docs page.
+        const nonselectedTab = await $('dx-button.docs-tab-link:nth-child(2)');
+        nonselectedTab.click();
+        await page.waitPageLoad();
+        const docsCards = await $$('>>>.docs-grid-container > dx-grid > dx-card-docs.docs-card');
+        await (await docsCards[0]).scrollIntoView();
+        expect(await nonselectedTab.getAttribute('class')).toEqual('docs-tab-link selected');
+        // await browser.waitUntil(
+        //     async () =>
+        //         (await (await docsCards[0].$('>>> dx-card-title > h3')).getText()) ===
+        //         'A Guide to Sharing Architecture',
+        //     {
+        //         timeout: 25000,
+        //         timeoutMsg: 'Expected Couch db docs could not be loaded',
+        //     },
+        // );
+        // expect(await (await docsCards[0].$('>>> dx-card-title > h3')).getText()).toEqual(
+        //     'A Guide to Sharing Architecture',
+        // );
+    });
+
+    it('Docs list : Search for invalid text to show no product result', async () => {
+        page = new OpenPage('/docs/list?filter_text=tableau%20xyz&lang=en-us&page=1');
+        page.open();
+        await page.waitPageLoad();
+        const emptyDocsMsg = await $('>>>dx-empty-state div > h3');
+        expect(await emptyDocsMsg.getText()).toEqual('Beep boop. That did not compute.');
+        expect(await (await $('>>>dx-empty-state div > p')).getText()).toEqual(
+            'Sorry, no results were found for your search "tableau xyz"',
+        );
+    });
+});

package/src/portal/specs/media-mapper.test.ts

@@ -0,0 +1,42 @@
+import GuidePage from '../../shared/pageobjects/guide.page';
+
+const mediaMapperTest = async (url: string, alt: string, expectedSrc: string) => {
+    const page = new GuidePage(url);
+    page.open();
+    await page.waitPageLoad();
+
+    const srcValue = await $(`[alt="${alt}"]`).getAttribute('src');
+
+    expect(srcValue).toMatch(expectedSrc);
+};
+
+describe('/docs Media Mapper > ', () => {
+    it('should show images with the cdn image when cdn image mapping is enabled', async () => {
+        const url = 'docs/plugin-development/guide/markdown-cheatsheet.html';
+        const alt = 'SalesforceDocs';
+        const expectedSrc =
+            'https://a.sfdcstatic.com/developer-website/sfdocs/example-repository/media/salesforcedocs.png';
+
+        await mediaMapperTest(url, alt, expectedSrc);
+    });
+
+    it('should show images with the cdn image in references', async () => {
+        const url =
+            'docs/commerce/ja-jp/flex-references-loc/references/manual-ref/find-sfra-tools.html';
+        const alt = 'Create Branch';
+        const expectedSrc =
+            'https://a.sfdcstatic.com/developer-website/sfdocs/example-repository/media/ja-jp/clone-create-branch.gif';
+
+        await mediaMapperTest(url, alt, expectedSrc);
+    });
+
+    it('should show images with the cdn image in other locales', async () => {
+        const url =
+            'docs/commerce/ja-jp/flex-references-loc/references/manual-ref/commerce-cloud-api-overview.html';
+        const alt = 'Clone Repo';
+        const expectedSrc =
+            'https://a.sfdcstatic.com/developer-website/sfdocs/example-repository/media/ja-jp/clone-repo.png';
+
+        await mediaMapperTest(url, alt, expectedSrc);
+    });
+});

package/src/portal/specs/scope.search.guide.test.ts

@@ -0,0 +1,33 @@
+import ScopeSeachTestPage from '../pageobjects/help-page/ScopeSeachTest.page';
+
+let page: ScopeSeachTestPage;
+
+describe.skip('Scope Search Reference Test', () => {
+    beforeEach(async () => {
+        page = new ScopeSeachTestPage(
+            'https://developer.salesforce.com/docs/platform/graphql/guide/',
+        );
+        page.open();
+        await page.waitPageLoad();
+    });
+
+    it('should send notfication if the scope search is not Working', async () => {
+        await $('doc-content-layout')
+            .then((layout) => layout.shadow$('div > dx-sidebar'))
+            .then((sidebar) => sidebar.waitForDisplayed());
+        const sidebar = await (await $('doc-content-layout')).shadow$('div > dx-sidebar');
+        const dxInput = await sidebar.shadow$(
+            'div > div.sidebar-header > div.search > dx-sidebar-search',
+        );
+        const dxinput1 = await dxInput.shadow$('dx-dropdown > dx-input');
+        const searchBox = await dxinput1.shadow$('input');
+        await searchBox.click();
+        await browser.keys('Support');
+        const trees = await sidebar.shadow$(
+            'div.container div.sidebar-content dx-sidebar-search-result',
+        );
+        const servicesTree = await trees.shadow$('span > span');
+        const searchResults = await servicesTree.getText();
+        expect(searchResults.length).toBeGreaterThan(0);
+    });
+});

package/src/portal/specs/scope.search.reference.test.ts

@@ -0,0 +1,37 @@
+import ScopeSeachTestPage from '../pageobjects/help-page/ScopeSeachTest.page';
+
+let page: ScopeSeachTestPage;
+
+describe.skip('Scope Search Reference Test', () => {
+    beforeEach(async () => {
+        page = new ScopeSeachTestPage(
+            'https://developer.salesforce.com/docs/platform/graphql/references/',
+        );
+        page.open();
+        await page.waitPageLoad();
+    });
+
+    it('should send notfication if the scope search is not Working for reference Page ', async () => {
+        await $('doc-amf-reference')
+            .then((additional) => additional.shadow$('doc-content-layout'))
+            .then((layout) => layout.shadow$('div > dx-sidebar'))
+            .then((sidebar) => sidebar.waitForDisplayed());
+
+        const layer = await (await $('doc-amf-reference')).shadow$('doc-content-layout');
+        const sidebar = await layer.shadow$('div > dx-sidebar');
+
+        const dxInput = await sidebar.shadow$(
+            'div > div.sidebar-header > div.search > dx-sidebar-search',
+        );
+        const dxinput1 = await dxInput.shadow$('dx-dropdown > dx-input');
+        const searchBox = await dxinput1.shadow$('input');
+        await searchBox.click();
+        await browser.keys('Graphql');
+        const trees = await sidebar.shadow$(
+            'div.container div.sidebar-content dx-sidebar-search-result',
+        );
+        const servicesTree = await trees.shadow$('span > span');
+        const searchResults = await servicesTree.getText();
+        expect(searchResults.length).toBeGreaterThan(0);
+    });
+});

package/src/shared/pageobjects/api-redoc-reference.page.ts

@@ -0,0 +1,40 @@
+import Page from './page';
+/**
+ * Redoc API reference page object so that we can use all centralized methods.
+ */
+class ApiRedocReferencePage extends Page {
+    constructor(url?: string) {
+        if (url) {
+            super(url);
+        } else {
+            super('/docs/');
+        }
+    }
+
+    async waitPageLoad(): Promise<void> {
+        await $('doc-redoc-reference > .redoc-container').waitForDisplayed({
+            timeout: this.REFERENCE_LOAD_WAIT_TIME,
+        });
+    }
+
+    async getApiTitle(): Promise<WebdriverIO.Element> {
+        return $('>>>div.api-info > h1');
+    }
+
+    async getSidebar(): Promise<WebdriverIO.Element> {
+        return $('.redoc-wrap > .menu-content');
+    }
+
+    async getContent(): Promise<WebdriverIO.Element> {
+        return $('.redoc-wrap > .api-content');
+    }
+
+    async getLnbItemByIndex(index: number): Promise<WebdriverIO.Element> {
+        const sidebar = await this.getSidebar();
+        const scrollbarContainer = sidebar.$('.scrollbar-container');
+        const lnbItems = await scrollbarContainer.$$('ul[role="menu"] > li');
+        return lnbItems[index];
+    }
+}
+
+export default ApiRedocReferencePage;

package/src/shared/pageobjects/callout.ts

@@ -0,0 +1,24 @@
+import Page from './page';
+
+/**
+ * sub page containing specific selectors and methods for a specific page
+ */
+export class Callout extends Page {
+    async waitAndGetDocPhaseParentInGuidePage(): Promise<WebdriverIO.Element> {
+        (await $('doc-content-layout')).waitForDisplayed({ timeout: 5000 });
+
+        return $('doc-content-layout');
+    }
+
+    async waitAndGetListOfCallout(
+        sectionsContentLayout: WebdriverIO.Element,
+    ): Promise<WebdriverIO.Element[]> {
+        (await sectionsContentLayout.shadow$('doc-content-callout')).waitForDisplayed({
+            timeout: 5000,
+        });
+
+        return sectionsContentLayout.$$('>>>doc-content-callout');
+    }
+}
+
+export default new Callout();

package/src/shared/pageobjects/doc-phase-config.ts

@@ -0,0 +1,106 @@
+export const phases = {
+    beta: 'beta',
+    pilot: 'pilot',
+    devPreview: 'devPreview',
+};
+
+export const getDocConfigWithPhaseForRedoc = (phase: string): { title: string; body: string } => {
+    switch (phase) {
+        case phases.beta:
+            return {
+                title: 'Parent Banner Indicator',
+                body: 'This parent banner feature is made available on an AS IS basis and use of this feature is at your sole risk.',
+            };
+        case phases.pilot:
+            return {
+                title: 'Reference Banner Indicator',
+                body: 'This reference feature is made available on an AS IS basis and use of this feature is at your sole risk.',
+            };
+        default:
+            return {
+                title: 'Developer Preview',
+                body: 'This dev preview feature is made',
+            };
+    }
+};
+
+export const getDocConfigWithPhase = (phase: string): { title: string; body: string } => {
+    switch (phase) {
+        case phases.beta:
+            return {
+                title: 'Beta Indicator',
+                body: 'This beta feature is made',
+            };
+        case phases.pilot:
+            return {
+                title: 'Pilot Indicator',
+                body: 'This pilot feature is made',
+            };
+        default:
+            return {
+                title: 'Developer Preview',
+                body: 'This dev preview feature is made',
+            };
+    }
+};
+
+export const waitAndGetDocPhaseParentInOverviewPage = async (): Promise<WebdriverIO.Element> => {
+    (await $('.content-type-overview')).waitForDisplayed({ timeout: 5000 });
+
+    return await $('.content-type-overview');
+};
+
+export const waitAndGetDocPhaseParentInGuidePage = async (): Promise<WebdriverIO.Element> => {
+    (await $('doc-content-layout')).waitForDisplayed({ timeout: 5000 });
+
+    return await $('doc-content-layout');
+};
+
+export const waitAndGetDocPhaseParentInReferencesPage = async (): Promise<WebdriverIO.Element> => {
+    (await $('doc-amf-reference')).waitForDisplayed({ timeout: 5000 });
+
+    const reference = await $('doc-amf-reference');
+    return await reference.shadow$('doc-content-layout');
+};
+
+export const waitAndGetDocPhaseParentInRedocReferencesPage =
+    async (): Promise<WebdriverIO.Element> => {
+        (await $('doc-redoc-reference')).waitForDisplayed({ timeout: 5000 });
+
+        const reference = await $('doc-redoc-reference > .redoc-container');
+        return reference;
+    };
+
+export const assertDocPhaseElements = async (
+    parentElement: WebdriverIO.Element,
+    phase: string = phases.devPreview,
+): Promise<void> => {
+    const docPhase = await parentElement.$('doc-phase');
+    const title = await docPhase.shadow$('.doc-phase-title');
+    const body = await docPhase.shadow$('.doc-phase-body');
+    const docConfig = getDocConfigWithPhase(phase);
+
+    expect(await title.getText()).toBe(docConfig.title);
+    expect(await body.getText()).toContain(docConfig.body);
+};
+
+export const assertDocPhaseElementsForRedoc = async (
+    parentElement: WebdriverIO.Element,
+    phase: string = phases.devPreview,
+): Promise<void> => {
+    const docPhase = await parentElement.$('doc-phase');
+    const title = await docPhase.shadow$('.doc-phase-title');
+    const body = await docPhase.shadow$('.doc-phase-body');
+    const docConfig = getDocConfigWithPhaseForRedoc(phase);
+    expect(await title.getText()).toBe(docConfig.title);
+    expect(await body.getText()).toContain(docConfig.body);
+};
+
+export const assertDocPhaseUnavailability = async (
+    parentElement: WebdriverIO.Element,
+): Promise<void> => {
+    const docPhase = await parentElement.$('doc-phase');
+    const isExisting = await docPhase.isExisting();
+
+    expect(isExisting).toBe(false);
+};

package/src/shared/pageobjects/docs-content-layout.ts

@@ -0,0 +1,17 @@
+class DocsContentLayout {
+    SIDEBAR_HEADING_SELECTOR = 'div > div.padding-horizontal > div.header > h1.header-title';
+
+    async waitForContentLayoutSidebar(): Promise<void> {
+        const layout = await $('doc-content-layout');
+        const sidebar = await layout.shadow$('div > dx-sidebar');
+        await sidebar.waitForDisplayed();
+    }
+
+    async getSidebarHeading(): Promise<string> {
+        const sidebar = await (await $('doc-content-layout')).shadow$('div > dx-sidebar');
+        const heading = await sidebar.shadow$(this.SIDEBAR_HEADING_SELECTOR);
+        return heading.getText();
+    }
+}
+
+export default new DocsContentLayout();

package/src/shared/pageobjects/error.page.ts

@@ -0,0 +1,14 @@
+import Page from './page';
+
+/**
+ * Error page (e.g. 404 / page-not-found)
+ */
+export default class ErrorPage extends Page {
+    constructor(url?: string) {
+        if (url) {
+            super(url);
+        } else {
+            super('/page-not-found');
+        }
+    }
+}

package/src/shared/pageobjects/guide.page.ts

@@ -0,0 +1,24 @@
+import Page from './page';
+
+/**
+ * Guide page
+ */
+class GuidePage extends Page {
+    constructor(url?: string) {
+        if (url) {
+            super(url);
+        } else {
+            super('/docs/apis');
+        }
+    }
+
+    async getApiTitle(): Promise<WebdriverIO.Element> {
+        return $('>>>div.api-title');
+    }
+
+    async waitPageLoad(): Promise<void> {
+        await (await $('>>>doc-content-layout')).waitForDisplayed();
+    }
+}
+
+export default GuidePage;

package/src/shared/pageobjects/overview.page.ts

@@ -0,0 +1,20 @@
+import Page from './page';
+
+/**
+ * Overview page
+ */
+class OverviewPage extends Page {
+    constructor(url: string) {
+        super(url);
+    }
+
+    async getApiTitle(): Promise<WebdriverIO.Element> {
+        return $('>>>h2.dx-text-heading-2');
+    }
+
+    async waitPageLoad(): Promise<void> {
+        await (await $('>>>.overview-content')).waitForDisplayed();
+    }
+}
+
+export default OverviewPage;