Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aexol-studio/bddx

Behavior driven development CLI. Write tests in Gherkin and integrate with Git and JIRA.
https://github.com/aexol-studio/bddx

bdd bdd-framework bdd-tests cli tests

Last synced: 27 days ago
JSON representation

Behavior driven development CLI. Write tests in Gherkin and integrate with Git and JIRA.

Host: GitHub
URL: https://github.com/aexol-studio/bddx
Owner: aexol-studio
License: mit
Created: 2022-11-03T11:16:59.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-06-21T15:35:43.000Z (over 1 year ago)
Last Synced: 2024-11-06T09:47:33.682Z (about 2 months ago)
Topics: bdd, bdd-framework, bdd-tests, cli, tests
Language: TypeScript
Homepage: https://www.bddtests.com
Size: 18.2 MB
Stars: 9
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # BDDx [![NPM Version](https://img.shields.io/npm/v/bddx.svg?style=flat)](https://www.npmjs.com/package/bddx) [![NPM Version](https://img.shields.io/github/checks-status/aexol-studio/bddx/main)](https://www.npmjs.com/package/bddx) [![NPM Version](https://img.shields.io/github/last-commit/aexol-studio/bddx)](https://github.com/aexol-studio/bddx)

Run Behavior-Driven Development tests inside a CLI

![Alt Text](packages/bddx-landing/src/components/Site/PresentationOfMDtx.gif)

### What is BDDx?

- Write tests in Gherkin, Cucumber's simply structured plain-text language

- Upload BDD test files in bulk,

- Run tests to execute them line by line for all your files

- Get a detailed summary on **what** failed and **why**

- Failed tests can be made to automatically result in a Jira task or Github issue to automate the fixing process

# Downloads:

## [![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/aexol-studio/bddx?color=yellow&filename=%2Fpackages%2Fbddx%2Fpackage.json&label=CLI&style=for-the-badge)](https://github.com/aexol-studio/bddx) [![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/aexol-studio/bddx?color=green&filename=%2Fpackages%2Fbddx-core%2Fpackage.json&label=CORE&style=for-the-badge)](https://github.com/aexol-studio/bddx/tree/main/packages/bddx-core)

## CLI commands:

### Installation and initialization:

[**Remember that Node is required**](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

| Description | Command |

| --- | --- |

| to install BDDx: | `npm i bddx` |

| to initialize BDDx (with optional Jira integration): | `npx bddx init` |

| to initialize only BDDx Jira integration without changing the basic configuration: | `npx bddx jiraInit` |

| to check if the Jira API token is working correctly¹ : | `npx bddx checkToken`

| to connect to bddx cloud² : | `npx bddx cloud`

¹If there's a problem with the loop BDDx will ask the user to provide the correct token value.

²User should create project and generate project key 

### Config file:

After initializing the config file contains:

```

{

  "in": "./bddx/tests",

  "out": "./bddx/results",

}

```

or when Jira is integrated:

```

{

   "in": "./bddx/tests",

   "out": "./bddx/results",

    "organizationName": "organizationName.atlassian.net",

    "projectName": "ProjectName",

    "issueTypeName": "TASK"

}

```

- in: string - input folder with the test files, **(default: "./bddx/tests")**

- out: string - output folder where the test result files are saved, **(default: "./bddx/results")**

The e-mail and Jira API token are saved locally on the machine to ensure safety!

### Running tests

| Description | Command |

| --- | --- |

| to run all .feature tests and save results in a file in the output directory: | `npx bddx` |

| to run all .feature tests and create a task for each failed one on the configured Jira: | `npx bddx jira` |

| to select an unfinished session and continue the tests from that point (you will also be asked about Jira usage): | `npx bddx continue` |

| to run all failed .feature tests in selected source and submit results to the bddx cloud: | `npx bddx failedTest` |

#### [Readme CORE](https://github.com/aexol-studio/bddx/blob/main/Readme.md)

## Roadmap

- [x] 2 test scenarios: display test & pass or fail test

- [x] Jira plugin

- [ ] GitHub plugin