SHOUT: The AI test companion SHOUT TERMS OF USE ------------------------------------------------------------ ## Important Notice: Terms of Use By downloading, installing, or using this tool ("Tool"), you agree to the following terms: 1. **Experimental Use:** - This Tool is provided free of charge on an experimental basis. Use it at your own discretion and risk. 2. **No Warranties:** - The Tool is provided "AS IS" without warranties of any kind, express or implied, including but not limited to merchantability or fitness for a particular purpose. 3. **OpenAI Account Usage:** - The Tool utilizes your OpenAI account for certain functionalities. Any charges incurred by OpenAI will be billed directly to your account. The Provider is not responsible for these charges. 4. **No Liability:** - The Provider (Dr. Michel Nass) is not liable for any damages, including but not limited to data loss, business interruption, or other issues resulting from the use of the Tool. 5. **No Obligation:** - Use of this Tool does not create any obligation to purchase or license any related product or service. 6. **Feedback:** - Feedback is welcome but entirely voluntary. By providing feedback, you grant the Provider a non-exclusive right to use it to improve the Tool. 7. **Intellectual Property:** - The Tool and its associated intellectual property remain the exclusive property of the Provider. 8. **Right to Terminate Experiment:** - Either the Provider or the Participant reserves the right to terminate the experiment and discontinue access to the Tool at any time without prior notice. --- If you do not agree to these terms, do not download or use the Tool. --- For questions or support, contact: michel.nass@gmail.com SETTINGS ------------------------------------------------------------ Edit settings.properties to add/change the: gpt_key (GPT-4 API key) Optionally also change: gpt_model gpt_assistant_model server_port: The port used by the SHOUT server. browser: Select Chrome, Firefox, Safari, or Edge. suite_folder: The folder name of the current suite. RUNNING SHOUT ------------------------------------------------------------ Windows: Run (double-click) the run.bat file (no Java JDK needed since using the included JDK) or double-click the Shout.jar file (need Java JDK 21 installed). Note that you might need to unblock the run.bat file since it was downloaded. Mac/Unix: Double-click the Shout.jar file (need Java JDK 21 installed). Start the SHOUT web interface in a browser at: localhost:5678 (default) Go to Settings and add/change: Application URL: The full URL to the system under test (SUT). Suite Objective: The objective of the test suite. Target No Tests: Keep at 0 to create tests manually. SHOUT will otherwise fill up with tests automatically. TESTING ------------------------------------------------------------ Changing the Application URL will load the website. Accept any cookies and log in if needed. Press the Save Cookies button to save the cookies (will be loaded automatically when URL is loaded). There are four ways of creating tests: 1. Automatically (SHOUT will create tests based on the Suite Objective). 2. Exploratory (SHOUT will explore the SUT based on an objective). 3. Import manual test instructions (either just test objectives or test objectives including steps). 4. Cocreate a test, step-by-step, in collaboration with SHOUT. 5. Assisted manual testing. SCHEDULING ------------------------------------------------------------ Tests can be auto run (and maintained) in intervals. Edit the suite.json file and modify: seconds_suite_delay: No of seconds between runs. Note that SHOUT should not be running when editing the suite.json file. COMMANDS ------------------------------------------------------------ The following commands can be used from a GET request in the format localhost:5678/command: request: A request to the AI Agent to answer a question, create a report, or to perform an action. >>request: Same as above but will respond in a raw format (not HTML page) useful when communicating with an external system. run: Run all tests. stop: Stop the test execution. kill: Terminate the server. TEST SUITE DATA ------------------------------------------------------------ The test suite data is stored in the "suite" folder that contains the following: history: Previous versions of the suite.json (backup). logs: Execution, prompts, error, tokens, and results from exploratory sessions. media: Screencaptures (from issues). data.txt: Test file to store business knowledge (username, passwords, workflows etc). stories.txt: Place any user stories in this file. suite.json: The test suite, tests, steps, issues in json format. Only edit this file when SHOUT is not running! website.cookies: Stored cookies. MULTIPLE TEST SUITES ------------------------------------------------------------ You may copy the "suite" folder to use more that one test suite. Adjust the suite_folder setting in the settings.properties file to point to the current test suite folder. USER MANUAL ------------------------------------------------------------ For details, read the user manual available from the SHOUT web interface.