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.

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

Data provider documentation is not self contained #273

Open
csvtuda opened this issue Mar 13, 2024 · 0 comments
Open

Data provider documentation is not self contained #273

csvtuda opened this issue Mar 13, 2024 · 0 comments
Labels
📄 bug Something isn't working. Suspicion of a bug 🛠 core Everything related to the QTAF core module 📄 documentation Improvements or additions to documentation 🚦 under investigation The issue is being investigated

Comments

@csvtuda
Copy link
Contributor

csvtuda commented Mar 13, 2024

It's currently impossible to follow the data provider tutorial in the documentation because the examples are not self contained. They mention page objects which have never been defined before:

@TestFeature(
        name = "Calls form",
        description = "Create call form"
)
public class CallsTest extends TestContext {
    @Test(testName = "CallsTest", description = "Calls Test")
    public void testCalls() {
        //Navigate to calls page
        navigator.goToRootPage(); // what is navigator?
        topNavbar.openMobileMenu(); // what is topNavbar?
        topNavbar.clickMobileCallsMenu();
        callsPage.clickCallsModuleButton(); // what is callsPage?
        topBarCallsMenu.clickLogCallLink();
        // Fill call form
        createCallForm.fillSubjectField("Call subject"); // what is createCallForm?
        createCallForm.fillDurationField();
        createCallForm.fillDescriptionField("Call description");
        createCallPage.clickSaveButton();
        //Navigate to Home page
        topNavbar.openMobileMenu();
        topNavbar.clickHomeMenuFromNotHomePage();
    }
}

This has lead to quite a lot of confusion for newcomers and should probably be changed such that either:

  • the page objects are defined as well within the data provider documentation
  • no page objects occur within the data provider documentation
@csvtuda csvtuda added 📄 bug Something isn't working. Suspicion of a bug 📄 documentation Improvements or additions to documentation 🛠 core Everything related to the QTAF core module labels Mar 13, 2024
@OliverHoenig OliverHoenig added the 🚦 under investigation The issue is being investigated label Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 bug Something isn't working. Suspicion of a bug 🛠 core Everything related to the QTAF core module 📄 documentation Improvements or additions to documentation 🚦 under investigation The issue is being investigated
Projects
None yet
Development

No branches or pull requests

2 participants