-
Notifications
You must be signed in to change notification settings - Fork 0
Add E2E smoke test #74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mschoe
wants to merge
3
commits into
main
Choose a base branch
from
e2e-smoke-test
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # End-to-End Smoke Test for c8ctl | ||
|
|
||
| Quick validation script that tests basic CLI functionality. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - **Camunda 8** running at `http://localhost:8080` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| ./tests/e2e/smoke-test.sh | ||
| ``` | ||
|
|
||
| Run with verbose output to see command responses: | ||
| ```bash | ||
| ./tests/e2e/smoke-test.sh --verbose | ||
| # or | ||
| ./tests/e2e/smoke-test.sh -v | ||
| ``` | ||
|
|
||
| Adjust wait times for slower environments: | ||
| ```bash | ||
| C8_WAIT_TIME=2 ./tests/e2e/smoke-test.sh | ||
| ``` | ||
|
|
||
| **Note**: The test uses a `c8_cmd` wrapper function for all CLI commands: | ||
| - **State-changing commands** (deploy, create, run, publish, add, remove): Automatically waits after execution (default: 1 second) to ensure data is properly indexed | ||
| - **Read-only commands** (list, get, search): Uses `c8_cmd 0` to skip wait time | ||
| - **Custom wait**: Use `c8_cmd 2 publish msg` for longer waits | ||
| - The default wait time can be configured via the `C8_WAIT_TIME` environment variable | ||
|
|
||
| ## Scenarios Covered | ||
|
|
||
| The smoke test validates these core CLI features: | ||
|
|
||
| 1. **Help command** | ||
| 2. **Deploy process** | ||
| 3. **Create process instance** | ||
| 4. **Run command and list process instances** | ||
| 5. **Get topology** | ||
| 6. **User task search/completion** | ||
| 7. **Message correlation** | ||
| 8. **Search functionality** | ||
| 9. **Profile management** | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The prerequisites mention Camunda 8 at
http://localhost:8080, but the CLI’s default self-managed base URL ishttp://localhost:8080/v2(and it falls back to demo/demo auth). Consider documenting the/v2requirement and any expected auth defaults. Also, if the smoke test is intended to be safe to run locally, document (or enforce in the script) usingC8CTL_DATA_DIRto isolate config so it doesn’t touch the user’s real~/.config/~/Library/...state.