# fsl. FakeHub State Language

[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
[![DevOps By Rultor.com](http://www.rultor.com/b/h1alexbel/fsl)](http://www.rultor.com/p/h1alexbel/fsl)
[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)

[![just](https://github.com/h1alexbel/fsl/actions/workflows/just.yml/badge.svg)](https://github.com/h1alexbel/fsl/actions/workflows/just.yml)
[![Crates.io Version](https://img.shields.io/crates/v/fsl)](https://crates.io/crates/fsl)
[![codecov](https://codecov.io/github/h1alexbel/fsl/graph/badge.svg?token=GXcsA2ffuN)](https://codecov.io/github/h1alexbel/fsl)
[![PDD status](http://www.0pdd.com/svg?name=h1alexbel/fsl)](http://www.0pdd.com/p?name=h1alexbel/fsl)
[![Hits-of-Code](https://hitsofcode.com/github/h1alexbel/fsl)](https://hitsofcode.com/view/github/h1alexbel/fsl)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/h1alexbel/fsl/blob/master/LICENSE.txt)
[![Known Vulnerabilities](https://snyk.io/test/github/h1alexbel/fsl/badge.svg)](https://snyk.io/test/github/h1alexbel/fsl)

FSL is a specific [DSL] for managing state inside [fakehub].

**Motivation**. When working with [fakehub], automated testing tool that mocks
GitHub REST API, we often require to setup initial state of the system with
testing data. Instead of repeating testing preparations, we developed
FSL, a language that takes file as an input, processes it, and creates FakeHub
instance with desired data.

## Quick Start

First, install `fsl` from [crates][fsl-crates]:

```bash
cargo add fsl
```

Then, create `init.fsl`:

```fsl
me: @jeff

+repo me/foo > foo
+repo me/bar
+issue "this is testing" +label "bug" -> foo
```

Here, we logged in as `@jeff` fake GitHub user, created two repositories:
`jeff/foo`, `jeff/bar`, submitted new issue with title `"this is testing"` and
`"bug"` label to `jeff/foo`.

And then transpile it:

```rust
use fsl::transpiler::fsl_transpiler::Fslt;
use std::path::Path;

let output = Fslt::file(Path::new("init.fsl")).out();
// output...
```

This should transpile `init.fsl` to [fakehub-compatible][fakehub] output in
[JSON] format.

### Apply to fakehub

To apply it on fakehub, run (make sure you have [fakehub] installed):

```bash
fakehub start --include init.fsl -d
```

Then, pull newly created data:

```bash
curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer @jeff" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://localhost:3000/repos/jeff/foo/issues/1
```

Response should be:

```json
{
  "url": "http://localhost:3000/repos/jeff/foo/issues/1",
  "repository_url": "http://localhost:3000/repos/jeff/foo",
  "labels_url": "http://localhost:3000/repos/jeff/foo/issues/1/labels{/name}",
  ...
}
```

## How to contribute?

Make sure that you have [Rust] and [just] installed on your system, then fork
this repository, make changes, send us a [pull request][guidelines]. We will
review your changes and apply them to the `master` branch shortly, provided
they don't violate our quality standards. To avoid frustration, before sending
us your pull request please run full build:

```bash
just full
```

[fakehub]: https://github.com/h1alexbel/fakehub
[DSL]: https://en.wikipedia.org/wiki/Domain-specific_language
[guidelines]: https://www.yegor256.com/2014/04/15/github-guidelines.html
[Rust]: https://www.rust-lang.org/tools/install
[just]: https://just.systems/man/en/chapter_4.html
[fsl-crates]: https://crates.io/crates/fsl
[JSON]: https://en.wikipedia.org/wiki/JSON