# AltWalker's LiveViewer
A web application for visualizing the progress of an AltWalker test run.
AltWalker's LiveViewer is a powerful tool designed to enhance your experience with AltWalker. This application provides real-time visualization and monitoring capabilities for your AltWalker test runs, allowing you to gain deeper insights into test execution, track progress, and identify potential issues with ease. With AltWalker's LiveViewer, you can effortlessly keep an eye on the execution of
your test models and ensure the success of your testing endeavors.
## Setup
Before you begin using AltWalker's LiveViewer, make sure you have AltWalker installed. If you haven't already, you can follow the installation instructions [here](https://altwalker.github.io/altwalker/).
Install the AltWalker LiveViewer command-line tool:
```bash
pip install altwalker-live-viewer
```
To verify that the CLI was installed correctly, run:
```bash
altwalker-viewer --version
```
You should see the version information displayed:
```bash
altwalker-viewer, version 0.4s.0
```
## Running
To use `altwalker-viewer`, you'll need the following prerequisites:
* Test model(s)
* Test code for the model(s)
If you can run your tests using `altwalker online`, you already have everything you need for the LiveViewer.
The `altwalker-viewer online` command shares arguments and options with `altwalker online`. However, it includes the `-p` option to set up the WebSocket port.
To start the WebSocket server:
```bash
altwalker-viewer online path/to/tests/ -m path/to/model.json "generator(stop_condition)" -x [python|dotnet]
```
For example:
```bash
altwalker-viewer online tests -m models/default.json "random(never)"
```
Now, open your web browser and visit: <https://altwalker.github.io/live-viewer/>.
If you want to run the frontend locally, you'll need to start a WebServer, which serves the LiveViewer frontend.
```bash
altwalker-viewer open
```
Now, open your web browser and visit: <http://localhost:8000/>.
## Troubleshooting
If you encounter any issues while using the LiveViewer, consider the following steps:
1. **Check Model and Code Validity**: First, ensure that your models and code are valid by using the following commands:
* `altwalker check` for the model(s)
* `altwalker verify` for code
1. **Terminating GraphWalker Processes**: If you experience problems when running the `altwalker-viewer online` command, it's essential to check for any existing GraphWalker processes. If any GraphWalker processes are running, you should stop them before running the `altwalker-viewer online` command.
## Documentation
### Getting help on commands and option names
* `-h`, `--help`: Show a help message and exit.
```bash
altwalker-viewer --help
```
```bash
altwalker-viewer online --help
```
```bash
altwalker-viewer open --help
```
## Development Setup
* python3
* node
* npm
### Install npm dependencies
```bash
npm install
```
### Install PyPi dependencies
```bash
pip install -r requirements
```
### Build the Frontend
```bash
npm run build
```
```bash
npm run start
```
### Install the CLI
```bash
pip install -e .
```
## License
This project is licensed under the [GNU General Public License v3.0](https://github.com/altwalker/live-viewer/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "altwalker-live-viewer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "model-based-testing,testing,tests,testing-framework",
"author": "",
"author_email": "Altom Consulting <altwalker@altom.com>, Dezmerean Robert <dezmereanrobert@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5a/05/c14377a536b6b430af3b79debb089d918f777299552fd559c189a382a557/altwalker-live-viewer-0.4.1.tar.gz",
"platform": null,
"description": "# AltWalker's LiveViewer\n\nA web application for visualizing the progress of an AltWalker test run.\n\nAltWalker's LiveViewer is a powerful tool designed to enhance your experience with AltWalker. This application provides real-time visualization and monitoring capabilities for your AltWalker test runs, allowing you to gain deeper insights into test execution, track progress, and identify potential issues with ease. With AltWalker's LiveViewer, you can effortlessly keep an eye on the execution of\nyour test models and ensure the success of your testing endeavors.\n\n\n\n## Setup\n\nBefore you begin using AltWalker's LiveViewer, make sure you have AltWalker installed. If you haven't already, you can follow the installation instructions [here](https://altwalker.github.io/altwalker/).\n\nInstall the AltWalker LiveViewer command-line tool:\n\n```bash\npip install altwalker-live-viewer\n```\n\nTo verify that the CLI was installed correctly, run:\n\n```bash\naltwalker-viewer --version\n```\n\nYou should see the version information displayed:\n\n```bash\naltwalker-viewer, version 0.4s.0\n```\n\n## Running\n\nTo use `altwalker-viewer`, you'll need the following prerequisites:\n\n* Test model(s)\n* Test code for the model(s)\n\nIf you can run your tests using `altwalker online`, you already have everything you need for the LiveViewer.\n\nThe `altwalker-viewer online` command shares arguments and options with `altwalker online`. However, it includes the `-p` option to set up the WebSocket port.\n\nTo start the WebSocket server:\n\n```bash\naltwalker-viewer online path/to/tests/ -m path/to/model.json \"generator(stop_condition)\" -x [python|dotnet]\n```\n\nFor example:\n\n```bash\naltwalker-viewer online tests -m models/default.json \"random(never)\"\n```\n\nNow, open your web browser and visit: <https://altwalker.github.io/live-viewer/>.\n\nIf you want to run the frontend locally, you'll need to start a WebServer, which serves the LiveViewer frontend.\n\n```bash\naltwalker-viewer open\n```\n\nNow, open your web browser and visit: <http://localhost:8000/>.\n\n## Troubleshooting\n\nIf you encounter any issues while using the LiveViewer, consider the following steps:\n\n1. **Check Model and Code Validity**: First, ensure that your models and code are valid by using the following commands:\n\n * `altwalker check` for the model(s)\n * `altwalker verify` for code\n\n1. **Terminating GraphWalker Processes**: If you experience problems when running the `altwalker-viewer online` command, it's essential to check for any existing GraphWalker processes. If any GraphWalker processes are running, you should stop them before running the `altwalker-viewer online` command.\n\n## Documentation\n\n### Getting help on commands and option names\n\n* `-h`, `--help`: Show a help message and exit.\n\n```bash\naltwalker-viewer --help\n```\n\n```bash\naltwalker-viewer online --help\n```\n\n```bash\naltwalker-viewer open --help\n```\n\n## Development Setup\n\n* python3\n* node\n* npm\n\n### Install npm dependencies\n\n```bash\nnpm install\n```\n\n### Install PyPi dependencies\n\n```bash\npip install -r requirements\n```\n\n### Build the Frontend\n\n```bash\nnpm run build\n```\n\n```bash\nnpm run start\n```\n\n### Install the CLI\n\n```bash\npip install -e .\n```\n\n## License\n\nThis project is licensed under the [GNU General Public License v3.0](https://github.com/altwalker/live-viewer/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": "GNU GPLv3",
"summary": "A web application for visualizing the progress of an AltWalker test run.",
"version": "0.4.1",
"project_urls": {
"Bug Tracker": "https://github.com/altwalker/live-viewer/issues",
"Homepage": "https://github.com/altwalker/live-viewer",
"Repository": "https://github.com/altwalker/live-viewer.git"
},
"split_keywords": [
"model-based-testing",
"testing",
"tests",
"testing-framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7742b8f20492aa836dfc950b97d02283ddb3501432a2283f3262939c798b4658",
"md5": "1740afee7640a20f68569d8bac16c44a",
"sha256": "feb0190585b4564b9d6b1ce190b45da35734383e02350fc5008ca53a1cfbfeb3"
},
"downloads": -1,
"filename": "altwalker_live_viewer-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1740afee7640a20f68569d8bac16c44a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 121044,
"upload_time": "2023-09-21T10:34:34",
"upload_time_iso_8601": "2023-09-21T10:34:34.470540Z",
"url": "https://files.pythonhosted.org/packages/77/42/b8f20492aa836dfc950b97d02283ddb3501432a2283f3262939c798b4658/altwalker_live_viewer-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a05c14377a536b6b430af3b79debb089d918f777299552fd559c189a382a557",
"md5": "c41ad2af518bc7fca0c089467205f8ee",
"sha256": "d5e95d3ebe23d3bac452ce7dfbe358d9315b80b58658a47e086b939b7e45d0e8"
},
"downloads": -1,
"filename": "altwalker-live-viewer-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "c41ad2af518bc7fca0c089467205f8ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 114982,
"upload_time": "2023-09-21T10:34:36",
"upload_time_iso_8601": "2023-09-21T10:34:36.170057Z",
"url": "https://files.pythonhosted.org/packages/5a/05/c14377a536b6b430af3b79debb089d918f777299552fd559c189a382a557/altwalker-live-viewer-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-21 10:34:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "altwalker",
"github_project": "live-viewer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "altwalker-live-viewer"
}
JSON
