feat: Provide WelcomeContentSection.getButton (#1757)

Co-authored-by: Dominik Jelinek <[email protected]>

Author: pospisilf

docs/CustomTreeSection.md

@@ -25,6 +25,9 @@ const contents = await welcome.getContents();
 // get all buttons
 const btns = await welcome.getButtons();
 
+// get specific button
+const btn = await welcome.getButton("title");
+
 // get paragraphs as strings in a list
 const text = await welcome.getTextSections();
 ```

packages/page-objects/src/components/sidebar/WelcomeContent.ts

@@ -54,7 +54,7 @@ export class WelcomeContentButton extends AbstractElement {
 export class WelcomeContentSection extends AbstractElement {
 	/**
 	 * @param panel  The panel containing the welcome content.
-	 * @param parent  The webelement in which the welcome content is embedded.
+	 * @param parent  The webElement in which the welcome content is embedded.
 	 */
 	constructor(panel: WebElement, parent: ViewSection) {
 		super(panel, parent);
@@ -77,6 +77,21 @@ export class WelcomeContentSection extends AbstractElement {
 		);
 	}
 
+	/**
+	 * Returns a specific button from the welcome view that matches the given title.
+	 * @param title The title of the button to search for.
+	 * @returns A `WelcomeContentButton` if found, otherwise `undefined`.
+	 */
+	public async getButton(title: string): Promise<WelcomeContentButton | undefined> {
+		const buttons = await this.getButtons();
+		for (const btn of buttons) {
+			if ((await btn.getTitle()) === title) {
+				return btn;
+			}
+		}
+		return undefined;
+	}
+
 	/** Finds all buttons in the welcome content */
 	public async getButtons(): Promise<WelcomeContentButton[]> {
 		return (await this.findElements(WelcomeContentSection.locators.WelcomeContent.button)).map((elem) => new WelcomeContentButton(elem, this));

tests/test-project/src/test/xsideBar/customView.test.ts

@@ -158,10 +158,10 @@ describe('CustomTreeSection', () => {
 	describe('WelcomeContentButton', () => {
 		it('takeAction executes the command', async function () {
 			this.timeout(10000);
-			const buttons = await ((await emptyViewSection.findWelcomeContent()) as WelcomeContentSection).getButtons();
-			await buttons[0].click();
-
 			await new Promise((res) => setTimeout(res, 500));
+			const button = await ((await emptyViewSection.findWelcomeContent()) as WelcomeContentSection).getButton('Add stuff into this View');
+			expect(button).to.be.not.be.undefined;
+			await button?.click();
 			expect(await emptyViewSection.findWelcomeContent()).to.equal(undefined);
 		});
 	});