PactFfi
Ruby spike gem, to show interactions with the Pact Rust FFI methods.
Available on RubyGems - https://rubygems.org/gems/pact-ffi
Installation
Add this line to your application's Gemfile:
gem 'pact-ffi'
And then execute:
bundle
Or install it yourself as:
gem install pact-ffi
Usage
Simple
require 'pact/ffi'
puts PactFfi.pactffi_version
- See
lib/pact/ffi.rb
for all available methods - See
spec
folder to see the tests, with the library in use - See
examples/area_calculator
folder for an example using a pact-plugin, to test the canonical area_calculator example - Test it out in your browser, with our Killercoda example! https://killercoda.com/safdotdev/course/safacoda/grpc_plugins_quick_start_ruby
Supported Platforms
- Ruby
- This gem is compatible with all the rubies, and various platforms, it comes pre-packaged with the pact_ffi binary for each platform.
OS | Ruby | Architecture | Supported | Ruby Platform |
---|---|---|---|---|
OSX | 2.6 - 3.3 | x86_64 | ✅ | x86_64-darwin |
OSX | 2.6 - 3.3 | aarch64 (arm) | ✅ | arm64-darwin |
Linux | 2.6 - 3.3 | x86_64 | ✅ | x86_64-linux |
Linux | 2.6 - 3.3 | aarch64 (arm) | ✅ | aarch64-linux |
Linux (musl) | 2.6 - 3.3 | x86_64 | ✅ | x86_64-linux-musl |
Linux (musl) | 2.6 - 3.3 | aarch64 (arm) | ✅ | aarch64-linux-musl |
Windows | 2.6 - 3.3 | x86_64 | ✅ | x64-mingw-ucrt |
You can checkout the ci tests, to see all the architectures, platforms and examples tested
- GitHub Actions https://github.com/YOU54F/pact-ruby-ffi/actions
- Cirrus CI https://cirrus-ci.com/github/YOU54F/pact-ruby-ffi/main
note - Alpine is currently not supported, but is on the list
FFI libraries for your current platform - run
./script/download-libs.sh
to downloadIf testing the protobuf plugin
3.0
for protobuf/grpc example- See https://grpc.io/docs/languages/ruby/quickstart/ for steps
- See
examples/proto-ruby/README.md
for notes - ruby-grpc is not currently, on m1 hardware for the
pact-protobuf-plugin
example - Have the pact-protobuf plugin available
- Run
pact-plugin-cli -y install https://github.com/pactflow/pact-protobuf-plugin/releases/latest
- Run
Development
- run
bin/setup
orbundle install
to install dependencies - run
./script/download-libs.sh
to download FFI libraries for your current platform - run
rake spec
to run tests
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pact-ffi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the PactFfi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Pact Compatibility Suite
Help us implement the Pact Compatibility Suite
compatibility-suite/pact-compatibility-suite/features
├── V1
│ ├── http_consumer.feature
│ └── http_provider.feature
├── V2
│ ├── http_consumer.feature
│ └── http_provider.feature
├── V3
│ ├── generators.feature
│ ├── http_consumer.feature
│ ├── http_generators.feature
│ ├── http_matching.feature
│ ├── http_provider.feature
│ ├── matching_rules.feature
│ ├── .feature
│ └── .feature
├── V4
│ ├── generators.feature
│ ├── http_consumer.feature ✅
│ ├── http_provider.feature
│ ├── matching_rules.feature
│ ├── .feature ✅
│ ├── .feature ✅
│ ├── .feature ✅
│ └── v4.feature ✅