settings-bar.ts

/**********************************************************************
 * Copyright (C) 2023-2024 Red Hat, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 ***********************************************************************/

import type { Locator, Page } from '@playwright/test';

import { waitUntil } from '../../utility/wait';
import type { SettingsPage } from './settings-page';

export class SettingsBar {
  readonly page: Page;
  readonly settingsNavBar: Locator;
  readonly resourcesTab: Locator;
  readonly proxyTab: Locator;
  readonly registriesTab: Locator;
  readonly authenticationTab: Locator;
  readonly extensionsTab: Locator;
  readonly desktopExtensionsTab: Locator;
  readonly preferencesTab: Locator;
  readonly cliToolsTab: Locator;

  constructor(page: Page) {
    this.page = page;
    this.settingsNavBar = page.getByRole('navigation', { name: 'PreferencesNavigation' });
    this.resourcesTab = this.settingsNavBar.getByRole('link', { name: 'Resources' });
    this.proxyTab = this.settingsNavBar.getByRole('link', { name: 'Proxy' });
    this.registriesTab = this.settingsNavBar.getByRole('link', { name: 'Registries' });
    this.authenticationTab = this.settingsNavBar.getByRole('link', { name: 'Authentication' });
    this.extensionsTab = this.settingsNavBar.getByRole('link', { name: 'Extensions', exact: true });
    this.desktopExtensionsTab = this.settingsNavBar.getByRole('link', { name: 'DesktopExtensions' });
    this.preferencesTab = this.settingsNavBar.getByRole('link', { name: 'preferences' });
    this.cliToolsTab = this.settingsNavBar.getByRole('link', { name: 'CLI Tools' });
  }

  public async openTabPage<T extends SettingsPage>(type: new (page: Page) => T): Promise<T> {
    const desiredPage = new type(this.page);
    await (await desiredPage.getTab()).click();
    return desiredPage;
  }

  public getSettingsNavBarTabLocator(name: string): Locator {
    return this.settingsNavBar.getByLabel(name);
  }

  public async expandExtensionDropdown(): Promise<SettingsBar> {
    await this.extensionsTab.click();
    await waitUntil(async () => (await this.getExtensions()).length > 0, 5000, 500);
    return this;
  }

  public async getCurrentExtensions(): Promise<Locator[]> {
    const extensions = await this.getExtensions();

    if (extensions.length > 0) return extensions;

    await this.expandExtensionDropdown();
    return await this.getExtensions();
  }

  private async getExtensions(): Promise<Locator[]> {
    const allLinks = await this.settingsNavBar.getByRole('link').all();
    const extensions: Locator[] = [];

    for (const link of allLinks) {
      const href = await link.getAttribute('href');
      if (href?.includes('/extension/')) extensions.push(link);
    }

    return extensions;
  }
}