@salesforcedevs/sfdocs-e2e 0.6.132-linkfix-alpha

package/src/shared/specs/reference.test.ts

@@ -0,0 +1,281 @@
+import { it } from 'mocha';
+import { ReferencePage } from '../pageobjects/reference.page';
+import GuidePage from '../pageobjects/guide.page';
+import layoutTest from './layout-tests';
+
+let referencePage: ReferencePage;
+describe('API Pages', () => {
+    describe('API References', () => {
+        beforeEach(async () => {
+            referencePage = new ReferencePage('/docs/commerce/test-cc-orders-api/references');
+            referencePage.open();
+        });
+
+        layoutTest(referencePage, 'doc-header');
+
+        it('should have the right title', async () => {
+            expect(browser).toHaveTitle('TEST Commerce Cloud Orders APIs');
+        });
+
+        it('renders the banner and header with correct text', async () => {
+            const apiTitle = await referencePage.getApiTitle();
+            const titleText = await apiTitle.getText();
+
+            expect(titleText).toMatch('Orders');
+        });
+
+        it('should highlight References in Nav tab', async () => {
+            const selectedHeaderNavItem = await referencePage.getActiveNavTab();
+
+            expect(await selectedHeaderNavItem.getText()).toMatch('Reference');
+        });
+
+        it('Highlight the first element in the sidebar ; Summary', async () => {
+            const selectedSideBar = await referencePage.getSidebarContent();
+
+            expect(await selectedSideBar.getText()).toMatch('Summary');
+        });
+    });
+});
+
+describe('Test Reference page transition> ', () => {
+    it('Check Guide to Reference page Transition', async () => {
+        const page = new GuidePage(
+            '/docs/commerce/test-cc-orders-api/guide/commerce-cloud-api-overview.html',
+        );
+        page.open();
+        await page.waitPageLoad();
+        await (await $('>>> h1#overview')).waitForDisplayed();
+        const docHeaderNav = await $('>>> .header_l2_group-nav_overflow');
+        const headerNav = await docHeaderNav.$('>>> dx-header-nav');
+        const navItem = await headerNav.shadow$$('nav > ul > li');
+        expect(navItem.length).toEqual(3);
+        const dxHeaderNavOpt = await navItem[2].$('dx-tab');
+        const referenceAnchor = await dxHeaderNavOpt.shadow$('a');
+        expect(await referenceAnchor.getAttribute('href')).toContain(
+            'docs/commerce/test-cc-orders-api/references',
+        );
+        expect(await (await referenceAnchor.$('span')).getText()).toEqual('Reference');
+        await navItem[2].click();
+        const header = await $('>>>doc-header');
+        await header.waitForDisplayed();
+        expect(await referenceAnchor.getAttribute('class')).toContain('nav-list-item state-active');
+    });
+});
+
+describe('API References Breadcrumbs', () => {
+    it('should show breadcrumbs properly', async () => {
+        referencePage = new ReferencePage(
+            '/docs/commerce/flex-references-vers/references/manual-ref/find-sfra-tools.html',
+        );
+        referencePage.open();
+        await referencePage.waitForMarkdownBasedReferencePageLoad();
+
+        const anchorBreadcrumb = await $('>>>doc-breadcrumbs doc-breadcrumb-item a');
+        const currentPageBreadcrumb = await $('>>>doc-breadcrumbs doc-breadcrumb-item span');
+
+        expect(anchorBreadcrumb).not.toBeNull();
+        expect(await anchorBreadcrumb.getText()).toBe('Get Started');
+        expect(currentPageBreadcrumb).not.toBeNull();
+        expect(await currentPageBreadcrumb.getText()).toBe('Find SFRA Tools');
+    });
+});
+
+describe('Reference Versioning', () => {
+    beforeEach(async () => {
+        referencePage = new ReferencePage('/docs/c-cart-apis/references/ref1?meta=Summary');
+        referencePage.open();
+    });
+
+    it('should check for the presence of version picker dropdown', async () => {
+        const versionBtn = await $('>>>.version-picker-button');
+        await versionBtn.waitForDisplayed();
+
+        expect(versionBtn.isExisting()).toBeTruthy();
+    });
+
+    it('should check for the default version in the version picker dropdown', async () => {
+        const versionText = await (await $('>>>p.selected-version-label')).getText();
+
+        expect(versionText).toEqual('0.1.3');
+    });
+
+    it('should check for all the versions in the version picker dropdown', async () => {
+        const versionBtn = await $('>>>.version-picker-button');
+        await versionBtn.waitForDisplayed();
+        await versionBtn.click();
+        const versionOptions = await $$('>>>doc-version-picker dx-dropdown-option');
+
+        expect(versionOptions.length).toEqual(2);
+        expect(await (await versionOptions[0].shadow$('div>div')).getText()).toEqual('0.1.3');
+        expect(await (await versionOptions[1].shadow$('div>div')).getText()).toEqual('0.1.2');
+    });
+
+    it('select an endpoint and change the version in version picker dropdown, it should navigate to summary', async () => {
+        const dxInput = await $('>>>dx-input.search-box');
+        const searchBox = await dxInput.shadow$('input');
+
+        await searchBox.click();
+        await browser.keys('/cart-coupons');
+
+        const dxTreeItems = await $$('>>>dx-tree-item');
+
+        expect(dxTreeItems.length > 2).toBeTruthy();
+
+        await (await dxTreeItems[2]).click();
+
+        const versionBtn = await $('>>>.version-picker-button');
+
+        await versionBtn.waitForDisplayed();
+        await versionBtn.click();
+
+        const versionOptions = await $$('>>>doc-version-picker dx-dropdown-option');
+
+        await versionOptions[1].waitForClickable();
+        await versionOptions[1].click();
+        await browser.pause(1000);
+
+        const apiTitle = await (await $('>>>div.api-title span')).getText();
+        const apiVersion = await (await $('>>>p.version span')).getText();
+
+        expect(apiTitle).toEqual('Salesforce Connect API');
+        expect(apiVersion).toEqual('53.0');
+    });
+
+    it('Change the version in version picker dropdown, url should have the selected version', async () => {
+        const versionPicker = await $('>>>.version-picker-button');
+
+        await versionPicker.waitForDisplayed();
+        await versionPicker.click();
+
+        const versionOptions = await $$('>>>doc-version-picker dx-dropdown-option');
+        const selectedVersionText = await (await versionOptions[1].shadow$('div>div')).getText();
+
+        await versionOptions[1].click();
+
+        const url = await browser.getUrl();
+        expect(url).toContain(selectedVersionText);
+    });
+
+    it('should check for the latest versioned reference title', async () => {
+        referencePage = new ReferencePage(
+            '/docs/commerce/flex-references-vers/references/manual-ref',
+        );
+
+        referencePage.open();
+        await referencePage.waitForMarkdownBasedReferencePageLoad();
+
+        const title = await $('>>>h1');
+        const titleText = await title.getText();
+
+        expect(titleText).toEqual('Overview');
+    });
+
+    it('change the version and check whether the page is navigated to the respective spec-based reference endpoint', async () => {
+        referencePage = new ReferencePage(
+            '/docs/commerce/flex-references-vers/references/spec-ref?meta=createBasket',
+        );
+        referencePage.open();
+
+        await referencePage.waitForSpecBasedReferencePageLoad();
+        await referencePage.selectVersion();
+
+        const container = await $('>>>div.title-area div');
+        const apiTitle = await container.getText();
+
+        expect(apiTitle).toEqual('createBasket');
+    });
+});
+
+describe('Markdown-Based Flexible References', () => {
+    let referencePage: ReferencePage;
+
+    it('should check for markdown-based reference default first topic', async () => {
+        referencePage = new ReferencePage(
+            '/docs/commerce/flexible-references/references/shopper-manual-ref',
+        );
+        referencePage.open();
+        await referencePage.waitForMarkdownBasedReferencePageLoad();
+
+        const title = await $('h1');
+        const titleText = await title.getText();
+
+        expect(titleText).toEqual('Overview');
+    });
+
+    it('change the markdown-based reference topic and check whether the page is rendered', async () => {
+        referencePage = new ReferencePage(
+            '/docs/commerce/flexible-references/references/shopper-manual-ref',
+        );
+        referencePage.open();
+        await referencePage.waitForMarkdownBasedReferencePageLoad();
+
+        const dxInput = await $('>>>dx-input.search-box');
+        const searchBox = await dxInput.shadow$('input');
+        await searchBox.click();
+        await browser.keys('Change Shipping Address');
+        await browser.pause(1000);
+        const sidebar = await (await $('>>>doc-content-layout')).shadow$('div > dx-sidebar-old');
+        const sideBarContent = await sidebar.shadow$$('div.container div.sidebar-content dx-tree');
+        expect(sideBarContent.length).toEqual(1);
+        const tile = await (
+            await sideBarContent[0].shadow$('dx-tree-item')
+        ).shadow$('dx-tree-tile');
+        expect(tile.isExisting()).toBeTruthy();
+        await (await sideBarContent[0].shadow$('dx-tree-item')).click();
+        await referencePage.waitForMarkdownBasedReferencePageLoad();
+        const title = await $('>>>h1');
+        const titleText = await title.getText();
+        const codeBlock = await $('div.custom-code-block');
+
+        expect(titleText).toEqual('Update Your Order');
+        expect(codeBlock).toBeTruthy();
+    });
+});
+
+describe('Localized Markdown-Based Flexible References', () => {
+    it('should check for localized markdown-based reference ', async () => {
+        referencePage = new ReferencePage(
+            '/docs/commerce/ja-jp/flex-references-loc/references/manual-ref/commerce-cloud-api-overview.html',
+        );
+        referencePage.open();
+        await referencePage.waitForMarkdownBasedReferencePageLoad();
+
+        const languageDropdown = await $('>>>dx-dropdown');
+        expect(languageDropdown).toBeDefined();
+
+        const languages = await languageDropdown.$$('>>>dx-dropdown-option');
+        expect(languages.length).toBe(2);
+
+        const title = await $('>>>h1');
+        const titleText = await title.getText();
+
+        expect(titleText).toEqual('概要');
+    });
+});
+
+describe('Spec-Based Flexible References', () => {
+    it('should check for the spec-based reference summary', async () => {
+        referencePage = new ReferencePage('/docs/commerce/flexible-references/references/spec-ref');
+        referencePage.open();
+        await referencePage.waitForSpecBasedReferencePageLoad();
+
+        const apiTitle = await referencePage.getApiTitle();
+        const titleText = await apiTitle.getText();
+
+        expect(titleText).toEqual('Shopper Baskets');
+    });
+
+    it('change the spec-based reference endpoint and check whether the page is rendered', async () => {
+        referencePage = new ReferencePage(
+            '/docs/commerce/flexible-references/references/spec-ref?meta=getBasket',
+        );
+        referencePage.open();
+        await referencePage.waitForSpecBasedReferencePageLoad();
+
+        const container = await $('>>>div.title-area div');
+        const apiTitle = await container.getText();
+
+        expect(apiTitle).toEqual('getBasket');
+    });
+});

