Unknown module "api" for project demo-shop — but features/api/ exists

Asked 29 Apr 20244,460 views2 answers

14votes

bash

sdods run -p demo-shop -e staging -m api

text

✖ CONFIG_INVALID: Unknown module "api" for project demo-shop.
  hint: Known modules: auth, inventory, cart, posts-api, hybrid.

The directory is features/api/, so where does posts-api come from? -m cart works and that folder is features/cart/.

asked by Fiona McAllister159 · 29 Apr 2024

2 answers

19votes✓
Accepted answer
-m takes the module name, not the folder. They are usually the same because path defaults to the name, but they do not have to be:
yaml
```
modules:
  - name: posts-api
    title: Posts API
    path: api
    layers: [api]
```
So cart works because that module never set path, and api fails because it is a folder, not a module.
bash
```
sdods run -p demo-shop -e staging -m posts-api
```
The hint always lists the real names, which is the fastest way to check without opening the yaml.
answered by Reeta Nandalmaintainer41,280 · 29 Apr 2024
6votes
The names are also what the module carries elsewhere — its testing types, the tag every scenario in it should have, its owner and Jira component. Keeping name readable and letting path be whatever the folder is called historically is fine; we did the reverse for a while and ended up with a module called svc-2.
answered by Bea Lindqvist4,318 · 30 Apr 2024

Have a different question? Ask it.