Olympix Tests Generation

Overview

The Olympix Test Generation action enables Olympix's test generator tool to be incorporated into continuous integration workflows for code repositories on GitHub. The action currently performs code analysis and test generation on projects written in Solidity. By using this action, Solidity developers can focus on building their smart contracts and let us handle the test creation when the CI workflow runs.

Features

• Unit Tests Generation: Automates the creation of unit tests ensuring the correctness and reliability of your code

Getting Started

1. Add a GitHub repository secret with your Olympix API token and set an environment variable on GitHub Workflow named OLYMPIX_API_TOKEN with the secret you just added
2. Add the olympix/test-generator GitHub Action into your workflow

*Add the following steps if you want to add the generated tests directly to your repository

4. Create a GitHub personal access token, add a GitHub repository secret with the personal access token you created and set an environment variable on GitHub Workflow named OLYMPIX_GITHUB_ACCESS_TOKEN with the secret you just added
5. Create a branch named opix-unit-test where the tests will be commited

Usage

Here's a workflow example that utilizes the Olympix Tests Generation Action. In this scenario, the process to generate the tests will be triggered every time a merge from main branch happens to the opix-unit-test branch:

name: Unit Test Generation Workflow
on:
  pull_request:
    types:
      - closed
      
jobs:
  test-generation:
    if: github.event.pull_request.merged == true && github.head_ref == 'main' && github.base_ref == 'opix-unit-test'
    
    runs-on: ubuntu-latest
    
    steps:
      - uses: actions/checkout@v3

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 18.17.1

      - name: Install dependencies
        run: npm install
      
      - name: Unit Test Generator
        uses: olympix/test-generator@main
        env:
          OLYMPIX_API_TOKEN: ${{ secrets.OLYMPIX_API_TOKEN }}
          OLYMPIX_GITHUB_ACCESS_TOKEN: ${{ secrets.OLYMPIX_GITHUB_TOKEN }}

This is another example which triggers the workflow on each commit that contains the string OPIX-GEN-UNIT-TESTS and runs forge install and npm install before triggering the test generator

name: Unit Test Generation Workflow
on:
  push

jobs:
  test-generation:
    
    if: contains(github.event.head_commit.message, 'OPIX-GEN-UNIT-TEST')
    runs-on: ubuntu-latest
    
    steps:
      - uses: actions/checkout@v3
        with: 
          submodules: recursive


      - name: Install dependencies
        run: npm install
     
      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1

      - name: Run forge install 
        run: |
          forge install


      - name: Unit Test Generator
        uses: olympix/test-generator@main
        env:
          OLYMPIX_API_TOKEN: ${{ secrets.OLYMPIX_API_TOKEN }}
          OLYMPIX_GITHUB_ACCESS_TOKEN: ${{ secrets.OLYMPIX_GITHUB_TOKEN }}

The workflow will start and an email will be sent to the address related to the api token with the result attached. The generation time varies based on the size and complexity of the contracts

Support Contact

If you have any question, feedback, or need help, feel free to contact us at contact@olympix.ai