package/src/shared/specs/video.test.ts

@@ -0,0 +1,31 @@
+import Page from '../pageobjects/page';
+let page: Page;
+
+describe('Video Plugin Scenarios ', () => {
+    beforeEach(async () => {
+        page = new Page('docs/commerce/test-cc-orders-api/guide/change-shipping-address.html');
+        page.open();
+    });
+
+    it('Should render the vidyard video ', async () => {
+        const videoRootElement = await $('>>>.video-plugin-div');
+        const videoTitle = await videoRootElement.$('.video-plugin-title');
+        expect(await videoTitle.getText()).toBe('Video from VidYard');
+        const videoContainer = await videoRootElement.$('.video-plugin-container');
+        const videoHref = await videoContainer.$('a');
+        expect(await videoHref.getAttribute('href')).toBe(
+            'https://www.vidyard.com/free-screen-record?utm_source=vidyard-player&utm_medium=product&utm_campaign=powered_by',
+        );
+    });
+
+    it('Should render the youtube video', async () => {
+        const videoRootElement = await $$('>>>.video-plugin-div')[1];
+        const videoTitle = await videoRootElement?.$('.video-plugin-title');
+        expect(await videoTitle?.getText()).toBe('Video from YouTube');
+        const videoContainer = await videoRootElement?.$('.video-plugin-container');
+        const iframeElement = await videoContainer?.$('iframe');
+        expect(await iframeElement?.getAttribute('src')).toBe(
+            'https://youtube.com/embed/di6iwHhrH6s',
+        );
+    });
+});

