How shafthq/shaft_engine works
Project type and purpose
• This is an open-source Java/Maven test-automation engine (SHAFT Engine). It exposes a unified API for GUI (Selenium/Appium), API (REST Assured), DB, CLI, data-driven, reporting, listeners, validations, performance and tooling.
• Its purpose is to let users write high-level, fluent test code while hiding boilerplate, synchronizations, integrations (Allure, ReportPortal, Selenium Grid, cloud providers) and configuration.
File structure
• Top-level:
• pom.xml (Maven build)
• .github/workflows (CI: e2e tests, publish, code-scanning)
• src/main/java/com/shaft: the core engine packages
• src/main/resources: default property files, docker-compose, k8s yamls, dynamic object repo
• src/test: comprehensive test suite organized by domain
• Core packages under com.shaft:
• api: RequestBuilder, RestActions
• cli: FileActions, TerminalActions
• cucumber: BDD step definitions
• db: DatabaseActions
• driver: DriverFactory, SHAFT class (entry point)
• gui: browser & element actions plus internal image/video/locator modules
• listeners: TestNG/JUnit/Cucumber listeners + Allure, Jira helpers
• performance: LightHouse reports
• properties: engine configuration loader & helpers
• tools: IO managers (CSV, JSON, Excel, PDF), security (Google Tink), support (HTML/JS/Java helpers), TMS integrations
• validation: Fluent validations builder for REST, file, number, WebDriver element/browser validations
• Resources:
• META-INF/services (auto-configured listeners)
• docker-compose & k8s (for grid, healenium, report-portal setups)
• default properties under src/main/resources/properties
README for additional insights
• The tech stack calls out Java, Maven, IntelliJ, Selenium, Appium, REST Assured, OpenCV, TestNG, JUnit5, Cucumber, Allure, ReportPortal, Selenium Grid, GitHub Actions, Dependabot, CodeQL, Codacy, JaCoCo, CodeCov.
• Features: scalability (parallel, containerized, cloud), reliability (auto-sync, logging, screenshots, video), maintainability (fluent API, smart locators).
• Indicates integration points (cloud device farms: BrowserStack, LambdaTest).
Essential checklist
• Clear labels on each component (package or class group).
• Configuration flow from PropertiesManager to all modules.
• Listener subscription to module events and reporting outputs.