{"id":34534348,"url":"https://github.com/sgort/operaton-screenshot-automation","last_synced_at":"2026-05-24T23:02:49.463Z","repository":{"id":326667265,"uuid":"1106448693","full_name":"sgort/operaton-screenshot-automation","owner":"sgort","description":"Automated toolkit for capturing Operaton webapp screenshots and running Front-end tests","archived":false,"fork":false,"pushed_at":"2025-12-01T10:29:51.000Z","size":110,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-01T11:39:08.540Z","etag":null,"topics":["automation","documentation","frontend-testing","operaton","screenshots"],"latest_commit_sha":null,"homepage":"https://operaton.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sgort.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-29T09:14:37.000Z","updated_at":"2025-11-29T17:26:44.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sgort/operaton-screenshot-automation","commit_stats":null,"previous_names":["sgort/operaton-screenshot-automation"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/sgort/operaton-screenshot-automation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sgort%2Foperaton-screenshot-automation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sgort%2Foperaton-screenshot-automation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sgort%2Foperaton-screenshot-automation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sgort%2Foperaton-screenshot-automation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sgort","download_url":"https://codeload.github.com/sgort/operaton-screenshot-automation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sgort%2Foperaton-screenshot-automation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33453557,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-24T19:21:36.376Z","status":"ssl_error","status_checked_at":"2026-05-24T19:21:10.562Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","documentation","frontend-testing","operaton","screenshots"],"created_at":"2025-12-24T05:57:39.788Z","updated_at":"2026-05-24T23:02:49.451Z","avatar_url":"https://github.com/sgort.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ⚠️ Operaton Screenshot Automation ⚠️\n\n[![status](https://img.shields.io/badge/status-work%20in%20progress-yellow)](https://github.com/sgort/operaton-screenshot-automation)\n[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)\n\n[![release](https://img.shields.io/github/v/release/sgort/operaton-screenshot-automation)](https://github.com/sgort/operaton-screenshot-automation/releases)\n[![CI](https://img.shields.io/github/actions/workflow/status/sgort/operaton-screenshot-automation/ci.yml?branch=dev\u0026label=CI)](https://github.com/sgort/operaton-screenshot-automation/actions/workflows/ci.yml)\n[![Node](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](package.json)\n\n\u003e 🚧 **Work in Progress — Baseline Under Development** 🚧\n\u003e\n\u003e This repository is a **baseline toolkit** intended to be battle-tested in practice. APIs, scripts,\n\u003e and automation may change frequently. **Not ready for production use**.\n\u003e\n\u003e Contributions, testing, and feedback are highly encouraged to improve the project.\n\n---\n\nAutomated toolkit for capturing Operaton webapp screenshots to replace Camunda screenshots in\ndocumentation.\n\n## Features\n\n- **Process Deployment**: Deploy BPMN/DMN processes to Operaton\n- **Data Generation**: Create users, groups, process instances, and tasks\n- **Scenario Simulation**: Create specific states (tokens, history, task states)\n- **Incident Creation**: Generate intentional failures for error screenshots\n- **Screenshot Capture**: Automated Puppeteer-based screen capture\n- **Environment Reset**: Clean wipe functionality for fresh starts\n- **Makefile Interface**: Convenient commands for all operations\n\n## Quick Start\n\n```bash\n# 1. Install dependencies\nmake install\n\n# 2. Configure environment\ncp .env.example .env\n# Edit .env with your Operaton instance details\n\n# 3. Check connection\nmake check\n\n# 4. Run quick workflow (deploy + data + capture)\nmake quick\n\n# Or run full workflow (includes incidents)\nmake full\n```\n\n## Available Commands\n\nRun `make help` to see all available commands:\n\n### Setup \u0026 Installation\n\n| Command        | Description                       |\n| -------------- | --------------------------------- |\n| `make install` | Install npm dependencies          |\n| `make setup`   | Full setup: install + create .env |\n| `make check`   | Check connection to Operaton      |\n\n### Deployment \u0026 Data\n\n| Command           | Description                  |\n| ----------------- | ---------------------------- |\n| `make deploy`     | Deploy BPMN/DMN processes    |\n| `make users`      | Create users and groups only |\n| `make data`       | Generate full test data      |\n| `make data-light` | Generate minimal test data   |\n\n### Simulation Scenarios\n\n| Command                 | Description                                    |\n| ----------------------- | ---------------------------------------------- |\n| `make simulate`         | Run all simulation scenarios                   |\n| `make simulate-tokens`  | Create instances with tokens at various stages |\n| `make simulate-history` | Generate completed instances for history views |\n\n### Incident Creation\n\n| Command                  | Description                   |\n| ------------------------ | ----------------------------- |\n| `make incidents`         | Create all types of incidents |\n| `make incidents-script`  | Script task failures only     |\n| `make incidents-service` | Service task failures only    |\n\n### Screenshot Capture\n\n| Command                 | Description                        |\n| ----------------------- | ---------------------------------- |\n| `make capture`          | Capture all screenshots (headless) |\n| `make capture-debug`    | Capture with visible browser       |\n| `make capture-cockpit`  | Capture only Cockpit screenshots   |\n| `make capture-tasklist` | Capture only Tasklist screenshots  |\n| `make capture-admin`    | Capture only Admin screenshots     |\n\n### Cleanup \u0026 Reset\n\n| Command                  | Description                        |\n| ------------------------ | ---------------------------------- |\n| `make reset`             | Reset Operaton (with confirmation) |\n| `make reset-force`       | Reset without confirmation         |\n| `make reset-instances`   | Delete process instances only      |\n| `make reset-deployments` | Delete deployments only            |\n| `make clean`             | Clean local output files           |\n| `make wipe`              | Full wipe: reset + clean           |\n\n### Workflows\n\n| Command      | Description                                    |\n| ------------ | ---------------------------------------------- |\n| `make quick` | Deploy → Data → Capture                        |\n| `make full`  | Deploy → Data → Simulate → Incidents → Capture |\n| `make fresh` | Reset → Full workflow                          |\n\n### Status \u0026 Debugging\n\n| Command                 | Description              |\n| ----------------------- | ------------------------ |\n| `make status`           | Show environment status  |\n| `make list-deployments` | List current deployments |\n| `make list-instances`   | List running instances   |\n| `make list-incidents`   | List current incidents   |\n| `make list-tasks`       | List current tasks       |\n\n## Configuration\n\n### Environment Variables (.env)\n\n```bash\n# Operaton Instance\nOPERATON_BASE_URL=https://operaton-doc.open-regels.nl\nOPERATON_REST_URL=https://operaton-doc.open-regels.nl/engine-rest\nOPERATON_USERNAME=demo\nOPERATON_PASSWORD=demo\n\n# Screenshot Settings\nSCREENSHOT_WIDTH=1920\nSCREENSHOT_HEIGHT=1080\nSCREENSHOT_SCALE=2\n\n# Capture Settings\nHEADLESS=true\nDEBUG=false\nOUTPUT_DIR=./output/screenshots\n```\n\n### Screenshot Definitions (config/screenshots.json)\n\nThe configuration file defines:\n\n- Screenshot categories (cockpit, tasklist, admin, welcome)\n- Individual screenshot definitions with URLs and selectors\n- Required data prerequisites\n- Output file paths\n\n## Directory Structure\n\n```\noperaton-screenshot-automation/\n├── Makefile                            # Command interface\n├── package.json                        # Node.js dependencies\n├── .env.example                        # Environment template\n├── config/\n│   └── screenshots.json                # Screenshot definitions\n├── processes/\n│   ├── bpmn/                           # BPMN process files\n│   │   └── invoice.bpmn                # Sample invoice process\n│   ├── dmn/                            # DMN decision files\n│   │   ├── invoice-assign-approver.dmn\n│   │   └── dish-decision.dmn\n│   └── cmmn/                           # CMMN case files\n├── scripts/\n│   ├── check-connection.js             # Connection checker\n│   ├── show-status.js                  # Status display\n│   ├── deploy-processes.js             # Process deployment\n│   ├── generate-data.js                # Data generation\n│   ├── simulate-scenarios.js           # Scenario simulation\n│   ├── create-incidents.js             # Incident creation\n│   ├── capture-screenshots.js          # Screenshot capture\n│   ├── analyze-documentation.js        # Doc analyzer\n│   └── reset-environment.js            # Environment reset\n└── output/\n    └── screenshots/                    # Captured screenshots\n```\n\n## Simulation Scenarios\n\n### Token Positions\n\nCreates process instances with execution tokens at specific activities:\n\n- Token at \"Approve Invoice\" user task\n- Token at \"Review Invoice\" user task\n- Token at \"Prepare Bank Transfer\" user task\n\n### History Data\n\nGenerates completed process instances with various outcomes:\n\n- Approved and paid invoices\n- Rejected invoices\n- Clarified and re-approved invoices\n\n### Task States\n\nCreates tasks in various states:\n\n- Unassigned tasks (candidate groups)\n- Assigned tasks\n- Overdue tasks\n- Tasks with follow-up dates\n\n## Incident Types\n\n### Script Task Failures\n\nDeploys processes with JavaScript that throws errors.\n\n### Service Task Failures\n\nDeploys processes with non-existent delegate expressions.\n\n### Expression Evaluation Errors\n\nDeploys processes with gateway conditions referencing undefined variables.\n\n### Async Job Failures\n\nDeploys async processes that fail during job execution.\n\n### External Task Failures\n\nCreates external tasks and explicitly fails them with error details.\n\n## Typical Workflow\n\n```bash\n# 1. Start fresh\nmake reset-force\n\n# 2. Deploy processes\nmake deploy\n\n# 3. Generate base data\nmake data\n\n# 4. Create specific scenarios\nmake simulate\n\n# 5. Add incidents for error screenshots\nmake incidents\n\n# 6. Check what we have\nmake status\n\n# 7. Capture all screenshots\nmake capture\n\n# 8. Review output\nls -la output/screenshots/\n```\n\n## Troubleshooting\n\n### Connection Issues\n\n```bash\nmake check  # Diagnose connection problems\n```\n\n### Screenshots Not Capturing\n\n```bash\nmake capture-debug  # Run with visible browser\n```\n\n### Processes Not Deploying\n\n- Check process XML validity\n- Verify REST API permissions\n- Check for existing deployments: `make list-deployments`\n\n### Incidents Not Created\n\n- Ensure processes are deployed first\n- Check job executor is running\n- Wait for async jobs: incidents may take a few seconds\n\n## Adding Custom Processes\n\n1. Add BPMN/DMN files to `processes/` directory\n2. Update `config/screenshots.json` with new screenshot definitions\n3. Add deployment config to deploy script if needed\n4. Run `make deploy`\n\n## License\n\nLicensed under the Apache License, Version 2.0. See the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsgort%2Foperaton-screenshot-automation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsgort%2Foperaton-screenshot-automation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsgort%2Foperaton-screenshot-automation/lists"}