package/static-portal-wdio.conf.js

@@ -0,0 +1,50 @@
+/**
+ * WebdriverIO configuration for E2E tests on Static Portal Pages (SSG)
+ *
+ * Prerequisites:
+ * 1. Build static pages: yarn build:static:portal
+ * 2. Start static server: yarn start:static:portal (runs on port 3000)
+ * 3. Run tests: yarn test:e2e:static:portal
+ */
+const BASE_CONFIG = require('./common-wdio.conf');
+
+exports.config = {
+    ...BASE_CONFIG.config,
+    // Static pages are served on port 3000 by default; override via E2E_BASE_URL env var
+    baseUrl: process.env.E2E_BASE_URL || 'http://localhost:3000',
+
+    // Reuse the same portal specs - static pages have the same URL structure
+    specs: ['./src/portal/specs/**/*.test.ts', './src/shared/specs/*.test.ts'],
+
+    // Exclude tests that require dynamic server features or pages not in static build
+    exclude: [
+        // /docs/apis landing page doesn't exist in static builds
+        './src/portal/specs/docs.api.test.ts',
+        // /docs landing page doesn't exist in static builds
+        './src/portal/specs/docs.test.ts',
+    ],
+
+    // Output directory for static test results
+    outputDir: './_results_/static-portal',
+
+    // Override reporters to use separate output directories
+    reporters: [
+        'spec',
+        [
+            require('wdio-video-reporter'),
+            {
+                saveAllVideos: false,
+                videoSlowdownMultiplier: 3,
+                outputDir: './_results_/static-portal/videos',
+            },
+        ],
+        [
+            'allure',
+            {
+                outputDir: './_results_/static-portal/allure-raw',
+                disableWebdriverStepsReporting: true,
+                disableWebdriverScreenshotsReporting: false,
+            },
+        ],
+    ],
+};

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "allowSyntheticDefaultImports": true,
+    "outDir": "./.tsbuild/",
+    "experimentalDecorators": true,
+    "resolveJsonModule": true,
+    "noUnusedLocals": true,
+    "declaration": true,
+    "sourceMap": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "target": "es2020",
+    "lib": ["ES2020"],
+    "types": [
+      "node",
+      "mocha",
+      "webdriverio/async",
+      "@wdio/mocha-framework",
+      "@wdio/selenium-standalone-service"
+    ]
+  },
+  "include": ["./src/**/*.ts"]
+}

package/wdio.conf.js

@@ -0,0 +1,6 @@
+const BASE_CONFIG = require('./common-wdio.conf');
+
+exports.config = {
+    ...BASE_CONFIG.config,
+    specs: ['./src/content-repo/specs/**/*.test.ts', './src/shared/specs/*.test.ts'],
+};