Gherkin

Gherkin Steps

Gherkin is a fluent wrapper for writing a workflow as a specification. Given sets up the precondition, the starting state. When describes the action. And chains another action or condition at the same level. Then describes the expected outcome. Each one takes a step, which is any Action: a method by name, or a lambda. GPAL.Gherkin holds no browser and no application of its own, so the automation is done by whatever the workflow opened and the step can reach.

NOTE

Gherkin does not change how GPAL automation works - it is a structural pattern that makes workflows read like plain English specifications. Each delegate you pass to Given, When, And, and Then is a method that performs the actual browser or application automation.

Examples

GPAL Fluent: High-level fluent C# API

//Each step runs as the chain reaches it. Nothing is collected to run later, so a spec reads top to bottom in the order it happens. What each call answers is what decides the shape: Given answers a When, When answers an And, And answers a Then, and Then answers another Then or another And. A spec cannot say Then before When, and the compiler is what tells you so rather than a failing run.

// the workflow owns the browser, and each step is a plain method that uses it

IBrowser browser = GPAL.Browser

.WithBrowserType(BrowserType.Chrome)

.WithDriverLocation(@"C:drivers")

.ToGPALObject();

void OpenLoginPage()

{

browser.GoTo("https://example.com/login");

}

void EnterCredentials()

{

browser

.WithSelector("#username")

.FillInFrom("admin");

}

void ClickLogin()

{

browser

.WithSelector("#submit")

.LeftClick();

}

void VerifyDashboard()

{

browser

.WithSelector(".dashboard-header")

.WaitFor(5_000);

}

// Given, When, And, Then. each takes a step and answers with what may follow it

GPAL.Gherkin

.Given(OpenLoginPage)

.When(EnterCredentials)

.And(ClickLogin)

.Then(VerifyDashboard);

Documentation Example

Documentation

Showing off some plain text in these paragraphs eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Other formats

Here you can find different accents and emphasis sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

This is a link and how it could look like bestlinkinthebeautifulworld. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Here's just some classic bold text adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam notBoldSecondbestlinkinthebeautifulworld illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at adipisicing elit libero vel voluptas? Expedita, adipisicing facere dolores voluptatem ad ab rem assumenda soluta!

Other cuple of colors in case we want to emphasize several ways adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at voluptatem libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Adding Images to the content

Lorem ipsum dolor sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta! Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quod veniam, quam ad expedita laborum sed at voluptates culpa ipsam ut vel. Ullam temporibus a mollitia quod aliquam ratione exercitationem nesciunt.

Coding Blocks

Lorem ipsum dolor sit amet consectetur adipisicing elit. Repudiandae quas consequuntur illo numquam assumenda autem exercitationem distinctio perspiciatis in natus. Eius dicta similique ipsam ipsa minima, nemo quae enim tempore.

GPAL

.CallIfNotFound(GenericCallIfNotFound)

.WithPublishToConsole();

//System.Drawing.Rectangle windowSize = new System.Drawing.Rectangle(10, 10, 1500, 1024);

// NOTE: we have to set browser = before we execute any steps

// this is due to the 'GenericCallIfNotFound' which might throw an exception, and BankScraper will not have the browser set when it calls scraper.Close()

// until the complete fluent line gets executed (meaning every step, meaning browser is not set until everything else succeeds)

browser = GPAL.Browser

.WithBrowserType(Enums.BrowserType.Chrome)

.WithProfileDataDirectory(ChromeProfileLocation)

.WithUseAutomationEngine(AutomationEngine.Selenium)

.WithWindowSize(new System.Drawing.Rectangle(0,0,1920,1080))

.ToGPALObject();

Gherkin

Gherkin

Gherkin Steps

Examples

Documentation Example

Documentation

Category

Endpoint

Enpoint

Enpoint

Enpoint

Other formats

Adding Images to the content

Coding Blocks

On this page