BAML Ruby Integration Tests

Install mise to manage ruby installations.

Build the ruby FFI client:

bash

cd ../engine/language_client_ruby
cargo build
mise exec -- bundle install
mise exec -- rake compile

To speed it up, you can try building the dev mode before doing rake compile:

bash

export RB_SYS_CARGO_PROFILE="dev"

Or you can add it in-place so you don't have to export again after closing the terminal:

bash

RB_SYS_CARGO_PROFILE="dev" mise exec -- rake compile

Running Tests

In this directory (integ-tests/ruby)

Install deps

bash

mise exec -- bundle install

Generate the BAML client code:

bash

mise exec -- rake generate

Run all tests

bash

infisical run --env=test -- mise exec -- rake test

Run specific tests

bash

# Run a specific test file
infisical run --env=test -- mise exec -- ruby test_functions.rb

# Run a specific test
infisical run --env=test -- mise exec -- rake test test_collector.rb TEST_OPTS="--name=/test_collector_no_stream_success/ -v"

Environment Variables

Tests can be run with environment variables using infisical (default)

bash

infisical run --env=test -- mise exec -- rake test

Alternatively, you can use a .env file with dotenv:

bash

mise exec -- rake test

Project Structure

baml_client/ - Generated BAML client code
test_functions.rb - Main test file
streaming-example.rb - Streaming functionality examples
tracing-demo1.rb - Tracing functionality examples
Gemfile - Ruby dependencies
Rakefile - Test and build tasks

Debugging Tests

Debug Logs

Add puts statements in your tests
Set the environment variable BAML_LOG=trace for detailed BAML client logs:

bash

BAML_LOG=trace infisical run --env=test -- mise exec -- rake test

Troubleshooting

Common Issues

Missing API Keys
- Ensure all required API keys are set in your environment
- Check that .env file exists if not using Infisical
- Verify Infisical is properly configured if using infisical run

Build Issues

If you get Rust compilation errors:

bash

# Clean and rebuild
(cd ../../engine/language_client_ruby && mise exec -- rake clean compile)

For Bundler issues:
bash
```
mise exec -- bundle install --clean
```

Ruby Version Issues
- Ensure mise is properly set up:
  bash
```
mise install
mise exec -- ruby --version
```
- If mise isn't picking up the right version:
  bash
```
mise trust
mise install
```
BAML Client Generation Issues
- Ensure BAML CLI is up to date
- Check that BAML source files in ../baml_src are valid
- Try regenerating the client:
  bash
```
rm -rf baml_client
mise exec -- baml-cli generate --from ../baml_src
```
Test Load Path Issues
- If tests can't find files, ensure you're running from the correct directory
- Try running with full paths:
  bash
```
mise exec -- ruby -I. test_functions.rb
```

Getting Help

Run tests with verbose output:

bash

infisical run --env=test -- mise exec -- rake test TESTOPTS="--verbose"

Use Ruby's debug mode:

bash

infisical run --env=test -- mise exec -- ruby -rdebug test_functions.rb

Check the test output for error backtraces and assertion details