ChipperCI Integration

Introduction

ChipperCI is a continuous integration service specifically designed for Laravel applications. OtterWise integrates seamlessly with ChipperCI, making it easy to automatically collect and report code coverage data after your test suite runs.

This integration uses a lightweight bash script uploader that runs as a step in your ChipperCI workflow, ensuring your code coverage data is sent to OtterWise while maintaining security and privacy.

How It Works

The ChipperCI integration:

1. Runs your Laravel/PHP test suite with coverage reporting enabled
2. Uses a bash script to process and upload the coverage data to OtterWise
3. Detects the repository, branch, and commit information automatically
4. Works with PHPUnit, Pest, and other PHP testing frameworks that can generate coverage reports

Prerequisites

Before setting up the ChipperCI integration, you'll need:

• A GitHub repository connected to OtterWise
• A ChipperCI account with your repository configured
• A test suite that can generate coverage reports (Clover XML format recommended)

Setting Up the Integration

Step 1: Add the OtterWise Token as a Secret

First, you need to add your OtterWise token as a ChipperCI secret:

1. Navigate to your repository in ChipperCI
2. Go to "Project Settings" > "Secrets"
3. Add a new secret with the name OTTERWISE_TOKEN
4. Set the value to your OtterWise token (available in your repository settings in OtterWise)
5. Click "Save"

Step 2: Configure Your ChipperCI Pipeline

Add the OtterWise uploader to your ChipperCI configuration file (usually chipper.yml in your project root). Make sure it runs after your test suite has completed:

- name: Upload Coverage
  cmd: bash <(curl -s https://raw.githubusercontent.com/getOtterWise/bash-uploader/main/uploader.sh) --repo-token $OTTERWISE_TOKEN

The uploader will automatically detect that it's running in ChipperCI and will configure itself accordingly.

Complete ChipperCI Pipeline Example

Here's a complete example of a ChipperCI configuration for a Laravel project:

version: 1

environment:
  php: 8.2
  node: 18

services:
  - mysql: 8.0

pipeline:
  - name: Setup
    cmd: cp .env.example .env && composer install --no-interaction --prefer-dist

  - name: Prepare Database
    cmd: php artisan migrate --force

  - name: PHP Tests with Coverage
    cmd: vendor/bin/pest --coverage-clover=build/logs/clover.xml

  - name: Upload Coverage
    cmd: bash <(curl -s https://raw.githubusercontent.com/getOtterWise/bash-uploader/main/uploader.sh) --repo-token $OTTERWISE_TOKEN

Customizing the Integration

The OtterWise uploader has several options that can be used to customize the integration. You can read more about it on the Bash Uploader page.

Example with custom options:

- name: Upload Coverage
  cmd: bash <(curl -s https://raw.githubusercontent.com/getOtterWise/bash-uploader/main/uploader.sh) --repo-token $OTTERWISE_TOKEN --file ./custom/path/coverage.xml --flag api-tests

Troubleshooting

If you encounter issues with the ChipperCI integration, check these common problems:

• Coverage file not found: Verify that your test framework is generating the coverage report in the expected location
• PHP Coverage extension missing: Ensure Xdebug or PCOV is enabled in your ChipperCI environment
• Authentication errors: Ensure your OTTERWISE_TOKEN is correctly set in ChipperCI Secrets
• Git issues: ChipperCI should provide the correct git history by default
• Debug output: Remove the --quiet flag if you're having issues to see full debug output

For further assistance, contact OtterWise support or check our example repository which contains working CI configuration examples.

Benefits of Using ChipperCI with OtterWise

ChipperCI is specifically optimized for Laravel applications, making it an excellent choice for Laravel developers looking to integrate code coverage reporting. When used with OtterWise, you get:

• Laravel-specific optimizations: Environment tuned for PHP and Laravel applications
• Simplified setup: Preconfigured PHP environment with coverage extensions installed
• Automatic detection: The OtterWise uploader automatically detects ChipperCI environment variables
• Privacy focused: Code is never sent to OtterWise servers, only coverage metadata
• GitHub integration: Works with OtterWise's Pull Request comments, status checks, and line annotations