Skip to content

Ecosystem

Zabil Cheriya Maliackal edited this page Nov 9, 2020 · 5 revisions

Ecosystem

Gauge Core

Gauge core, as the name suggests is the primary codebase. Repository - https://github.com/getgauge

Requirements

Gauge-proto

This is a repository which contains the google protobuf messages and gRPC Services. It contains the .proto files that defines contracts between plugins and gauge core.

Several components uses this repository as a sub module. The Protocol Buffer tooling helps generate code stubs that corresponds to the messages in various languages.

Repository: https://github.com/getgauge/gauge-proto

Common

This is a shared utility code between components written in Golang.

Repository - https://github.com/getgauge/common)

Requirements

Gauge Screenshot

This is a cross platform utility to capture the active display screenshot. Used for reporting failures.

Repository - https://github.com/getgauge/gauge_screenshot)

Requirements

Note A language runner can invoke gauge_screenshot or a custom_implementation to take screen shots on failure.

Language runners

Enables gauge support for a specific language. Below is a list of all currently supported language runners.

Notes: Golang plugin is community contributed/maintained language runner.

Reporting plugins

The summary of the test result can be viewed in the following formats

The test execution status can viewed in realtime using the following plugin,

There is also another reporting plugin that does not relate to test results, rather helps users visualize their test suite.

IDE Plugins

Enables gauge support in IDE. Below is the list of all supported IDEs.

Gauge-repository

This repository contains the meta-data of language runner and reporting plugins which is used during installation and upgrades.

Repository: https://github.com/getgauge/gauge-repository

Note There is also a nightly repository available to publish nightly builds of the plugins.

Gauge-maven-plugin

This plugin is used to integrate gauge with maven so that the specs can be run using maven.

Repository - https://github.com/getgauge/gauge-maven-plugin

Gauge-mvn-archetypes

One can create projects using several templates. This contains the template of Maven archetypes for Gauge.

Repository - https://github.com/getgauge/gauge-mvn-archetypes

Gauge Examples

There are many different example test suites mostly maintained in this github organization.

Gauge User Documentation

Python+Sphinxdoc is used to edit and contribute to the documentation.

Repository - https://github.com/getgauge/docs.gauge.org)

Set-up will help you get started...