Clarify that tests are run locally when specifying a model .fga.yaml + store-id

Open Beginner friendly
#335 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
go
Domain
cli

Research direction

Start at the model test CLI entry point and trace handling of --tests store.fga.yaml with --store-id. Run the example command to confirm the current behavior, then make the output clarify when a model in the file causes local execution; preserve server execution when fga.yaml has no model.

Written by the indexing model from the issue text.

Description

documentation enhancement good first issue help wanted

When you run model test using a file that has a model and we specify the store-id, the store-id is ignored and tests are run locally on the CLI.

fga model test --tests store.fga.yaml --store-id 01HYX4FWK9P2VFRQ0YABYNQ447

I think that's the right behavior, but we should display a message clarifying it:

$ fga model test --tests store.fga.yaml --store-id 01HYX4FWK9P2VFRQ0YABYNQ447
Ignoring store-id parameter, running tests locally using model from store.fga.yaml

# Test Summary #
Tests 2/2 passing
Checks 4/4 passing

Note that if the fga.yaml file does NOT have a model, tests are run in the OpenFGA server.

Dominant language
Go
Stars
102
Forks
49
Avg merge
1d 1h
Merged PRs (30d)
16

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openfga/cli

All issues in openfga/cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.