Smoke testing is a crucial aspect of the software development lifecycle, allowing developers to catch critical issues before code changes are pushed to production. OpenClaw Deploy Gate provides an effective way to automate this process, ensuring your application is stable and ready for deployment. In this tutorial, we will cover how to set up and implement pre-push smoke testing using OpenClaw Deploy Gate. ## Prerequisites Before we dive into the setup, ensure you have the following: 1. **Basic Knowledge of Git**: Familiarity with Git commands and workflows is essential. 2. **OpenClaw Account**: You will need an account on OpenClaw to access the Deploy Gate features. 3. **Node.js and npm**: Make sure you have Node.js installed, as we will use npm for package management. 4. **A Sample Application**: You should have a sample application ready for testing. It can be a simple web application or an API service. 5. **Access to Your Repository**: Ensure you have write access to the repository where you will implement the smoke tests. ## Step-by-Step Instructions ### 1. Setting Up Your Project First, navigate to your application directory and ensure you have a proper Node.js environment set up. ```bash cd /path/to/your/project npm init -y ``` ### 2. Installing Required Packages You will need a testing framework to perform smoke tests. For this tutorial, we'll use `Jest`. Install it using npm: ```bash npm install --save-dev jest ``` ### 3. Writing Smoke Tests Create a `tests` directory in your project root. Inside this directory, create a file named `smoke.test.js`. This file will contain your smoke tests. ```bash mkdir tests touch tests/smoke.test.js ``` Open `smoke.test.js` and add the following example tests: ```javascript const request = require('supertest'); const app = require('../app'); // Adjust the path based on your project structure describe('Smoke Tests', () => { it('should return 200 for the homepage', async () => { const response = await request(app).get('/'); expect(response.statusCode).toBe(200); }); it('should return 200 for the API health check', async () => { const response = await request(app).get('/health'); expect(response.statusCode).toBe(200); }); }); ``` ### 4. Configuring Jest Add a test script to your `package.json` to easily run the tests: ```json "scripts": { "test": "jest" } ``` ### 5. Setting Up OpenClaw Deploy Gate Log in to your OpenClaw account and navigate to the Deploy Gate section. Here, you'll configure the pre-push hooks. ### 6. Creating a Pre-Push Hook You need to create a pre-push hook in your Git repository. Create a new file named `pre-push` in the `.git/hooks` directory: ```bash touch .git/hooks/pre-push chmod +x .git/hooks/pre-push ``` Open the `pre-push` file and add the following contents: ```bash #!/bin/bash # Run smoke tests npm test # Capture the exit code TEST_RESULT=$? if [ $TEST_RESULT -ne 0 ]; then echo "Smoke tests failed. Push aborted." exit 1 fi echo "Smoke tests passed. Proceeding with push." exit 0 ``` ### 7. Testing Your Setup Now that everything is set up, try making changes to your application and attempt to push them to your repository. 1. **Make a change** to your application. 2. **Stage and commit** your changes: ```bash git add . git commit -m "Test commit for smoke testing" ``` 3. **Push** your changes: ```bash git push origin main ``` The pre-push hook will execute, running your smoke tests. If the tests pass, the push will proceed; if they fail, the push will be aborted with an error message. ### 8. Troubleshooting Tips - **Tests are Failing**: Review the output in your terminal to identify which tests failed. Ensure your application is running correctly and that the endpoints used in the tests are accurate. - **Hook Not Executing**: Confirm that the `pre-push` hook is executable. You can set the executable permission using `chmod +x .git/hooks/pre-push`. - **Jest Not Found**: If you encounter an error about Jest not being found, ensure that it is installed in your project and that you are running the push command from the correct directory. ## Next Steps Congratulations! You have successfully set up pre-push smoke testing using OpenClaw Deploy Gate. ### Related Topics: - [Continuous Integration with OpenClaw](https://stormap.ai/documentation/ci) - [Automating Your Testing Workflow](https://stormap.ai/documentation/automation) - [Advanced Testing Techniques in Jest](https://stormap.ai/documentation/jest) Explore these topics to enhance your testing practices and streamline your development workflow!