A Template for using SHAFT_Engine

I. Quick Start Guide 🏃

Step 1: Setting up your project

• Click the blue button above that says "Use this template" > "Create a new repository"
• From your new repository click the blue button that says "<> Code" > "Open with GitHub Desktop"
• From your GitHub Desktop click the button that says "Open in JetBrains IntelliJ Idea Community Edition"
• Due to a known issue with IntelliJ you need to edit your run configuration templates before running your tests by following these steps:
  • Open 'Edit Run/Debug Configurations' dialog > Edit Configurations... > Edit configuration templates...
  • Select TestNG > Listeners > and add these listeners one by one:
    com.shaft.tools.listeners.AlterSuiteListener, com.shaft.tools.listeners.SuiteListener, com.shaft.tools.listeners.InvokedMethodListener
  • Select Cucumber Java > Program Arguments > and add this argument:
    --plugin com.shaft.tools.listeners.CucumberFeatureListener
  • After saving the changes, remember to delete any old test runs you may have triggered by mistake before adding the needed config.

Step 2: Running some Tests

• Navigate to the module that you want to play with. For example GUI_Web
• Navigate to any test class. For example src/test/java/TestPackage/TestClass.java
• Press the green play button next to the class name to run the entire class, or next to a test method to run only that method.
• Test execution will begin, and you'll see the browser opening and the test running.
• The Test execution report will open automatically in your default web browser after the test run is completed.

II. What's next?

Configuration and User Guide

• Change the target browser, operating system, timeouts, and other configurations using the ⚙️ Configuration Manager.
• Learn more about using SHAFT_Engine from the 👤 User Guide and 📚 Javadocs.
• Make sure to Star ⭐ SHAFT_Engine to get notified when new releases are pushed out.
• After upgrading your Engine it is sometimes recommended to delete the properties folder src\main\resources\properties and allow SHAFT to regenerate the defaults by running any test method.

CI/CD & DevOps

• This template comes preloaded with some Selenium grid 4 powered CI/CD pipelines to get you started!
• Navigate to "Actions" and then select "Desktop Browser Tests" from the side menu
• Click "Run workflow" and confirm your choice.
• You will notice that the pipeline has started building, and you can download the execution reports once the execution is completed.

III. Who else is using SHAFT? ¹

                                                                                                

IV. For Support & Contributions 👥

• Join us via Slack & Facebook
  
• And feel free to create PRs directly. This lovely tutorial will help.

Stop Reinventing the wheel! Start using SHAFT!

Footnotes

1. Company names are collected via anonymous surveys and provided freely by engineers who claimed to be using SHAFT_Engine within these companies. ↩