Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yusukeiwaki/charai
Charai(Chat + Ruby + AI) driver for Capybara. Prototype impl for Kaigi on Rails 2024 presentation.
https://github.com/yusukeiwaki/charai
Last synced: about 1 month ago
JSON representation
Charai(Chat + Ruby + AI) driver for Capybara. Prototype impl for Kaigi on Rails 2024 presentation.
- Host: GitHub
- URL: https://github.com/yusukeiwaki/charai
- Owner: YusukeIwaki
- License: mit
- Created: 2024-10-05T11:37:44.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T12:35:12.000Z (3 months ago)
- Last Synced: 2024-11-27T03:31:22.159Z (about 2 months ago)
- Language: Ruby
- Size: 74.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/charai)
# Charai
Chat + Ruby + AI = Charai
## Setup
Add `gem 'charai'` into your project's Gemfile, and then `bundle install`
Also, this gem requires **Firefox Developer Edition** to be installed on the location below:
- /Applications/Firefox Developer Edition.app (macOS)
- /usr/bin/firefox-devedition (Linux)
## Configuration
Configure your Capybara driver like below.
```
Capybara.register_driver :charai do |app|
Charai::Driver.new(app, openai_configuration: config)
end
Capybara.register_driver :charai_headless do |app|
Charai::Driver.new(app, openai_configuration: config, headless: true)
end
```
Please note that this driver required OpenAI service.
### OpenAI
```
config = Charai::OpenaiConfiguration.new(
model: 'gpt-4o',
api_key: 'sk-xxxxxxxxxxx'
)
```
### Azure OpenAI (Recommended)
```
config = Charai::AzureOpenaiConfiguration.new(
endpoint_url: 'https://YOUR-APP.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-05-01-preview',
api_key: 'aabbcc00112233445566'
)
```
## Usage
Since this driver works with the OpenAI service, we can easily describe E2E test like below :)
```ruby
before do
Capybara.current_driver = :charai
Capybara.javascript_driver = :charai
page.driver.additional_instruction = <<~MARKDOWN
* このページは、3ペイン構造です。ユーザが仕事を探すためのページです。
* 左ペインには仕事の絞り込みができるフィルター、中央ペインが仕事（求人）の一覧で、30件ずつ表示されます。
* 左ペインにマウスを置いてスクロールしても、中央ペインはスクロールされません。一覧をスクロールしたいときには、中央ペインの座標を確認し、その中央にマウスを置いてスクロールしてください。
* 右ペインは、広告エリアです。検索条件に応じた広告が表示されます。
MARKDOWN
end
it 'should work' do
page.driver << <<~MARKDOWN
* 仕事の一覧が表示されたら、左ペインでサーバーサイドエンジニアで「Ruby on Rails」の仕事に絞り込みをしてください。
* 左ペインで絞り込んだら、中央ペインにRuby on Railsに関する仕事が表示されていることを確認してください。
* Ruby on Railsに関係のない仕事が、検索結果件数の半分以上あるばあいには、このテスト「検索結果不適合」として失敗としてください。
MARKDOWN
end
```
### Report for long-running E2E tests
We often trigger E2E test during the night since it costs a lot of time. It is really boring to sit down in front of the PC during E2E testing.
This driver provides an extension (callback) feature for reporting.
First, let's prepare a report formatter like this.
```ruby
class HtmlReport
def initialize
@content = []
end
def start(introduction)
@content << <<~HTML
#{introduction}
HTML
end
def add_conversation(content, answer)
if content.is_a?(Array)
text = content.find { |c| c[:type] == 'text' }[:text]
@content << <<~HTML
user
#{text}
HTML
content.each do |c|
next unless c[:type] == 'image_url'
@content << <<~HTML
HTML
end
@content << <<~HTML
assistant
#{answer}
HTML
else
@content << <<~HTML
user
#{content}
assistant
#{answer}
HTML
end
end
def to_html
@content << ""
@content.join("\n")
end
end
```
and then configure a callback for recording test-results into the report. It would be a good choice to use Allure reports's attachment feature for this.
```ruby
config.around(:each, type: :feature) do |example|
report = HtmlReport.new
Capybara.current_session.driver.callback = {
on_chat_start: -> (introduction) {
report.start(introduction)
},
on_chat_conversation: ->(content_hash, answer) {
puts answer
report.add_conversation(content_hash, answer)
},
}
example.run
Allure.add_attachment(
name: "Chat Report",
source: report.to_html,
type: 'text/html',
)
end
```
With this report, we can check evidences for each test and investigate failed tests (postmotem).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).