testcontainers-postgres 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25e023c24e32f22ba240ff88dc76549f0a09613aa68f1c36c531797bfde7ff06
+  data.tar.gz: f0664ba9fadfca4dac0d16128d520ca822adae889270cc7162730db5ac1bd666
+SHA512:
+  metadata.gz: 85ef1679c31fe67156afa4bb324dd0b6b050cd8a4d62bbf044a88753799a995e458dfdc69d5836bdd253d5ceddcfce022b57c86e9e2c4f68975636a04de86aff
+  data.tar.gz: 78ce60e49c0a6d680fd13061fe008b7737ff437b6709399f578dd6c8a3f63ea13238dbab38f07e6b9517fdf0d4f17437426b0f66378c6b5809d09bb0afe4dc07

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.0] - 2023-05-13
+
+### Added
+
+- Initial release of the Postgres module

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in testcontainers-postgres.gemspec
+gemspec
+
+# Use the latest version of testcontainers-core from the local path
+gem "testcontainers-core", path: "../core"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: ../core
+  specs:
+    testcontainers-core (0.1.2)
+      docker-api (~> 2.2)
+
+PATH
+  remote: .
+  specs:
+    testcontainers-postgres (0.1.0)
+      testcontainers-core (~> 0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docker-api (2.2.0)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.99.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    minitest (5.18.0)
+    minitest-hooks (1.5.0)
+      minitest (> 5.3)
+    multi_json (1.15.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pg (1.5.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.28.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-hooks (~> 1.5)
+  pg (~> 1.5)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  testcontainers-core!
+  testcontainers-postgres!
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Guillermo Iguaran
+
+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,148 @@
+# Testcontainers module for Postgres
+
+testcontainers-postgres simplifies the creation and management of Postgres containers for testing purposes using the Testcontainers library.
+
+## Installation
+
+Add the library to the test section in your application's Gemfile:
+
+```ruby
+group :test do
+  gem "testcontainers-postgres"
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install testcontainers-postgres
+```
+
+
+## Usage
+
+To use the library, you first need to require it:
+
+```ruby
+require "testcontainers/postgres"
+```
+
+### Creating a Postgres container
+
+Create a new instance of the `Testcontainers::PostgresContainer` class:
+
+```ruby
+container = Testcontainers::PostgresContainer.new
+```
+
+
+This creates a new container with the default Postgres image, user, password, and database. You can customize these by passing arguments to the constructor:
+
+```ruby
+container = Testcontainers::PostgresContainer.new("postgres:11", username: "custom_user", password: "custom_pass", database: "custom_db")
+```
+
+### Starting and stopping the container
+
+Start the container:
+
+```ruby
+container.start
+```
+
+Stop the container when you're done:
+
+```ruby
+container.stop
+```
+
+### Connecting to the Postgres container
+
+Once the container is running, you can obtain the connection details using the following methods:
+
+```ruby
+host = container.host
+port = container.first_mapped_port
+```
+
+Or, you can generate a full database URL:
+
+```ruby
+database_url = container.database_url
+```
+
+Use this URL to connect to the Postgres container using your preferred postgres client library.
+
+### Customizing the container
+
+You can also customize the container using the following methods:
+
+```ruby
+container.with_database("custom_db")
+container.with_username("custom_user")
+container.with_password("custom_pass")
+```
+
+### Example
+
+Here's a complete example of how to use testcontainers-postgres to create a container, connect to it, and run a simple query:
+
+```ruby
+require "testcontainers/postgres"
+require "pg"
+
+container = Testcontainers::PostgresContainer.new
+container.start
+
+client = PG.connect(container.database_url)
+
+result = client.exec("SELECT 1 AS number")
+result.each do |row|
+  puts row.inspect
+end
+
+client.close
+container.stop
+```
+
+This example creates a Postgres container, connects to it using the `pg` gem, runs a simple `SELECT 1 as number` query, and then stops the container.
+
+### Using with RSpec
+
+You can manage the container in the `before(:suite)` / `after(:suite)` blocks in your `spec_helper.rb`:
+
+```ruby
+RSpec.configure do |config|
+  # This helps us to have access to the `RSpec.configuration.mysql_container` without using global variables.
+  config.add_setting :postgres_container, default: nil
+
+  config.before(:suite) do
+    config.postgres_container = Testcontainers::PostgresContainer.new.start
+    ENV["DATABASE_URL"] = config.postgres_container.database_url # or you can expose it to a fixed port and use database.yml for configuration
+  end
+
+  config.after(:suite) do
+    config.postgres_container&.stop
+    config.postgres_container&.remove
+  end
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/guilleiguaran/testcontainers. 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/guilleiguaran/testcontainers-ruby/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 Testcontainers project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/guilleiguaran/testcontainers-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/testcontainers/postgres/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Testcontainers
+  module Postgres
+    VERSION = "0.1.0"
+  end
+end

data/lib/testcontainers/postgres.rb

@@ -0,0 +1,107 @@
+require_relative "postgres/version"
+require "testcontainers"
+require "uri"
+
+module Testcontainers
+  # PostgresContainer class is used to manage containers that runs a PostgresQL database
+  #
+  # @attr_reader [String] port used by the container
+  # @attr_reader [String] username used by the container
+  # @attr_reader [String] password used by the container
+  # @attr_reader [String] database used by the container
+  class PostgresContainer < ::Testcontainers::DockerContainer
+    # Default port used by the container
+    POSTGRES_DEFAULT_PORT = 5432
+
+    # Default image used by the container
+    POSTGRES_DEFAULT_IMAGE = "postgres:latest"
+
+    POSTGRES_DEFAULT_USERNAME = "test"
+    POSTGRES_DEFAULT_PASSWORD = "test"
+    POSTGRES_DEFAULT_DATABASE = "test"
+
+    attr_reader :port, :username, :password, :database
+
+    # Initializes a new instance of PostgresContainer
+    #
+    # @param image [String] the image to use
+    # @param username [String] the username to use
+    # @param password [String] the password to use
+    # @param database [String] the database to use
+    # @param port [String] the port to use
+    # @param kwargs [Hash] the options to pass to the container. See {DockerContainer#initialize}
+    # @return [PostgresContainer] a new instance of PostgresContainer
+    def initialize(image = POSTGRES_DEFAULT_IMAGE, username: nil, password: nil, database: nil, port: nil, **kwargs)
+      super(image, **kwargs)
+      @port = port || ENV.fetch("POSTGRES_PORT", POSTGRES_DEFAULT_PORT)
+      @username = username || ENV.fetch("POSTGRES_USER", POSTGRES_DEFAULT_USERNAME)
+      @password = password || ENV.fetch("POSTGRES_PASSWORD", POSTGRES_DEFAULT_PASSWORD)
+      @database = database || ENV.fetch("POSTGRES_DATABASE", POSTGRES_DEFAULT_DATABASE)
+    end
+
+    # Starts the container
+    #
+    # @return [PostgresContainer] self
+    def start
+      with_exposed_ports(@port)
+      _configure
+      super
+    end
+
+    # Returns the database url (e.g. postgres://user:password@host:port/database)
+    #
+    # @param protocol [String] the protocol to use in the string (default: "postgres")
+    # @param database [String] the database to use in the string (default: @database)
+    # @param options [Hash] the options to use in the query string (default: {})
+    # @return [String] the database url
+    # @raise [ConnectionError] If the connection to the Docker daemon fails.
+    # @raise [ContainerNotStartedError] If the container has not been started.
+    def database_url(protocol: "postgres", username: nil, password: nil, database: nil, options: {})
+      database ||= @database
+      username ||= @username
+      password ||= @password
+      query_string = options.empty? ? "" : "?#{URI.encode_www_form(options)}"
+
+      "#{protocol}://#{username}:#{password}@#{host}:#{mapped_port(port)}/#{database}#{query_string}"
+    end
+
+    # Sets the database to use
+    #
+    # @param database [String] the database to use
+    # @return [PostgresContainer] self
+    def with_database(database)
+      @database = database
+      self
+    end
+
+    # Sets the username to use
+    #
+    # @param username [String] the username to use
+    # @return [PostgresContainer] self
+    def with_username(username)
+      @username = username
+      self
+    end
+
+    # Sets the password to use
+    #
+    # @param password [String] the password to use
+    # @return [PostgresContainer] self
+    def with_password(password)
+      @password = password
+      self
+    end
+
+    private
+
+    def _configure
+      add_env("POSTGRES_DATABASE", @database)
+      add_env("POSTGRES_USER", @username)
+
+      raise ContainerLaunchException, "Password is required for non-root users" if @password.nil? || @password.empty?
+
+      add_env("POSTGRES_PASSWORD", @password)
+      add_env("POSTGRES_ROOT_PASSWORD", @password)
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: testcontainers-postgres
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Piza
+- Guillermo Iguaran
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: testcontainers-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Testcontainers makes it easy to create and clean up container-based dependencies
+  for automated tests.
+email:
+- pedro920224@gmail.com
+- guilleiguaran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/testcontainers/postgres.rb
+- lib/testcontainers/postgres/version.rb
+homepage: https://github.com/guilleiguaran/testcontainers-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/postgres
+  source_code_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/postgres
+  changelog_uri: https://github.com/guilleiguaran/testcontainers-ruby/blob/main/postgres/CHANGELOG.md
+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.4.1
+signing_key:
+specification_version: 4
+summary: 'Testcontainers for Ruby: Postgres module'
+test_files: []