tlopo-selenium-docker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e44606ee96d7d1dd5c3be75a0d6c15783d45a76e6b8ff6c5d348cba082f49039
+  data.tar.gz: efd32c53c7cc27ed02e59a49adbe20311f1fc9b6633beab61db0511ce166ba36
+SHA512:
+  metadata.gz: 8279b6e826b5bbac0561c07eec38c31f9c6214c435c02fb4c26b4afde289c12f459e602b424ec141d6bba4f5d5cf27c7fdc52f047840a89bcbbcd87c546ac616
+  data.tar.gz: cd2b86ebbb72a22fbcc9389d82470fc60bb57ff9760d730eb6f30add1875d5589617a0c3944193da00b1ee3ce25d130b4bc6bda3ff5ebe8fa4c801e6eabe76d3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 tlopo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Tlopo::Selenium::Docker
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tlopo/selenium/docker`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tlopo-selenium-docker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tlopo-selenium-docker/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tlopo::Selenium::Docker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tlopo-selenium-docker/blob/main/CODE_OF_CONDUCT.md).

data/lib/tlopo/selenium_docker/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tlopo
+  class SeleniumDocker
+    VERSION = "0.1.0"
+  end
+end

data/lib/tlopo/selenium_docker.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require_relative "selenium_docker/version"
+require "zlib"
+require "fileutils"
+require "timeout"
+require "socket"
+require "docker"
+require "tlopo/futex"
+require "logger"
+require "selenium-webdriver"
+
+module Tlopo
+  class SeleniumDocker
+    LOGGER ||= Logger.new $stderr
+
+    def initialize(opts = {})
+      @selenium_image = opts[:selenium_image] || "selenium/standalone-chrome:4.8.3"
+      @video_image = opts[:video_image] || "selenium/video:ffmpeg-4.3.1-20220726"
+      @chrome_data_dir = opts[:chrome_data_dir] || nil
+      @video_path = opts[:video_path] || nil
+      @name = "selenium-#{gen_short_id}"
+      @ws = "/tmp/#{@name}"
+      FileUtils.mkdir_p @ws
+      FileUtils.mkdir_p @chrome_data_dir if @chrome_data_dir
+    end
+
+    def run
+      start
+      yield driver
+    ensure
+      driver.quit
+      stop
+    end
+
+    def gen_short_id
+      Zlib.crc32(Time.now.strftime("%s.%N")).to_s(36)
+    end
+
+    def get_port_lock(port)
+      filename = "/tmp/.selenium-docker-#{port}"
+      f = Tlopo::Futex.new(filename)
+      f.lock
+      f
+    end
+
+    def start
+      pull_images
+      lock_chrome_data_dir if @chrome_data_dir
+      @port = find_free_port 8100, 8150
+      @port_lock = get_port_lock @port
+      @vnc_port = find_free_port 5900, 5950
+      @vnc_port_lock = get_port_lock @vnc_port
+      create_network
+      start_selenium
+      start_video if @video_path
+    end
+
+    def stop
+      stop_video if @video_path
+      stop_selenium
+      remove_network
+      @port_lock.release
+      @vnc_port_lock.release
+      @chrome_data_dir_lock&.release
+      copy_video
+      FileUtils.rm_rf @ws
+    end
+
+    def copy_video
+      return unless @video_path
+
+      path = @video_path =~ /\.mp4$/ ? @video_path : "#{@video_path}.mp4"
+      FileUtils.cp "#{@ws}/video/video.mp4", path
+      LOGGER.debug "Recorded video saved to '#{path}''"
+    end
+
+    def find_free_port(from, to)
+      (from..to).each do |port|
+        next if Tlopo::Futex.new("/tmp/.selenium-docker-#{port}").locked?
+
+        Timeout.timeout(1) { TCPSocket.new("127.0.0.1", port).close }
+      rescue Errno::ECONNREFUSED
+        return port
+      end
+    end
+
+    def pull_images
+      [@selenium_image, @video_image].each do |image|
+        unless Docker::Image.exist? image
+          LOGGER.debug "Pulling image #{image}"
+          Docker::Image.create("fromImage" => image)
+        end
+      end
+    end
+
+    def create_network
+      network_name = @name.to_s
+      return if Docker::Network.all.map(&:info).any? { |n| n["Name"] == network_name }
+
+      LOGGER.debug "Creating network #{network_name}"
+      Docker::Network.create network_name
+    end
+
+    def remove_network
+      network_name = @name.to_s
+      return unless Docker::Network.all.map(&:info).any? { |n| n["Name"] == network_name }
+
+      LOGGER.debug "Removing network #{network_name}"
+      Docker::Network.get(network_name).remove
+    end
+
+    def get_container(container_name)
+      Docker::Container.get(container_name)
+    rescue Docker::Error::NotFoundError
+      nil
+    end
+
+    def stop_container(container_name, timeout = 30)
+      c = get_container(container_name)
+      return if c.nil?
+
+      LOGGER.debug "Stopping container '#{container_name}'"
+      c.stop t: timeout
+    end
+
+    def lock_chrome_data_dir
+      @chrome_data_dir_lock = Tlopo::Futex.new("#{@chrome_data_dir}/.chrome_data_dir.lock")
+      @chrome_data_dir_lock.lock
+    end
+
+    def start_selenium
+      ws = @chrome_data_dir || "/#{@ws}/chrome-data-dir"
+      LOGGER.debug "Starting selenium, container name: #{@name}, vnc port: #{@vnc_port}"
+      Docker::Container.create(
+        Image: @selenium_image,
+        name: @name.to_s,
+        HostConfig: {
+          NetworkMode: @name.to_s,
+          AutoRemove: true,
+          PortBindings: {
+            "4444/tcp": [{ HostPort: @port.to_s }],
+            "5900/tcp": [{ HostPort: @vnc_port.to_s }]
+          },
+          "Binds" => ["#{ws}:/tmp/chrome-data-dir"],
+          "ShmSize" => 2 * 1024 * 1024 * 1024 # 2 GB in bytes
+        },
+        Env: ["VIDEO=true"]
+      ).start
+    end
+
+    def stop_selenium
+      stop_container @name.to_s
+    end
+
+    def start_video
+      LOGGER.debug "Starting video, container name: #{@name}-video"
+      Docker::Container.create(
+        Image: @video_image,
+        name: "#{@name}-video",
+        HostConfig: {
+          NetworkMode: @name.to_s,
+          AutoRemove: true,
+          "Binds" => ["#{@ws}/video:/videos"]
+        },
+        Env: ["DISPLAY_CONTAINER_NAME=#{@name}"]
+      ).start
+    end
+
+    def stop_video
+      stop_container "#{@name}-video"
+    end
+
+    def driver
+      return @driver unless @driver.nil?
+
+      Timeout.timeout(60) do
+        loop do
+          TCPSocket.new("localhost", @port).close
+          url = "http://localhost:#{@port}/wd/hub"
+
+          options = Selenium::WebDriver::Chrome::Options.new
+          options.add_argument("--no-first-run")
+          options.add_argument("--user-data-dir=/tmp/chrome-data-dir")
+
+          @driver = Selenium::WebDriver.for :remote, url: url, capabilities: options
+          LOGGER.debug "driver created for #{@name}"
+          break
+        rescue Errno::ECONNREFUSED
+          sleep 0.5
+        rescue EOFError
+          sleep 0.5
+        rescue Selenium::WebDriver::Error::UnknownError
+          sleep 0.5
+        end
+      end
+      @driver
+    end
+  end
+end

data/lib/tlopo-selenium-docker.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "tlopo/selenium_docker"

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: tlopo-selenium-docker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tlopo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-28 00:00:00.000000000 Z
+dependencies: []
+description: Manges Selenium Docker container lifecycle and provides a handle to Selenium
+  driver
+email:
+- tlopo@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/tlopo-selenium-docker.rb
+- lib/tlopo/selenium_docker.rb
+- lib/tlopo/selenium_docker/version.rb
+homepage: https://github.com/tlopo-ruby/tlopo-selenium-docker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tlopo-ruby/tlopo-selenium-docker
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Manges Selenium Docker container lifecycle and provides a handle to Selenium
+  driver
+test_files: []