sriv edited this page May 10, 2017 · 1 revision

API

There are different Request/Response for Language, Reporting and IDE Plugins.

api

The following sections details out Requests/Responses for different category of plugins.

Language Plugin

Gauge will send requests to Language Plugin and Language Plugin will perform actions based on request and send the response back.

Execute hooks (when requested to)

|Request |Purpose |Response | |---------------------------|-----------------------------|-------------------------| |ExecutionStarting |Execute BeforeSuite Hooks |ExecutionStatusResponse| |ExecutionEnding |Execute AfterSuite Hooks |ExecutionStatusResponse| |SpecExecutionStarting |Execute BeforeSpec Hooks |ExecutionStatusResponse| |SpecExecutionEnding |Execute AfterSpec Hooks |ExecutionStatusResponse| |ScenarioExecutionStarting|Execute BeforeScenario Hooks|ExecutionStatusResponse| |ScenarioExecutionEnding |Execute AfterScenario Hooks |ExecutionStatusResponse| |StepExecutionStarting |Execute BeforeStep Hooks |ExecutionStatusResponse| |StepExecutionEnding |Execute AfterStep Hooks |ExecutionStatusResponse|

Execute method corresponding to a step

|Request |Purpose |Response | |-------------|--------------------------------------|-------------------------| |ExecuteStep|Execute method corresponding to a step|ExecutionStatusResponse|

Refactor method signatures with changes defined by Gauge

|Request |Purpose |Response | |-------------|--------------------------------------|-------------------------| |StepNameRequest|Request for step text present in the implementaion for a Step.|StepNameResponse| |RefactorRequest|Refactors the method signature and the step text|RefactorResponse|

Read/write to datastore

|Request |Purpose |Response | |-----------------------|-----------------------------------|-------------------------| |SuiteDataStoreInit |initialize Suite level DataStore. |ExecutionStatusResponse| |SpecDataStoreInit |initialize Spec level DataStore |ExecutionStatusResponse| |ScenarioDataStoreInit|initialize Scenario level DataStore|ExecutionStatusResponse| All Data Stores should be cleared at their respective levels.

Holds reference to Step text and Method / execution block.

|Request |Purpose |Response | |---------------------|-----------------------------------------------------------------------|----------------------| |StepNamesRequest |Get all the step names present in the implementaion side. |StepNamesResponse | |StepValidateRequest|To check if there is an implementation defined for the given Step Text.|StepValidateResponse|

ShutDown after Execution.

|Request |Purpose |Response| |--------------------|-----------------------------|--------| |KillProcessRequest|Tells the runner to shutdown.| - |

Send Response when a unsupported message request is sent.

|Request |Purpose |Response| |--------------------|-----------------------------|--------| |Unknown Request|Request not supported by plugin.| UnsupportedMessageResponse |

Reporting Plugin

Gauge will send messages to Reporting Plugin at the end of execution and Reporting Plugin will recieve the message and perform action.

Get the result after ececution

|Request |Purpose |Response| |--------------------|-----------------------------|--------| |SuiteExecutionResult|Structure representing the result of entire Suite execution.| - |

ShutDown after Execution.

|Request |Purpose |Response| |--------------------|-----------------------------|--------| |KillProcessRequest|Tells the plugin to shutdown.| - |

IDE Plugin

IDE Plugin will send requests to Gauge and Gauge will perform actions based on request and send the response back.

Autocomplete

|Request |Purpose |Response | |-----------------------|-----------------------------------------------------|------------------------| |GetAllStepRequest |Fetches all the steps in the gauge project as a list.|GetAllStepResponse | |GetAllConceptsRequest|Fetches all the concepts in the gauge project as a list.|GetAllConceptsResponse|

Combine the results of the above requests to show all the steps and concepts present in gauge project.

Format Specification.

|Request |Purpose |Response| |--------------------|-----------------------------|--------| |FormatSpecsRequest|Request contains list of spec file names to format, Response will contain errors & warnings occurred on formatting.|FormatSpecsResponse|

Gets language plugin libs location.

|Request |Purpose |Response | |---------------------------------|---------------------------------------------------------------|----------------------------------| |GetLanguagePluginLibPathRequest|Request to get the location of language plugin's Lib directory.|GetLanguagePluginLibPathResponse|

Get Gauge Installation Path

|Request |Purpose |Response | |----------------------------|------------------------------------------------------------|-----------------------------| |GetInstallationRootRequest|Request to get the Root Directory of the Gauge installation.|GetInstallationRootResponse|

Get Project Root

|Request |Purpose |Response | |----------------------------|------------------------------------------------------------|-----------------------------| |GetProjectRootRequest|Request to get the Root Directory of the project.|GetProjectRootResponse|

Refactoring

|Request |Purpose |Response | |---------------------------|----------------------------------------------------------|----------------------------| |PerformRefactoringRequest|request to gauge to perform a step name refactoring on the project.|PerformRefactoringResponse|

Extract to Concept

|Request |Purpose |Response | |-----------------------|--------------------------------------------------|------------------------| |ExtractConceptRequest|Request to perform Extract to Concept refactoring.|ExtractConceptResponse|

Get Parsed Step

|Request |Purpose |Response | |---------------------|---------------------------------------------------------------------------------|----------------------| |GetStepValueRequest|Gets the step value which contains param, parsed text for a particular step name.|GetStepValueResponse|

Get Specs in Project

|Request |Purpose |Response | |--------------------|----------------------------------------------------------------------------------------------------------|---------------------| |GetAllSpecsRequest|Request to get all Specs in the project and returns a collection of Specs that are defined in the project.|GetAllSpecsResponse|

Documentation Plugin

[TODO]

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.