Skip to content

Latest commit

 

History

History
172 lines (106 loc) · 6.5 KB

README.md

File metadata and controls

172 lines (106 loc) · 6.5 KB
Raw

Go Go Report Card

forge! The StormForger Command Line Client

If you have any questions, don't hesitate to get in contact.

Using forge you can:

  • use StormForger's HAR converter
  • work with organisations (only list currently)
  • work with test-runs (start, abort, reporting, listing and call logs)
  • work with test-cases (list, create, update)
  • work with data-sources (list, download, push, rename, show)
  • work with service-accounts (list, create)

You can use --help to get usage information on all commands.

For more information on how to usage StormForger in general, visit our documentation.

Installation

Download the latest release from GitHub releases page.

In case you are on macOS and using Homebrew you can:

brew install stormforger/forge/forge

You can also use our published Docker image stormforger/cli. We will publish the latest tag, so you can do:

docker pull stormforger/cli
docker run stormforger/cli

Getting Started

Most actions require authentication. So in case you don't have a StormForger account yet, you have to sign up first - no worries, it's free!

When done, you can login via

forge login [email protected]

You will be asked for your credentials. On successful authentication your token will be written to ~/.stormforger.toml (use --no-save to print the token instead).

Beside via .stormforger.toml, you can provide your JWT via

  1. Environment: export STORMFORGER_JWT="your-jwt-token"
  2. Flag: --jwt "your-jwt-token"

When you are done, you can check your token via ping which makes an authenticated ping request:

forge ping

Usage

Help is available to all commands with --help.

There is a global --output option that allows to select between human, plain and json (default human). Note that this is not yet implemented for all commands. Also the JSON output is not yet fully settled and is subject to change. plain tries to be a very simple, human-readble format, whereas human is a more verbose default for interactive usage.

Test Cases

Test cases are scoped by organisation. You always have to provide at least the organisation (acme-inc) or a test case in form of organisation-name/test-case-name.

You can...

  • list existing test cases in your acme-inc organisation: forge test-case list acme-inc
  • validate a test definition without saving it: forge test-case validate acme-inc cases/simple.js
  • create a new test case named checkout inside acme-inc: forge test-case create acme-inc/checkout cases/simple.js
  • update an existing test case named checkout inside acme-inc: forge test-case update acme-inc/checkout cases/simple.js
  • bundle a ESModule based case into a single JavaScript file: forge test-case build cases/index.mjs

Commands that take a file, also accept - to take input from stdin.

Commands that take a test definition file (JavaScript) do support ESModules if the file extension is .mjs. Consult forge test-case build for details.

Test Runs

Test runs are executions of test cases. The subcommand is test-run or tr.

You can...

  • launch acme-inc/checkout: forge test-case launch acme-inc/checkout
  • watch a running test run: forge test-run watch acme-inc/checkout/42
  • list all test runs of a test case: forge test-run list acme-inc/checkout
  • show details: forge test-run show acme-inc/checkout/42
  • view logs: forge test-run logs acme-inc/checkout/42
  • view full traffic dump: forge test-run dump acme-inc/checkout/42
  • check your requirements: forge test-run nfr acme-inc/checkout/42 requirements/basic.yml

Data Sources

Data sources are scoped per organisation. Working with data sources can be done with the datasource (or short ds) sub command, e.g. forge datasource ls acme-inc.

You can...

  • list available data sources: forge datasource ls acme-inc
  • show details: forge datasoure show acme-inc auth/users.csv
  • download originally uploaded file: forge datasource get acme-inc auth/users.csv
  • rename data source: forge datasource mv acme-inc users.csv auth/users.csv
  • create or update data sources: forge datasource push acme-inc …

push takes some more arguments: forge datasource push acme-inc <list of files> [flags]. It can be used to update or create new data sources (think update and create in one command: upsert). To get more information about available flags, use --help.

  • --delimiter: Column delimiter for the structured file
  • --fields: Name of the fields for columns, comma separated (can be edited later)
  • --name: Name of the new data source. If not provided it will be inferred from the uploaded file name (optional)
  • --name-prefix-path: Path prefix for new data sources (optional)
  • --raw: Upload file as is (optional, default: false)
  • --auto-field-names: Interpret first row as headers and use them as field names

Build

You can STOP READING now unless you want to know how to build forge and make releases!

Building

We don't have generated code or other complications, so you can use the normal go tools:

go build -o forge .

Dependencies

We use Go modules to manage dependencies.

If you change or update dependencies, run go mod tidy.

Testing

Same as building, just use go:

go test ./...

Note that we don't have many tests yet, so any PRs to up the coverage is appreciated!

Release

Releases are done via Github Actions.

When ready for a release and pull requests are merged into main, just create and push a new tag:

git tag vA.B.C
git push --tag

Github Actions will make a build and on success automatically publish a release to GitHub releases, to Docker hub and also update our homebrew tab.

Now go to the releases page and add release notes.